v50 Steam/Premium information for editors
  • v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
  • Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.

Template:Documentation subpage/doc

From Dwarf Fortress Wiki
< Template:Documentation subpage
Revision as of 02:31, 26 January 2023 by Jerimee (talk | contribs) (→‎Related pages: remove related links)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Not to be confused with Template:Documentation.

This template displays a message that the current page is a documentation subpage.

Usage

{{Documentation subpage}} or {{Documentation subpage|[[Page where the documentation transcluded]]}}



Text customization

The parameters |text1= and |text2= can be used to set the text of, respectively, the template's first and second lines. If text1 is set but not text2, both lines' text will derive from text1: Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}

Template:Hidden end Template:Hidden begin {{Documentation subpage |text2='''''text2 appears here'''''}}

Template:Hidden end Template:Hidden begin {{Documentation subpage |text1='''''text1 appears here'''''}}

Template:Hidden end

Other parameters

|inhibit=yes will prevent this template from generating any categories. (By default, "Namespace documentation pages" (usually Category:Template documentation pages) is added, or Category:Documentation subpages without corresponding pages if the main page doesn't exist.)

Display

This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed:

  • On a /doc page, it displays a box explaining template documentation and links to the template page.
  • On other pages – i.e. pages transcluding the /doc page – the template will not show. The template page itself (which contains Template:Template link) will automatically note that the documentation is transcluded from a subpage.

Functions

In addition to its message, the template adds pages to Category:Template documentation pages, Category:User documentation pages, or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the sort key to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".