Help:Templates/id

Jika Anda memiliki teks standar yang ingin disertakan pada beberapa laman, fitur templat MediaWiki memegang peranan. Tidak seperti ekstensi dan berkas media, tidak ada tempat penyimpanan terpusat untuk templat. Templat bisa ditulis baru atau agar tidak bersusah payah melakukan pekerjaan yang sama, diekspor dari wiki lain, misalnya Wikipedia, dan kemudian diimpor ke wiki target.

Pembuatan
Templat adalah halaman wiki biasa yang isinya dirancang untuk ditransklusikan (ditanamkan) di dalam di halaman lain. Templat mengikuti sebuah konvensi yaitu namanya diawali dengan " ", memasukkannya ke ruang nama itu; selain ini, Anda bisa membuatnya seperti halaman wiki lainnya.

Berikut adalah penggunaan templat yang sangat sederhana. JIka Anda membuat halaman berjudul "Templat:Selamat Datang" dengan isi:

Halo! Selamat datang di wiki ini.

Anda telah membuat templat pertama Anda! Jika Anda kemudian memasukkan kode:

di halaman lain manapun, ketika halaman tersebut dibuka, teks "Halo! Selamat datang di wiki ini." akan muncul bukannya. Isi templat "ditransklusikan" ke halaman yang lain, atau bisa dibilang isinya dipakai di halaman lain.

Anda kemudian bisa memasukkan  ke titik manapun di halaman manapun yang Anda ingin jadikan tempat menyambut seseorang. Misalkan templatnya digunakan di 100 halaman. Jika Anda mengubah isi templatnya menjadi:

Hai! Selamat datang di wiki yang indah ini.

dan mengunjungi halaman manapun di antara ke-100 halaman yang menggunakan templat itu, Anda akan melihat teks yang baru dan bukan yang sebelumnya. Dengan begitu, Anda telah mengubah isi 100 halaman tanpa menyunting mereka, karena templatnya sudah ditransklusikan ke halaman-halaman itu.

Ini adalah mekanisme dasarnya. Ada beberapa fitur transklusi lain yang memperkaya mekanisme ini dan menjadikan templat sangat berguna.

Penggunaan
Templat bisa digunakan di halaman lain dengan cara-cara ini:


 * — sebagaimana dijelaskan sebelumnya, pranala ini akan diganti secara dinamis dengan isi terkini dari Template:Nama ketika halaman dengan pranala templatnya dimuat. Pranalanya tidak akan berubah di kode sumber halaman.
 * — ketika pranala templat ini digunakan, pranalanya akan diganti untuk selamanya dengan isi Templat:Nama ketika halaman dnegan pranalanya disimpan: sebuah salinan isi Templat:Nama akan mensubstitusikan pranala templat. Isinya sekarang adalah bagian dari halaman yang dimasuki, dan bisa disunting seperti biasa, terpisah dari isi templat yang asli. Catatan: perubahan beriktunya di halaman templat sumber tidak akan memengaruhi halaman yang diberi pranala templat.
 * — ini diperkenalkan untuk memungkinkan substitusi yang tidak merusak transklusi, lihat w:en:Help:Substitution.
 * memasukkan templat dalam bentuk yang menampilkannya sebagai sintaks wiki mentah (mirip dengan ) ketika halaman yang memilikinya diambil.

Sebenarnya, halaman wiki biasapun juga bisa digunakan sebagai templat, hanya dengan memberitahukan ruang nama letaknya, jadi:


 * memasukkan
 * memasukkan
 * memasukkan
 * mengganti dirinya sendiri dengan isi

Jika tidak ada ruang nama yang disebut, judul lengkapnya diasumsikan merupakan templat:


 * memasukkan

Parameter
Untuk memperkaya mekanisme transklusi, MediaWiki membolehkan parameter diberikan kepada templat ketika ditransklusikan. Parameter memungkinkan templat menghasilkan isi atau perilaku yang berbeda-beda.

Misalkan Anda ingin memberikan terima kasih di halaman pembicaraan pengguna lain, misalnya:

Catatan terima kasihnya akan memiliki alasan (dalam kasus ini, "semua usahamu") dan tanda tangan ("Aku"). Tujuan Anda adalah agar semua pengguna bisa berterima kasih kepada pengguna manapun, untuk alasan apapun.

Agar catatannya tampak mirip di manapun digunakannya, Anda bisa mendefinisikan templat bernama, sebagai contoh. Meskipun catatannya harus terlihat mirip setiap kali seorang pengguna berterima kasih ke pengguna lain, isi spesifiknya (alasan dan tanda tangannya) akan berbeda-beda. Untuk itu, Anda perlu memberikan mereka sebagai parameter. Jika kita mengabaikan elemen yang memformat kotaknya, isi inti templatnya akan terlihat seperti ini:

Perhatikan penggunaan  dan. Ini adalah cara mengenali, di dalam templat, parameter yang akan diberikan ketika templatnya digunakan. Perhatikan bahwa, di dalam templat, setiap parameter ditutupi oleh tiga tanda kurung kurawal:. Ini berbeda dari penggunaan nama templat normal.

Ketika menggunakan templat di suatu halaman, Anda mengisi nilai parameternya, dipisahkan oleh sebuah karakter "pipa". MediaWiki membolehkan parameter diberikan ke templat melalui tiga cara: Anonim, Bernomor, dan Bernama.

Parameter anonim
Untuk memberikan parameter anonim, daftarkan nilai parameter-parameter itu secara berurutan:

Dalam kasus ini, templat  menerima parameter   dan , menghasilkan:

Urutan pemberian parameter anonim sangatlah penting untuk menentukan perilakunya. Membalikkan urutan parameter, seperti:

akan menghasilkan ini:

Parameter bernomor
Untuk memberikan parameter berdasarkan nomor, masukkan setiap parameter dengan nomor pengenalnya:

Kali ini, templat  menerima parameter   dan , meskipun mereka diberikan dalam urutan yang berbeda, dan menghasilkan:

Parameter bernama
Cara ketiga untuk memberikan parameter adalah menggunakan nama bukannya nomor. Dalam kasus ini, isi templat diubah menjadi:

Terima kasih... atas. pelukan dari,

Di dalam templat, kita menggunakan  dan   untuk membedakan setiap parameter, bukannya nomor. Untuk memberikan parameter menggunakan nama, bedakan setiap parameter ketika memberikannya:

Dalam kasus ini, templat  menerima parameter   dan , menghasilkan:

Parameter bernama peka kapital, jadi:

menghasilkan:

Keuntungan dari menggunakan parameter bernama di templat Anda adalah, selain lebih fleksibel urutan pemberian parameternya, membuat kode templatnya lebih muda dipahami apabila terdapat banyak parameter.

Nilai bawaan
Jika Anda mentransklusikan suatu templat yang memerlukan parameter, tapi tidak memberikan argumennya, seperti ini:

dalam contoh parameter bernomor di atas, maka Anda akan mendapatkan hasil berikut:

Karena tidak ada argumen yang diberikan, templat akan menampilkan parameter itu sendiri, bukannya nilainya masing-masing. Dalam kasus ini, akan berguna jika didefinisikan nilai bawaan untuk parameter, yaitu nilai yang akan digunakan juka tidak ada nilai yang diberikan. Misalnya, jika iisi templat diganti menjadi:

maka  mendefinisikan bahwa jika tidak ada argumen yang diberikan untuk parameter , maka nilai   akan digunakan. Tidak jauh berbeda,, membuat parameter   bernilai   secara bawaan. Sekarang, mentransklusikan templat lagi tanpa argumen akan menghasilkan:

Often default values are used to specify alternate names of parameters. For example, if you have, the template will first look for a parameter named "a". If it is not set, it will use the parameter named "b". If neither "a" nor "b" is set, it will output nothing.

Evaluation
Generally speaking, template parameters are substituted into the template after tokenization, but as is. They are not evaluated until they are used.

This has a few consequences. First of all, if you have a  containing , and a   containing  , and put   on a page, mytemplate isn't transcluded, because tokens like "|" cannot be added by a template and keep their special meaning in templates. You can still use templates to control the name of a parameter or template, but you cannot split a template call amongst multiple templates.

The second consequence of this is dead-code elimination. If you make a template call like, and Template:Foo does not contain  , then the displaytitle is not used, since it is only evaluated when needed, and it there is no parameter to substitute it into, so it is never evaluated. This usually comes into play when using Extension:ParserFunctions, and can be especially noticed when used in combination with the  magic word that varies by user language.

Template calls starting with the magic word  or   are evaluated in a separate first pass that only happens at save time, along with ~ and links using the pipe trick. If they cannot be evaluated during the first pass, subst: calls are ignored, and safesubst: are treated as if a normal template.

Many but not all parser functions, parser tags and trancluded special pages are not directly included like templates but instead are replaced by a "strip marker". This means you cannot manipulate the results with parser functions like padleft: or similar functions from extensions, as they see the strip marker instead of the result of the parser function.

Rekursi dalam templat
Memasukkan templat di dalam dirinya sendiri tidak akan membuat MediaWiki melakukan rekursi tak terhingga. MediaWiki akan menghentikan rekursi dengan nama templat ditembalkan. Contohnya, jika isi "Templat:Aaaa" adalah " ", maka templatnya akan ditampilkan sebagai "Template:Aaaa" dan menampilkan Template loop detected: Templat:Aaaa.

Pengendalian penyertaan templat
Secara bawaan, isi templat ditampilkan seluruhnya, ketika ditampilkan secara langsung maupun ketika dimasukkan di halaman lain. Akan tetapi, Anda bisa mengendalikan bagian templat mana saja yang akan dilihat dan disertakan dengan menggunakan tag,   dan.

Semua yang berada di antara  dan   hanya akan terlihat ketika halaman templat dibaca secara langsung, tapi tidak ketika dimasukkan di halaman lain. Ini berguna apabila Anda ingin memasukkan teks atau kode di templat yang tidak ingin Anda sertakan di halaman yang memasukkannya, misalnya:


 * Pranala kategori ketika mengategorikan templat itu sendiri
 * pranala interbahasa ke templat yang serupa dalam bahasa lain
 * Teks penjelasan cara menggunakan templat

Mirip dengan itu, segala hal yang berada di antara  dan   hanya akan diproses dan ditampilkan ketika halamannya sedang dimasukkan, tapi tidak ketika halaman templat sedang dibaca secara langsung, dan ini berguna dalam situasi-situasi seperti:


 * Mengategorikan halaman yang mengandung suatu templat. Catatan: ketika mengubah kategori yang diterapkan oleh suatu templat dengan cara ini, kategorisasi halaman yang mengandung templat itu tidak akan diperbarui sampai beberapa waktu kemudian: ini dikendalikan oleh . Untuk memaksakan pengategorian ulang suatu halaman, buka bagian penyuntingan halaman lalu simpan tanpa melakukan perubahan.
 * Memastikan kode templat tidak dijalankan ketika membuka halaman templat. Biasanya ini karena memerlukan parameter, dan eksekusinya tanpa parameter memiliki hasil yang tidak diinginkan.

Semua hal diluar  dan   diproses dan ditampilkan secara normal; artinya, sama ketika halaman templat dibaca secara langsung maupun ketika dimasukkan di halaman lain. Ini berfokus mengenai apa yang ada di dalam kedua tag itu.

Semua hal di luar tag  tidak disertakan ketika transklusi. Bahkan bagian yang ditandai dengan includeonly juga tidak disertakan dalam transklusi kecuali mereka juga ditandai dengan onlyinclude. Fokusnya mengenai apa yang ada di luar tag ini.

Memasukkan tag di dalam tag juga bisa dilakukan.

Ketiga tag transklusi parsial ini memungkinkan berbagai kombinasi apa-apa saja yang diproses dan ditampilkan. Comments also fill a role.

Pengorganisasian templat
For templates to be effective, users need to find them, and find out how to use them.

To find them, users can:
 * 1) Click ' > '
 * 2) In the ' list, choose Template and click '.

To give usage information, include an example like this one on the template page:

Usage
Welcome users:

Then, an editor can simply copy and paste the example to use the template.

Linking to a template
A template page can be linked to like any other wiki page. For example, the link is generated using the wikicode.

On many wikis, Template:Tl can be used to provide a link to a template formatted in a way that shows the "double curly-braces" wikicode necessary to transclude the template without actually doing the tranclusion. For example, the code  may be used to create the link Navbar.

This construct is commonly used in template documentation, on help pages, and on talk pages when referring to templates. The same effect can be achieved by using, but the tl approach involves much less typing. On any given wiki the Tl template, if it exists, may or may not render the text in a "code" element, as shown here. If not, another similarly named template may do so. See, for example, the "See also" section of the documentation of en:Template:Tl at the English Wikipedia.

Penyalinan dari satu wiki ke yang lain
Templates often require CSS or other templates, so users frequently have trouble copying templates from one wiki to another. The steps below should work for most templates.

MediaWiki code
If you have import rights (Specifically importupload) on the new wiki:


 * 1) Go to Special:Export on the original wiki, and download an .xml file with the complete history of all necessary templates, as follows:
 * 2) * Enter the name of the template in the big text box, e.g. "Template:Welcome". Pay special attention to capitalization and special characters — if the template name isn't exactly correct, the export may still occur but the .xml file will not have the expected data.
 * 3) * Check the box "".
 * 4) * Uncheck the box "".
 * 5) * Click "".
 * 6) Go to Special:Import on the new wiki and upload the .xml file.

If you don't have import rights on the new wiki:


 * 1) Go to the template you want to copy from the original wiki. Go to the edit page, and copy all the wikitext
 * 2) On the new wiki, go to the page with the same name as the template you copied. Hit create/edit and paste the wikitext you copied. In the edit summary of each template, link to the original page for attribution.
 * 3) Back in the original wiki at the edit window, below the edit box, look at the list of "Templates used on this page". For each template listed follow these instructions. Also do that for any template used by any of these templates, and so on.

This will copy the entire code necessary, and will suffice for some templates. If it doesn't work also check for red links listed under "Pages transcluded onto the current version of this page:", below the edit box. If there are any repeat the above steps for these as well and also copy the code in the modules.

After successfully importing the template and all its linked templates from the other wiki, edit it to change customisations to suit your wiki. For example to change a logo, remove redundant categories or red links.

Extensions
An extension often used in templates is ParserFunctions. Visit page and check if any of the functions listed there are used in the templates you've copied. If so, you have to install the extension. To install it, you'll need system admin access to the server of your MediaWiki installation.

Another dependency that may be used in templates, especially those on Wikipedia, is Lua. Having   in template code is a good sign for it. In case it's used, you need to install the extension and system admin access is required too. See that page for more instructions about installing and using the extension.

CSS and JavaScript code
Besides MediaWiki code, many templates make use of CSS and some rely on JavaScript to work fully. If the copied templates are not behaving as expected, this may be the cause. To copy the required CSS and JavaScript to your wiki you'll normally need to have admin privileges, because you'll be editing system messages in the "MediaWiki:" namespace.


 * 1) Look for the use of CSS classes (text like  ) in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy those classes to "MediaWiki:Common.css" on the new wiki and check if the template is now fine.
 * 2) If the copied template is still not working as expected, check if there is code in "MediaWiki:Common.js" or "MediaWiki:Monobook.js" on the original wiki. If so, you can try copying it to "MediaWiki:Common.js" on the new wiki. Normally, it is a good idea to only copy code from trusted sources, and first browsing the code to identify and select the parts that are relevant. You may find comments that can serve as clues to identify the functionality of each part.

Lihat pula

 * – a template special use case example
 * – fancy stuff you may find in some templates
 * – additional fancy control functions such as #if and #switch
 * – guidance on using parser functions in templates
 * m:Help:Template – contains a much more thorough manual on how exactly templates function
 * m:Help:Advanced templates – describes even more advanced techniques such as dynamic template calls and variable parameter names
 * m:Help:Embed page – embedding pages from namespaces other than.
 * Manual:Creating pages with preloaded text – Using templates as the starting text of a page
 * Manual:Creating pages with preloaded text – Using templates as the starting text of a page
 * Manual:Creating pages with preloaded text – Using templates as the starting text of a page
 * Manual:Creating pages with preloaded text – Using templates as the starting text of a page
 * Manual:Creating pages with preloaded text – Using templates as the starting text of a page