Template:Doc/multi-subpage/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Created page with "{{Doc/subpage}} The replacement of {{Code|1=<nowiki><noinclude>{{doc|0}}</noinclude></nowiki>}}. == Usage == {{Code|<nowiki>{{Doc/subpage}}</nowiki>|select=all}} == Parameters == {{Capsule|style=2| *{{param|1}} - ''Optional:'' Parameter for switching the template assignment. Default is {{Code|0}}. **0 – will display the message “This is a documentation subpage for <page>”. **1 – will display the message “This is the sandbox subpage for <page>”. **2 – will...")
 
No edit summary
 
Line 1: Line 1:
{{Doc/subpage}}
{{Doc/subpage}}
The replacement of {{Code|1=<nowiki><noinclude>{{doc|0}}</noinclude></nowiki>}}.
The replacement of {{Code|1=<nowiki><noinclude>{{doc|4}}</noinclude></nowiki>}}.


== Usage ==
== Usage ==
Line 13: Line 13:
**3 – will display the message “This is the <page> info subpage”. Useful for user subpages.
**3 – will display the message “This is the <page> info subpage”. Useful for user subpages.
**4 – will display the message “This is a documentation subpage for use on multiple pages”. If the {{param|list}} parameter is used, then the text will be: “This is a documentation subpage for use on multiple pages listed in <list page>”.
**4 – will display the message “This is a documentation subpage for use on multiple pages”. If the {{param|list}} parameter is used, then the text will be: “This is a documentation subpage for use on multiple pages listed in <list page>”.
*{{param|list}}: specifies a page or category that lists pages using a particular documentation page. Used only if parameter {{param|1}} is set to 4.
}}''Quoted from [[Template:Doc/doc]]''
}}''Quoted from [[Template:Doc/doc]]''
*{{Param|force}}: forces the template to show on base pages.
*{{Param|force}}: forces the template to show on base pages.

Latest revision as of 12:34, 8 May 2025

Edit-copy.png
This is a documentation subpage for Template:Doc.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

The replacement of <noinclude>{{doc|4}}</noinclude>.

Usage

{{Doc/subpage}}

Parameters

  • {{{1}}} - Optional: Parameter for switching the template assignment. Default is 0.
    • 0 – will display the message “This is a documentation subpage for <page>”.
    • 1 – will display the message “This is the sandbox subpage for <page>”.
    • 2 – will display the message “This page is not a sandbox”.
    • 3 – will display the message “This is the <page> info subpage”. Useful for user subpages.
    • 4 – will display the message “This is a documentation subpage for use on multiple pages”. If the {{{list}}} parameter is used, then the text will be: “This is a documentation subpage for use on multiple pages listed in <list page>”.

Quoted from Template:Doc/doc

  • {{{force}}}: forces the template to show on base pages.

Preview

Edit-copy.png
This documentation subpage is used on many pages and changes may be widely noticed.
Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage.
Consider discussing changes on the talk page before implementing them.