Gravy: 1 revision imported from :starcitizen:Template:Documentation/doc

2026-11-12T07:45:18Z

1 revision imported from starcitizen:Template:Documentation/doc

← Older revision		Revision as of 00:45, 12 November 2026
(No difference)

starcitizen>Alistar Bot: Sync from Git (documentation-refresh 0b275d5) (via update-page on MediaWiki MCP Server)

2026-09-28T16:56:44Z

Sync from Git (documentation-refresh 0b275d5) (via update-page on MediaWiki MCP Server)

New page

{{documentation|git=true}}

The documentation header on module and template pages. Place it at the top of every <code><nowiki>/doc</nowiki></code> subpage.

== Usage ==

<syntaxhighlight lang="wikitext">
{{Documentation}}
</syntaxhighlight>

For a page kept in the wiki-tools repository, or imported from another wiki:

<syntaxhighlight lang="wikitext">
{{Documentation|git=true|importedFrom=[https://runescape.wiki/w/Module:Module_toc RuneScape Wiki]}}
</syntaxhighlight>

== Parameters ==

<templatedata>
{
"description": "The documentation header on module and template pages. Place it at the top of every /doc subpage.",
"params": {
"1": {
"label": "Documented page",
"description": "Page the header's links point to, when it is not the page this /doc belongs to.",
"type": "wiki-page-name",
"required": false,
"example": "Template:Foo"
},
"git": {
"label": "Synced with wiki-tools",
"description": "Adds a Source line linking the page's directory in the wiki-tools repository. The README converter sets it on every page it deploys.",
"type": "boolean",
"required": false,
"example": "true"
},
"importedFrom": {
"label": "Imported from",
"description": "Where the page came from, as a wikitext link. Adds \"Imported from\" and the link to the Source line.",
"type": "content",
"required": false,
"example": "[https://runescape.wiki/w/Module:Module_toc RuneScape Wiki]"
},
"fromWikipedia": {
"label": "Imported from Wikipedia",
"description": "Shorthand for importedFrom linking the same title on the English Wikipedia.",
"type": "boolean",
"required": false,
"example": "true"
},
"category": {
"label": "Add categories",
"description": "Set to no to stop the Technical details panel adding its categories: Lua-based templates, Strict mode modules and Unused modules.",
"type": "boolean",
"required": false,
"default": "yes",
"example": "no"
}
},
"paramOrder": [
"1",
"git",
"importedFrom",
"fromWikipedia",
"category"
],
"format": "inline"
}
</templatedata>

== Behavior ==

* The header links to the <code><nowiki>/doc</nowiki></code> page and offers Edit, History and Purge. Viewed on its own, the <code><nowiki>/doc</nowiki></code> page shows a Documentation subpage header linking back instead.
* Below the header, the folded Technical details panel lists where the page comes from, which pages use it, what it uses, and a module's functions.
* A rule marks where the documentation ends.
* On a <code><nowiki>git=true</nowiki></code> page, the parameter table's own description is hidden: the page's first paragraph already says the same thing.
* Categories: a module page joins Modules, and a page with <code><nowiki>importedFrom</nowiki></code> or <code><nowiki>fromWikipedia</nowiki></code> joins Imported modules or Imported templates. The <code><nowiki>/doc</nowiki></code> page itself joins Modules documentation or Templates documentation instead, sorted by its base page name.

== See also ==

* [[Module:Documentation]], which draws the header.
* [[Module:Dependencies]], which draws the Technical details panel.

Template:Documentation/doc - Revision history

Gravy: 1 revision imported from :starcitizen:Template:Documentation/doc

starcitizen>Alistar Bot: Sync from Git (documentation-refresh 0b275d5) (via update-page on MediaWiki MCP Server)