Plantilya:Dokumentasyon

Dokumentasyon nin Plantilya[hilingon] [liwaton] [historiya] [purgahon]

Uses Lua:

Module:Documentation

Ito ang padron o suleras na {{Documentation}}.

Para sa karamihan sa mga tagubilin tungkol sa kung paano at kung kailan gamitin ang padron o suleras na ito, tingnan ang Wikipedia:Template documentation.

Ipinapakita ng padrong ito ang isang luntiang doc box gaya ng kung paano mo ito nakikita ngayon, at kusang ikinakaraga ang nilalaman mula sa subpahinang /doc. Maaari ring kargahin nito ang nilalaman mula sa iba pang kinalalagyan kapag binigyang-tagubilin man.

Nilalayon ang padrong ito para sa pagsasa-dokumento ng mga padron o suleras at ng iba pang mga pahinang kasama (transcluded) sa iba pang mga pahina. Maaari rin itong gamitin sa template space at karamihan sa iba pang mga namespaces.

Ang paggamit ng padrong ito ay pinapayagan ang mga padron ng naka-protekta kapag kinakailangan, habang pinapayagan ang sino mang mag-edit ng dokumentasyon at mga kategorya.

Paggamit

Karaniwan, ginagamit ang padrong ito nang walang kahit na anong mga parametro, na nakalagay sa ilalim ng padron ng pahinang dinokumentuhan, sa loob o pagitan ng <noinclude>:

<!--Huling linya ng iyong kodegong pampadron--><noinclude>
{{Documentation}}
<!-- Idagdag ang mga kategorya sa subpahinang /doc at sa mga interwiki sa Wikidata, huwag dito! -->
</noinclude>

Saka naman kusang ikakarga ng padrong ito ang nilalaman mula sa subpahinang /doc ng padrong pinag-gamitan.

Maaari ring ikarga ng padrong ito ang nilalaman mula sa kahit na anong pahina. Katulad nito:

<!--Huling linya ng iyong kodegong pampadron--><noinclude>
{{Documentation |Template:Other page/doc}}
</noinclude>

Paalala na sa tuwing ikinakarga ang documentasyon mula sa isang pahina bukod pa sa lokal na pahinang /doc nagiging kalito-lito na hawakan ang mga kategorya at mga kawing na pang-interwiki.

Dapat rin naka-direkta bilang teksto ang nilalaman mismo. Katulad nito:

<!--Huling linya ng iyong kodegong pampadron--><noinclude>
{{Documentation |content=
Iba pang mga tekstong pang-dokumentasyon.
}}
</noinclude>

Kapag ginamit ang parametrong |content=, karaniwang hindi pinapakita ng doc box ang mga kawing na [edit] [purge] sa bandang sulok sa itaas na pakanan. Paalala na kung nairal ang pahinang /doc, ang kawing na papunta roon ay ipinapakita pa rin sa kahong pangkawing sa ilalim ng doc box.

Ang parametrong |1= at ang parametrong |content= ay maaari ring pagsamahin, katulad nito:

<!--Huling linya ng iyong kodegong pampadron--><noinclude>
{{Documentation
|1=Template:Any page/doc
|content=
{{Template:Any page/doc |mga parametro}}
}}
</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:Any page/doc|parameters}}. 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 <noinclude> (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 <includeonly>...</includeonly> tags. For more complex cases, see Wikipedia:Template documentation#Categories and interwiki links.

If the documentation page contains <includeonly> or <noinclude> tags as part of the visible documentation text, replace the "<" with "<".

The heading

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

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 {{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 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 <noinclude> tags. But in some cases this template needs to be on the talk page:

In the Mediawiki namespace, since <noinclude> often does not work in system messages, 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 <noinclude>...</noinclude> 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.

Testing

You can simulate the output for a given page by using the |page= parameter. For example, if you use the code |page=Template:Edit protected, the template will behave exactly as if it were on the page Template:Edit protected, including showing the documentation from Template:Edit protected/doc, linking to Template:Edit protected/sandbox, etc. This parameter is useful for testing, and is used extensively on the module test cases page.

Technical details

This template calls {{Documentation/start box2}} and {{Documentation/end box2}} which in turn call {{Documentation/start box}} and {{documentation/end box}}. 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. 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.