Template: Documentation

From LibrePlanet
Revision as of 15:48, 23 July 2013 by Koni (talk | contribs) (Created page with "<!-- Automatically add {{template sandbox notice}} when on a /sandbox page. -->{{#ifeq: {{SUBPAGENAME}} | sandbox | <div style="clear: both;"></div>{{template sandbox notice|{{...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This is the Template:Tl meta-template.

It helps other templates detect if they are on a "Template:" page or some "other" type of page.

Usage

This template usually takes two parameters, like this:

{{template other | Template page text | Other pages text }}

If the template is on a "Template:" page, it will return this:

Template loop detected: Template:Template other

If the template is on any other page, it will return this:

Template loop detected: Template:Template other

A typical usage case could be to make it so that a template only adds a category when not on a template page. Thus not adding the template itself and other templates that are built with it to the category. Like this:

{{template other | | [[Category:Some maintenance category]] }}

Note that in the example above the "template" parameter was left empty.

Demospace

For testing and demonstration purposes this template can take a parameter named demospace.

  • If it has the value template it returns the template page text.
  • It if has the value other or any other value such as the name of some other namespace it returns the other pages text.
  • If the parameter is empty or undefined, the actual page type determines the result.

Like this:

{{template other 
| Template page text 
| Other pages text 
| demospace = template
}}

No matter on what kind of page the code above is used it will return this:

Template loop detected: Template:Template other

You can make it so your template also understands the demospace parameter. That means you can demonstrate the different appearances of your template in the documentation for your template. Then do like this:

{{template other 
| Template page text 
| Other pages text 
| demospace = {{{demospace|}}}
}}

Technical details

This template detects "Template talk:" pages as type other.

This template works like Template:Tl, for more examples and technical details see full documentation there.

See also

Template:Namespace detect see also

50px Template documentation[view] [edit] [history] [purge]

This is the Template:Tl template.

For most of the instructions about how and when to use this template, see Wikipedia:Template documentation.

This template displays a green doc box like you are seeing now, and automatically loads the content from a /doc subpage. It can also load the content from other places if instructed to.

This template is intended for documenting templates and other pages which are transcluded onto other pages. It can be used in template space and most other namespaces.

Use of this template allows templates to be protected where necessary, while allowing anyone to edit the documentation and categories.

Usage

Normally this template is used without any parameters, placed at the bottom of the template or page being documented, within <noinclude>:

<!--Last line of your template code--><noinclude>

{{documentation}}
<!-- Add categories to the /doc subpage and interwikis in Wikidata, not here! -->
</noinclude>

Then this template automatically loads the content from the /doc subpage of the template it is used on.

This template can also load the content from any other page. Like this:

<!--Last line of your template code--><noinclude>

{{documentation |Template:Other page/doc}}
</noinclude>

Note that when loading the documentation from another page than the local /doc page it becomes tricky to handle the categories and interwiki links.

The content can also be fed directly as text. Like this:

<!--Last line of your template code--><noinclude>

{{documentation |content=
Some documentation text.
}}
</noinclude>

When the |content= parameter is used, the doc box normally does not show the [edit] [purge] links in the top right corner. Note that if the /doc page exists a link to it is still shown in the link box below the doc box.

Parameter |1= and the |content= parameter can also be combined, like this:

<!--Last line of your template code--><noinclude>

{{documentation
|1=Template:Any page/doc
|content=
{{Template:Any page/doc |parameters}}
}}
</noinclude>

Then the pagename fed as parameter 1 is used for the [edit] [purge] links and for the /doc link in the link box below the doc box. But the content parameter is used for the content shown in the doc box. The above code means that the content is transcluded as Template:Tnull. In this example a parameter is also fed to the /doc page being loaded.

Best practice

The code should be added at the bottom of the template code, with no space before Template:Tag (which would cause extra space on pages where the template is used).

Categories and interwiki links that apply to the template itself should be added to the bottom of the /doc subpage, inside Template:Tag tags. For more complex cases, see Wikipedia:Template documentation#Categories and interwiki links.

If the documentation page contains Template:Tag or Template:Tag tags as part of the visible documentation text, replace the "<" with "&lt;".

The heading

When in the Template namespace, this template shows this heading:

32px Template documentation

In most other namespaces, such as "Wikipedia:", it shows this heading:

Documentation

But when on File (image) pages it shows this heading:

Summary

The heading parameter can be used to set the heading to something else. Like this:

{{documentation |heading=Infobox documentation}}

If the heading parameter is empty but defined, no heading is shown and no [edit] [purge] links are shown. Like this:

{{documentation |heading=}}

The heading-style parameter can be fed optional CSS values. Without quotation marks " " but with the ending semicolons ;. For example:

heading-style = color: red; font-size: 150%;

The link box

Below the big doc box is a small link box that shows some meta-data about the documentation. The link box shows different things depending on what parameters are fed to this template, and in which namespace it is used. In some cases the link box is not shown at all.

To hide the link box, add the parameter |link box=off.

You can also insert customised text in the link box, by defining the |link box= parameter. For example: |link box=This documentation is automatically generated by [[Template:Country showdata]]

Automatic functions

If the documentation page does not exist, the [create] link includes a preload page so that clicking it will pre-fill the edit form with the basic documentation page format. Preload text is also used for the /sandbox and /testcases (create) links.

When this template is on a protected template page it now automatically adds Template:Tl which shows the grey or red padlock in the top right corner. So no need to manually add Template:Tlf to templates that use Template:Tl.

When this template is on a /sandbox subpage it automatically adds the Template:Tl. If that sandbox is not a subpage of the live template, then the |livepage= parameter can be used to correctly link back to that template.

Subject namespaces vs. talk namespaces

Terminology: Subject namespaces are the opposite of talk namespaces. For instance "Template:" is the subject space of "Template talk:".

This template is usually placed in a subject namespace, within Template:Tag tags. But in some cases this template needs to be on the talk page:

  • In the Mediawiki namespace, since Template:Tag often does not work in system messagesm and since the Mediawiki namespace needs to be kept clean for performance reasons.

When placed on talk pages, this template usually is placed near the top of the page and without Template:Tag tags.

The /doc, /sandbox and /testcases pages should normally be in the subject namespace, except in the namespaces that do not have the MediaWiki subpage feature enabled: Main, File, Mediawiki and Category. (But currently we only show the /sandbox and /testcases links from User, User talk, Template and Template talk namespaces.) There are also a whole bunch of other technical reasons why the /doc page must be stored under the talk page for those (but only those) namespaces.

This template automatically points its [create] links for the /doc, /sandbox and /testcases to the right namespace.

Technical details

This template calls Template:Tl and Template:Tl which in turn call Template:Tl and Template:Tl. The /start box (and /end box) hold most of the code, while this template and /start box2 (and /end box2) do parameter preprocessing.

The preload page for the /doc [create] link is Template:Documentation/preload, but in File namespace it is Template:Documentation/preload-filespace. The preload pages for the /sandbox and /testcases [create] links are Template:Documentation/preload-sandbox and Template:Documentation/preload-testcases.

For more technical details see the talk page.

See also
https://libreplanet.org/wiki?title=Template:Documentation&oldid=30319
libreplanet.org
CC-MAIN-2024-10
45036
application/http; msgtype=response
sha1:4SDJAATL4XGKOFV7XMV24H6QTU6MWY4F
<urn:uuid:5cfadf21-c92c-4fca-a21b-7441bc9ba341>
2024-02-23T13:11:23Z
209.51.188.242
text/html
sha1:7DW3OHOJYK3GOM2CEUDS2LCL7NM2SX4O
<urn:uuid:945036e1-d332-42bb-a281-eb9cec7a59ed>
https://libreplanet.org/wiki?title=Template:Documentation&oldid=30319
response
<urn:uuid:b6a1dd41-e85b-4cb2-ba32-d7800306598b>
isPartOf: CC-MAIN-2024-10
publisher: Common Crawl
description: Wide crawl of the web for February/March 2024
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-88
software: Apache Nutch 1.19 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.5-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/