Template:I5
From Wikipedia, the free encyclopedia
This 'Indent_family_usage' template documentation is transcluded for all tagged templates [edit].
| Similar templates at English sister projects [edit] | |||
|---|---|---|---|
 |
wpd | Wikipedia | I5 |
 |
cms | Commons | I5 |
 |
wbk | Wikibooks | I5 |
 |
wsp | Wikispecies | I5 |
 |
wvy | Wikiversity | I5 |
See template talk:indent for a demonstration of the various formatting features within wiki-markup that this family of templates makes available to editors.
[edit] Usage
- This is common usage
- located in for the small family of typing-aid and formatting templates calling {{Indent}}— or derived from it... For the specific differences and behaviors, see the entry for this '{{I5|nn|xx}}' template below.
- Within wikimarkup, a 'wrapped-newline' means it will indent to align with line beginning formatting commands such as
':#', ':::::', '::**' etcetera.
As any second argument (parameter) to 'indent' will produce a second double wrapped newline— this gives the capacity for adding vertical whitespace to paragraph organized test stream even when deeply indented by successive numberized (or not) sub-paragraphs. This useful behavior has earned itself its own hardcoded template:2 with a conveniently shorter name. Placing this at the end of a formatted line, begins the next line with inherited indentation and font features, but with double-spaced appearance.
{{Indent|nn}}, {{Indent|nn|anything}} takes a numeric argument 'nn' after the pipe and provides that many ('nn') consecutive spaces like {{Space}}
(or 'S' and 'SP') do to pad spaces, but with the option of one or two newlines first preserving font and indentation of paragraphs.
- Indent differs from {{space}} only in that it automatically begins a wrapped-newline, then spaces over 'nn' spaces, whereas {{space}} spaces over 'nn' in the same (current) line.
- Consequently, combinations of these templates can not be used inline to create alignment between adjacent text lines, or to space out titles, etc. and are particularly useful inside wikitables and to control formatting in infoboxes or within other templates.
However, the wrapped-newline generated is not the same as an HTML <br> (or hard return) newline, but instead one which returns left to the margin of 'whatever indentation level' is in effect in expansion of the text block built using wiki markup language set by the familiar control characters ':', '*', or '#', and their legal combinations, like ':*', '**', ':#' and etc.
- A feature of note in this family is that text formatting commands like bold or italic text carry over past the application of the template through and past the so called 'wrapped newline'. Hence these (related) templates have many uses in block quotes. Wiki-markup would require each paragraph displayed to individually be text effect formatted. Judicious use of these can save a lot of time and effort. Note the clarity and vertical separation of the numberized list following in related family members.
- The actual number of resulting 'displayed' spaces in these templates or those depending upon {{Space}} is highly browser and font selection dependent, due to the way it treats a given text line and tries to compact whitespace, uses partial width characters in the font, etcetera. Combine with the HTML monospace specifier <tt>{{s|5}}</tt> or <tt>{{s|5}}</tt> will give less uncertain left-right spacing at a given zoom in/out setting.
In general, lining things of unequal length up in a column gives a near miss to the ideal, being a somewhat wavy column differing by partial spaces given the letters in a font. It is however just a near miss, and quite useful.
[edit] Related family members
- Most of these once called {{indent}} directly,
- and using {{indent}} 'directly' itself is rare as 'I', 'I0', 'I2', 'I5' are all much shorter and more compact. (Which attribute is certainly desirable in a typing aide.)
- {{I}} -- defaults to three spaces, and no longer calls Indent, but has a 10 space mini version of the same logic structure. This unburdens the pre-expansion sizes needed for templates.
This line begins with an {{I}} call. Note the indented nature and truncation of the line preceding.
In sum, {{I}} terminates the sentence immediately preceding, and starts a newline with an indented first line. Subsequent wrapped lines, wrap to whatever wiki markup paragraph control characters is in effect on the text block. This makes it versatile and useful for signed posts and involved discussions on wiki talk pages.
(Also very useful in tables where edit-jumble is a factor, or on talks to create indented paragraph beginnings inside a wiki indented ':', '::', '::*', or a '#' prefixed line).
Can also be given a second parameter such as {{I|15|2}} in which case, acts identical to {{I2|15}} below— both these examples causing a fifteen space indentation.
- {{I0}} -- that's eye-zero, not (the two letters) eye-Oh -- Spaces down one line like 'i' preventing additional wrapping, but lining up with whatever inherited indentation comes from wiki markup control characters '*', ':', '#', etc. are operative. It is most frequently used to restore indentation to the 'normal indent' immediately following something doubly indented by '**' or '##' using the sequence construct:
":{{I0}} continuation text in the discussion"
- {{I2}} -- performs a second linefeed similar to <br><br> in a line, but retains the inherited indent in a text block, and like I0, does not actually indent the first line unless given a second parameter. This creates vertical whitespace that was a common misnomer (commonly misnamed) 'double spaced' paragraphs in the days of typewriters before WYSIWIG and word processing. It makes keeping presentations clear easy and painless.
- {{I5}} -- Same as I, but using a default of five spaces extra indentation in and after single newline effect within wiki markup paragraphs indented flow.
[edit] Example calls
- {{I2|5}}-- precedes the sentence beginning: However, the newline generated... early in the text above.
- {{I}}-- use is illustrated above immediately preceding the paragraphs beginning "{Very useful..." and "Consequently, this template...", as well as several other places which should be obvious as the lines are indented three spaces one line down.
- {{indent|2}}, {{space|7}}, etc. ...
space and indent are limited to adding 30 spaces.
