模板:Documentation/doc

[刷新]

This is the documentation page. It should be transcluded into the main template page. See Template:Documentation for more information

This template used module Module:Documentation，These scripts are written in Lua.
Read w:Wikipedia:Lua and mw:Extension:Scribunto for more.

For templates, append <noinclude>{{subst:doc}}</noinclude> to the end of page.

Document pages will automatically add to Category:Documentation. Use {{doc}} without subst: will add page to Category:Need replace template.

Optional parameters[编辑 | 编辑源代码]

Add these parameters to {{subst:doc}} or {{documentation}} when creating page.

type[编辑 | 编辑源代码]

Defines the "type" of documentation.

This parameter will be automatically determined from namespace.

page[编辑 | 编辑源代码]

The page where the document is located. Defaults to a subpage of the current page, called "doc".

content[编辑 | 编辑源代码]

Allows document content to be specified directly, rather than on a separate subpage. Useful for subpage templates specific to small pages.

If the template has no documentation and you don't know how to use it, add nodoc=1 to the documentation template on the documentation page. The background of the document will turn red to make it stand out, and pages will be added to categories based on the type of page.

It is automatically set if the document page does not exist or is empty, so it is usually not required.

baddoc[编辑 | 编辑源代码]

Similar to nodoc, it is used to mark up templates that have documentation, but not very well. This could mean that it doesn't have enough examples, doesn't explain all the features correctly, or doesn't explain the gist of the template correctly. The background of the document will turn yellow to make it more noticeable, and pages will be added to categories based on the type of page.

Optional parameters[编辑 | 编辑源代码]

type[编辑 | 编辑源代码]

page[编辑 | 编辑源代码]

content[编辑 | 编辑源代码]

nodoc[编辑 | 编辑源代码]

baddoc[编辑 | 编辑源代码]