Template:Topic series doc

Template documentation[view] [edit] [history] [purge]

The output of this template can be seen below the documentation.

Purpose

This template is used to provide generic documentation for most of the Article series templates.

|header= Used to add any header notes to docs. Add things such as shortcut links here.
|footer= Used to add any footer notes to docs.
|usage= Used to replace the standard Usage-section with a user defined.
|sort= Used to set the {{DEFAULTSORT}} for the template.
|cat= Category name (without "Category:"), if it is something more specific than Sidebar templates by topic
- Templates will be added automatically to Category:Sidebar templates by topic and Category:Exclude in print,
- if the |nocats= is set to yes, the template will not be added to any categories.

Templates for topics about a person should use the |sort= parameter.

Like the general {{Documentation}} template, place {{Topic series doc}} between <noinclude> tags below the template code. Be sure to place the first tag, <noinclude> (the opening tag), after the very last code of the template. If the opening tag is placed on its own line below the template code, then it will introduce undesirable whitespace below the end-product template.
The "Usage" header below and the text (code) beneath it will be included in the template documentation under that header unless altered by the usage= parameter.

The above documentation is transcluded from Template:Topic series doc/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.

Template documentation

This template does not display in the mobile view of Wikipedia; it is desktop only. Read the parent documentation for an explanation.

Simply add this template {{Topic series doc}}, after any infobox, to items that are part of the series.

This template is used to provide generic documentation for most of the Article series templates.

|header= Used to add any header notes to docs. Add things such as shortcut links here.
|footer= Used to add any footer notes to docs.
|usage= Used to replace the standard Usage-section with a user defined.
|sort= Used to set the {{DEFAULTSORT}} for the template.
|cat= Category name (without "Category:"), if it is something more specific than Sidebar templates by topic
- Templates will be added automatically to Category:Sidebar templates by topic and Category:Exclude in print,
- if the |nocats= is set to yes, the template will not be added to any categories.

Templates for topics about a person should use the |sort= parameter.

Like the general {{Documentation}} template, place {{Topic series doc}} between <noinclude> tags below the template code. Be sure to place the first tag, <noinclude> (the opening tag), after the very last code of the template. If the opening tag is placed on its own line below the template code, then it will introduce undesirable whitespace below the end-product template.
The "Usage" header below and the text (code) beneath it will be included in the template documentation under that header unless altered by the usage= parameter.

This documentation is transcluded from Template:Topic series doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.