Templat:Documentation
 | Templat ini menggunakan Lua: |
Ini adalah templat {{dokumentasi}}.
Untuk instruksi lebih lanjut mengenai bagaimana dan kapan harus menggunakan template ini, lihat Wikipedia:Dokumentasi templat.
Templat ini menampilkan kotak doc berwarna hijau seperti yang Anda lihat sekarang, dan secara otomatis memuat isi dari subhalaman /doc. Dapat juga memuat konten dari tempat lain jika diminta.
Templat ini dimaksudkan untuk mendokumentasikan templat dan halaman lain yang ditransklusikan ke halaman lain. Dapat juga digunakan dalam templat ruang nama dan ruang nama lainnya.
Penggunaan templat ini memungkinkan templat untuk dilindungi jika diperlukan, sambil membiarkan siapa saja untuk mengedit dokumen, kategori, dan tautan interwiki.
Penggunaan
Biasanya templat ini digunakan tanpa parameter, ditempatkan di bagian bawah templat atau halaman yang didokumentasikan, dalam format <noinclude>...</noinclude>:
<!--Ini adalah baris terakhir dari kode templat Anda--><noinclude>
{{dokumentasi}}
<!-- Tambahkan kategori dan interwiki pada sub-halaman /doc, bukan di sini! -->
</noinclude>
Maka templat ini secara otomatis memuat isi dari subhalaman /doc dari templat yang digunakan.
Template ini juga dapat memuat konten dari halaman lain. Seperti ini:
<!--Ini adalah baris terakhir dari kode templat Anda--><noinclude>
{{dokumentasi|Templat:Halaman lain/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.
Konten juga dapat diberi input langsung sebagai teks. Seperti ini:
<!--Ini adalah baris terakhir dari kode templat Anda--><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:
<!--Ini adalah baris terakhir dari kode templat Anda--><noinclude>
{{dokumentasi
| 1 = Templat:Halaman apapun/doc
| content = {{Templat: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.
Praktik yang disarankan
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 templat#Kategori dan pranala antarbahasa.
If the documentation page contains <includeonly> or <noinclude> tags as part of the visible documentation text, replace the "<" with "<".
Bagian heading
When in Template space this template shows this heading:
Dokumentasi templat
In most other namespaces, such as "Wikipedia:", it shows this heading:
- Dokumentasi
But when on File (image) pages it shows this heading:
- Ringkasan
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%;
Kotak pranala
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 [[Templat:Country showdata]]
Fungsi otomatis
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 {{templat berisiko tinggi}} which shows the grey or red padlock in the top right corner. So no need to manually add {{templat 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 Pembicaraan Templat:AfC preload and Pembicaraan Templat: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, Berkas, 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.
Rincian teknis
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 Templat:Dokumentasi/preload, but in File space it is Templat:Dokumentasi/preload-filespace. The preload pages for the /bak pasir and /kasus uji (create) links are Templat:Dokumentasi/preload-sandbox and Templat:Dokumentasi/preload-testcases.
For more technical details see the talk page.
Lihat juga
- {{dokumentasi}} – Ditempatkan pada bagian templat dan halaman lain untuk mendokumentasinya.
- {{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 templat – The how-to guide about template documentation.
- Wikipedia:Kasus uji templat – How to use /bak pasir and /kasus uji subpages and more about template testing.