Bantuan:DataTemplat
 |
Catatan: Apabila anda menyunting halaman ini, anda bersetuju untuk memberi keizinan sumbangan anda tertakluk di bawah CC0. Lihat Laman Bantuan Domain Awam untuk maklumat lanjut. | |
TemplateData ialah sambungan yang menyimpan maklumat dan parameter yang dikaitkan dengan templat teks wiki dan menjadikannya tersedia untuk antara muka penyuntingan yang boleh mendapatkan dan membentangkannya dalam editor templat -- yang kesemuanya membantu pengguna menambah dan mengedit templat pada muka surat.
Mulai April 2019, kefungsian data templat adalah sebahagian daripada pengalaman pengguna lalai untuk semua pengguna di semua wiki Wikimedia apabila mereka menambah templat, walaupun pengguna tidak berdaftar. Kedua-dua sumber lalai dan editor visual menggabungkannya dalam beberapa cara, seperti juga banyak skrip, alat dan alat. Jika anda mahukan fungsi ini pada wiki anda sendiri, pasang Sambungan:TemplateData.
- : désambiguïser alwi mawa#
Anda boleh melakukan ini secara manual atau dengan editor data templat, antara muka pengguna grafik yang boleh anda akses pada halaman "Sunting"/"Sunting sumber" templat di wiki dengan sambungan TemplateData dipasang. JSON mengandungi senarai parameter dan maklumat templat tentang parameter tersebut dan tentang templat secara keseluruhan (lihat di bawah untuk butiran).
Templat yang mengandungi data templat akan memaparkan maklumat ini dalam antara muka pengguna apabila pengguna menambah templat. Dalam sesetengah kes, ia akan mengubah cara editor berkelakuan apabila anda menggunakannya untuk mengedit atau memasukkan templat yang diberikan, menjadikannya lebih mudah untuk pengguna melakukan langkah yang diperlukan untuk menambah templat yang diberikan.
Sejarah
Data templat pada asalnya dibangunkan pada awal 2013 dengan VisualEditor dalam fikiran, yang berada dalam peringkat ujian MediaWiki pada masa itu.vv Editor visual ialah antara muka penyuntingan visual utama untuk wiki Wikimedia, dan data templat membolehkannya mempunyai antara muka yang lebih berguna apabila menambah templat. Ia disokong secara rasmi oleh editor visual segera. Apabila editor visual dilancarkan ke pelbagai wiki Wikimedia utama sebagai ciri lalai dari 2013 hingga 2016, data templat juga menjadi sebahagian daripadanya.
Pada Disember 2016, antara muka editor visual telah disediakan untuk mengedit kod sumber sebagai ciri beta. Ini dipanggil 2017 wikitext editor. Ini membawa ciri data templat kepada penyuntingan sumber buat kali pertama.
Pada Mac 2018, Sam Wilson membangunkan TemplateWizard, sambungan editor templat GUI untuk penyunting sumber Wikimedia lalai, WikiEditor (atau dikenali sebagai editor teks wiki 2010), direka bentuk untuk memudahkan proses menambah templat dengan menggunakan maklumat daripada data templat.v Pada April 2019, TemplateWizard telah dijadikan bahagian lalai editor teks wiki 2010 pada semua wiki Wikimedia. Ini bermakna data templat kini merupakan bahagian lalai bagi kedua-dua editor visual dan penyunting sumber di wiki Wikimedia.
Menambah atau menyunting TemplateData
Untuk menambah atau mengedit data templat, mula-mula navigasi ke halaman templat, yang terletak di "/Templat:Nama Templat".
Menyemak keadaan semasa
Sebelum menambah atau mengedit data templat, semak sama ada templat mempunyai subhalaman dokumentasi. Kemudian semak sama ada templat sudah mengandungi data templat dan, jika ya, sama ada ia terletak pada halaman templat atau subhalaman dokumentasi.
Subhalaman dokumentasi
Terdapat dua cara utama templat pada kebanyakan wiki Wikimedia menyimpan nota penggunaannya dan data lain yang tidak sepatutnya disertakan dalam templat sebenar itu sendiri, seperti kategori templat harus terkandung dalam:
- Sebilangan besar templat menyimpan nota penggunaan dan data lain yang bukan milik halaman templat itu sendiri pada subhalaman dokumentasi: "/Template:Templatename/doc". Pada halaman seperti ini, templat {{Documentation}} transcludes semua kandungan halaman /doc ke halaman templat, memastikan kod sumber templat lebih bersih.
- Pada templat dengan subhalaman dokumentasi, tajuk "
Dokumentasi templat" akan diikuti dengan pautan seperti [view], [edit], [history] dan [purge].
- Pada templat dengan subhalaman dokumentasi, tajuk "
- Beberapa halaman templat telah mengekalkan maklumat tersebut pada halaman utama templat. Anda boleh melihatnya di halaman ini dengan mencari kejadian
{{Documentation|content=antara teg<noinclude>.
Wiki yang berbeza mungkin menyampaikan semua ini secara berbeza.
Jarang sekali, halaman templat utama mungkin masih mengandungi dokumentasi walaupun anda telah menyemak semua perkara di atas;
di sini, pengguna akan menambah tajuk halaman /dokumen tersuai antara "{{Documentation|" dan "|content=" dan kemudian menambah kandungan selepas "|content=".
Anda juga boleh mencari notis di bahagian bawah halaman yang serupa dengan ini: "Dokumentasi di atas ditransklusikan daripada Templat:Templatename/doc".
Templat tanpa subhalaman dokumentasi
Jika templat tidak mempunyai subhalaman dokumentasi, buat dan alihkan dokumentasi templat ke sana (atau pemegang tempat untuknya). Kemudian anda boleh menambah data templat pada subhalaman dokumentasi.
Mencipta subhalaman dan memindahkan dokumentasi
Untuk membuat subhalaman dokumentasi, klik "Sunting"/"Sunting sumber" pada halaman templat utama; cari tag <noinclude> dan kandungan mereka (biasanya di bahagian bawah).
Ia sepatutnya kelihatan seperti ini:
<noinclude>
{{Documentation|content=
== Penggunaan ==
Maklumat tentang penggunaan.
== Contoh lain bagi tajuk ==
contoh lain kandungan
[[Kategori:Kategori contoh]]
[[Kategori:Contoh kategori 2]]
}}
</noinclude>
Anda juga mungkin mendapati ia sudah mengandungi data templat. Jika ya, ia akan kelihatan seperti ini:
<noinclude>
{{Documentation|content=
...
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "Contoh parameter",
"description": "Contoh uraian parameter",
"type": "string"
}
}
}
</templatedata>
</noinclude>
Pilih semua selepas "|content=" dan sebelum "</noinclude>" dan potong ke papan klip anda atau simpan ke dalam dokumen sementara. Hapus "|content=" dengan hanya meninggalkan yang berikut:
<noinclude>
{{Documentation}}
</noinclude>
Simpan halaman templat.
Sekarang, untuk mencipta subhalaman baharu, lihat bar alamat penyemak imbas anda dan tambahkan /doc pada penghujung URL. Klik ↵ Enter, kemudian pilih pilihan untuk membuat halaman baru.
Jika wiki ini mempunyai templat notis {{Documentation subpage}}, tambahkan di bahagian atas halaman baru. Anda juga mungkin ingin menambah templat lain, seperti pautan {{Purge button}} atau {{Purge}} (jika disokong oleh wiki berkenaan).
Masukkan teks yang anda potong atau simpan dalam teks sebelumnya (di bawah templat notis, jika berkenaan).
Balut mana-mana kategori dalam teg <includeonly> supaya ia digunakan hanya pada halaman utama templat:
<includeonly>
[[Category:Example category]]
[[Category:Example category 2]]
</includeonly>
Banyak wiki mempunyai templat {{Sandbox other}}.
Gunakan templat ini di sini jika kemungkinan templat yang anda edit wujud dalam versi kotak pasir (terletak di "Templat:Nama Templat/kotak pasir") untuk mengelakkan kategori daripada digunakan pada halaman kotak pasir:
<includeonly>{{sandbox other||
[[Category:Example category]]
[[Category:Example category 2]]
}}</includeonly>
Akhirnya, menerbitkan halaman.
Anda kini boleh menambah dan mengedit data templat pada subhalaman dokumentasi menggunakan arahan yang diterangkan dalam #Methods.
Menambah dan menyunting data templat pada halaman templat utama
Jika anda tidak boleh membuat halaman /doc, anda boleh menambah dan mengedit data templat pada halaman utama templat dengan mengikut arahan dalam #Methods.
Jika templat mempunyai subhalaman dokumentasi, semak kedua-dua halaman utama dan subhalaman dokumentasi untuk kehadiran data templat (teg <templatedata> diikuti dengan tatasusunan dalam kurungan kerinting: {}).
Sebagai alternatif, sambungan TemplateData boleh melakukan semakan ini untuk anda. Klik "Sunting" atau "Sunting sumber" pada mana-mana halaman. Jika templat sudah mempunyai data templat pada mana-mana halaman, anda akan melihat notis kuning di bahagian atas halaman yang menyatakan sama ada:
- Perhatian: terdapat sudah blok DataTemplat pada halaman berkaitan"Templat:Templatename/doc".
atau
- Perhatian: terdapat sudah blok DataTemplat pada halaman berkaitan"Templat:Templat nama".
Jika templat mempunyai data templat pada subhalaman dokumentasinya
Jika templat mempunyai data templat pada subhalaman dokumentasinya, ini ialah halaman yang perlu anda edit.
Anda boleh melakukan ini dengan mengklik "[edit]" yang terletak selepas tajuk ".svg){kind=icon}
Templat dokumentasi" (atau serupa), atau, jika anda sudah berada di halaman /doc, dengan mengklik "Sunting" atau "Sunting sumber" di bahagian atas.
Ikuti panduan di #Methods untuk menambah atau mengedit data templat.
Jika templat mempunyai data templat pada halaman utamanya
Jika templat mempunyai data templat pada halaman utamanya, anda sekali lagi mempunyai dua pilihan:
- Anda boleh sama ada beralih ke subhalaman dokumentasinya. Ini adalah pilihan pilihan.
- Atau, anda boleh mengeditnya pada halaman templat utama.
Mengalih data templat ke subhalaman dokumentasi
Untuk melakukan ini, klik "Sunting"/"Sunting sumber" pada halaman templat utama dan cari teg <templatedata>, yang disertakan dalam teg <noinclude>.
Ia sepatutnya kelihatan seperti ini:
<noinclude>
{{Documentation}}
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "Contoh parameter",
"description": "Contoh perihalan parameter",
"type": "string"
}
}
}
</templatedata>
</noinclude>
Potong hanya teg <templatedata> dan kandungannya daripada kod, kemudian simpan halaman tersebut.
Seterusnya, edit subhalaman dokumentasi dengan mengklik "[edit]" yang terletak selepas tajuk " Dokumentasi templat" (atau serupa).
Taipkan tajuk, seperti "Data templat", kemudian di bawahnya tampal data templat.
Anda kini boleh mengedit data templat berdasarkan panduan di #Methods.
Menambah dan menyunting data templat pada halaman templat utama
Jika anda tidak mahu mengalihkan data templat ke halaman /doc, anda boleh mengeditnya pada halaman templat utama. Lihat #Methods untuk cara mengedit data templat.
Jika templat belum mempunyai data templat tetapi mempunyai subhalaman dokumen
Jika templat belum mempunyai data templat, anda harus menambahkannya ke subhalaman dokumentasi.
Lakukan ini dengan mengklik "[edit]" yang terletak selepas tajuk " Templat dokumentasi" (atau serupa), atau, jika anda sudah berada di halaman /doc, dengan mengklik "Sunting" atau "Sunting sumber "di bahagian atas.
Taipkan tajuk, seperti "Data templat", kemudian tambahkannya di bawah tajuk ini.
Bahagian #Methods menerangkan cara menambah data templat.
Kaedah
Kaedah penyunting data templat
Ini ialah cara mudah untuk menambah atau mengedit data templat, disyorkan untuk pengguna yang kurang berpengalaman.
Editor data templat ialah antara muka pengguna grafik untuk menambah dan mengedit data templat. Ia adalah sebahagian daripada sambungan TemplateData, tersedia pada mana-mana halaman templat (atau subhalaman dokumentasi) dengan mengklik "Sunting" atau "Sunting sumber".
Selepas mengklik "Sunting" atau "Sunting sumber", anda akan melihat butang di atas kawasan penyuntingan dan tajuk halaman yang menyatakan "Sunting data templat".
Mengklik butang ini akan membawa anda ke editor data templat. Jika halaman yang anda lawati sudah mengandungi data templat, ia akan dipaparkan secara automatik di sini.
Ciri-ciri dalam tetingkap di atas:
- Item teratas memilih bahasa teks antara muka. Ia membolehkan anda memasukkan kandungan teks dalam berbilang bahasa, dipaparkan kepada pengguna berdasarkan tetapan mereka dalam Keutamaan, bukan berdasarkan bahasa wiki; wiki yang berbeza mempunyai pangkalan data templat yang sama sekali berbeza. Jika tiada data templat bahasa wujud, antara muka hanya akan menawarkan pengguna bahasa wiki sendiri, tetapi pengguna boleh mengklik "Tambah bahasa" untuk menambah lebih banyak input. Kod bahasa dipaparkan dalam kurungan bersebelahan dengan parameter yang boleh digunakan, seperti perihalan dan label.
- Item seterusnya ialah penerangan templat. Ini ialah perihalan templat secara keseluruhan; ia ditunjukkan kepada pengguna di banyak tempat dalam editor templat sambil menambah templat. parameter ini dan kesannya didokumenkan di bawah.
- Item ketiga mengawal pemformatan teks wiki templat. Parameter ini menentukan cara teks wiki akan dibentangkan apabila pengguna mengklik "Terapkan", dua jenis utama ialah
"inline"(pada satu baris) dan"block"(pada baris baharu). parameter ini dan kesannya didokumenkan di bawah.
- Jika pengguna memilih "Tersuai", mereka boleh memasukkan teks wiki di bawah "Rentetan format tersuai" mengikut Peraturan format tersuai yang didokumenkan di bawah, untuk mencipta reka letak tersuai untuk templat apabila pengguna mengklik "Terapkan".
- Item keempat mengkonfigurasi parameter templat. Jika parameter telah ditakrifkan dalam data templat, kawasan ini memaparkannya dalam senarai. Jika kod sumber templat menentukan parameter yang tiada data templat wujud, anda mungkin melihat butang berlabel "Tambah 2 parameter yang dicadangkan". Editor mengekstrak cadangan ini daripada kod sumber templat dengan mencari
{{{parametername}}}atau{{{parametername|}}}. Mengklik "Tambah 2 parameter yang dicadangkan" akan menambah parameter ini menggunakan nama mereka seperti yang ditakrifkan dalam kod sumber. Notis hijau juga akan muncul di bahagian atas, contohnya, "2 parameter baru diimport:nama parameter". - Di bahagian bawah tetingkap anda melihat butang "Tambah parameter". Ini membolehkan anda menambah parameter secara manual dengan nama tersuai.
Teruskan ke langkah seterusnya dengan mengklik mana-mana satu daripada parameter dalam senarai. Ini akan membolehkan anda mengedit maklumat parameter tersebut.
Semua ciri ini dan kesannya digariskan dalam bahagian #Within a parameter's name.
- Mengklik "Keluarkan maklumat parameter" akan memadamkan parameter dan semua maklumatnya daripada data templat. Anda tidak boleh mendapatkan semula atau membuat asal ini dalam data templat melainkan anda mengklik "X" selepas itu. Anda boleh membuat asal sebarang perubahan yang dibuat selepas mengklik "Terapkan" dengan menekan Ctrl+Z.
- Keluar daripada editor data templat selepas membuat perubahan menggesa anda untuk mengesahkan bahawa anda ingin membuang perubahan anda.
Apabila selesai, klik "Terapkan".
Ini secara automatik akan memasukkan data templat di bahagian bawah halaman sebelum teg </noinclude>; atau, jika sudah ada, ia akan dikemas kini dengan maklumat baharu tanpa mengubah kedudukannya.
Teks data templat juga akan dipilih apabila anda mengklik "Terapkan".
Editor data templat mencipta parameter "paramOrder" di bahagian bawah data templat (atau mengemas kininya jika sudah wujud).
"paramOrder" mengandungi parameter data templat semasa dalam susunan ia dipaparkan oleh editor data templat.
Anda boleh menukar "paramOrder" dengan menyeret parameter ke atas dan ke bawah dalam editor data templat menggunakan tiga bar mendatar di sebelah kiri.
"paramOrder" dan kesannya didokumenkan di bawah.
Selepas ini, klik "Simpan" untuk menyimpan semakan halaman anda.
Kaedah manual
Anda juga boleh menambah atau mengedit data templat secara manual.
Data templat ditulis dalam JSON, tetapi anda tidak perlu mempelajari JSON untuk mengetahui cara membuat data templat.
Data templat mengikut beberapa peraturan yang sangat mudah dan hanya menerima beberapa dozen kemungkinan parameter dan nilai yang dipratentukan, biasanya mengikut format "parameter": "value".
Menambah data templat secara manual
Pertimbangan:
- Jika anda menambah data templat pada subhalaman dokumentasi templat (disyorkan), anda boleh menambahkannya di mana-mana sahaja pada halaman; semak untuk melihat sama ada Wikipedia bahasa anda mempunyai lokasi pilihan untuknya. Sebagai contoh, pada Wikipedia Bahasa Inggeris, data templat lazimnya terletak berhampiran bahagian bawah halaman dokumentasi; di Wikipedia Jerman, ia biasanya berada di bahagian atas.
- Jika anda menambah data templat pada halaman utama templat (tidak disyorkan; lihat #Semakan sebelumnya), anda mesti pastikan untuk meletakkannya di dalam teg
<noinclude>...</noinclude>.
Klik "Sunting" atau "Sunting sumber" pada halaman masing-masing, kemudian beralih ke tempat dalam halaman yang anda ingin tambahkan data templat dan tulis tajuk: "Data templat".
Banyak wiki mempunyai templat {{TemplateData header}} yang menambah notis ringkas mengenai data templat. Jika wiki anda ada, tambahkannya selepas tajuk.
Untuk mula menambah data templat, taip teg pembukaan dan penutup <templatedata> dan sepasang kurungan kerinting pada baris baharu, dengan garis kosong di antaranya:
<templatedata>
{
}
</templatedata>
Seterusnya, tambahkan inden pada baris kosong antara dua kurungan kerinting dan mula menambah parameter. Butiran untuk parameter boleh didapati di #Templat data parameter. Kebanyakannya adalah pilihan; ada yang sangat disyorkan.
Parameter boleh dalam sebarang susunan, tetapi yang berikut ialah susunan yang paling sesuai dengan dokumentasi data templat dan menjadikan kandungan paling mudah digunakan untuk editor:
<templatedata>
{
"description": "",
"format": "",
"params": {
"parameter1": {
"aliases": ["",""]
"label": "",
"description": "",
"type": ""
}
},
"paramOrder": [
""
]
}
</templatedata>
Pastikan parameter, sebagai contoh, dalam objek "params", kekal di dalam objek itu; jika tidak, anda akan mencetuskan ralat "Sifat "propertyname" tidak dijangka." apabila anda cuba menyimpan.
Contoh
Berikut ialah beberapa contoh data templat untuk templat pembersihan hipotetikal. Templat seperti itu akan memaparkan notis dan meletakkan halaman ke dalam kategori ber tarikh berdasarkan bulan dan tahun yang dimasukkan. Pemberitahuan itu mungkin juga mengandungi pautan ke bahagian halaman perbincangan. Data templat akan kelihatan seperti ini:
<templatedata>
{
"description": "Gunakan templat ini untuk menunjukkan bahawa satu artikel memerlukan pembersihan.",
"format": "inline",
"params": {
"date": {
"label": "Bulan dan tahun",
"description": "Bulan dan tahun templat itu ditambahkan",
"type": "string",
"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
"example": "Januari 2013",
"suggested": true
},
"reason": {
"aliases": ["1"],
"label": "Sebab",
"description": "Sebab artikel itu memerlukan pembersihan",
"type": "string"
},
"talk": {
"aliases": ["seksyen perbualan"],
"label": "Seksyen halaman perbincangan",
"description": "Bahagian halaman perbincangan yang mengandungi perbincangan yang berkaitan",
"type": "string"
}
},
"paramOrder": [
"date",
"reason",
"talk"
]
}
</templatedata>
Dokumentasi data templat yang sepadan akan dipaparkan seperti berikut:
Gunakan templat ini untuk menunjukkan bahawa artikel memerlukan pembersihan.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Bulan dan tahun | tarikh | Bulan dan tahun templat itu ditambahkan
| String | suggested |
| Sebab | sebab 1 | Sebab artikel itu memerlukan pembersihan | String | optional |
| Seksyen halaman perbincangan | bincang seksyen perbualan | Bahagian halaman perbincangan yang mengandungi perbincangan yang berkaitan | String | optional |
Parameter TemplateData
All available template data parameters (i.e those between tags <templatedata>...</templatedata> of the wiki source) are listed below with a description and example.
They are also listed in more technical detail at Extension:TemplateData#Format.
- This information is current as of November 2021 and may change if new parameters are added or the template editing interfaces get updates to support existing parameters or treat certain parameters differently.
- Wiki markup will not work in descriptions or labels. They are strictly plain text strings.
- New lines ("
\n") in descriptions, labels, examples or defaults will not show in any of the main editors (TemplateWizard, the visual editor or the 2017 wikitext editor), even though they show in the auto-generated template data documentation. They are replaced by a null string in input forms and by a space elsewhere.
| Parameter | Description | Example |
|---|---|---|
| description |
The Effects On the template documentation page, the description will show in plain text below the "Template data for [template name]" subheading. In all main editors (VisualEditor, the 2017 wikitext editor and the Alat sunting wiki with TemplateWizard), the description shows in two main instances:
In the visual editor and 2017 wikitext editor, the description gets truncated to about 50 characters under each search suggestion, followed by a "...", but the whole description shows in the main template editor window. Both are shown in grey text. In the main template editor window, descriptions longer than four lines (about 540 characters) are provided a separate scrollbar, and they are shown in black text. If not specified If the description parameter does not exist or is not specified, the text "Tiada keterangan." will be displayed in the template data documentation below the "Template data for [template name]" subheading. Additionally:
|
"description": "A template for linking to a commons category",
|
| format |
The This parameter is not required, but it is recommended. The default behavior when this parameter is not provided is preserving the existing formatting for existing parameters, or inline formatting for newly added parameters and templates. Effects Inline: ( When inserted, the template will lay its wikitext out on a single line with no white space between elements, like so:
Block: ( When inserted, the template will distribute its parameters each on a new line, with single spaces between each element, like so: {{Foo
| bar = baz
| longparameter = quux
}}
Custom formatting: Alternatively, if the parameter is set to a custom string of wikitext, as per the rules listed at #Custom formats, the template will lay its wikitext out as per the given wikitext. |
"format": "inline"
|
| params |
The It should contain the name of each parameter followed by a set of template data sub-parameters listed in #Within a parameter's name. If there are multiple parameters, place a comma between each parameter object, but do not add one after the last curly bracket (see example). |
"params": {
"parameter1": {
... // parameter info
}, // comma here
"parameter2": {
... // parameter info
}, // and here
"parameter3": {
... // parameter info
} // but not here
}
|
| paramOrder |
The How to use Add the parameter The parameters need not be on new lines (they may be written as We recommend you place You must include every parameter mentioned in the template data; otherwise a "Sifat "propertyname" yang diperlukan tidak dijumpai." error will show. If not specified Without With other parameters In the 2010 wikitext editor with TemplateWizard:
In the visual editor and the 2017 wikitext editor, |
"paramOrder": [
"date",
"reason",
"talk"
]
|
Within params
| Parameter | Description | Example |
|---|---|---|
| Nama parameter |
The only first-level item of the For example, in a template's source code, You may also see parameters named
Note: a user can still force the use of How to use Each of these "Nama parameter" objects should contain all of the information about the parameter, in the form of more template data parameters. These are listed in the following section, Within a parameter's name. |
"1": { // name of the parameter
... // information about the parameter goes here
}
|
Within the parameter's name
| Parameter | Description | Example |
|---|---|---|
| aliases |
The optional
or
This means that if the user inserts either of these parameters with a value, they will perform the same function. Literally, it translates to, "Value of parameter1. If parameter1 doesn't exist or have a value: value of parameter2." In the second case, it also means, "If parameter2 doesn't exist or have a value: no value." To insert the |
"aliases": ["1", "talk", "talksection"],
|
| inherits |
To use this parameter, type |
"params": {
"topic1": {
"label": "Topic",
"description": "A topic mentioned on this disambiguation page",
"type": "string"
},
"topic2": {
"inherits": "topic1"
},
"topic3": {
"inherits": "topic1",
"label" : "A different label"
}
}
|
| label |
The |
"label": "Month and year",
|
| description |
Here, |
"description": "The month and year that the template was inserted",
|
| type |
See the #Type parameter section. |
|
| default |
Some template parameters have a default value; the value is used unless overridden by the user.
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), the With other parameters In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), if |
"default": "Category:CommonsRoot",
|
| autovalue |
A parameter can be assigned an This value can be overwritten by the user in the template editor. With other parameters In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), |
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
|
| example |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), this property is displayed below the parameter description (and below the With other parameters In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), |
"example": "January 2013",
|
| suggested values |
The parameter property
Other types (file, page, template, user, date, boolean, URL) are not currently supported because they have special functionalities in the visual editor already, such as autocomplete, which would interfere with the drop-down menu for suggested values in the visual editor. Editing template data as JSON in wikitext To add suggested values to any parameter type, add the new property "suggestedvalues" to the parameter in JSON. The “suggestedvalues” attribute must be a list of strings. Editing template data with the template data editor
Effects Once the values have been added to template data, the visual editor will display them in a combo box (a dropdown into which users can also enter a custom value) for the parameter types listed above. The user selects the desired value by clicking on it. If the list of values is long -- for example, a list of a country’s states -- the user can begin typing in the field, whereupon the list will be filtered to show only values containing the typed text. To change an entered value, the user must simply clear the field, and the full dropdown list will appear again. If the user needs a value not included in the list (for example, "message in a bottle") they can type it in manually. |
"suggestedvalues": [
"Journal",
"Book",
"Newspaper",
"Magazine"
]
|
| Status option | Description | Example |
|---|---|---|
| required |
The It determines whether filling in the given parameter is mandatory for the template. Effects This status has several effects in the visual editor and the 2017 wikitext editor:
In the Alat sunting wiki with Sambungan:TemplateWizard, as in the other editors, it displays the parameter automatically when a user inserts the template, but the parameter cannot be removed using this or any editor. It also does not display "Parameter diperlukan." in the parameter description; rather, it lists the parameter on the side under "Required parameters". Other than this, it generally behaves the same as in the other editors, except that the prompt says that the input doesn't "match the expected format". With other parameters In the visual editor and the 2017 wikitext editor, the |
"required": true
|
| suggested |
The Use Effects In the visual editor and the 2017 wikitext editor, it causes the parameter to automatically show up when a user inserts a template. If the parameter has an autovalue set, this will also automatically be in the parameter's input box. It has no other effect and doesn't show any additional text or warnings. In the Alat sunting wiki with TemplateWizard, it does not place the parameter in the template automatically but instead causes it to be listed on the side under "Suggested parameters". The user can then click a "+" next to the parameter to add it to the template. With other parameters The |
"suggested": true
|
| deprecated |
Finally, there is This is a status for parameters that should not be used any more but still exist for the time being. This could be because uses of the template are being moved from one set of parameters to another. Effects The effect of this parameter in the visual editor and the 2017 wikitext editor is that a grey exclamation mark shows next to the parameter's label when it is inserted, and in the parameter's information tooltip, the grey, italic text "Parameter telah dilupuskan. deprecation reason" is shown below the parameter description. It does not affect the functionality or usability of the parameter or show any additional warnings. Despite the fact that it can take a string, as of January 2020 none of the main editors (the visual editor, the 2017 wikitext editor or the 2010 wikitext editor) display the contents of the string anywhere to users.
Inputting a string has the same effect as In the 2010 wikitext editor with TemplateWizard, setting this value as With other parameters If you set both this and If you set both this and In the 2010 wikitext editor with TemplateWizard, |
"deprecated": "Please use 'publicationDate' instead."
|
Note: if neither "required", "suggested" nor "deprecated" are set as true for a parameter, its status will show as "optional" in the template data documentation.
Once you're done, hit "Simpan". If you've made errors, it will not let you save (which is disruptive but means you can't break anything). Should you run into errors, explain on the feedback page what you were trying to do, and we will be happy to help.
Note that if you are abusing a hack template to dynamically generate template data, it cannot be checked for errors before saving.
Note that each item of information is enclosed in quotation marks (except for true and false) and separated from the next item by a comma (unless it's the last one).
Type parameter
The "type" parameter is meant to signal to a template editor the nature of a parameter's value.
In some cases, template editors have been programmed to modify the user interface for a certain parameter according to this template data value, such as to only allow the user to enter valid values that match the specified type.
This parameter does not have any functional effect on the template parameter or its value; it merely controls how template editors see and treat the parameter in editing mode.
How to use
It is used by adding the "type" parameter, followed by a colon and a space, then adding any of the values listed in the table below in quotation marks.
Example:
"type": "string",
Effects
As of February 2020, only 5 of the 13 type values have visible effects in VisualEditor and the 2017 wikitext editor, while 8 have visible effects in TemplateWizard.
The effects of certain values are likely to change as the template editors get updates to support them. One such effort for VisualEditor and the 2017 wikitext editor is tracked in the Phabricator task T55613. A similar effort to get TemplateWizard to support the boolean value is tracked in T200664.
The currently known effects are listed as follows.
| Value | Description | |
|---|---|---|
| unknown |
The Effects In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| string |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| line |
The Effects
| |
| content |
The Effects
| |
| unbalanced-wikitext |
The Effects
| |
| wiki-page-name |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-file-name |
The Effects
| |
| wiki-template-name |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-user-name |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| number |
The Effects
With other parameters
| |
| boolean |
The Effects As of February 2020, none of the main Wikimedia editors (the visual editor, the 2017 wikitext editor or the 2010 wikitext editor with TemplateWizard) make use of this value. It has no visible effects. With the | |
| date |
The Effects
With other parameters
| |
| url |
The Effects
required" setting, but it does not warn the user if they attempt to insert the template without a valid URL. It also occurs with any status setting (such as "suggested"" or "deprecated").
With other parameters
| |
Custom formats
When editing the "format" value, you create custom formats by inputting a set of wikitext symbols using some predefined rules.
{{- start of the template_- content (e.g., string, integer or parameter). This underscore serves to indicate the minimum length of a value in characters and can be repeated, like_______. If this length is not reached, it fills the remaining characters with spaces. This can be used to align all equals signs to a specific position after a parameter (if used with\nfor new lines).|- pipe (separates parameters)=- equals sign (precedes the value of a parameter)\nor pressing the enter key - new line (this will display as↵in the entry field)\nto indent new lines)}}- end of the template
The wikitext should at least meet the minimum of {{_|_=_}}, otherwise there will be an invalid format string error.
| Objective | Format string | Output |
|---|---|---|
| Inline formatting | {{_|_=_}} inline
|
{{Foo|bar=baz|longparameter=quux}}{{Bar}}
|
| Block formatting | {{_\n| _ = _\n}} block
|
{{Foo
| bar = baz
| longparameter = quux
}}{{Bar}}
|
| No space before the parameter name, each template on its own line | \n{{_\n|_ = _\n}}\n
|
{{Foo
|bar = baz
|longparameter = quux
}}
{{Bar}}
|
| Indent each parameter | {{_\n |_ = _\n}}
|
{{Foo
|bar = baz
|longparameter = quux
}}{{Bar}}
|
| Align all parameter names to a given length | {{_\n|_______________ = _\n}}\n |
{{Foo
|bar = baz
|longparameter = quux
|veryverylongparameter = bat
}}
{{Bar}}
|
| Pipe characters at the end of the previous line | {{_|\n _______________ = _}}
|
{{Foo|
bar = baz|
longparameter = quux}}{{Bar}}
|
| Inline style with more spaces, must be at start of line | \n{{_ | _ = _}}
|
{{Foo | bar = baz | longparameter = quux}}
{{Bar }}
|
| Template at the start of a line, indent-aligned parameters, pipe beforehand | \n{{_ |\n _______________ = _}}
|
{{Foo |
bar = baz |
longparameter = quux}}
{{Bar}}
|
Blank boilerplate
You can copy the blank boilerplate below to add new template data to a template. Only the most common tags are included.
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "",
"description": "",
"type": ""
},
"2": {
"label": "",
"description": "",
"type": ""
}
}
}
</templatedata>
Errors
Ralat sintaks dalam JSON. / Bad JSON format
These errors occur when saving template data, usually manually edited, with invalid JSON code (duplicate keys/parameters, trailing or missing commas, etc.) in the visual editor or the 2017 wikitext editor.
"Ralat sintaks dalam JSON." appears in the visual editor and the 2017 wikitext editor; "Bad JSON format" appears when editing in the template data GUI editor.
These errors can be difficult to detect and come in too many forms to list. The best way to avoid them is to edit template data exclusively with the template data editor; the best way to detect them once they've occurred is to use an external JSON validator, such as JSONLint, which will highlight errors and aid in fixing them.
The 2010 wikitext editor does not check for invalid JSON thanks to an old, unfixed bug (task T128029). Pages that contain invalid JSON may throw alarming "Ralat dalaman" messages. To fix these errors, your best bet is to use a JSON validator (see above).
Sifat "paramOrder[number]" yang diperlukan tidak dijumpai.
This error occurs if you state a parameter in "params" that is not stated in "paramOrder".
The number in the square brackets refers to the parameter in "paramOrder" that is missing. It refers to its order in the sequence, but it is one less than its actual position, since "paramOrder" is an array; 0 is the first one, 1 is the second, etc.
"params": {
"date": { ...
},
"reason": { ...
},
"talk": { ... // <-- This parameter is not stated in "paramOrder", but it should be.
}
},
"paramOrder": [
"date",
"reason"
]
// Error: Required property "paramOrder[2]" not found.
To fix this, make sure all parameters stated in "params" are listed in "paramOrder".
Alternatively, you can remove the "paramOrder" object to remove this error.
Nilai tidak sah untuk sifat "paramOrder[number]".
This error occurs if you state a parameter in "paramOrder" that is not stated in "params".
The number in the square brackets refers to the parameter in "paramOrder" that shouldn't be there. It refers to its order in the sequence, but it is one less than its actual position, since "paramOrder" is an array; 0 is the first one, 1 is the second, etc.
"params": {
"date": { ...
},
"talk": { ...
}
},
"paramOrder": [
"date",
"reason", // <-- This parameter is not stated in "params", but it should be.
"talk"
]
// Error: Invalid value for property "paramOrder[1]".
To fix this, make sure all parameters stated in "paramOrder" are listed in "params".
Alternatively, you can remove the "paramOrder" object to remove this error.
Sifat "params.parametername.required" dijangka jenis "boolean".
"suggested": "true" // <-- These quotation marks shouldn't be here.
These are boolean values, not strings, therefore they require no quotation marks.
To fix this, remove any quotation marks around the values true or false for these parameters.
Property "format" is expected to be ...
If the "format" parameter exists but its value is not "inline", "block" or a valid format string, you will see the error message "Property "format" dijangka "inline", "block", atau rentetan format yang sah.".
"format": "notinline"
// Error : Property "format" is expected to be "inline", "block", or a valid format string.
To fix this, make sure the value after "format": equals "inline" or "block" and that there no spelling mistakes. Alternatively, if it's wikitext, make sure it contains a minimum of {{_|_=_}} and that there are no mistakes in the syntax that would normally cause a template to fail, such as duplicate equals signs or missing/duplicate curly brackets; see the section #Custom formats for the syntax for custom formats.
Alternatively, you can remove the "format" parameter to remove this error.
Sifat "parametername" tidak dijangka.
This error occurs if you state a parameter that is unknown in template data. This is probably due to spelling mistakes or the use of uppercase letters instead of lowercase.
<templatedata>
{
"description": "",
"format": "inline",
"params": {
"1": {
"label": "",
"descriptino": "", // <-- spelling mistake
"type": ""
}
}
}
</templatedata>
It also occurs if you state a parameter in any template data object that is not a parameter of that object. This may be due to spelling mistakes, or you may have written the parameter of one template data object under another object that it doesn't belong to.
For example, you might have written the parameter "label" under the root template data object instead of inside "params":
<templatedata>
{
"description": "",
"format": "inline",
"label": "", // <-- incorrectly placed parameter
"params": {
"1": { // ↓ it should be in here
"description": "",
"type": ""
}
}
}
</templatedata>
Alternatively, if the unexpected parameter is under a template parameter inside "params", you'll see its name after "params.parametername." in the error.
To fix this, make sure there aren't any spelling mistakes in the parameter names, and make sure your parameters are in their correct location. Additionally, make sure you don't state any parameters that don't exist for a template data object. You can check which parameters exist for an object in the section #Template data parameters.
Sifat "params" yang diperlukan tidak dijumpai.
This error occurs if there is no "params" object in the template data.
This is a necessary object, as it contains all the details of each parameter, so to fix this error, make sure it's added and that there are no spelling mistakes.
See the section above on how to add the "params" parameter.
Limitations and feedback
- Missing features – Template data is an example of a tool that was made available with few features, in hope that users would help to guide development of features that they desired. If you'd like to request new features for template data, please let us know.
- Delays in showing in templates – After adding template data to a template, the metadata should be visible immediately when the template is opened in the visual editor. However, it is possible that it will take several hours before the metadata will show. You can force an update by making a null edit to the template page itself (not the documentation subpage). To perform a null edit, open the template page for editing, and save the page without making any change and without adding any edit summary.
- Current issues – A list of current bugs and feature requests is available in the Wikimedia bug tracker.
Other tools
- Bantuan:Sambungan:TemplateWizard
- A toolbar dialog window for entering template wikitext via an form built from template data.
- TemplateData Wizard
- A tool that generates template data through an interactive interface.
- Skeleton TemplateData generator
- A tool that reads the source wikicode of a template, tries to find all the parameters used and outputs a skeleton document with the parameters listed.
- JSONLint
- A tool that allows you to validate manually-written JSON to help find errors in the syntax.
- List of all templates with template data on this wiki
- With dewiki template template data: template data is shown in a box, and the template is added to a category of templates with template data
- https://query.wikidata.org/ and Query Helper