View source for Template:Indent family usage

<!-- --------------- Interwiki Doc page pattern -------------------><includeonly>{{-}}
<small>''This 'Indent_family_usage' template documentation is [[w:Wikipedia:Template doc page pattern|transcluded]] for all {{Lts| Indent family usage }} tagged templates'' [<span class="plainlinks">[{{fullurl:Template:Indent family usage|action=edit}} edit]</span>].{{#ifeq:{{SITENAME}}|Wikipedia|&nbsp;|[[W:template:{{PAGENAMEE}}|Masterpage]]
&nbsp;}}</small> </includeonly> <noinclude>{{template doc page viewed directly}}
{{interwikitmp-grp|V=0|cats=|inhib=yes|{{PAGENAME}}|{{PAGENAME}}}} <!-- Self-declare  -->
 
[[Category:Template documentation|{{PAGENAME}}]]
<!-- EDIT IN TEMPLATE CATEGORIES BELOW THIS LINE --></noinclude><includeonly>
[[Category:Typing-aid templates|{{PAGENAME}}]]
[[Category:Wikipedia formatting and function templates|{{PAGENAME}}]]<!--



-->
{{#if:{{ifequal|{{PAGENAME}}|I|{{PAGENAME}}|I2|{{PAGENAME}}|I5}}<!--This is pairs which may match or not, but pairs!
-->|{{interwikitmp-grp|V=3|cat=typing-aid templates|wdy=|wqt=|wsr=|wnw|mta=<!--
-->|SYS=yes|{{PAGENAME}}|{{{2|}}}<!--
-->}}<!--
-->|{{interwikitmp-grp|V=3|cat=typing-aid templates|wdy=|wqt=|wsr=|wnw<!--
-->|SYS=yes|{{PAGENAME}}|{{{2|}}} }}<!--
-->}}<!--
--></includeonly><noinclude><!--
+++ Quick and dirty Version (quasi) table -- please observe the five fields and update accordingly.
+++   #1   #2    #3       #4                     #5
+++ Ver Code# SITENAME What was changed then your signature.
+++ 
+++  After a change, please update the linked sister sites, but save and then re-edit to capture 
+++  the time stamped signature before capturing with [CTRL-A].
+++
-->{{Left66|{{{width|60}}}|BG=#d7e8f9|M={{{margin|0 3em 3em 0}}};| P={{{padding|.3em;}}}| B={{{border|1}}}| ALTCMD={{{other|}}}}}
<center style="width:98.0%; background:#d7ffe0; border:1px; padding:3px;margin:0;">[[W:WP:TSP|Template Sharing Project]] ''stable version at a glance'' <br/>for '''[<code> Template: {{{page|{{{1}}}}}} </code>]'''.<!--
+++
---></center> <!-- begin iftest, returns TRUE iff [( {{{1|}}} OR {{{data|}}}) AND ( {{{2|}}} OR {{{ver|}}} )]
  +++
  -->{{#if:<!-- Input error trap if statement. Scope spans to end of template
+++ +++-->{{#if:{{{1|x}}}{{{data|}}}|{{{2|x}}}{{{ver|}}}<!-- →ends AND boolean→ 
+++             
+++ +++-->}}
|<hr/><!-- begin then case of trap... do display, have enough inputs. -->
'''Version: {{{ver|{{{2|Ver E.1}}}}}}'''<br/><!-- endif
}}{{#if:{{{data|}}}{{{3|x}}}|{{{data|{{{3|}}} }}}
:Ver: E.1 -- Text grooming and spelling fixes [[User:JohnI|JohnI]] ([[User talk:JohnI|talk]]) 08:14, 20 January 2008 (UTC)
:Ver: D--updating sister sites using older of these variants (e.g. including some of which where've they've been deleted)<br/><b>[[User:Fabartus|Fra]]</b><font color="green">[[User talk:Fabartus|nkB]]</font> 19:43, 2 November 2007 (UTC)
:Ver: C.2--Wikipedia-- bold Formatting, add notation  and documentation on {&#123;[[template:1]]}&#125; &amp;&amp; {{[[template:2]]}&#125; <b>[[User:Fabartus|Fra]]</b><font color="green">[[User talk:Fabartus|nkB]]</font> 14:58, 5 April 2007 (UTC)
:Ver: C.1--Wikipedia-- (Mn) fx interwiki link, delete extra /noinclude at bottom -- <b>[[User:Fabartus|Fra]]</b><font color="green">[[User talk:Fabartus|nkB]]</font> 13:04, 9 February 2007 (UTC)
:Ver: B--Wikipedia-- nesting fix <b>[[User:Fabartus|Fra]]</b><font color="green">[[User talk:Fabartus|nkB]]</font> 09:31, 9 February 2007 (UTC)
:Ver: A--Wikipedia-- V=4 call revision, <b>[[User:Fabartus|Fra]]</b><font color="green">[[User talk:Fabartus|nkB]]</font> 05:19, 3 February 2007 (UTC)
:Ver: _--Wikipedia--Split out of {{Tl2|Indent}} at this date and time. // <B>[[User:Fabartus|Fra]]</B><font color="green">[[User talk:Fabartus|nkB]]</font> 20:12, 2 January 2007 (UTC)
<!-- End Then -->
|<!-- #if trap then case ends, begin it's else case here
  +
+++ start by ending the narrow display block to have a wider margin, using a noticably different color. 
  +
+++ Immediately start error handling width and color ---
--> </div >{{Left66|98|BG=#f7e5b8|M=0 3em 3em 0;|P=.3em;|B=1}}<center><code>Error: Parameter 'data=...' (or <nowiki>{{{1}}} and {{{2}}}</nowiki> undefined in Template:{{{1|{{PAGENAME}}}}}</center></code>
<br/><code>
;define parameters as</code>:

<pre>
In the following:  ({{{page}}} overrides {{{1}}}, ver overrides {{{2}}}, data overides {{{3}}}

{{{1}}} or {{{page}}}  
{{{2}}} or {{{ver }}} Current '''version "ID" string''' - should match annotation in data following
{{{3}}} or {{{data}}} Block of change sentences, paragraph size group of lines about significant edits:
           The Lines of annotations on significant edit history i.e. those indented using 
           ':' or '*' etc. recording sisterproject originating the change, it's scope, etc.
           Oldest at bottom, newest changes at top, preferably timestamped by signature.
</pre>

<code>'''call examples</code>:'''
<pre>
{{Q&D version|Tl2|Ver C.1 (tag words in a series of changes, A, B, C... etc.
|←All the accumulated lines of words describing the changes each terminated by a ~~~~ 
<last change>
<...>
<earlier change> In practice, changes beyond a year or two or so are irrelevant.
}} <--  last change history line is above the close of the template call.
</pre>

----
<small><tt>set help=anything in preview, to see a few more optional parameters.</tt></small>

<pre>
{{Q&D version
  | page= Tl2
  |  ver= Ver C.1 (tag words in a series of changes, A, B, C... etc.
  | data= ←All the accumulated lines of words describing the changes each terminated by a ~~~~ 
<last change>
<...>
<earlier change> In practice, changes beyond a year or two or so are irrelevant.
}} <--  last change history line is above the close of the template call.

</pre></div <!--
+++
+++ End of Error trap upper div block, restore original width command to finish
-->
>{{Left66|{{{width|60}}}|BG=#d7e8f9|M={{{margin|0 3em 3em 0}}};|P={{{padding|.3em;}}}|B={{{border|1}}}|ALTCMD={{{other|}}}}}

{{#if:{{{help|x}}}
|xxx{{Left66|{{{width|60}}}|BG=#d7f9e8|M=0 0.3em 0.3em 0;|P=.3em;|B=2px blue solid;}}
;other parameters:
<pre> Note: These are all relative to a <div>...</div> block:
width              Must be a percentage, tweak if needed; default is 60%
other              Free formatting parameter in the controlling (outer) &lt;div>
                     {{Bull;}}use to float:, align, clear or other HTML command
margin             overrides the default, should you float:right, etc.
border             overrides the default
padding            overrides the default
</pre>
end3</div ><!-- ends Helps div call -->}}
end2</div ><!------ endelse {{{data}}}/{{{3}}} test  -->}}<!------ endelse {{{data}}}/{{{3}}} test  -->
end1}}</div><!-- End of Version Table --->
{{-}}
;End of Version Table, confirmed?
----
;This template is called as usage notes by the entire family of templates using Indent logic. It also auto-categories them and tags all the same with the same interwikitmp-grp template and categories.

</noinclude>

See {{wpd|template talk:indent}} for a demonstration of the various formatting features within wiki-markup that this family of templates makes available to editors.
----
==Usage==
{{32FC|
{{#ifeq:{{PAGENAME}}|I|<!-- 
--- "I" note: -->
;This is similar to {{Tlx|I5}}, which defaults to five spaces but this version defaults to three spaces when given no parameter as that proved most useful within tables when indenting in a maze of pipes and parentheses and such clutter.
:As of c. 19:43, 2 November 2007 (UTC), ths has b disconnected from calling {{tl|Indent}} as it almost always is used as <nowiki>{{I}}</nowiki> sans arguments following a similar change to {{tl|I5}} months ago. 
:*Unlike `I5', `I` will still take <nowiki>{{{1}}}</nowiki> and expand it, but this is '''limited to five spaces'''/counts vice the 30 of indent.
}}
{{#ifeq:{{PAGENAME}}|I2|<!-- This cut in from template I2 11-04-2007! --->
;This is similar to {{Tl2|I5}}, which defaults to five spaces but this version defaults to three spaces when given no parameter as that proved most useful within tables when indenting in a maze of pipes and parentheses and such clutter.
}}

;This is common usage: located in {{lts|Indent family usage}} for the small family of typing-aid and formatting templates calling {{Tlx|Indent}}&mdash; or derived from it... For the specific differences and behaviors, see the entry for this '{{Tlx|{{PAGENAME}}|nn|xx}}' template below.

* Within [[w:wikimarkup|wikimarkup]], a 'wrapped-newline' means it will indent to align with line beginning formatting commands such as {{I0}}'''<big>':#', ':::::', '::**'&nbsp;'''etcetera.</big> {{2}}As any second argument (parameter) to 'indent' will produce a second double wrapped newline&mdash; '''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 [[w:hardcode|hardcode]]d [[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|5}}'''<nowiki>{{Indent|nn}}, {{Indent|nn|</nowiki>''anything''<nowiki>}}</nowiki>''' takes a numeric argument 'nn' after the pipe and provides that many ('nn') consecutive spaces like {{Tlx|Space}} {{I5}}(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 {{tl|space}} only in that '''''it automatically begins a wrapped-newline''', then spaces over ''''nn'''' spaces'', whereas {{tl|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. {{I2|5}} However, the wrapped-newline generated is not the same as an HTML <nowiki><br></nowiki> (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'' <b>':', '*', or '#',</b> and their legal combinations, like <big><b> ':*', '**', ':#'</b> </big>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 {{TL|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 '''<nowiki><tt>{{s|5}}</tt> or <tt>{{s|5}}</tt></nowiki>''' will give less uncertain left-right spacing at a given zoom in/out setting. 
{{I}}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.

==Related family members==
;Most of these once called {{tlx|indent}} directly, :and using {{TLX|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''.){{I2}}
# '''{{Tlx|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. {{i}}This line begins with an {{tl|I}} call. Note the indented nature and truncation of the line preceding. {{I}}In sum, {{TL|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. {{i}}(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).{{I}}Can also be given a second parameter such as '''{{Tlx|I|15|2}}''' in which case, acts identical to '''{{tlx|I2|15}}''' below&mdash; both these examples causing a fifteen space indentation.{{I2}}
# '''{{tlx|I0}}''' -- that's ''eye-zero'', not (the two letters) ''eye-Oh'' -- Spaces down <u>one line</u> 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: {{I}}"''':{{tlx|I0}}''' ''continuation text in the discussion''"<br />{{#ifexist:template 2|<br /># '''{{Tlx|2}}''' is strictly speaking not part of this family as it does not connect to {{tl|indent}} under any use condition. However, functionally it is effectively the sub-template that is used in the {{tl|I2}} below to generate double-spacing. Unlike {{tl|I2}}, it will Subst cleanly and easily if needed. (In general calls to {{tl|indent}} are best left as a template without substitution.){{I2}}|<br />}}
# '''{{Tlx|I2}}''' -- performs a second linefeed similar to <nowiki><br><br></nowiki> 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 [[w:misnomer|misnomer]] (commonly misnamed) 'double spaced' paragraphs in the days of typewriters before WYSIWIG and word processing. It makes keeping presentations clear easy and painless.{{I2}} 
#'''{{tlx|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.

==Example calls==
* '''{{TLX|I2|5}}'''-- precedes the sentence beginning: ''However, the newline generated...'' early in the text above. 

* '''{{tl|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. 

* '''<nowiki>{{indent|2}}, {{space|7}}, etc. </nowiki>'''...{{i|5}}'''space''' and '''indent''' are limited to adding '''30 spaces'''.
<!--- DO NOT add Noinclude block around above text. 
[[Category:WikiProject Interwiki equalization|!{{PAGENAME}}]]---><!--- convention: '!' designates template in Project category --->
|32FC ends}}