Omniversalis:Line-break handling

From Omniversalis

Template:Wikipedia how to

This page explains different methods for creating, controlling and preventing line breaks and word wraps in Wikipedia articles and pages.

When a paragraph or line of text is too long to fit on one line, web browsers, like many other programs, automatically wrap the text to the next line. Web browsers usually insert the word wraps where there are spaces in the text.

Causing line breaks[edit]

There are several ways to force line breaks and paragraph breaks in the text. The simplest method is by inserting newlines; for example:

Markup Renders as
A single newline in the markup 
does not cause a visible line break.

A single newline in the markup does not cause a visible line break.

Two newlines in the markup

causes a paragraph break.

Two newlines in the markup

causes a paragraph break.

Three newlines in the markup


causes an extra-wide paragraph break. This should normally be avoided.

Three newlines in the markup


causes an extra-wide paragraph break. This should normally be avoided.

<br>[edit]

The <br> or <br /> tag is used for a single forced line break. This can for instance be useful in a parameter of an infobox template, since tighter line spacing than paragraph breaks are often preferred inside boxes.

Markup Renders as
And this line of text<br>will break in the middle.

And this line of text
will break in the middle.

(For content that is semantically a list, such as in infoboxes, actual list markup is preferred. See Script error: The function "formatLink" does not exist. below.)

The MediaWiki software converts valid forms like <br>, <br/> and <br > to <br />. Additionally, HTML Tidy – which is slated for removal As of 2017 – converts the invalid form </br> to <br />. These conversions do not occur on a number of MediaWiki interface pages, and can cause invalid HTML and problems rendering the page when used there.

Until Tidy is removed, the forms <br>, <br/> and <br /> are equivalent. After Tidy's removal, only <br /> can be guaranteed to display correctly. Editors should therefore use <br />.

<poem>[edit]

The <poem> extension adds HTML-like tags to maintain newlines and spaces. This is useful for longer blocks of text such as poems, lyrics, mottoes, oaths and the like. These tags may be used inside other tags such as <blockquote>. For example:

Markup Renders as
<poem>
In Xanadu did Kublai Khan
  A stately pleasure-dome decree:
Where Alph, the sacred river, ran
  Through caverns measureless to man
Down to a sunless sea.

So twice five miles of fertile ground
  With walls and towers were girdled round:
And there were gardens bright with sinuous rills,
  Where blossomed many an incense-bearing tree;
And here were forests ancient as the hills,
  Enfolding sunny spots of greenery.
</poem>

In Xanadu did Kublai Khan
  A stately pleasure-dome decree:
Where Alph, the sacred river, ran
  Through caverns measureless to man
Down to a sunless sea.

So twice five miles of fertile ground
  With walls and towers were girdled round:
And there were gardens bright with sinuous rills,
  Where blossomed many an incense-bearing tree;
And here were forests ancient as the hills,
  Enfolding sunny spots of greenery.

Lists[edit]

Numbered and bulleted lists are created using standard wikimarkup. In cases where a plain list without number or bullet is desired, such as in an infobox, many editors will simply create a list using breaks. This method does not apply the semantics of a list, and for those using screen readers it will not sound like a list. For these cases, {{plainlist}} and {{unbulleted list}} both use list markup without numbers or bullets:

Markup Renders as
{{plainlist|
* cat
* dog
* horse
* cow
* sheep
* pig
}}
  • cat
  • dog
  • horse
  • cow
  • sheep
  • pig

Preventing and controlling word wraps[edit]

There are several ways to prevent word wraps (line wraps) from occurring in unwanted places. This is an overview of when to use which method.

&nbsp;[edit]

The HTML entity &nbsp; is a non-breaking, or hard, space. It renders like a normal space " ", but prevents a line wrap from occurring, like this:

Markup Renders as
Lots of text 10&nbsp;kg more text.

It may render like this:

Lots of text 10 kg
more text.

Or it may render like this:

Lots of text
10 kg more text.

But it will not render like this:

Lots of text 10
kg more text.

The nonbreaking space works within links exactly like a regular space. Thus you can link to [[J.&nbsp;R.&nbsp;R. Tolkien]] directly and it will render as J. R. R. Tolkien. The initials will not be separated across a line break.

&#8209;[edit]

Similarly, words or phrases containing hyphens normally line wrap where necessary. A non-breaking hyphen may be used to prevent this occurring, as in:

As seen in section 1&#8209;2 of the paper.

Thus, line wrapping that breaks the section identifier 1‑2 is prevented.

{{nowrap}}[edit]

The {{nowrap}} template prevents line wraps in text and links containing spaces. Consider a more complex case like "10 kg (22 lb)". It can be coded like this:

Lots of text 10&nbsp;kg&nbsp;(22&nbsp;lb) more text.

But that is slightly awkward. So in such cases it is instead recommended to use the {{nowrap}} template. Like this:

Lots of text {{nowrap|10 kg (22 lb)}} more text.

It may render like this:

Lots of text 10 kg (22 lb)
more text.

Or like this:

Lots of text
10 kg (22 lb) more text.

But it will not render like this:

Lots of text 10 kg (22
lb) more text.

(For the specific case of unit conversions, see {{convert}}.)

In some cases {{nowrap}} doesn't work so well. For instance, when you want to prevent wraps in longer or more complex text, then it might be hard to see where the {{nowrap}} ends. Additionally, the MediaWiki template mechanisms interpret characters such as equal signs "=" and pipes "|" in template parameters as special characters, and thus they cause problems. In these cases, it is instead recommended to use {{nowrap begin}} + {{nowrap end}}, like this:

{{nowrap begin}}2 + 2 = 4{{nowrap end}} and
{{nowrap begin}}|2| < 3{{nowrap end}}

It may render like this:

2 + 2 = 4 and
|2| < 3

But it will not render like this:

2 + 2 = 4 and |2|
< 3

<wbr /> and soft hyphens[edit]

<wbr /> is a word break opportunity; that is, it specifies where it would be OK to add a line-break where a word is too long, or it is perceived that the browser will break a line at the wrong place.

Markup
Now is the time to become a power editor, by learning Hyper<wbr />Text Markup Language...
Renders as It may render like this:
Now is the time to become a power editor, by learning HyperText Markup Language...

Or it may render like this (in a narrow browser window):

Now is the time to become a power editor, by learning Hyper
Text Markup Language ...

Note that <wbr /> will not work inside {{nowrap}}.

In many cases breaking up a word with a space would be inappropriate. Soft hyphens create a word break opportunity, but will add a hyphen rather than a space. The code &shy; is employed in the same manner as <wbr /> as seen in the examples above.

Use of soft hyphens should be limited to special cases, usually involving very long words or narrow spaces (such as captions in infoboxes or other tight page layouts, or column labels in narrow tables). Widespread use of soft hyphens is strongly discouraged, because it makes the wikitext very difficult to read and to edit. For example:

Markup Renders as
This Wi&shy;ki&shy;source ex&shy;am&shy;ple is dif&shy;fi&shy;cult to un&shy;der&shy;stand

This Wikisource example is difficult to understand

Markup Renders as
{{shy|This al|ter|na|tive syn|tax im|proves read|a|bil|ity}}

This alternative syntax improves readability

Wrap between (linked) list items[edit]

In lists of links such as inside infoboxes and navboxes, use the CSS class hlist (perhaps via the template {{flatlist}}) to format lists.

For occasional cases where you need to delineate two pieces of text outside of a list, you can use the templates {{·}} or {{•}} which contain a &nbsp; before the dot, thus handling some of the wrapping problems.

See also[edit]