Template:Block indent/doc - Revision history

Matt at 22:12, 9 April 2025

2025-04-09T22:12:52Z

← Older revision		Revision as of 18:12, 9 April 2025
Line 1:		Line 1:
	{{wikipedia\|page name}}		{{wikipedia\|page name}}
	{{Documentation subpage}}		{{Documentation subpage}}
	~~{{used in system}}~~
	{{tsh\|bi}}		{{tsh\|bi}}
	{{Uses TemplateStyles\|Template:Block indent/styles.css}}		{{Uses TemplateStyles\|Template:Block indent/styles.css}}

Matt at 14:55, 9 April 2025

2025-04-09T14:55:40Z

← Older revision		Revision as of 10:55, 9 April 2025
Line 27:		Line 27:

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

	produces:		produces:

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

	===Parameters===		===Parameters===
Line 50:		Line 50:
	! scope="col"\|{{tl\|Blockquote}}		! 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>{{block indent\|1=}}</nowiki></code>
	\| width="50%"\| <code><nowiki>~~{{Lorem ipsum}}~~{{Blockquote\|1=~~{{Lorem ipsum}}{{Lorem ipsum}}}}{{Lorem ipsum~~}}</nowiki></code>		\| width="50%"\| <code><nowiki>{{Blockquote\|1=}}</nowiki></code>
	\|-		\|-
	\| ~~{{Lorem ipsum}}~~{{block indent\|1=~~{{Lorem ipsum}}{{Lorem ipsum}}}}{{Lorem ipsum~~}}		\| {{block indent\|1=}}
	\| ~~{{Lorem ipsum}}~~{{Blockquote\|1=~~{{Lorem ipsum}}{{Lorem ipsum}}}}{{Lorem ipsum~~}}		\| {{Blockquote\|1=}}
	\|}		\|}

Matt at 13:23, 9 April 2025

2025-04-09T13:23:57Z

← Older revision		Revision as of 09:23, 9 April 2025
Line 60:		Line 60:
	{{Block bug documentation}}		{{Block bug documentation}}

	~~==See also==~~
	* {{tl\|indent}}, which indents a single line, after a newline, using a mixture of en- and em-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, which is only for quotations

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|

Matt at 14:43, 8 April 2025

2025-04-08T14:43:32Z

← Older revision		Revision as of 10:43, 8 April 2025
Line 66:		Line 66:
	* {{tl\|hanging indent}}, the block hanging indent template		* {{tl\|hanging indent}}, the block hanging indent template
	* {{tl\|Blockquote}}, the block quotation template, which is only for quotations		* {{tl\|Blockquote}}, the block quotation template, which is only for quotations
	~~{{semantic markup templates}}~~

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|

Matt at 22:55, 6 April 2025

2025-04-06T22:55:58Z

← Older revision		Revision as of 18:55, 6 April 2025
Line 12:		Line 12:
	===Alternatives that are not recommended===		===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.)		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 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.)		{{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:		The default display of {{tl\|block indent}} differs from that of {{tl\|Blockquote}} in that it does not:
Line 36:		Line 36:
	{{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\|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 ~~[[Em (typography)\|~~<code>em</code> units]] by which to indent the material from the left; defaults to <code>3</code>		{{para\|left}} a.k.a. {{para\|em}} the value (e.g. <kbd>0.1</kbd> or <kbd>7</kbd>) in <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\|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)
Line 42:		Line 42:
	{{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\|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.		{{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)===		===Comparison with {{tl\|Blockquote}} (block quotation)===

Matt: Created page with "{{wikipedia|page name}} {{Documentation subpage}} {{used in system}} {{tsh|bi}} {{Uses TemplateStyles|Template:Block indent/styles.css}} == Usage == {{tl|block indent}} adds a block of indented text to a page. :`{{block indent|1={{var|The material to be indented here. May include markup, paragraph breaks, etc.}}}}` ===Alternatives that are not recommended=== A colon at the start of the line produces a similar indent, but i..."

2025-03-06T22:32:45Z

Created page with "{{wikipedia|page name}} {{Documentation subpage}} {{used in system}} {{tsh|bi}} {{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 i..."

New page

{{wikipedia|page name}}
{{Documentation subpage}}
{{used in system}}
{{tsh|bi}}
{{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 [[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-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, which is only for quotations
{{semantic markup templates}}

<includeonly>{{Sandbox other||

[[Category:Inline spacing templates]]
[[Category:Typing-aid templates]]
[[Category:Semantic markup templates]]
}}</includeonly>