Difference between revisions of "Template:Block indent/doc"
en>SchreiberBike (Fix typo) |
(No difference)
|
Revision as of 18:01, 13 December 2017
 | This is a documentation subpage for Template:Block indent. It contains usage information, categories and other content that is not part of the original template page. |
Contents
Usage
This template block-indents the value that is supplied to it. This is similar to block quotation, but it uses the HTML <div>...</div> element, instead of semantically abusing the <blockquote>...</blockquote> element, which is only for block quotations. It is also preferred over semantically abusing a colon at the start of the line, which should be used only for description lists.
{{block indent |1=The material to be indented here. May include markup, paragraph breaks, etc.}}
The default display differs from the block quotation template {{Quote}} 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.
- support that other template's attribution parameters (since it isn't for quotations).
- support plain blank-line paragraph breaks inside it.
Both templates support paragraph breaks using <p>...</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, as its behavior may be altered at any time by the developers.
Example
{{block indent |1={{Lorem}}}}
produces:
Parameters
|1= a.k.a. |text= The material to be indented. {{{1}}}, because any occurrence (e.g. in a URL, template, etc.) of the = character will break the template without it.
|left= a.k.a. |em= the value (e.g. 0.1 or 7) in em units by which to indent the material from the left; defaults to 3
|right= the value, also in em, by which to indent the material from the right; defaults to 0 (use 7 to match the default left indentation)
|style= arbitrary CSS declarations, e.g. font-size: 95%;. This parameter should not normally be needed. Note: It already includes overflow: hidden; by default, to avoid collision of the div's background with floating elements.
|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 {{Quote}} (block quotation)
| {{Block indent}} | {{Quote}} |
|---|---|
{{lorem}}{{block indent|1={{lorem}}<p>{{lorem}}</p>}}{{lorem}}
|
{{lorem}}{{quote|1={{lorem}}<p>{{lorem}}</p>}}{{lorem}}
|
| 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.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. | 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.<templatestyles src="Template:Quote/styles.css"/>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. |
Technical issues with block templates
If the block-formatted content begins with a list (or any other wikimarkup that is dependent upon a specific markup character being at the beginning of a line) then due to a bug in MediaWiki, a <nowiki /> must exist before the list (or whatever) starts. Compare:
| code | result | |
|---|---|---|
| FAIL |
{{Block indent|1=
*Firstly, ...
*Secondly, ...
*Thirdly, ...
}}
|
|
| Works as intended |
{{Block indent|1=<nowiki />
*Firstly, ...
*Secondly, ...
*Thirdly, ...
}}
|
To embed a table in block markup like this, the block template's content parameter must be named or numbered and include the self-closing noinclude – as in |1=<nowiki /> – then every | character in the table markup must be escaped with {{!}}. An alternative is to use explicit HTML <table>, <tr>, <th>, and <td> markup.
See also
- {{indent}}, which indents a single line, after a newline, using a mixture of en- and em-dash sized spaces.
- {{spaces}}, which indents a single line (or content inline in one) uses non-breaking spaces.
- {{in5}}, which indents a single line (or content inline in one), skipping up to fifty equal en-sized spaces.
- {{quote}}, the block quotation template
- {{hanging indent}}, the block hanging indent template
