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:

menghasilkan
 * Contoh:

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 menampilkan "a a Template loop detected:  Template:Aaaa z z".

Forbidden idiom
This safeguard precludes a potentially useful template idiom where a template self-normalizes its own calling arguments. In this forbidden example  can either be called   or. If called in the first manner, it recurses into itself with the second argument structure (obtained using string parser functions), which then follows a unified processing path.



If  is modified to recurse into   and   is an identical manual copy of   this idiom works fine as the self-recursion safeguard operates dynamically and not statically.

A feasible way for the MediaWiki software to loosen the self-recursion rule would be to require that each recursive call have a distinct argument count from all previous active calls, at most once recursing with the argument count non-decreasing. That would provide a strong guarantee against infinite self-recursion while enabling useful idioms such as the one described here in a flexible manner.

If the processing path is of low complexity, a simple solution using only one template is to handle each calling convention on a separate if/else branch, duplicating the logic of the processing path within each case. If the processing path is more complex, each call-structure case can delegate to an implementation template with a unified call structure which provides the final template behaviour.

Tables in parameters
Since the syntax for wikitables involves pipes in single braces ({ }) and using the pipe trick will not work in transclusion parameters, one will have to create a table as a separate page and transclude it from there.

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. Komentar juga memiliki peran.

Pengorganisasian templat
Agar templat bisa efektif, pengguna harus bisa menemukannya, dan bisa mencari tahu cara menggunakannya.

Untuk menemukannya, para pengguna bisa:
 * 1) Menekan ' > '
 * 2) Di daftar ', pilih Templat dan tekan '.

Untuk memberikan informasi penggunaan, sertakan contoh seperti yang satu ini di halaman templat:

Penggunaan
Memberikan selamat:

Kemudian, seorang penyunting tinggal menyalin dan menempel contoh itu untuk digunakan di templat.

Menautkan ke templat
Halaman templat bisa ditautkan seperti halaman wiki lainnya. Contohnya, pranala dihasilkan menggunakan kode wiki.

Di banyak wiki, Template:Tlbisa digunakan untuk memberikan pranala ke templat yang diformat dengan menampilkan kode wiki "tanda kurung kurawal ganda" yang diperlukan transklusi tanpa benar-benar melakukan transklusi. Contohnya, kode  bisa digunakan untuk membuat pranala Navbar.

Konstruksi ini biasanya digunakan dalam dokumentasi templat, di halaman bantuan, dan di halaman pembicaraan ketika merujuk kepada templat. Hasil yang sama bisa dihasilkan menggunakan, tetapi cara tl memerlukan lebih sedikit pengetikan. Di wiki manapun, templat Tl, jika ada, bisa jadi menghasilkan teks dalam elemen "code", seperti yang ditunjukkan di sini. Jika tidak, templat lain yang bernama mirip mungkin melakukannya. Lihat, untuk contoh, bagian "See also" dari dokumentasi en:Template:Tl di Wikipedia bahasa Inggris.

Penyalinan dari satu wiki ke yang lain
Templat kadang membutuhkan CSS atau templat lain, jadi beberapa pengguna kadang menemukan kesulitan ketika menyalin templat dari satu wiki ke wiki lainnya. Tahap-tahap di bawah harusnya bekerja untuk kebanyakan templat.

Kode MediaWiki
Jika Anda punya hak impor (secara spesifik importupload) di wiki yang baru:


 * 1) Pergi ke Special:Export di wiki yang asli, dan unduh sebuah berkas .xml beserta riwayat lengkap semua templat yang diperlukan, seperti berikut:
 * 2) * Masukkan nama templat di kotak teks besar, contoh "Templat:Selamat datang". Perhatikan kapitalisasi dan karakter-karakter khusus — jika nama templatnya tidak tepat, ekspor mungkin masih dilakukan tetapi berkas .xml tidak akan memiliki data yang diharapkan.
 * 1) * Centang kotak "".
 * 1) * Hapus centang kotak "".
 * 1) * Tekan "".
 * 2) Pergi ke Special:Import di wiki yang baru dan unggah berkas .xml.

Jika Anda tidak punya hak impor di wiki yang baru:


 * 1) Pergi ke templat yang ingin Anda salin dari wiki yang asli. Pergi ke halaman penyuntingan, dan salin semua teks wiki
 * 2) Di wiki yang baru, pergi ke halaman dengan nama yang sama dengan templat yang Anda salin. Tekan buat/sunting lalu tempelkan teks wiki yang Anda telah salin. Di ringkasan suntingan di setiap templat, tautkan halaman yang asli sebagai atribusi.
 * 3) Kembali ke wiki yang asli di jendela penyuntingan, di bawah kotak penyuntingan, lihat daftar "Templat yang digunakan di halaman ini". Untuk setiap templat yang didaftaran, ulangi instruksi ini. Lakukan juga untuk templat yang digunakan templat-templat tersebut, dan seterusnya.

Ini akan menyalin seluruh kode yang diperlukan, dan harusnya cukup untuk sebagian templat. Perhatikan bahwa hanya elemen halaman yang di-parse selama penggambaran halaman yang diekspor, jadi, sebagai contoh, subhalaman dokumentasi tidak diekspor sebagai bagian dari proses ini. Jika tidak bekerja, periksa apakah ada pranala merah yang didaftarkan di "Halaman yang ditransklusikan ke versi terkini halaman ini:", di bawah kotak penyuntingan. Jika ada, ulangi tahap-tahap di atas untuk pranala-pranala tersebut dan juga salin kode dalam modul.

Setelah berhasil mengimpor templat dan semua templat yang berkaitan dari wiki lain, suntinglah agar sesuai dengan wiki Anda. Misalnya, ubah logonya, hapus pranala merah atau kategori yang tidak diperlukan.

Ekstensi
Ekstensi yang sering digunakan dalam templat adalah ParserFunctions. Kunjungi halaman dan periksa apakah ada fungsi di sana yang digunakan di templat yang Anda salin. Jika iya, Anda perlu memasang ekstensi. Untuk memasangnya, Anda memerlukan akses system admin ke peladen pemasangan MediaWiki Anda.

Kebutuhan lain yang mungkin digunakan dalam templat, khususnya di Wikipedia, adalah Lua. Terdapatnya   dalam kode templat adalah tanda digunakannya Lua. Jika digunakan, Anda perlu memasang ekstensi dan melakukannya juga perlu akses system admin. Lihat halaman itu untuk instruksi lebih lanjut mengenai cara memasang dan menggunakan ekstensi.

Kode CSS dan JavaScript
Selain kode MediaWiki, banyak templat yang menggunakan CSS dan beberapa mengandalkan JavaScript agar bisa bekerja sepenuhnya. Jika templat yang disalin tidak bertingkah seperti yang diharapkan, ini mungkin penyebabnya. Untuk menyalin CSS dan JavaScript yang diperlukan ke wiki Anda, biasanya Anda memerlukan hak pengurus, karena Anda akan menyunting pesan sistem di ruang nama "MediaWiki:".


 * 1) Cari penggunaan kelas CSS (teks seperti  ) dalam teks templat. Jika kelas-kelas tersebut ada di "MediaWiki:Common.css" atau "MediaWiki:Monobook.css" di wiki yang asli, salin kelas-kelas tersebut ke "MediaWiki:Common.css" di wiki yang baru dan periksa apakah templatnya sekarang bekerja.
 * 2) Jika templat yang disalin masih belum bekerja, periksa apakah ada kode di "MediaWiki:Common.js" atau "MediaWiki:Monobook.js" di wiki yang asli. Jika iya, Anda bisa mencoba menyalinya ke "MediaWiki:Common.js" di wiki yang baru. Biasanya, akan lebih baik jika hanya menyalin kode dari sumber yang terpercaya, dan dahulukan menelusuri kode untuk menemukan bagian-bagian yang relevan. Anda mungkin bisa menemukan komentar yang bisa menjadi petunjuk mengenai fungsionalitas masing-masing bagian.

Lihat pula

 * w:Help:Table - intruksi termudah yang dapat digunakan.
 * – sebuah contoh penggunaan khusus templat
 * – hal-hal menarik yang bisa ditemukan di beberapa templat
 * – fungsi kendali tambahan seperti #if dan #switch
 * – panduan menggunakan fungsi parser dalam templat
 * m:Help:Template – berisi panduan yang lebih menyeluruh mengenai cara kerja templat
 * m:Help:Advanced templates – menjelaskan teknik lanjutan sepeti pemanggilan templat dinamis dan nama parameter variabel
 * m:Help:Embed page – menanamkan halaman dari ruang nama selain.
 * – Using templates as the starting text of a page
 * – Using templates as the starting text of a page
 * – Using templates as the starting text of a page
 * – Using templates as the starting text of a page
 * – Using templates as the starting text of a page

Pranala luar

 * Repositori templat Miraheze - Templat MediaWiki yang dimaksudkan untuk penggunaan umum.