Template:DocPageName

Template:DocPageName/doc

Template documentationview · edit · history · purge ]
This documentation is transcluded from Template:DocPageName/doc.

No description yet available.

Usage

{{DocPageName}}

Template parameters

<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


Wikipedia's help about TemplateDataCommons-specific information

Returns the “/doc” subpage for the target page.

Template parameters

ParameterDescriptionTypeStatus
Page Name1

The name of the page to get the “/doc” subpage of.

Default
{{SUBJECTPAGENAME}}
Page nameoptional
Edit parameter translations

Additional information

The template is intended to be used in the following namespaces: the Template namespace

The template is intended to be used by the following user groups: all users

Relies on:

  • Extension:ParserFunctions
    • {{#ifeq:...}}
    • {{#titleparts:...}}

Examples

{{DocPageName|Template:Example}}

renders as:

Template:Example/doc


{{DocPageName|Template:Example/sandbox}}

renders as:

Template:Example/doc

Localization

This template is not intended to be localized.