Documentation The documentation below is transcluded from Template:Formatting subpage/doc. (edit | history)This template is used on formatting subpages to provide a very basic, standardized documentation of their purpose. It also automatically categorizes the page accordingly.
This aims at addressing the common misunderstanding of especially newer editors considering a page with no visible output unnecessary and unused.
Usage[]
{{ formatting subpage | onlybox = y | <partial customization of doc text> | nocat = y }}
All parameters are optional.
- onlybox
Only display the box. This is often used if a subpage requires documentation that exceeds the standard, predefined text.
- First unnamed parameter
Partially modify the standard, predefined documentation text, e.g. if only a small customization needs to be made. Only has an effect if $onlybox is not set.
There are different predefined texts, depending on the subpage's title:
| Subpage title | Text |
|---|---|
resultcell |
This page is used to have an invisible {{item infobox}} for each row (for storing the item's data to cargo) of the "Recipes" table on the base page, Template:Formatting subpage. |
row |
This page is used for printing each table row on the base page, Template:Formatting subpage. |
| default | This page is used for formatting certain data in a standardized way on the base page, Template:Formatting subpage. |
| default (customized) |
This page is used <custom text from first unnamed parameter> on the base page, Template:Formatting subpage. |
- nocat
Prevent categorization of the subpage.
Examples[]
- Only box
{{formatting subpage|onlybox=y}} results in:
- Full
{{formatting subpage}} results in:
This page is used for formatting certain data in a standardized way on the base page, Template:Formatting subpage.
- Full (custom text)
{{formatting subpage|to print a list of items}} results in:
This page is used to print a list of items on the base page, Template:Formatting subpage.
zh:Template:Formatting subpage