View source for Template:Block indent/doc

{{Documentation subpage}}
<!--{{high-use}}-->
{{tsh|bi}}
{{cleanup}}
{{Uses TemplateStyles|Template:Block indent/styles.css}}

== Usage ==
{{tl|block indent}} adds a block of indented text to a page.

:<code><nowiki>{{block indent|1=</nowiki>{{var|The material to be indented here. May include markup, paragraph breaks, etc.}}<nowiki>}}</nowiki></code>

===Alternatives that are not recommended===

A colon at the start of the line produces a similar indent, but it produces incorrect HTML. See [[MOS:INDENT]]. (An initial <code>:</code> was intended only for use after <code>;</code>, in constructing [[MOS:DEFLIST|description lists]], but most editors have used it almost everywhere for indenting.)

{{tl|Blockquote}} is for actual quotations only. Using it for block indent is not correct [[semantic HTML]], and the appearance differs. ({{tl|Blockquote}} produces the HTML {{tag|blockquote}} element, which indicates a [[block quotation]]; {{tl|block indent}} produces the HTML {{tag|div}} element.)

The default display of {{tl|block indent}} differs from that of {{tl|Blockquote}} in that it does not:
* introduce whitespace margins above or below the indented material (just add a blank line above and/or below manually); nor
* indent from the right as well as the left (there is an optional parameter for this); nor
* affect the font size of its contents; nor
* (on mobile) bookend the block with large quotation marks; nor
* support plain blank-line paragraph breaks inside it; nor
* support attribution parameters (because {{tl|block indent}} isn't for quotations).

{{tl|Blockquote}} and {{tl|block indent}} both support paragraph breaks using {{tag|p}} around second and subsequent paragraphs, as well as other HTML markup, and it is always safest to explicitly format with HTML rather than rely on MediaWiki's parser to do the right thing, because the developers could alter its behavior at any time.

===Example===
{{tlx|block indent|1{{=}}{{tl|Lorem ipsum}}}}

produces:

{{block indent|1={{Lorem ipsum}}}}

===Parameters===
{{para|1}} a.k.a. {{para|text}} The material to be indented. {{strong|1=It is always safest to explicitly define this with <code>1=</code>, not as an unnamed parameter}}, because any occurrence (e.g. in a URL, template, etc.) of the <code>=</code> character will break the template without it.

{{para|left}} a.k.a. {{para|em}} the value (e.g. <kbd>0.1</kbd> or <kbd>7</kbd>) in {{Wikipedia|Em (typography)|<code>em</code> units}} by which to indent the material from the left; defaults to <code>3</code>

{{para|right}} the value, also in <code>em</code>, by which to indent the material from the right; defaults to <code>0</code> (use <kbd>7</kbd> to match the default left indentation)

{{para|style}} arbitrary CSS declarations, e.g. <code>font-size: 95%;</code>. This parameter should not normally be needed. Note: It already includes <code>overflow: hidden;</code> by default, to avoid collision of the div's background with floating elements.

{{para|class}} any CSS class names (e.g. as defined at [[MediaWiki:Common.css]]), comma-separated if more than one. This parameter should not normally be needed.

===Comparison with {{tl|Blockquote}} (block quotation)===
{| class="wikitable"
|-
! scope="col"|<nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>}}</nowiki>
! scope="col"|{{tl|Blockquote}}
|-
| width="50%"| <code><nowiki>{{Lorem ipsum}}{{block indent|1={{Lorem ipsum}}{{Lorem ipsum}}}}{{Lorem ipsum}}</nowiki></code>
| width="50%"| <code><nowiki>{{Lorem ipsum}}{{Blockquote|1={{Lorem ipsum}}{{Lorem ipsum}}}}{{Lorem ipsum}}</nowiki></code>
|-
| {{Lorem ipsum}}{{block indent|1={{Lorem ipsum}}{{Lorem ipsum}}}}{{Lorem ipsum}}
| {{Lorem ipsum}}{{Blockquote|1={{Lorem ipsum}}{{Lorem ipsum}}}}{{Lorem ipsum}}
|}

===Technical issues with block templates===
{{Block bug documentation}}

==See also==
* {{tl|indent}}, which indents a single line, after a newline, using a mixture of en- and em-dash sized spaces
* {{tl|spaces}}, which indents a single line (or content inline in one) uses non-breaking spaces
* {{tl|in5}}, which indents a single line (or content inline in one), skipping up to fifty equal en-sized spaces
* {{tl|hanging indent}}, the block hanging indent template
* {{tl|Blockquote}}, the block quotation template

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Inline spacing templates]]
[[Category:Typing-aid templates]]
[[Category:Semantic markup templates]]
}}</includeonly>