Difference between revisions of "Template:Linum/doc"

From blackwiki
Jump to navigation Jump to search
imported>SMcCandlish
(doc update)
imported>SMcCandlish
(→‎Tech note: udpate)
Line 92: Line 92:
  
 
==Tech note==
 
==Tech note==
{{outdated}}<!-- Fix in progress as of 2016-09-05. – SMcCandlish -->
+
This template uses <code>list-style-type: none</code> and <code>value=""</code> to suppress the the automated number generation of ordered lists.
This template uses <code>list-style</code> instead of the more specific <code>list-style-type</code> because of [[phab:T33746|MediaWiki task T33746]]. What that's fixed, the template should be, too.
 
  
 
==See also==
 
==See also==

Revision as of 22:26, 5 September 2016

Usage

This template, {{linum}} (for "list item, numbered") is part of the system of templates for copy-pasteable lists. It is used inside {{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

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

Examples

Basic copy-pasteable list:
{{unbulleted list
 | {{linum|1|The first ordered list item}}
 | {{linum|2|The second ordered list item}}
}}
  • 1.  The first ordered list item
  • 2.  The second ordered list item


Compare bare wikimarkup, with non-copy-pasteable numbers:

# The first ordered list item
# The second ordered list item
  1. The first ordered list item
  2. The second ordered list item

The style of this can be matched more closely with a parameter on the wrapper template:

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


Outline style:
{{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 -->

  • A)  The first ordered list item
  • B)  The second ordered list item
    • 1)  A nested sub-item


As a compact alternative to description lists:
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)}}
}}

Plural 'you' constructions:

  • English:  you all (informal), y'all (colloquial), yous (colloq.), yins (colloq.), ye (obsolete)
  • French:  vous
  • Mandarin:  nǐmen 你们
  • Spanish:  tus (informal), ustedes (formal)

Tech note

This template uses list-style-type: none and value="" to suppress the the automated number generation of ordered lists.

See also

Template:Olist/see-also