View source for Template:Linum/doc

{{documentation subpage}}
==Usage==
This template, {{tlx|linum}} (for "list item, numbered") is part of the '''system of templates for copy-pasteable lists'''.  It is used inside {{tlx|unbulleted list}} to provide a number, automatically spaced for you, in front of an item in an ordered list.  It can be used to layout complicated outlines, e.g. "I) ... A) ... 1) ... i) ..." and other formats.

===Parameters===

* {{para|1}} or first unnumbered parameter – the number, letter or other designation of the line item (e.g. <code>1</code>, <code>A</code>, <code>xiv</code>, <code>physics</code>, etc.). This can have wikimarkup (e.g. style, even a link) applied to it.
* {{para|2}} or {{para|text}} or {{para|content}} or second unnumbered - text of the item (can contain wikilinks and other markup like normal).
* {{para|punct}} – the punctuation after the number or other designation (e.g. <code>)</code>, <code>:</code>, <code>&amp;nbsp;–</code>; defaults to <code>.</code> like our default list <code>#</code>-formatted wikicode list style's output). No trailing space is needed; the template will provide that.
* {{para|color}} – a <code>#{{var|XXXXXX}}</code> color code or [[Web color]] name for the text (not background) color of the designation supplied in {{para|1}}, for unusual cases in which this is needed.  This should not normally be used in mainspace {{crossref|(see [[MOS:COLOR]])}}.

===Examples===

;Basic copy-pasteable list{{colon}}:
<pre>
{{unbulleted list
 | {{linum|1|The first ordered list item}}
 | {{linum|2|The second ordered list item}}
}}
</pre>

{{unbulleted list
 | {{linum|1|The first ordered list item}}
 | {{linum|2|The second ordered list item}}
}}


Compare bare wikimarkup, with non-copy-pasteable numbers:
<pre>
# The first ordered list item
# The second ordered list item
</pre>

# The first ordered list item
# The second ordered list item

The style of this can be matched more closely with a parameter on the wrapper template:
<pre>
{{unbulleted list |style=margin-left: 2em
 | {{linum|1|The first ordered list item}}
 | {{linum|2|The second ordered list item}}
}}
</pre>

{{unbulleted list |style=margin-left: 2em
 | {{linum|1|The first ordered list item}}
 | {{linum|2|The second ordered list item}}
}}


;Outline style{{colon}}:

<pre>
{{unbulleted list |style=margin-left: 1.5em
 | {{linum|A |punct=) |text=The first ordered list item}}
 | {{linum|B |punct=) |text=The second ordered list item <!-- leave item open for nested list -->
   {{unbulleted list |style=margin-left: 1.5em
      | {{linum|1 |punct=) |text=A nested sub-item}}
   }} <!-- close nested list -->
 }} <!-- close open item -->
}} <!-- close main list -->

</pre>

{{unbulleted list |style=margin-left: 1.5em
 | {{linum|A |punct=) |text=The first ordered list item}}
 | {{linum|B |punct=) |text=The second ordered list item <!-- leave item open for nested list -->
   {{unbulleted list |style=margin-left: 1.5em
      | {{linum|1 |punct=) |text=A nested sub-item}}
   }} <!-- close nested list -->
 }} <!-- close open item -->
}} <!-- close main list -->


;As a compact alternative to [[description list]]s{{colon}}:
This kind of usage should be in some {{em|clear order}} (alphabetical, chronological, etc.); otherwise use an unordered list.

<pre>
Plural 'you' constructions:
{{unbulleted list |style=margin-left: 1em
 | {{linum|English  |punct=: |text=you all (informal), y'all (colloquial), yous (colloq.), yins (colloq.), ye (obsolete)}}
 | {{linum|French   |punct=: |text=''{{lang|es|vous}}''}}
 | {{linum|Mandarin |punct=: |text=''nǐmen'' {{lang|zh|你们}} }}
 | {{linum|Spanish  |punct=: |text=''{{lang|es|tus}}'' (informal), ''{{lang|es|ustedes}}'' (formal)}}
}}
</pre>

Plural 'you' constructions:
{{unbulleted list |style=margin-left: 1em
 | {{linum|English  |punct=: |text=you all (informal), y'all (colloquial), yous (colloq.), yins (colloq.), ye (obsolete)}}
 | {{linum|French   |punct=: |text=''{{lang|es|vous}}''}}
 | {{linum|Mandarin |punct=: |text=''nǐmen'' {{lang|zh|你们}} }}
 | {{linum|Spanish  |punct=: |text=''{{lang|es|tus}}'' (informal), ''{{lang|es|ustedes}}'' (formal)}}
}}

==Tech note==
This template uses <code>list-style-type: none</code> and <code>value=""</code> to suppress the automated number generation of ordered lists, then replaces them with a copy-pasteable (and scalable!) value provided by the editor (it is passed to and generated by the {{tl|lino}} meta-template).

==See also==
{{olist/see-also}}

<includeonly>{{Sandbox other||
<!-- Categories go here -->
[[Category:Copy-pasteable list templates]]
}}</includeonly>