Template:Documentation

Template documentation

From Template:Documentation/doc

Technical detailswiki-tools · uses 1

Source

Synced with wiki-tools on GitHub

Uses

Invokes1

• doc in Module:Documentation

{{#seo:

|type = website |description = Template:Documentation is a template page used on the Paracosm Wiki. Templates are pages that are embedded (transcluded) into other pages to allow for the repetition of information. |site_name = Paracosm Wiki |locale = en }}

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

Usage

{{Documentation}}

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

{{Documentation|git=true|importedFrom=[https://runescape.wiki/w/Module:Module_toc RuneScape Wiki]}}

Parameters

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

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Documented page	1	Page the header's links point to, when it is not the page this /doc belongs to. Example Template:Foo	Page name	optional
Synced with wiki-tools	git	Adds a Source line linking the page's directory in the wiki-tools repository. The README converter sets it on every page it deploys. Example true	Boolean	optional
Imported from	importedFrom	Where the page came from, as a wikitext link. Adds "Imported from" and the link to the Source line. Example [https://runescape.wiki/w/Module:Module_toc RuneScape Wiki]	Content	optional
Imported from Wikipedia	fromWikipedia	Shorthand for importedFrom linking the same title on the English Wikipedia. Example true	Boolean	optional
Add categories	category	Set to no to stop the Technical details panel adding its categories: Lua-based templates, Strict mode modules and Unused modules. Default yes Example no	Boolean	optional

Behavior

• The header links to the /doc page and offers Edit, History and Purge. Viewed on its own, the /doc 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 git=true 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 importedFrom or fromWikipedia joins Imported modules or Imported templates. The /doc 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.