Template:Notelist/doc

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.

This page is part of Wikibooks Trainz Wikibook Administration.
• It lists a template which may be useful editing Trainz. Trainz specific (special purpose) templates will be found in or under Category:Trainz Templates, which also lists/links to this Help page.

Warning: Note, this is nearly but not identical to the Wikipedia template of the same name. This version defaults to group=note versus Wikipedia's default of 'lower-alpha', as does the Wikibook version of {{efn}} or "Explanatory Foot Note".

{{notelist}} creates a section of explanatory notes that were individually specified by {{efn}} tags in the article. This is analogous to the use of long form <tag>...</tag> and <references /> tags for normal citations. This creates one or a block of tagged notes in a block or section that should be placed above and ahead of any citations or {{reflist}} template. See the whatlinkshere for plenty of examples in the Trainz Wikibook.

The {{notelist}} section should generally occur before the references. This is required when the explanatory notes are referenced, otherwise there will be citations errors. Even if the explanatory notes are not referenced, they are probably more likely to be read than the references, and should be nearer to the top of the MOS:APPENDIX sections than the "References" section for this reason.

Usage

XML Example

{{notelist}}

Parameters

Single unnamed parameter:

column-count: a natural number specifying fixed columns into which the reference list is to be rendered. Example: |2.

column-width: a typographic unit of measurement such as em|, specifying the width for the reference list columns. Example: |30em.

colwidth: explicitly sets the column-width.
refs: used with named references (e.g., <ref name=name />); it specifies a list of some or all named references used in the article.
group: |group= Sets the group name|, and needs to be the same as those inline. This defaults to lower-alpha.

The available options are:

group	Styled as
upper-alpha	^[A]
upper-roman	^[IV]
lower-alpha	^[a]
lower-greek	^[a][ß]
lower-roman	^[iv]
note	^{[note 1]}

close: forces the reference list to close and render all references defined to that point; see the section on multiple uses| for details.

Example

See w:Template:Notelist/doc for working examples.: (truncated help below using {{void}} to by-pass.