Template:Doc/subpage/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
No edit summary
Line 5: Line 5:
{{Code|<nowiki>{{Doc/subpage}}</nowiki>|select=all}}
{{Code|<nowiki>{{Doc/subpage}}</nowiki>|select=all}}


== Parameter ==
== Parameters ==
{{Capsule|style=2|
{{Capsule|style=2|
*{{param|1}} - ''Optional:'' Parameter for switching the template assignment. Default is {{Code|0}}.
*{{param|1}} - ''Optional:'' Parameter for switching the template assignment. Default is {{Code|0}}.
Line 15: Line 15:
*{{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.
*{{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 even on non-template pages.


== Preview ==
== Preview ==

Revision as of 11:58, 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|0}}</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>”.
  • {{{list}}}: specifies a page or category that lists pages using a particular documentation page. Used only if parameter {{{1}}} is set to 4.

Quoted from Template:Doc/doc

{{{force}}}: forces the template to show even on non-template pages.

Preview

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.