View source for Template:Block indent/doc

{{Documentation subpage}}
{{Used in system}}
{{Template redirect|Blockindent}}{{Template shortcut|Bi}}
{{Uses TemplateStyles|Template:Block indent/styles.css}}
The {{Template link general|Block indent}} template adds an indented content block to a page.

== Usage ==
{{Template link general|code=yes|Block indent|2=1=<var>The material to be indented here. May include markup, paragraph breaks, etc.</var>}}

=== Example ===
{{Template link general|_show_result=yes|nowrapname=yes|plaincode=yes|Block indent|2=1=Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.}}

== TemplateData ==
{{Format TemplateData|1=<templatedata>{
	"description": "Add a content block indented from one or both page margins",
	"format": "inline",
	"paramOrder": [
		"1",
		"left",
		"right",
		"style",
		"class"
	],
	"params": {
		"1": {
			"aliases": [
				"content",
				"quote",
				"text"
			],
			"label": "Indented content",
			"description": "The page content to display indented. This should always be defined as a ''named'', '''not an unnamed''', parameter to avoid parser errors.",
			"type": "content",
			"required": true
		},
		"left": {
			"aliases": [
				"em"
			],
			"label": "Left indentation width",
			"type": "number",
			"default": "3",
			"description": "A valid [[CSS]] length value (e.g. <kbd>0.1</kbd> or <kbd>7</kbd>) in [[Em (typography)|em units]] by which to indent the material from the left page margin"
		},
		"right": {
			"label": "Right indentation width",
			"type": "number",
			"description": "A valid [[CSS]] length value, also in [[Em (typography)|em units]], by which to indent the material from the right page margin (define as <code>7</code> to match the default left margin indentation)",
			"default": "0"
		},
		"style": {
			"label": "Custom styling",
			"type": "line",
			"description": "Custom [[CSS]] style declarations to be added following the default (<code>overflow: hidden;</code>), each terminated by a [[semicolon]]",
			"example": "font-size: 0.95rem;"
		},
		"class": {
			"label": "CSS classes",
			"type": "line",
			"description": "Additional [[CSS]] class names (e.g. as defined at [[MediaWiki:Common.css]]) to declare alongside the default (<code>block-indent</code>), [[Whitespace character|whitespace]]-delimited if more than one",
			"example": "toccolours2"
		}
	}
}</templatedata>}}

== Alternatives that are not recommended ==
A colon at the start of the line produces a similar indent, but it produces incorrect HTML; see {{Section link|Wikipedia:Manual of Style|Indentation}} for more details. (An initial {{Code|:}} was intended only for use after {{Code|;}} in constructing [[Wikipedia:Manual of Style/Lists#Description (definition, association) lists|description lists]], but many editors have used it ubiquitously for simple indentation.)

{{Template link general|Blockquote}} employs the HTML {{Tag|blockquote|link=yes}} element and is intended for use only with actual [[block quotation]]; using it for indenting simple block elements breaks [[semantic HTML]] and the appearance differs. (Whereas {{Template link general|Block indent}} employs an HTML {{Tag|div|link=yes}} element with padding offsetting it from the left and/or right page margins.)

The default display of {{Template link general|Block indent}} differs from that of {{Template link general|Blockquote}} in that it does not:
* introduce vertical whitespace above or below the indented material (add blank lines above and/or below manually, as needed)
* indent from the right as well as the left (though the optional {{Parameter|right}} parameter triggers this behavior)
* affect the font size of its contents
* bookend the block with large quotation marks on mobile devices
* support plain blank-line paragraph breaks inside it, or
* support attribution parameters (because {{Template link general|Block indent}} isn't for quotations).

{{Template link general|Blockquote}} and {{Template link general|Block indent}} both support internal paragraph breaks through the use of HTML {{Tag|p|link=yes}} tags around subsequent paragraphs, as well as other HTML markup. It is always safest to explicitly format using raw HTML rather than rely on MediaWiki's parser because future updates to it could alter the output at any time.

=== Comparison with [[Template:Blockquote]] ===
{| class="wikitable"
 ! scope="col" | {{Template link general|{{BASEPAGENAME}}}}{{Efn|group=comptable|<syntaxhighlight lang="wikitext" inline="1">{{Lorem ipsum}}{{Block indent|1={{Lorem ipsum}}}{{Lorem ipsum}}</syntaxhighlight>}}
 ! scope="col" | {{Template link general|Blockquote}}{{Efn|group=comptable|<syntaxhighlight lang="wikitext" inline="1">{{Lorem ipsum}}{{Blockquote|1={{Lorem ipsum}}}}{{Lorem ipsum}}</syntaxhighlight>}}
 |-
 | {{Lorem ipsum}}{{Block indent|1={{Lorem ipsum}}}}{{Lorem ipsum}}
 | {{Lorem ipsum}}{{Blockquote|1={{Lorem ipsum}}}}{{Lorem ipsum}}
 |-
 | colspan="2" style="background-color: var(--background-color-base, #f8f9fa); border-bottom: hidden; border-left: 0 solid var(--background-color-base, #f8f9fa); border-right: hidden;" | <div style="font-size: 0.925em; font-style: italic; margin: 0 0 -0.75em 1em;">Source wikitext:</div>{{Notelist|group=comptable}}
|}

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

== See also ==
{{Block indentations templates}}
* {{Template link general|Blockquote}}, only for use with [[block quotation]]s
* {{Template link general|Hanging indent}}
* {{Template link general|Indent}} – indents a single line, after a newline, using a mixture of [[En (typography)|en]] and/or [[Em (typography)|em]] [[Whitespace character|spaces]]
* {{Template link general|Indent 5}} – indents a single line (or portion of inline content) using up to fifty (50) equal [[En (typography)|en]] [[Whitespace character|spaces]]
* {{Template link general|Spaces}} – indents a single line (or portion of inline content) using [[non-breaking space]]s

{{Semantic markup templates}}

<includeonly>{{Sandbox other||<!-- Please place category links below this line, and interwiki links at Wikidata. Thank you. -->
[[Category:Inline spacing templates]]
[[Category:Semantic markup templates]]
[[Category:Typing-aid templates]]
}}</includeonly>