Bantuan:Templat
Catatan: Ketika Anda menyunting halaman ini, Anda setuju untuk melepas kontribusi Anda di bawah CC0. Lihat Laman Bantuan Domain Publik untuk informasi lebih lanjut. |
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. Templates can be newly written or, to save duplicating work already done, exported from another wiki e.g. Wikipedia, and then imported into the target wiki.
Basic usage
Templat adalah halaman wiki biasa yang isinya dirancang untuk ditransklusikan (ditanamkan) di dalam di halaman lain. Templat mengikuti sebuah konvensi yaitu namanya diawali dengan "Templat:
", memasukkannya ke ruang nama itu; selain ini, Anda bisa membuatnya seperti halaman wiki lainnya.
To transclude a template, you used double open & close curly brackets {{template name}}
.
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:
{{Welcome}}
di halaman lain manapun, ketika halaman tersebut dibuka, teks "Halo! Selamat datang di wiki ini." akan muncul bukannya {{Selamat Datang}}
. Isi templat "ditransklusikan" ke halaman yang lain, atau bisa dibilang isinya dipakai di halaman lain.
Anda kemudian bisa memasukkan {{Selamat Datang}}
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.
Ways to invoke a template
Templat bisa digunakan di halaman lain dengan cara-cara ini:
{{Nama}}
— 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. Because the template call remains in the pages's source, any subsequent change to Template:Name will be seen on the page containing the template call. Also, the page will be listed among those that "link to" the template.{{subst:Nama}}
— 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 di halaman templat sumber tidak akan memengaruhi halaman yang diberi pranala templat. That is, a copy of the contents of Template:Name will be substituted for the template call. No link is maintained between the page and the template, so each can be edited further without affecting the other. In effect, there is little difference between substituting the content in this way and simply typing it into the page's source "manually". See Bantuan:Substitusi for more information.<>Template:Safety:Nama</>
— ini diperkenalkan untuk memungkinkan substitusi yang tidak merusak translate, lihat w:en:Help:Substitution#The safety: modifier. See Bantuan:Substitusi for more information.
{{msgnw:Nama}}
memasukkan templat dalam bentuk yang menampilkannya sebagai sintaks wiki mentah (mirip dengan<nowiki>
) ketika halaman yang memilikinya diambil.
For example, {{msgnw:Template:Thankyou}}
displays:
<noinclude> <languages/> </noinclude> '''Terima kasih...''' atas {{{reason|{{{1}}}}}}. pelukan dari, {{{signature|{{{2}}}}}} <noinclude> [[Category:Template examples{{#translation:}}|{{PAGENAME}}]] </noinclude>
Sebenarnya, halaman wiki biasapun juga bisa digunakan sebagai templat, hanya dengan memberitahukan ruang nama letaknya, jadi:
{{Templat:Namahalaman}}
memasukkan[[Templat:Namahalaman]]
{{Pembicaraan:Namahalaman}}
memasukkan[[Pembicaraan:Namahalaman]]
{{:Namahalaman}}
memasukkan[[Namahalaman]]
{{subst::Namahalaman}}
mengganti dirinya sendiri dengan isi[[Namahalaman]]
Jika tidak ada ruang nama yang disebut, judul lengkapnya diasumsikan merupakan templat:
{{Foo:Bar}}
memasukkan[[Templat:Foo:Bar]]
Regardless of what syntax is used, the name of the template can be relative to the current page
For example, if {{/bar}}
is called on page foo, it will transclude the page foo/bar.
It can also be generated dynamically.
For example, {{ {{foo}} }}
calls Template:foo and interprets the result as the name of another template to call.
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:
Terima kasih...
atas semua usahamu.
pelukan dari, Aku
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 Templat:Thankyou , 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:
'''Terima kasih...'''
atas {{{1}}}.
pelukan dari, {{{2}}}
Perhatikan penggunaan {{{1}}}
dan {{{2}}}
. 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:
{{Thankyou|semua usahamu|Aku}}
Dalam kasus ini, templat {{Thankyou}}
menerima parameter {{{1}}}=semua usahamu
dan {{{2}}}=Aku
, menghasilkan:
Terima kasih...
atas semua usahamu.
pelukan dari, Aku
Urutan pemberian parameter anonim sangatlah penting untuk menentukan perilakunya. Membalikkan urutan parameter, seperti:
{{Thankyou|Aku|semua usahamu}}
akan menghasilkan ini:
Terima kasih...
atas Aku.
pelukan dari, semua usahamu
{{{1}}}
, dll.) hanya bekerja pada parameter anonim. Parameter yang dikenali berdasarkan namanya, seperti yang ditunjukkan di bawah, tidak akan bisa diakses oleh templat menggunakan nomor.
Parameter bernomor
Untuk memberikan parameter berdasarkan nomor, masukkan setiap parameter dengan nomor pengenalnya:
{{Thankyou|2=Aku|1=pertemananmu}}
Kali ini, templat {{Thankyou}}
menerima parameter {{{1}}}=pertemananmu
dan {{{2}}}=Aku
, meskipun mereka diberikan dalam urutan yang berbeda, dan menghasilkan:
Terima kasih...
atas pertemananmu.
pelukan dari, Aku
- Contoh
{{Thankyou|1=menambahkan “=”|2=Aku}}
menghasilkan
Terima kasih...
atas adding “=”.
pelukan dari, Me
Parameter bernama
Cara ketiga untuk memberikan parameter adalah menggunakan nama bukannya nomor. Dalam kasus ini, isi templat diubah menjadi:
'''Terima kasih...''' atas {{{reason}}}. pelukan dari, {{{signature}}}
Di dalam templat, kita menggunakan {{{reason}}}
dan {{{signature}}}
untuk membedakan setiap parameter, bukannya nomor. Untuk memberikan parameter menggunakan nama, bedakan setiap parameter ketika memberikannya:
{{Thankyou|signature=Aku|reason=menjadi dirimu sendiri}}
Dalam kasus ini, templat {{Thankyou}}
menerima parameter {{{reason}}}=menjadi dirimu sendiri
dan {{{signature}}}=Aku
, menghasilkan:
Terima kasih...
atas menjadi dirimu sendiri.
pelukan dari, Aku
Parameter bernama peka kapital, jadi:
{{Thankyou|signature=Aku|Reason=menjadi dirimu sendiri|reason=bersifat peka kapital}}
menghasilkan:
Terima kasih...
atas bersifat peka kapital.
pelukan dari, Aku
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.
Spaces and newlines are automatically stripped from the start and end of named parameter names and values, but are preserved in unnamed parameters.
Mixing named and unnamed parameters
If the template supports it, both kinds of parameters can be used in one call.
For example, {{Thankyou|supporting both parameter types|signature=Me}}
results in:
Terima kasih...
atas supporting both parameter types.
pelukan dari, Me
Be careful when doing this, because it can result in conterintuitive results as unnamed parameter counts are based only on the unnamed parameters, not the named parameters. For example, {{Thankyou|Me|reason=supporting both parameter types}}
results in:
Terima kasih...
atas supporting both parameter types.
pelukan dari, {{{2}}}
The template is coded to prefer the named parameter for the reason over the unnamed parameter, resulting in the "Me" being lost and no signature being given. This results in a default value of {{{2}}} being shown, as explained below.
Nilai bawaan
Jika Anda mentransklusikan suatu templat yang memerlukan parameter, tapi tidak memberikan argumennya, seperti ini:
{{Thankyou}}
dalam contoh parameter bernomor di atas, maka Anda akan mendapatkan hasil berikut:
Terima kasih...
atas {{{1}}}.
pelukan dari, {{{2}}}
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:
'''Terima kasih...'''
atas {{{reason|segalanya}}}.
pelukan dari, {{{signature|Aku}}}
maka {{{reason|segalanya}}}
mendefinisikan bahwa jika tidak ada argumen yang diberikan untuk parameter {{{reason}}}
, maka nilai segalanya
akan digunakan. Tidak jauh berbeda, {{{signature|Aku}}}
, membuat parameter {{{signature}}}
bernilai Me
secara bawaan. Sekarang, mentransklusikan templat lagi tanpa argumen akan menghasilkan:
Terima kasih...
atas segalanya.
pelukan dari, Aku
{{foo|bar=}}
or {{foo|bar=|baz=qux}}
, the foo
template considers the bar
parameter to be ""
. This is different from omitting the parameter altogether, which leaves it undefined and triggers the default value mechanism described above.{{#if:{{{1|}}}|{{{1|}}}|undefined}}
returns undefined if the parameter is either undefined or empty, while {{{1|undefined}}}
does so only if the parameter is undefined.Sering kali nilai baku digunakan untuk menetapkan nama alternatif dari parameter.
Contohnya, jika Anda punya {{{a|{{{b|}}} }}}
, pertama-tama templat akan mencari parameter yang bernama "a".
Jika ia tidak ditetapkan, maka parameter bernama "$2" akan digunakan.
Jika "a" ataupun "b" tidak ditetapkan, tidak akan dihasilkan apa-apa.
Passing parameters to other templates
If raw parameter syntax is generated by the above template call, and then passed through to another template, it is not interpreted as a parameter. This means that {{Thankyou2 }}, which just calls {{Thankyou }} with no parameters, does not work: {{thankyou2|everything|me}} -> Terima kasih... atas {{{1}}}. pelukan dari, {{{2}}} .
You instead need to explicitly pass the parameter to the other template, i.e if {{Thankyou3 }} contains
{{thankyou|{{{1}}}|{{{2}}}}}}
then {{thankyou3|everything|me}} -> Terima kasih... atas everything. pelukan dari, me } works properly.
This example does not preserve emptiness vs. undefinedness in parameter values - you would need more complicated syntax if you wanted to do that.
Empty vs undefined parameters
The {{t2demo|| a }}
(refer to {{T2demo }} ), with a double pipe, sets the first parameter to an empty string instead of leaving it undefined.
It produces the output start--middle- a -end
, similar to how {{t2demo|1=|2= a }}
results in start--middle- a -end
.
On the other hand, explicitly setting the parameter "2" to "a," results in the first unnamed parameter being left undefined:
{{t2demo|2= a }} results in start-{{{1}}}-middle- a -end
If the second parameter should not be trimmed, it must be unnamed.
Therefore, you can assign an empty string to the first parameter, but you cannot leave it undefined.
Making emptiness and undefinedness equivalent
Good template coding practices result in passing an empty string to a parameter working the same as not assigning any value. This makes things easier and more consistent.
For example, using p=
can show that a template has a parameter "p" that doesn't have a value yet.
To make an empty string and an undefined value equivalent, use the following approaches:
- Use
{{{p|}}}
exclusively instead of{{{p}}}
orq
where "q" is a non-empty value. - Use conditional checks like
{{#if:{{{p|}}}|..{{{p}}}..|..}}
, to ensure{{{p}}}
is only used when it has a value.
If for some reason you want to treat undefined parameters differently from empty parameters or any other possible value you can compare the same parameter twice with different defaults, i.e {{#ifeq:{{{foo|bar}}}|{{{foo|baz}}}|parameter is defined|parameter is undefined}}
.
Using equals signs in unnamed parameters
Unnamed parameters can include equals signs, but this must be done indirectly. Here are some methods using template:T1demo:
- Default Value for Undefined Parameter
Assign a default value to an undefined parameter:
{{T1demo|{{{1| a=b }}}}}
This renders as: start a=b end
.
- Using the
{{=}}
parser function
Use a parser function that safely includes an equals sign:
{{T1demo| a{{=}}b }}
This renders as: start a=b end
.
- HTML Entities
Replace the equals sign with an HTML entity for display:
{{T1demo| a=b }}
This renders as: start a=b end
.
This renders correctly without affecting the other parameters.
Handling unmatched curly and square brackets
Unmatched curly brackets ({{
, }}
) or square brackets ([[
, ]]
) must be inside nowiki tags or use HTML entities:
- Rendering curly brackets have two options:
- Use
<nowiki>{{</nowiki>
or{
for{
- Use
<nowiki>}}</nowiki>
or}
for}
.
- Use
- Use
[
for[
and]
for]
.
Below are some examples:
- Unmatched curly brackets
{{T1demo| <nowiki>{{</nowiki>content<nowiki>}}</nowiki> }}
This correctly renders the braces without breaking the template.
- Unmatched square brackets
{{T1demo| text [link] more text }}
This correctly renders the braces without breaking the template.
This renders as:
start text [link] more text end
Unmatched pairs not placed in nowiki tags either prevent template expansion or are taken as closing braces for the template call.
Below are some examples:
{{T1demo|abc]]def[[ghi}}
This will not expand correctly because of unmatched brackets.
The correct use:
{{T1demo|abc<nowiki>]]</nowiki>def<nowiki>[[</nowiki>ghi}}
This renders as:
startabc]]def[[ghiend
Template-generated brackets
An alternate technique for passing arguments with unmatched brackets is to wrap them in another template. In that situation, (which exists with {{(( }} and {{)) }}) on this wiki), the unmatched brackets will be rendered literally, and not decoded as another template call. For example:
{{t1demo|{{((}}t1demo{{))}}}}
results in: start{{t1demo}}end
When substituting a template, template inclusions are parsed once when the subst happens (with the same caveats explained above) and then a second time when rendering the resulting wikitext. For example:
{{subst:((}}t1demo|foo}}
will expand on save to:
{{((}}t1demo|foo}}
which will then render as:
startfooend
If the wikitext generated via the first subst itself includes "subst:" syntax it will not be processed on the same save, but may be on the next save. This technique may be used to implement recursive substitutions that take multiple saves to evaluate.
Using pipes in parameter values
A parameter value cannot contain a pipe character (|), because it would be interpreted as the end of that parameter and the start of the next parameter.
This can be worked around by using the parser function {{!}}
, or the HTML entity &124;.
The two methods of doing this have slightly different behavior, which can be relevant in some corner cases like when a template is producing wikitable syntax.
Example:
{{T1demo|abc|def}}
produces:
startabcend
The "def" doesn't display because it is treated as part of another unnamed parameter, which the template does not use.
{{T1demo|abc{{!}}def}}
produces:
startabc|defend
The "def" displays properly.
{{T1demo|abc|def}}
produces:
startabc|defend
The "def" displays properly again.
Formatting template calls using extra parameters
Since templates ignore parameters they are passed but do not handle specifically, they can be used as a way of a adding extra whitespace or unused content to the template call.
For example:
{{template name|foo|bar|baz|mumble|quux}}
is equivalent to, assuming the template doesn't recognize SPACEN as a parameter name:
{{template name|SPACE1=
|foo|SPACE2=
|bar|SPACE3=Random stuff
|baz|SPACE4=
|mumble|SPACE5=
quux
}}
It is also possible to use the same name for each spacer (often the empty string), but this will populate Category:Pages using duplicate arguments in template calls, which many wikis prefer to keep empty to catch instances of user error.
This can be used to make the template render in a way similar to its output, like showing each row of w:Template:Chess position on its own like to make the wikitext also look like a chessboard.
Tracking parameter usage
It may be wise for a template to add a link or category to a page if a certain parameter or combination of parameters is used, to make if possible to easily determine what pages are using a given parameter, and thus what the impacts of changing that parameter in the template would be.
Evaluasi
Secara umum, parameter templat dimasukkan ke templat setelah tokenisasi, tetapi dimasukkan sebagaimana adanya. Mereka tidak dievaluasi sebelum digunakan.
Ini punya beberapa akibat.
- If you have a
Template:Start
containing{{mytemplate
, and aTemplate:End
containing|foo=bar}}
, and put{{start}}{{end}}
on a page, mytemplate isn't transcluded, because tokens like "|" cannot be added by a template and keep their special meaning in templates. Anda tetap bisa menggunakan templat untuk mengendalikan nama parameter atau templat, tetapi Anda tidak bisa memecah satu pemanggilan templat kepada beberapa templat. - Akibat yang kedua dari ini adalah eliminasi kode mati. If you make a template call like
{{foo|{{DISPLAYTITLE:Bar}} }}
, andTemplate:Foo
does not contain {{{1}}}, then theDISPLAYTITLE
is not used, since it is only evaluated when needed, and 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 theint:
magic word that varies by user language. This isn't perfect, and in some cases even if the result of expanding a template is not used (because it is part of an if statement condition, for example), the process of evaluating it can still have side effects. For example, any links produced or other templates used will still be added to Special:WhatLinksHere even if they are not displayed.
Template parameters are pass by value, which means a template cannot modify its arguments. Parameters are treated as associative array, and parameter names are evaluated before parameter values. If the same parameter name is given more than once (either as named or unnamed), only the last instace is used, and the page is added to Category:Pages using duplicate arguments in template calls.
Template calls starting with the magic word subst:
or safesubst:
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.
Kebanyakan fungsi parser, tag parser, dan halaman istimewa yang ditransklusikan bukan secara langsung dimasukkan seperti templat, melainkan diganti oleh sebuah "penanda strip". Ini artinya Anda tidak bisa memanipulasi hasil templat dengan fungsi parser seperti padleft: atau fungsi-fungsi serupa dari ekstensi, karena templat akan melihat penanda strip bukannya hasil dari fungsi parser.
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 a {{Aaaa}} z
, maka templatnya akan menampilkan "a a Template loop detected: Template:Aaaa z z".
This safeguard precludes a potentially useful template idiom where a template self-normalizes its own calling arguments.
In this forbidden example template:d
can either be called {{d|20200311}}
or {{d|y=2020|m=3|d=11}}
.
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:{{{1|}}}|{{d|y={{#sub:{{{1}}}|0|4}}|m={{#sub:{{{1}}}|4|2}}|d={{#sub:{{{1}}}|6|2}}}}|<!-- processing path with arguments y,m,d regardless of original call pattern -->}}
If template:d
is modified to recurse into template:d/2
and template:d/2
is an identical manual copy of template:d
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 pipe character (|
) and equality sign (=
) have different meanings in template calls and wikitables, in order to use table markup in the value of a template parameter one generally needs to "escape" those characters (i.e., protect them from interpretation as template markup) using special sequences:
- the built-in magic word
{{!}}
provides an "escaped" version of|
since MediaWiki 1.24 - the built-in magic word
{{=}}
provides an "escaped" version of=
since MediaWiki 1.39
Before the introduction of these magic words, many wikis used templates to accomplish the same things. On such a wiki, the magic words take precendence over the same-named templates.
Example table
A | B | C |
---|---|---|
A1 | B1 | C1 |
A2 | B2 | C1 |
Table code:
{| class=wikitable
!A!!B!!C
|-
|A1||B1||C1
|-
|A2||B2||C1
|}
Escaped table code:
{{{!}} class{{=}}wikitable
!A!!B!!C
{{!}}-
{{!}}A1{{!}}{{!}}B1{{!}}{{!}}C1
{{!}}-
{{!}}A2{{!}}{{!}}B2{{!}}{{!}}C2
{{!}}}
Note that the first left-brace ({
) is interpreted as a literal left-brace character because it is immediately followed by the {{!}}
magic word.
Similarly, the last right-brace (}
) is interpreted as a literal right-brace character because it is immediately preceeded by the same magic word.
However, in some cases these brace characters do cause problems, so some wikis provide templates for escaping these characters, as well:
- the template call
{{(}}
might provide an "escaped" version of{
- the template call
{{)}}
might provide an "escaped" version of}
Some wikis go even further and provide other convenience templates like {{(!}} ({|
), {{!)}} (|}
), {{!!}} (||
).
On such a wiki, the code can be simplified a bit to this form:
{{(!}} class{{=}}wikitable
!A!!B!!C
{{!}}-
{{!}}A1{{!!}}B1{{!!}}C1
{{!}}-
{{!}}A2{{!!}}B2{{!!}}C2
{{!)}}
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 $noinclude, $includeonly dan $onlyinclude.
The template's page when viewed directly appears exactly as the template would render without any parameters. If the template requires parameters to function properly, this will result in raw wikitext syntax or errors as a result of them being missing.
For example:
- If a parameter has no default value, it shows as the literal text {{{1}}}, indicating the template needs a parameter.
- If a parameter has an empty default value (it is written as {{{1|}}}), it displays nothing, which achieves the intended effect but lacks clarity for self-documentation. Using a non-empty default value like
{{{1|$1}}}
could clarify a parameter's role, especially for templates involving images. - If a parameter without a default is passed to the
#expr
parser function, it results in an error message: "Expression error: unrecognized punctuation character '{'." - If a template creates a table, it's helpful for the template page to show the table's structure rather than the wikitext used to make it. To do this, the table syntax isn't enclosed in tags, and each table element includes both
<noinclude>...</noinclude>
and<includeonly>...</includeonly>
parts where needed.
However, you can control which parts of a template will be seen and included by the use of the <noinclude>
, <includeonly>
and <onlyinclude>
tags.
Semua yang berada di antara <noinclude>
dan </noinclude>
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 It's a common pattern on some wikis to use a template like {{Documentation }} to transclude the documentation from a subpage of the template. For example, Template:Void is documented at Template:Void/doc.
Mirip dengan itu, segala hal yang berada di antara <includeonly>
dan </includeonly>
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 antrean pekerjaan . 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 <noinclude>
dan <includeonly>
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 <onlyinclude>
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.
For example, if a page like Help:Templates/onlyinclude demo has the wikitext:
abc<onlyinclude>def</onlyinclude>ghi<includeonly>jkl</includeonly>
The result of transcluding it is def.
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.
Inclusion tags are respected when using {{subst:templatename}}
, but they are not respected when using {{msgnw:templatename}}
as that displays the raw wikitext without any processing.
Section transclusion
To transclude different sections of a template on different pages, you can wrap the content in onlyinclude tags and use an if statement on parameters to select which section.
Consider "Template:Example" with this wikitext:
== Section 1 ==
{{#ifeq:{{{1|1}}}|1|
Content of section one.
}}
{{#ifeq:{{{1|2}}}|2|
== Section 2 ==
Content of section two.
}}
This will render both sections on the example page itself, and allow other pages to transclude the first section with {{example|1}}
and the second section with {{example|2}}
.
Another approach is to use literal parameter syntax instead:
{{{section1|
== Section 1 ==
Content of section one.
}}}
{{{section2|
== Section 2 ==
Content of section two.
}}}
Transclude the first section with {{example|section2=}}
and the second section with {{example|section1=}}
. If neither parameter is used, then both sections will display.
A third approach is to use Labeled Section Transclusion.
Pengorganisasian templat
Agar templat bisa efektif, pengguna harus bisa menemukannya, dan bisa mencari tahu cara menggunakannya.
Untuk menemukannya, para pengguna bisa:
- Menekan Halaman istimewa > Daftar halaman
- Di daftar Ruang nama:, pilih Templat dan tekan Lanjut.
Untuk memberikan informasi penggunaan, sertakan contoh seperti yang satu ini di halaman templat:
<noinclude> == Penggunaan == Memberikan selamat: {{Thankyou|reason=alasan Anda|signature=Tanda tangan Anda}} </noinclude>
Kemudian, seorang penyunting tinggal menyalin dan menempel contoh itu untuk digunakan di templat.
While editing a page, a list of all templates used is available under the editing form, in a collapsible section titled "Templat yang digunakan di halaman ini:" (also named "Templat yang digunakan di pratayang ini:", or "Templat yang digunakan di bagian ini:" depending on the context). This list provides a convenient link to the template's page, as well as information about its protection status. Redirected templates are shown in italics, with the redirect target added as a separate list item.
Menautkan ke templat
Halaman templat bisa ditautkan seperti halaman wiki lainnya. Contohnya, pranala Template:Navbar dihasilkan menggunakan kode wiki [[Template:Navbar]]
.
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 {{tl|Navbar}}
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 {{[[Template:Navbar|Navbar]]}}
, tetapi cara {{Tl }}
memerlukan lebih sedikit pengetikan.
Di wiki manapun, templat Tl, jika ada, bisa jadi menghasilkan teks dalam elemen "code" atau sebagai tipe monospace.
Jika tidak (seperti di wiki ini), templat lain yang bernama mirip mungkin melakukannya.
Lihat, sebagai contoh, bagian "Lihat pula" di dokumentasi Template:Tl kami.
Template naming
The name of a template is case-sensitive excluding the first character.
You make redirects for alternate capitalizations.
For example, if a template is named "AdminAbbr", you can create a redirect named "Adminabbr".
This way, the template can be called with either {{AdminAbbr}}
or {{adminabbr}}
.
If an editor prefers a mix of upper and lower case for clarity, they can use functions like lc or uc.
For instance, instead of {{CURRENTINTERNETTIME}}
, they could use {{ {{uc:CurrentInternetTime}} }}
Because template names are interpreted in the same way to the names of other pages, underscores are replaced with spaces, and any text after a number sign (what would be a anchor in a standard link) is ignored.
An underscore _
can be alternative to a blank space.
Possible uses of templates
Templates can be used for any situation in which one wants two or more pages to contain identical or similar content that is edited together rather than independently. They can be used to:
- Provide structured elements on many pages, like infoboxes, maintenance templates, navigational boxes, etc.
- Perform calculations used as a programming tool on various pages, like w:Template:Sum.
- Build composite pages that display the content of multiple existing pages together, like w:WP:Village pump (all) which includes content from each section of the village pump. The content of these pages can either be shown individually, or together, but the revision history, watchlist, etc. will only pick up changes to the transcluded pages and the raw wikitext of the composite page itself, not implicit changes to the composite page.
- Share some content between a few related pages. For example, the list at Help:Preferences#Beta features is duplicated at Beta Features#Current Beta Features. While on MediaWiki.org that is built using Extension:LabeledSectionTransclusion instead, it could have been done using a template.
- Store content referenced multiple times on the same page, so it only has to be written and calculated once. For example w:Template:Cite Monumentenregister/URL is called twice by w:Template:Cite Monumentenregister in two different places, and using another template means the URL pattern only has to be written once in the base template.
- Use templates as a programming element to generate a loop: if Template:A calls Template:B 10 times with different parameters, then that crudely simulates a for loop. If Template:B calls Template:C 10 times, then you have a nested loop of 100 calls of Template:C. But keep in mind that it is easy to run into the template limits when using templates as advanced programming constructs, and using Scribunto is generally clearer and easier to follow.
Penyalinan dari satu wiki ke yang lain
It is possible, if allowed by the wiki configuration to transclude templates from other wikis. This configuration setting is disabled on Wikimedia wikis. Otherwise, you need to manually copy the template and its dependencies from the source wiki to the destination wiki to use it.
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:
- Pergi ke Special:Export di wiki yang asli, dan unduh sebuah berkas .xml beserta riwayat lengkap semua templat yang diperlukan, seperti berikut:
- 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.
- Pilih kotak "Termasuk templat".
- Pilih kotak "Hanya ekspor revisi sekarang, bukan seluruh versi terdahulu".
- Tekan "Ekspor".
- Pergi ke Special:Import di wiki yang baru dan unggah berkas .xml.
Jika Anda tidak punya hak impor di wiki yang baru:
- Pergi ke templat yang ingin Anda salin dari wiki yang asli. Pergi ke halaman penyuntingan, dan salin semua teks wiki
- 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.
- 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.
- 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.
- 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.
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 Ekstensi:ParserFunctions dan periksa apakah ada fungsi di sana yang digunakan di templat yang Anda salin. Jika iya, Anda perlu memasang ekstensi ParserFunctions . 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 {{#invoke: }}
dalam kode templat adalah tanda digunakannya Lua.
Jika digunakan, Anda perlu memasang ekstensi Scribunto 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:".
- Cari penggunaan kelas CSS (teks seperti
class="foobar"
) 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. - 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.
Redirection
If a page uses a redirect as a template, the redirect is resolved before processing the template and the target is used instead. This won't work if the target doesn't exist (a broken redirect), or is itself a redirect (a double redirect).
A page that just includes another page as a template might look like a redirect, but there are several differences between them:
- The header of the result displays the title of the page it came from.
- No "Redirected from" message is shown.
- Buttons like edit, watch, talk, history, "what links here," and "last modified" point to the referring page. To access the target page, use a section edit link and navigate from there.
- Unless includeonly and/or noinclude tags are used, the referring page shares the same categories as the target page.
- "Double redirects" work when one or both are this type of pseudo-redirect.
Parser functions
MediaWiki also supports parser functions, which function similarly to templates but follow slightly different syntax:
- Parser functions utilize a ":" instead of the initial "|".
- An edit page does not display parser functions used on that page.
- There is no "What links here" feature for parser functions to identify the pages where they are utilized.
- Parser functions templates do not generally accept named parameters, so equal signs generally have no special significance. For example:
{{ #if: not blank | x=abc }}
givesx=abc
Lihat pula
General template usage
- Manual:Expr parser function syntax
- Help:Substitution
- w:Help:Template
- Manual:Advanced templates – * m:Help:Advanced templates – menjelaskan teknik lanjutan sepeti pemanggilan templat dinamis dan nama parameter variabel
- Help:Multiple-instance templates - on the use of multiple instances of the same template on a page.
- Manual:Newlines and spaces#Automatic newline
Special constructs used in templates
- Bantuan:Kata ajaib – hal-hal menarik yang bisa ditemukan di beberapa templat
- Bantuan:Ekstensi:ParserFunctions – fungsi kendali tambahan seperti #if dan #switch
- Help:Parser functions in templates – panduan menggunakan fungsi parser dalam templat
- Bantuan:TemplateData
- Bantuan:Ekstensi:ParserFunctions
- Ekstensi:Scribunto
Other relevant information
- Help:ExpandTemplates
- Bantuan:Pencarian eksternal – sebuah contoh penggunaan khusus templat
- Manual:Importing Wikipedia infoboxes tutorial
- Extension:PageTemplates
- Manual:Creating pages with preloaded text – Using templates as the starting text of a page
- Bantuan:Transklusi – * m:Help:Embed page – menanamkan halaman dari ruang nama selain
Templat:
. - Manual:Template limits
- Bantuan:Pranala balik
- Special:Mostlinkedtemplates - shows the templates with the most uses
- Special:Unusedtemplates - shows templates with no uses (although they may be substituted)
- Manual:$wgEnableScaryTranscluding - using templates from other wikis
- w:WP:Anatomy of a template
- w:Wikipedia:Transclusion costs and benefits
- Manual:Parser.php
- Help:Extension:TemplateSandbox - for previewing your changes to a template as it renders elsewhere
Pranala luar
- Repositori templat Miraheze - Templat MediaWiki yang dimaksudkan untuk penggunaan umum.