Template:Sandbox other/doc

From OpenStreetMap Wiki
Jump to navigation Jump to search

This template allows to differentiate between regular Template:... and Template:.../sandbox pages. It is typically used to prevent a /sandbox page being categorised with their main page.

Also
when numbered /sandbox1

Any subpage /sandboxANYTEXT is considered a /sandbox. So this includes /sandbox1, /sandbox_2.

Also
/doc

A /doc subpage is also considered a /sandbox.

Usage

This template can be used on template documentation pages to ensure that any given template sandbox or template documentation does not populate its main template's categories.

This template has two unnamed or positional parameters, |1 = and |2 =. Near the bottom of a /doc page where the categories are usually placed, install this template as follows:

{{Documentation subpage}}
<!-- All documentation code goes here -->
…
<includeonly>{{Sandbox other||
<!-- Categories the main template should be in, but not the /sandbox: -->
[[Category:(first category)]]
[[Category:(second category)]]
}}</includeonly>
  • Usage of an empty first parameter (two pipes together, ||, at the end of the first line of code above) essentially means |1 = (do nothing) and will not allow the sandbox page to populate the listed categories.
  • Note that the closing template braces, }}, are placed just before the </includeonly> tag. This is the same as |2 = (category comment and categories). In "long hand" it may appear as follows:
<includeonly>{{Sandbox other|1=<!-- Keep sandbox out of categories -->|2=
<!-- Categories go below this line -->
[[Category:(first category)]]
[[Category:(second category)]]
(More categories, if needed)
}}</includeonly>

TemplateData

This is the TemplateData for this template used by VisualEditor.
TemplateData for Sandbox other

This template allows to differentiate between regular Template:... and Template:.../sandbox pages.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Sandbox text1

no description

Contentoptional
Non-sandbox text2

no description

Contentoptional