Template:BS-category/road/doc

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:BS-category/road.

---

This template adds some information about the colours used in the files in the category.

Usage

{{BS-category/road |1= |2= |w= |f= |set= |text= }}

Template parameters

 Parameter text is empty

<templatedata>JSON</templatedata> ./. {{TemplateBox}}

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

---

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

---

Wikipedia's help about TemplateData • Commons-specific information

This template adds some information about the colours used in the files in the category.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
	1	The root road category Default none	String	required
	2	Sub-category Default none	String	optional
	f	adds a line for the formation feature color; any value Default none	String	optional
	set	adds lines for a rail line's colors; must be a valid argument for Template:BS-color Default none	String	optional
	text	suppresses the header line of text Default none	String	optional
	w	adds a line for the water feature color; any value Default none	String	optional

Additional information

The template is intended to be used in the following namespaces: the Category namespace

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

Localization

This template is not intended to be localized.

Example

For example, {{BS-category/road|RD|crossing/rail|f=y}} would produce

These BSicons are to be used with route diagram templates. For an overview, see Category:BSicon. Colour RGB hex triplet road #AA9966 open line #BE2D2C closed line #D77F7E structure #80A080

on the page Category:BSicon/road/RD/crossing.