imported>SebastianHelm: /* Purpose */ MOS:INDENTGAP

2022-01-13T23:10:29Z

New page

{{Documentation subpage}}
{{used in system}}
{{Template shortcut|pb|parabr|paragraph}}

== Usage ==
This template produces a "visual paragraph break" by inserting the following empty tag pair:

{{tag|div|attribs=class="paragraphbreak"|content=}}

Example:

{{block indent|{{xt|Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<nowiki>{{paragraph break}}</nowiki>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}}}

produces:

{{block indent|Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.{{paragraph break}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}

== Purpose ==
In some instances, it is not possible to introduce paragraph breaks using newlines alone. For example, within a list item and within references. However, using {{code|lang=html|code=<p>}} tags can cause problems for navigation with screen readers, which expect these tags to delimit paragraphs of prose (see e.g. [[MOS:INDENTGAP]]). This template is used mostly in footnotes, where a visual break is desired, without adding an additional paragraph navigation point.

== Example 1 ==
The following reference uses line breaks for multiple lines.<ref>Paragraph 1a
Paragraph 1b</ref>
The following reference uses the paragraph break template for paragraph breaks.<ref>Paragraph 2a{{paragraph break}}Paragraph 2b</ref>
The following reference uses {{code|lang=html|code=<br />}} tags for paragraph breaks.<ref>Line 3a<br />Line 3b</ref>

'''Notes'''
{{reflist}}

which was generated using:
<syntaxhighlight lang="html">
1.<ref>Paragraph 1a
Paragraph 1b</ref>
2. <ref>Paragraph 2a{{paragraph break}}Paragraph 2b</ref>
3. <ref>Line 3a<br />Line 3b</ref>
</syntaxhighlight>

== Example 2 ==
Consider the following list
# Paragraph 1a {{paragraph break}} Paragraph 1b
# Paragraph 2

which was generated using
<pre>
# Paragraph 1a {{paragraph break}} Paragraph 1b
# Paragraph 2
</pre>

<includeonly>{{Sandbox other||

[[Category:Typing-aid templates]]
}}</includeonly>
<templatedata>
{
"params": {},
"description": "Produces a \"visual paragraph break\"."
}
</templatedata>

Template:Paragraph break/doc - Revision history

imported>SebastianHelm: /* Purpose */ MOS:INDENTGAP