Wikipediya ra ensiklopediya xosere
Jump to: şiyayış, Cı geyre
[bıvurne] [peyni] [Newe ke] Documentation icon Dokuman


This is the {{Documentation}} template.

Usage[bıvurne | çımey bıvurne]

The heading[bıvurne | çımey bıvurne]

When in Template space this template shows this heading:

Template-info.svg Template documentation

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


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


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[bıvurne | çımey bıvurne]

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[bıvurne | çımey bıvurne]

If the documentation page doesn't 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 {{Pp-template}} which shows the grey or red padlock in the top right corner. So no need to manually add {{pp-template}} to templates that use {{Documentation}}.

When this template is on a /sandbox subpage it automatically adds the {{Template sandbox notice}}.

Subject space vs talk space[bıvurne | çımey bıvurne]

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

This template is usually placed in subject space, within <noinclude> tags. But in some cases this template needs to be on the talkpage:

  • In MediaWiki space, since <noinclude> often doesn't work in system messages and since MediaWiki space needs to be kept clean for performance reasons.

When placed on talkpages this template usually is placed near the top of the page and without <noinclude> tags.

The /doc, /sandbox and /testcases pages should normally be in subject space, except in the namespaces that don't 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 space.) There are also a whole bunch of other technical reasons why the /doc page must be stored under the talkpage for those namespaces.

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

Technical details[bıvurne | çımey bıvurne]

This template calls {{Documentation/start box2}} and {{Documentation/end box2}} which in turn call {{Documentation/start box}} and {{Documentation/end box}}. /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 space 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[bıvurne | çımey bıvurne]