Template:Formatting subpage/doc

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	此页面在基础页面Template:Formatting subpage/doc上用于让“配方”表格的每一行拥有一个不可见的 {{item infobox}}（用来将物品的数据存入 cargo）。
row	此页面在基础页面Template:Formatting subpage/doc上用于打印出表格的每一行。
default	此页面在基础页面Template:Formatting subpage/doc上用于以一种标准的方式格式化特定数据。
default (customized)	此页面在基础页面Template:Formatting subpage/doc上<custom text from first unnamed parameter>。

nocat

Prevent categorization of the subpage.

Examples

Only box

{{formatting subpage|onlybox=y}} results in:

此页面只在Template:Formatting subpage上用于格式化目的。

Full

{{formatting subpage}} results in:

此页面只在Template:Formatting subpage上用于格式化目的。

此页面在基础页面Template:Formatting subpage上用于以一种标准的方式格式化特定数据。

Full (custom text)

{{formatting subpage|to print a list of items}} results in:

此页面只在Template:Formatting subpage上用于格式化目的。

此页面在基础页面Template:Formatting subpage上to print a list of items。