Template:Notelist/doc

From Len'en Wiki
Jump to navigation Jump to search
This is a documentation subpage for Template:Notelist.
It contains usage information, categories and other content that is not part of the original template page.

{{Notelist}} makes use of {{Reflist}} that provides formatting and organizational features for footnotes at the bottom of a page. Just like {{Reflist}}, it encapsulates the <references /> tag used by the cite MediaWiki extension to show the list of references as defined by <ref> tags. It adds support for sizing the column width, groups and list-defined references. This was originally from Wikipedia.

Specifically, {{Notelist}} is used to list notes about various aspects of a page.

Usage[edit source]

{{Notelist}} usually needs to be placed at the bottom of a page, with a h2 header above it named "Notes" (or a h3 header depending on the position of the template). The usage for this is mostly for listing trivial notes, such as meanings to translations. Note that this template is not used to list citations: that is taken care of with {{Reflist}}.

Note that you must use {{Note}} as the footnote marker rather than {{ref}} or a typical <ref> tag (depending on how you use the |group= parameter). This allows your notes to appear within the Notelist template.

The following text shows how it would be typically written:
Lorem ipsum.{{note|Note stuff}}
Lorem ipsum dolor sit amet.{{note|Note stuff}}

==Notes==
{{Notelist}}
And as such, it would be rendered as:

Lorem ipsum.[a] Lorem ipsum dolor sit amet.[b]

Notes[edit source]

  1. Note stuff
  2. Note stuff

Parameters[edit source]

You can add parameters, but they are optional; if none are supplied, a single-column list will be generated if there are fewer than 10 references in the list. If more than 10 references appear, it will use columns of 30em wide depending on the device. These get passed onto the {{Reflist}} (since this template makes use of that).

Optional parameters are:

  • Unnamed parameter (must be the first one if used): the minimum width for each column of references, typically in ems. Syntax (for example) |30em with no space (i.e. not |30 em). You can also use |colwidth=.
  • |refs=: used with list-defined references.
  • |group=: identifies by name the subset of references to be rendered; the value should correspond to that used inline, e.g., {{Reflist|group=groupname}} renders all references with groupname as the group name (<ref group=groupname>). Wikipedia has five pre-defined group names that style the list differently, but the Len'en Wiki would only need three at most.
  • |liststyle=: specifies the style used when the reference list is rendered. The default is an alphabetical list. When set, it will override the style set by the |group= parameter, without affecting group functionality.

Since this template is pretty much a replica of {{Reflist}}, see the documentation of that template for further details on how these parameters are used.

See also[edit source]