Cithakan:Dokumentasi

Dokumentasi cithakan

Kiye kuwe cithakan {{dokumentasi}}.

Nek kepengin ndeleng instruksi kepriwe carane lan kapan kudu nggunakna cithakan kiye, deleng bae Wikipedia:Dokumentasi cithakan.

Cithakan kiye nampilna kothak ijo kaya sing Rika deleng sekiye, lan otomatis mbuka isine sekang subhalaman /doc. Kiye uga teyeng mbuka isine kaca liyane angger pancen diprentahna kon kaya kuwe.

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, categories, and interwiki links.

Cara nganggo

Biasane cithakan kiye dinggone ora mawi nganggo parameter apa-apa, disog nang ngisore cithakan utawa kaca sing arep di dokumentasikna, nang jerone kode <noinclude>:

<!--Baris keri dhewek sekang kode cithakane Rika--><noinclude>

{{dokumentasi}}
<!-- Tambahna kategori lan interwiki maring subkaca /doc, aja nang kene! -->
</noinclude>

Kode kuwe mau bakal otomatis muat isine subkaca /doc sekang cithakan sing nggunakna kode kuwe.

Cithakan kiye uga teyeng muat isine sekang kaca liyane. Contone kaya kiye:

<!--Baris keri dhewek sekang kode cithakane Rika--><noinclude>

{{dokumentasi|Cithakan:Kaca liyane/doc}}
</noinclude>

Ningen Rika kudu ngati-ati dong arep muatna dokumentasi sekang kaca liyane, kuwe bakal marekna ruwet gole ngatur kategori lan pranala interwikine.

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

<!--Baris keri dhewek sekang kode cithakane Rika--><noinclude>

{{dokumentasi
| content = Teks dokumentasi.
}}
</noinclude>

When the content parameter is used the doc box normally doesn't 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.

But parameter 1 and the content parameter can also be combined, like this:

<!--Baris keri dhewek sekang kode cithakane Rika--><noinclude>

{{dokumentasi
| 1 = Cithakan:Halaman apapun/doc
| content = {{Cithakan:Halaman apapun/doc|parameter}}
}}
</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:Dokumentasi cithakan#Kategori lan pranala antarbasa.

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

Judul

Dong nang bilik jeneng "Cithakan", cithakan kiye bakal ngethokna judul:

Dokumentasi cithakan

Nang bilik jeneng liyane, kaya "Wikipedia:", judule:

Dokumentasi

Ningen angger nang kaca Gambar judule dadi:

Ringkesan

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

{{dokumentasi| heading = Dokumentasi kotak info }}

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

{{dokumentasi| 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=Dokumentasi ini ditampilkan secara otomatis oleh [[Cithakan:Country showdata]]

Automatic functions

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 /bak pasir and /kasus uji (create) links.

When this template is on a protected template page it now automatically adds {{cithakan berisiko tinggi}} which shows the grey or red padlock in the top right corner. So no need to manually add {{cithakan berisiko tinggi}} to templates that use {{dokumentasi}}.

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

Subject space vs talk space

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:

• For preload pages (usually in Template or Wikipedia space), since they can't use <noinclude>. See for instance Template talk:AfC preload and Template talk:RfD subpage starter. Such talkpages can be marked with {{talkdoc}}.

• 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, /bak pasir and /testcases pages should normally be in subject space, except in the namespaces that don't have the MediaWiki subpage feature enabled: Utama, Gambar, MediaWiki and Kategori. (But currently we only show the /bak pasir and /kasus uji links from Pengguna, Pembicaraan Pengguna, Templat and Pembicaraan Templat 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, /bak pasir and /kasus uji to the right namespace.

Technical details

This template calls {{dokumentasi/start box2}} and {{dokumentasi/end box2}} which in turn call {{dokumentasi/start box}} and {{dokumentasi/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 Cithakan:Dokumentasi/preload, but in File space it is Cithakan:Dokumentasi/preload-filespace. The preload pages for the /bak pasir and /kasus uji (create) links are Cithakan:Dokumentasi/preload-sandbox and Cithakan:Dokumentasi/preload-testcases.

For more technical details see the talk page.

Deleng uga

• {{dokumentasi}} – Placed on templates and other pages to document them.
• {{subhalaman dokumentasi}} – Used at the top of /doc subpages to explain what they are and to link back to the page they document.
• Wikipedia:Dokumentasi cithakan – The how-to guide about template documentation.
• Wikipedia:Kasus uji cithakan – How to use /bak pasir and /kasus uji subpages and more about template testing.