Template:BS-lists/doc

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search

This template generates code for {{BSicon catalogue}} based on presets.

Usage

{{BS-lists |1= |2= |3= |4= |5= |first= }}

Template parameters

ParameterDescriptionDefaultStatus
1TypePreset to be used for generating catalogue code. Valid values: endings, endings2, diagonals, curves, curves2, curves3, curves4, corners, to-corners, transitions, junctions, junctions2, junctions2x, junctions3, junctions3x, junctions-across, junctions-across2, junctions-across2x.emptyrequired
2Icon name (before suffix)Part of icon name to be used in each row before the preset's suffixemptysuggested
3Icon name (after suffix)Part of icon name to be used in each row after the preset's suffixemptysuggested
4DescriptionMain description for the rows of iconsemptysuggested
5Description (small text)Small text shown in each row after the main description and before the preset's descriptionemptyoptional
firstShow first rowIf true, displays a first row without a preset suffix or preset descriptionemptyoptional

Additional information

The template is intended to be used in the following namespaces: the main or gallery namespace (unprefixed)

The template is intended to be used by the following user groups: all users

Example

{{BS-lists|curves2|kBHF||Station|on k-curve}}

renders as:

kBHF+1~~Station~~on k-curve; line from corner 1
kBHF2~~Station~~on k-curve; line to corner 2
kBHF3~~Station~~on k-curve; line to corner 3
kBHF+4~~Station~~on k-curve; line from corner 4
kBHFr+1~~Station~~on k-curve; line to right from corner 1
kBHF2+r~~Station~~on k-curve; line to corner 2 from right
kBHF3+l~~Station~~on k-curve; line to corner 3 from left
kBHFl+4~~Station~~on k-curve; line to left from corner 4

Used in {{BSicon catalogue}}:

  ex u uex
kBHF+1         Station on k-curve; line from corner 1
kBHF2         Station on k-curve; line to corner 2
kBHF3         Station on k-curve; line to corner 3
kBHF+4         Station on k-curve; line from corner 4
kBHFr+1         Station on k-curve; line to right from corner 1
kBHF2+r         Station on k-curve; line to corner 2 from right
kBHF3+l         Station on k-curve; line to corner 3 from left
kBHFl+4         Station on k-curve; line to left from corner 4
  ex u uex