Bantuan:DataTemplat

From mediawiki.org
This page is a translated version of the page Help:TemplateData and the translation is 30% complete.
PD Catatan: Ketika anda menyunting halaman ini, anda setuju untuk memberi izin kontribusi anda tunduk di bawah CC0. Lihat Situs Bantuan Domain Publik untuk informasi lebih lanjut.
PD

TemplateData adalah ekstensi yang menyimpan informasi dan parameter yang terkait dengan suatu templat teks wiki dan menyediakannya kepada antarmuka penyunting yang dapat mengambil dan menampilkan informasi ini dalam penyunting templat mereka. Semua hal tersebut akan mempermudah bagi para pengguna untuk menambahkan dan menyunting templat di halaman.

Per April 2019, fungsionalitas TemplateData merupakan bagian dari pengalaman pengguna standar bagi semua pengguna di semua wiki Wikimedia ketika mereka menambahkan sebuah templat, bahkan bagi pengguna tidak terdaftar. Baik penyunting sumber maupun visual menggunakannya dalam suatu bentuk. Begitu pula banyak skrip, peralatan, dan perkakas. Jika Anda menginginkan fungsionalitas ini di wiki Anda sendiri, pasanglah Extension:TemplateData .

Adding TemplateData to a template for this extension to use involves inserting a small, simple block of JSON (explained below) into the template's documentation page. You can do this manually or with the TemplateData editor, a graphical user interface you can access on a template's "Sunting"/"Sunting sumber" pages on wikis with the TemplateData extension installed. The JSON contains a list of the template's parameters and information about those parameters and about the template as a whole (see below for details).

Templates that contain TemplateData will display this information in the user interface when a user adds the template. In some cases, it will change how the editor behaves when you use it to edit or insert a given template, making it much easier for users to perform the steps needed to add a given template.

TemplateData was originally developed in early 2013 with VisualEditor in mind, which was in MediaWiki testing stages at the time. VisualEditor is the main visual editing interface for Wikimedia wikis, and TemplateData allowed it to have a more useful interface when adding templates. It was officially supported by VisualEditor immediately. As VisualEditor was rolled out to the various major Wikimedia wikis as a default feature from 2013 through 2016, TemplateData became a part of them as well.

In December 2016, the VisualEditor interface was made available for editing source code as a beta feature. This was termed the Penyunting teks wiki 2017 . This brought the features of TemplateData to source editing for the first time.

In March 2018, Sam Wilson developed TemplateWizard , a GUI template editor extension for the default Wikimedia source editor, WikiEditor (otherwise known as the 2010 wikitext editor), designed to make the process of adding templates easier by using information from TemplateData. In April 2019, TemplateWizard was made a default part of the 2010 wikitext editor on all Wikimedia wikis. This meant that TemplateData was now a default part of both the visual editor and the source editor on Wikimedia wikis.

Adding or editing TemplateData

To add or edit TemplateData, first navigate to a template's page, located at "/Template:Templatename".

Checking the current state

Before adding or editing TemplateData, check whether the template has a documentation subpage. Then check whether the template already contains TemplateData and, if so, whether it's located on the template page or the documentation subpage.

Be sure to check whether a subpage exists. If you add TemplateData to a template's main page while a subpage exists with TemplateData, the TemplateData in the main page will override the data on the subpage.

Documentation subpages

There are two main ways templates on most Wikimedia wikis store their usage notes and other data that shouldn't be included in the actual template itself, like categories the template should be contained in:

  • The vast majority of templates keep usage notes and other data that doesn't belong on the template page itself on a documentation subpage: "/Template:Templatename/doc".

On pages like this, the {{Documentation}} template transcludes all the /doc page's content onto the template page, keeping the template's source code much cleaner.

    • On templates with documentation subpages, the "Test Template Info-Icon - Version (2).svg Template documentation" heading will be followed by links such as [view], [edit], [history] and [purge].
  • A few template pages have retained that information on the template's main page.

You can spot it on these pages by looking for an occurrence of {{Documentation|content= between ‎<noinclude> tags.

Different wikis may present all this differently. Rarely, main template pages may still contain documentation even when you've checked all of the foregoing; here, a user will have added a custom /doc page title between "{{Documentation|" and "|content=" and then added content after "|content=".

You can also look for a notice at the bottom of the page similar to this: "The above documentation is transcluded from Template:Templatename/doc".

Templates without documentation subpages

If a template doesn't have a documentation subpage, create it and move the template's documentation there (or a placeholder for it). Then you can add TemplateData to the documentation subpage.

Creating the subpage and moving the documentation
On many Wikimedia wikis, you can only create a page if you have been a registered user there for a number of days and have made a minimum number of edits.

To create the documentation subpage, click "Sunting"/"Sunting sumber" on the main template page; look for the ‎<noinclude> tags and their contents (usually at the bottom).

It should look something like this:

<noinclude>
{{Documentation|content=
== Usage ==

Information about usage.

== More example headings ==

More example contents

[[Category:Example category]]
[[Category:Example category 2]]
}}
</noinclude>

You may also find that it already contains TemplateData. If so, it will look something like this:

<noinclude>
{{Documentation|content=
...
<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "Example parameter",
            "description": "Example parameter description",
            "type": "string"
        }
    }
}
</templatedata>
</noinclude>

Select everything after "|content=" and before "‎</noinclude>" and cut it into your clipboard or save it in a temporary document. Delete "|content=", leaving only the following:

<noinclude>
{{Documentation}}
</noinclude>

Save the template page.

Now, to create the new subpage, look at your browser's address bar and add /doc to the end of the URL. Press ↵ Enter, then choose the option to create a new page.

If this wiki has a {{Documentation subpage}} notice template, add it at the top of the new page. You may also wish to add other templates, such as a {{Purge button}} or {{Purge}} link (if supported by the wiki in question). See m:Help:Template documentation for more info.

Insert the text you cut or saved in the previous text (beneath the notice template, if applicable).

Wrap any categories in ‎<includeonly> tags so that they apply only to the template's main page:

<includeonly>
[[Category:Example category]]
[[Category:Example category 2]]
</includeonly>

Many wikis have a {{Sandbox other}} template. Use this template here if it's likely that the template you're editing exists in a sandbox version (located at "Template:Templatename/sandbox") in order to prevent the categories from applying to the sandbox page:

<includeonly>{{sandbox other||
[[Category:Example category]]
[[Category:Example category 2]]
}}</includeonly>

Finally, publish the page.

You can now add and edit the TemplateData on the documentation subpage using the instructions described in #Methods.

Adding and editing TemplateData on the main template page

If you can't create the /doc page, you can add and edit TemplateData on the template's main page by following the instructions in #Methods.

If a template has a documentation subpage, check both the main page and the documentation subpage for the presence of TemplateData (the ‎<templatedata> tag followed by an array inside curly brackets: {}).

Alternatively, the TemplateData extension can perform this check for you. Click "Sunting" or "Sunting sumber" on either page. If the template already has TemplateData on either page, you will see a yellow notice at the top of the page saying either:

Perhatian: sudah terdapat sebuah blok DataTemplat pada halaman terkait "[[Template:Templatename/doc]]".

or

Perhatian: sudah terdapat sebuah blok DataTemplat pada halaman terkait "[[Template:Templatename]]".

If the template has TemplateData on its documentation subpage

If the template has TemplateData on its documentation subpage, this is the page you should edit. You can do this by clicking the "[edit]" located after the heading "Test Template Info-Icon - Version (2).svg Template documentation" (or similar), or, if you are already on the /doc page, by clicking "Sunting" or "Sunting sumber" at the top. Follow the guidance at #Methods to add or edit the TemplateData.

If the template has TemplateData on its main page

If the template has TemplateData on its main page, you once again have two options:

  • You can either move to its documentation subpage. This is the preferred option.
  • Or, you can edit it on the main template page.

Moving TemplateData to the documentation subpage

To do this, click "Sunting"/"Sunting sumber" on the main template page, and look for the ‎<templatedata> tags, enclosed within ‎<noinclude> tags. It should look something like this:

<noinclude>
{{Documentation}}
<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "Example parameter",
            "description": "Example parameter description",
            "type": "string"
        }
    }
}
</templatedata>
</noinclude>

Cut only the ‎<templatedata> tags and their contents out of the code, then save the page.

Next, edit the documentation subpage by clicking the "[edit]" located after the heading "Test Template Info-Icon - Version (2).svg Template documentation" (or similar).

Type a heading, like "TemplateData", then beneath it paste the TemplateData.

You can now edit the TemplateData based on the guidance at #Methods.

Editing TemplateData on the main template page

If you do not wish to move the TemplateData to the /doc page, you can edit it on the main template page. See #Methods for how to edit TemplateData.

If the template does not yet have TemplateData but has a doc subpage

If the template does not yet have TemplateData, you should add it to the documentation subpage.

Do this by clicking the "[edit]" located after the heading "Test Template Info-Icon - Version (2).svg Template documentation" (or similar), or, if you are already on the /doc page, by clicking "Sunting" or "Sunting sumber" at the top. Type a heading, like "TemplateData", then add it beneath this heading. The section #Methods explains how to add TemplateData.

Methods

Metode penyunting TemplateData

Ini adalah cara yang lebih sederhana untuk menambahkan atau mengubah TemplateData, bisa dilakukan oleh pengguna kurang berpengalaman.

Penyunting TemplateData merupakan sebuah antarmuka pengguna grafis untuk menambahkan dan mengubah TemplateData. Penyunting ini merupakan bagian dari ekstensi TemplateData yang bisa diakses dengan membuka halaman templat tersebut atau subhalaman dokumentasinya lalu menekan tombol "Sunting" atau "Sunting sumber".

Setelah menekan "Sunting" atau "Sunting sumber", Anda akan melihat sebuah tombol di atas area penyuntingan dan judul halaman yang mengatakan "Kelola DataTemplat".

Manage template documentation button for TemplateData 2014.png

Menekan tombol ini akan membawa Anda ke penyunting TemplateData. Penyunting ini memungkinkan Anda untuk menambahkan parameter templat dan mengatur atribut yang paling umum. Jika halaman yang Anda sunting sudah mengandung blok DataTemplat, maka informasi yang sudah didokumentasikan akan secara otomatis muncul saat Anda membuka halaman yang benar di penyunting DataTemplat.

Tangkapan layar perkakas penyuntingan DataTemplat.

Features in the above window:

  • The top item chooses the language of the interface text. It allows you to enter text content in multiple languages, displayed to users based on their settings in Preferences, not based on the wiki's language; different wikis have entirely different template databases. If no language TemplateData exists, the interface will only offer users the wiki's own language, but users can click "Tambah bahasa" to add more inputs. The language code is displayed in brackets next to the parameters to which it can be applied, such as descriptions and labels.
  • The next item is the template description. This is the description of the template as a whole; it's shown to users in numerous places in the template editors while adding a template. This parameter and its effects are outlined here.
  • The third item controls the wikitext formatting of the template. This parameter determines how the wikitext will be laid out when the user clicks "Terapkan", the two main types being "inline" (on one line) and "block" (on new lines). This parameter and its effects are outlined here.
If the user chooses "Ubahsuai", they can enter wikitext under "Teks format ubahsuai" according to rules outlined here, in order to create a custom layout for the template when the user clicks "Terapkan".
  • The fourth item configures a template's parameters. If parameters have already been defined in TemplateData, this area displays them in a list. If the template's source code specifies parameters for which no TemplateData exists, you may see a button labeled "Tambahkan 2 parameter yang disarankan". The editor extracts these suggestions from the template's source code by looking for {{{parametername}}} or {{{parametername|}}}. Clicking "Tambahkan 2 parameter yang disarankan" will add these parameters using their names as defined in the source code. A green notice will also appear at the top, for example, "2 parameter baru telah diimpor: names of parameters.".
  • At the bottom of the window you see an "Tambah parameter" button. This allows you to add a parameter manually with a custom name.

Continue to the next step by clicking any one of the parameters in the list. This will allow you to edit that parameter's info.

Tangkapan layar dari penyunting DataTemplat yang menampilkan sebuah parameter kedua yang sedang ditambahkan

All of these features and their effects are outlined in the section #Within a parameter's name.

  • The TemplateData editor will not allow you to change a parameter to a blank "Nama". Parameters in TemplateData that somehow acquire blank strings as names will not cause issues in the 2010 wikitext editor with TemplateWizard, but neither VisualEditor nor the 2017 wikitext editor will display them at all. This is the only mandatory field in the TemplateData editor.
  • Clicking "Hapus informasi parameter" will delete the parameter and all its information from the TemplateData. You can't retrieve or undo this in the TemplateData unless you click "X" afterwards. You can undo any changes made after clicking "Terapkan" by hitting Ctrl+Z.
  • Exiting the TemplateData editor after making changes prompts you to confirm that you want to discard your changes.

When finished, click "Hapus informasi parameter". This will automatically insert the TemplateData at the bottom of the page before the ‎</noinclude> tag; or, if already present, it will be updated with the new information without changing its position. The TemplateData text will also be selected when you click "Hapus informasi parameter".

The TemplateData editor creates a "paramOrder" parameter at the bottom of the TemplateData (or updates it if it already exists). "paramOrder" contains the current TemplateData parameters in the order in which they were displayed by the TemplateData editor. You can change the "paramOrder" by dragging the parameters up and down in the TemplateData editor using the three horizontal bars on the left. "paramOrder" and its effects are described here.

After this, click "Simpan" to save your revision of the page.

Manual method

You can also add or edit TemplateData manually. Struktur DataTemplat kurang lebih berlandaskan pada standar JSON. JSON Harap perhatikan, semua deskripsi dalam DataTemplat harus berupa teks biasa tanpa teks wiki, tanpa tautan, dsb. TemplateData follows a few very simple rules and accepts only a few dozen possible predefined parameters and values, typically following a "parameter": "value" format.

Adding TemplateData manually

Considerations:

  • If you're adding TemplateData on a template's documentation subpage (recommended), you may add it anywhere on the page; check to see if your language's Wikipedia has a preferred location for it. For example, on the English Wikipedia, TemplateData is typically near the bottom of the documentation page; on the German Wikipedia, it is typically at the top.
  • If you're adding TemplateData on a template's main page (not recommended; see #Prior checks), you must make sure to place it inside the ‎<noinclude>...‎</noinclude> tags.

Click "Sunting" or "Sunting sumber" on the respective page, then move to the place in the page where you intend to add TemplateData and write a heading: "TemplateData".

Many wikis have a {{TemplateData header}} template that adds a short notice regarding TemplateData. If your wiki does, add it after the heading.

To start adding TemplateData, type an opening and closing ‎<templatedata> tag and a pair of curly brackets on new lines, with an empty line between them:

<templatedata>
{

}
</templatedata>

Next, add an indent on the empty line between the two curly brackets, and start adding parameters. Details for the parameters can be found at #TemplateData parameters. Most are optional; some are highly recommended.

Parameters can be in any order, but what follows is the order that best conforms to TemplateData documentation and makes the content easiest to use for editors:

<templatedata>
{
    "description": "",
    "format": "",
    "params": {
        "parameter1": {
            "aliases": ["",""]
            "label": "",
            "description": "",
            "type": ""
        }
    },
    "paramOrder": [
    	""
    ]
}
</templatedata>

Make sure the parameters, for example, in the "params" object, remain inside that object; otherwise you will trigger an "Properti "properlyname" tidak diharapkan." error when you try to save.

Contoh

Here is some example TemplateData for a hypothetical cleanup template. Such a template would display a notice and place the page into a dated category based on the month and year entered. The notice might also contain a link to a talk page section. The TemplateData would look something like this:

<templatedata>
{
	"description": "Use this template to indicate that an article is in need of cleanup.",
	"format": "inline",
	"params": {
		"date": {
			"label": "Month and year",
			"description": "The month and year that the template was added",
			"type": "string",
			"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
			"example": "January 2013",
			"suggested": true
		},
		"reason": {
			"aliases": ["1"],
			"label": "Reason",
			"description": "The reason the article is in need of cleanup",
			"type": "string"
		},
		"talk": {
			"aliases": ["talksection"],
			"label": "Talk page section",
			"description": "The section of the talk page containing relevant discussion",
			"type": "string"
		}
	},
	"paramOrder": [
		"date",
		"reason",
        "talk"
	]
}
</templatedata>

The corresponding TemplateData documentation would display as follows:

Use this template to indicate that an article is in need of cleanup.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Month and yeardate

The month and year that the template was added

Example
January 2013
Auto value
{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}
Stringsuggested
Reasonreason 1

The reason the article is in need of cleanup

Stringoptional
Talk page sectiontalk talksection

The section of the talk page containing relevant discussion

Stringoptional

Parameter TemplateData

Semua parameter TemplateData yang tersedia didaftarkan di bawah beserta sebuah keterangan dan contoh. Mereka juga didaftarkan secara lebih teknis di Ekstensi:TemplateData#Format.

  • Informasi ini terkini pada November 2021 dan mungkin berubah apabila parameter baru ditambahkan atau antarmuka penyuntingan templat diperbarui untuk mendukung parameter yang ada atau memperlakukan parameter tertentu dengan cara yang berbeda.
  • Markah wiki tidak bekerja di deskripsi atau label. Mereka hanyalah string teks polos.
  • New lines ("\n") in descriptions, labels, examples or defaults will not show in any of the main editors (TemplateWizard, VisualEditor or the 2017 wikitext editor), even though they show in the auto-generated TemplateData documentation. They are replaced by a null string in input forms and by a space elsewhere.
Parameter Deskripsi Contoh
description

Parameter "description" menjelaskan apa yang dilakukan templat tersebut. Sifatnya opsional tetapi sangat disarankan.

Efek

Di halaman dokumentasi templat, deskripsi akan ditampilkan sebagai teks polos di bawah subjudul "Data templat untuk [nama templat]".

Di semua penyunting utama (VisualEditor , Penyunting teks wiki 2017 dan Perpanjangan:WikiEditor dengan TemplateWizard), deskripsi ditampilkan dalam dua kasus utama:

  • di bawah nama templat di setiap saran pencarian ketika pengguna sedang mencari sebuah templat
  • di bawah nama templat di penyunting templat, ketika mereka menambahkan nilai ke parameter di templat.

Di VisualEditor dan penyunting teks wiki 2017, deskripsinya terpotong setelah 50 karakter di bawah setiap saran penyuntingan, diikuti oleh sebuah "...", dan seluruh deskripsinya ditampilkan di jendela penyunting templat utama. Keduanya ditampilkan sebagai teks abu-abu.

Dalam jendela penyunting templat utama, deskripsi yang lebih panjang dari empat baris (kira-kira 540 karakter) disediakan sebuah bilah geser terpisah, dan mereka ditampilkan sebagai teks hitam.

Jika tidak ditetapkan

Jika parameter deskripsinya tidak ada atau tidak ditetapkan, teks "Tidak ada keterangan." akan ditampilkan di dokumentasi TemplateData di bawah subjudul "Data templat untuk [nama templat]". Selain itu:

  • di VisualEditor dan penyunting teks wiki 2017, templat akan bertingkah seperti templat yang tidak punya TemplateData; bukannya sebuah deskripsi, teks berikut akan ditampilkan:
"The "Template:Templatename" template doesn't yet have a description, but there might be some information on the template's page."
  • di penyunting teks wiki 2010 dengan TemplateWizard, teks berikut akan ditampilkan di mana deskripsinya harusnya berada (tetapi tidak di saran pencarian):
"Tidak ada deskripsi untuk templat ini."
Ini berbeda dengan dua deskripsi pengganti standar ketika TemplateData tidak ada:
  • "Due to missing TemplateData, parameters for this template have been auto-generated. Please be aware that they may not be accurate."
  • "No parameters could be determined for this template due to absence of TemplateData documentation. You may insert the template without parameters."
"description": "Sebuah templat untuk membuat pranala ke kategori Commons",
format

Parameter "format" menjelaskan cara penataan teks wiki dari templat. Ini dapat diatur ke pemformatan standar seperti "inline" dan "block", atau pengguna bisa memasukkan sekumpulan simbol teks wiki untuk membuat sebuah format ubah suaian; simbol-simbol ini beserta beberapa contoh didaftarkan di bagian #Format ubah suaian.

Parameter ini tidak diharuskan, tetapi disarankan. Perilaku standar ketika parameter ini tidak ada adalah pemformatan dalam baris dan tidak ada pemberitahuan yang bersesuaian yang ditampilkan di dokumentasi TemplateData di bawah judul tabel.

Efek

Dalam baris:

Jika parameter diatur ke "inline", maka templat akan menampilkan pemberitahuan yang sesuai mengenai preferensinya dalam dokumentasi TemplateData, di bawah judul tabel, "Parameter templat":

{{int|quotation-marks|[<translate>circles and pipes icon</translate>] {{int|templatedata-doc-format-inline}}}}

Ketika dimasukkan, templat akan menuliskan teks wikinya di satu baris tanpa ruang putih antar elemennya, seperti:

{{Foo|bar=baz|qux=quux}}

Blok:

Jika parameter diatur ke "block", templat akan menampilkan pemberitahuan preferensi berikut di dokumentasi TemplateData-nya:

{{int|quotation-marks|[<translate>stacked blocks and pipes icon</translate>] [[int|templatedata-doc-format-block}}}}

Ketika dimasukkan, templat akan membagi parameter-parameternya di garis baru dengan satu spasi di antara elemen-elemen, seperti:

{{Foo
| bar = baz
| qux = quux
}}

Format ubah suaian:

Selain itu, jika parameter diatur menjadi sebuah string teks wiki buatan sendiri, sesuai aturan yang didaftarkan di #Format ubah suaian, templat akan menampilkan pemberitahuan preferensi berikut di dokumentasi TemplateDatanya.

"[<translate>cogwheel icon</translate>] {{int|templatedata-doc-format-custom}}"

Ketika dimasukkan, templat akan menuliskan teks wikinya sebagaimana teks wikinya dimasukkan.

"format": "inline"
params

Objek "params" berisi informasi untuk masing-masing parameter templat. Ini diharuskan, dan parameter-parameternya bisa dilihat di bagian #Di dalam params.

Parameter ini seharusnya berisi nama setiap parameter diikuti dengan sekumpulan subparameter TemplateData yang didaftarkan di #Di dalam nama parameter.

Jika terdapat beberapa parameter, letakkan tanda koma di antara masing-masing paramter objek, tetapi jangan tambahkan setelah tanda kurung kurawal penutup (lihat contoh).

"params": {
    "parameter1": {
        ...    // info parameter
    },      // di sini tanda koma
    "parameter2": {
        ...    // info parameter
    },      // dan di sini
    "parameter3": {
        ...    // info parameter
    }       // tetapi tidak di sini
}
paramOrder

Objek "paramOrder" adalah objek opsional yang bisa memaksa parameter-parameter templat ditampilkan dalam urutan tertentu ketika ditambahkan di penyunting templat.

Cara menggunakan

Tambahkan parameter "paramOrder", diikuti dengan sebuah tanda titik dua, spasi dan tanda kurung siku terbuka, lalu ketik nama setiap parameter templat dalam tanda kutip ganda (") dengan urutan yang diinginkan, dipisahkan oleh tanda koma. Kemudian, akhiri dengan tanda kurung siku terbuka.

Parameter tidak harus diletakkan di baris baru (mereka bisa berbentuk "paramOrder": ["param1","param2","param3"]), tetapi meletakkan mereka di baris baru bisa membuatnya lebih mudah dibaca.

Kami menyarankan agar Anda meletakkan "paramOrder" setelah "params", seperti yang dilakukan penyunting TemplateData; ini tidak ditampilkan di dokumentasi TemplateData tetapi hanya memaksakan urutan parameter. Penyunting di masa mendatang mungkin ingin melihat rincian parameter secara singkat dan menyuntingnya tanpa melewati "paramOrder", khususnya apabila terdapat banyak parameter. Jika Anda memilih untuk meletakkamnya di tempat selain TemplateData, Anda perlu memasuktikan ada dda

Anda harus mencantumkan semua parameter yang disebutkan di TemplateData; jika tidak maka galat "Properti "properlyname" yang wajib diisi tidak ditemukan. akan muncul.

Jika tidak ditetapkan

Jika "paramOrder" tidak ada atau tidak ditetapkan, parameter templat akan ditampilkan dalam urutan di mana mereka dideklarasikan di kode sumber templat. Jika kode sumber mengandung objek di dalam objek, parameter di dalam objek luar akan didahulukan, setelah itu baru objek dalam.

Dengan parameter lain

Di penyunting teks wiki 2010 dengan TemplateWizard:

  • Parameter "required" selalu ditampilkan di paling atas, bagaimanapun urutannya di "paramOrder"
  • Parameter "suggested" selalu ditampilkan setelahnya, di atas parameter "optional".
  • Parameter "deprecated" tidak ditampilkan sama sekali dalam penyunting ini; lihat keterangan mengenai "deprecated" untuk informasi lebih lanjut.
  • "paramOrder" hanya akan memaksakan urutannya di dalam kategori-kategori tersebut (jadi, semua parameter "required" akan ditampilkan dalam urutan yang ditetapkan oleh "paramOrder", dan semua parameter "suggested" juga ditampilkan sedemikian pula, tetapi semua parameter "suggested" akan ditampilkan di bawah semua parameter "required").

Di VisualEditor dan penyunting teks wiki 2017, "paramOrder" memaksakan urutannya tidak peduli status masing-masing parameter.

"paramOrder": [
	"date",
	"reason",
	"talk"
]

Di dalam params

Parameter Deskripsi Contoh
Nama parameter

Satu-satunya item tingkat satu dari objek params adalah nama parameter templat tersebut.

Sebagai contoh, di dalam kode sumber suatu templat, jika Anda melihat {{{date}}}, ini adalah sebuah parameter, dan ini seharusnya ditambahkan ke "params" dengan nama "date".

Anda juga bisa melihat parameter yang bernama {{{1}}} atau bilangan lain (yang nama TemplateData-nya seharusnya, sebagai contoh, "1".) Parameter seperti ini menghentikan pengguna yang memasukkan templat dari harus mengetik nama parameter dan tanda sama dengan (|value| bukannya |parametername=value|). Ketika terdapat beberapa parameter tidak bernama, bilangan ini menandakan parameter tidak bernama yang diacu olehnya. Sebagai contoh, untuk

{{example template|value1|value2}}

value1 adalah nilai untuk parameter {{{1}}}, dan value2 adalah nilai untuk parameter {{{2}}}. Pastikan untuk menjelaskan parameter TemplateData Anda dengan sesuai.

Catatan: seorang pengguna tetap bisa memaksa menggunakan {{{2}}} tanpa {{{1}}} dengan memasukkan parameter bernama "2" di penyunting templat atau mengetik "|2=" di teks wiki. Finally, note that "aliases" creates alternatives to the parameter name which can be used interchangeably, and "label" replaces the parameter name in the user interface with the specified label (for situations in which the parameter name is not human readable or easily understood).

Cara menggunakan

Setiap objek "Nama parameter" seharusnya berisi semua informasi mengenai parameter, dalam bentuk parameter TemplateData yang lebih banyak lagi. Parameter tersebut didaftarkan di bagian berikutnya, Di dalam nama parameter.

"1": {     // nama parameter
    ...    // informasi mengenai parameter di sini
}

Di dalam nama parameter

Parameter Deskripsi Contoh
aliases

The optional "aliases" parameter allows a template parameter to have multiple names. You can check this by going into the template's source code and looking for:

{{{parameter1|{{{parameter2}}}}}}

or

{{{parameter1|{{{parameter2|}}}}}}

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" parameter, add the text "aliases" followed by a colon, a space and an open square bracket, then typing the name of each of the parameter's aliases in quotation marks, separated by commas. End with a closed square bracket, creating an array.

"aliases": ["1", "talk", "talksection"],
inherits

"inherits" is an optional parameter for when a parameter should inherit all of the TemplateData of another parameter. This can then be overridden by any parameters specified for the inheriting parameter.

To use this parameter, type "inherits" : followed by another template parameter's name, such as "talk" or "1". You can then type another specific setting for the parameter underneath if you wish, like "label" : "A different label". The first parameter will inherit all of the second parameter's properties except this one.

    "params": {
        "topik1": {
            "label": "Topik",
            "description": "Topik yang tercantum dalam halaman disambiguasi ini",
            "type": "string"
        },
        "topik2": {
            "inherits": "topik1"
        },
        "topik3": {
            "inherits": "topik1",
            "label" : "A different label"
        }
    }
label

Parameter "label" adalah judul yang dapat dibaca manusia bagi parameter tersebut yang akan ditampilkan dalam penyunting templat. Label ditampilkan menggantikan nama asli parameter pada setiap saat, termasuk ketika sebuah alias digunakan oleh teks wiki. Parameter ini sifatnya opsional, tetapi sangat disarankan.

"label": "Bulan dan tahun",
description

Di sini "description" merupakan deskripsi parameternya, bukan templat secara keseluruhan. This description appears below the parameter name (a long descriptions will be shortened with a button to optionally expand it). Sifatnya opsional tetapi sangat disarankan.

"description": "Bulan dan tahun templat dimasukkan",
type

See the [[<tvar name=1>#Type parameter</tvar>|#Type parameter]] section.

default

Some template parameters have a default value; the value is used unless overridden by the user. The "default" item is an optional item, documentary only, that is intended to communicate this default value to the user. The value need not match the actual default (if there is one) and has no functional effect. (Not to be confused with "autovalue", which is a functional parameter that fills in a field for the user.)

Effects

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), the "default" text will show as grey text in the input box of any open parameter when it is empty, in the format "Default: default text". Additionally, it will show in plain black text in the parameter description (when the user hovers over the "i" symbol). In VisualEditor and the 2017 wikitext editor, this will be below the parameter description, below "Field is required"/"Field is deprecated", if specified (the 2010 wikitext editor doesn't show this text), and above "example", if specified ("example" does not show in the parameter description in the 2010 wikitext editor). In the 2010 wikitext editor with TemplateWizard, the "default" text shows directly after the parameter description, on the same line, following a space. It shows in the same format as the other editors ("Default: default text").

With other parameters

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), if "default" is specified, the "example" value will not show in the input box.

"default": "Category:CommonsRoot",
autovalue

A parameter can be assigned an "autovalue". When a user adds the template to a page, this value will automatically appear in the input box. For example, many cleanup templates need the date added; setting the "autovalue" for the template's date parameter to be {{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}, the month and year that the template was added will be filled in automatically.

This value can be overwritten by the user in the template editor.

With other parameters

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "autovalue" overrides the visible effects of "url" in VisualEditor and the 2017 wikitext editor. See the description for "type" for more info.

"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
example

The "example" parameter is optional and documentary only; its value contains an example that helps the template's user understand the correct way to fill in the parameter (not to be confused with "suggested"; see that entry for more information).

Effects

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), this property is displayed below the parameter description (and below the "default" text, if specified).

With other parameters

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "example" will not show in the input box if "default" is specified.

"example": "January 2013",
required

Lalu kita punya "required", yang dapat diatur ke true atau false. Ketika tidak ditentukan, maka nilai standarnya adalah false.

Ini menentukan apakah pengisian parameter tersebut diwajibkan dalam templat.

Efek

This status has several effects in VisualEditor and the Penyunting teks wiki 2017 :

  • it displays the parameter automatically when a user inserts the template;
  • it shows a black asterisk within the input box, on the right;
  • it shows the grey, italic text "Bidang ini wajib diisi." below the parameter description;
  • it makes the input box glow red if the user clicks away without entering a value;
  • if a user attempts to insert the template without a value in the required parameter, it will show them a prompt, asking if they are sure. If they confirm, it will insert the parameter with a blank value. It will not stop them from inserting the template, though, and it does not result in a visible error by itself (though templates can be programmed to display an error when a required parameter is not filled in).

In the Perpanjangan:WikiEditor with Extension: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 "Bidang ini wajib diisi." in the parameter description; rather, it lists the parameter on the side under "Parameter yang diwajibkan". 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 VisualEditor and the 2017 wikitext editor, the "deprecated" status does not override the functionality of this parameter, but in the 2010 wikitext editor with TemplateWizard it does. See the description of "deprecated" for more info.

"required": true
suggested

Ada juga "suggested", yang dapat diatur ke true atau false. Jika Anda tidak menentukannya, maka akan dianggap false.

Use "suggested" for parameters that are not mandatory but strongly recommended for template users to provide. When filling in this parameter, a user will see this suggestion.

Efek

In VisualEditor and the Penyunting teks wiki 2017 , 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 Perpanjangan:WikiEditor with TemplateWizard, it does not place the parameter in the template automatically but instead causes it to be listed on the side under "Parameter yang disarankan". The user can then click a "+" next to the parameter to add it to the template.

With other parameters

The "required" status overrides the functionality of this status in all main editors (VisualEditor, the 2017 wikitext editor and the 2010 wikitext editor). It also overrides the displayed "suggested" status in TemplateData documentation (it will display "required" if both "required" and "suggested" are set to true).

"suggested": true
deprecated

Terakhir, ada "deprecated", yang dapat diatur ke true, false, atau teks yang menjelaskan apa yang harus dilakukan pengguna. Jika Anda tidak menentukannya, maka akan dianggap false.

Ini merupakan status untuk parameter yang seharusnya tidak digunakan lagi, namun tetap ada untuk sementara waktu. Ini bisa disebabkan oleh penggunaan templat sedang dipindahkan dari sekumpulan parameter ke yang lainnya.

Efek

The effect of this parameter in VisualEditor 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 "Bidang telah usang. 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 (VisualEditor, 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 true.

In the 2010 wikitext editor with TemplateWizard, setting this value as true does not allow the parameter to be added or seen.

With other parameters

If you set both this and "suggested" as true, the parameter status will show as "deprecated" in the TemplateData documentation, but in VisualEditor and the 2017 wikitext editor both functionalities will be retained; the parameter will automatically show up when a user inserts a template, but it will have the "deprecated" warnings around it.

If you set both this and "required" as true, the parameter status will show as "deprecated" in the TemplateData documentation, but in VisualEditor and the 2017 wikitext editor it will have the same functionality as only "required"; the parameter will automatically show up when a user inserts a template, and it will have the "required" warnings around it. This is the same for if you set "deprecated", "suggested" and "required" as true.

In the 2010 wikitext editor with TemplateWizard, "deprecated" overrides the parameters "required" and "suggested".

"deprecated": "Silakan gunakan 'publicationDate' saja."
suggested values

The parameter property suggestedvalues lets you define a list of parameter values to be shown to VisualEditor users in a dropdown for easy selection. This can be done either directly in JSON or using the TemplateData editor (no coding required). You can add suggested values to be displayed in the VisualEditor for parameters which have their type set to one of the following options (reference):

  • content
  • line
  • string
  • number
  • unknown
  • unbalanced wikitext

Other types (file, page, template, user, date, boolean, URL) are not currently supported because they have special functionalities in the VisualEditor already, such as autocomplete, which would interfere with the drop-down menu for suggested values in the VisualEditor.

Editing TemplateData 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 TemplateData with the TemplateData Editor

  1. Click on "Kelola DataTemplat".
  2. Click on the name of the parameter you want to add suggested values to.
  3. If it’s not already done, set parameter type to one of the following: content, line, string, number, unknown, unbalanced wikitext. A new input field "Nilai yang disarankan" will appear. If the parameter is already set to one of these types, the input field should already be visible.
  4. Type in the suggested value(s), including any spaces and special characters, and press enter to add the value(s) to the list.

Effects

Once the values have been added to TemplateData, the VisualEditor 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"
	]

Catatan: jika "required", "suggested" ataupun "deprecated" tidak diberi nilai true untuk suatu parameter, statusnya akan ditampilkan sebagai "optional" di dokumentasi TemplateData.

Ketika sudah selesai, tekan "Simpan". Jika Anda membuat galat, Anda tidak akan dapat menyimpan (memang mengganggu, namun berarti Anda tidak dapat sampai merusaknya). Jika Anda mengalami galat, jelaskan pada halaman umpan balik apa yang Anda lakukan, dan kami akan dengan senang hati membantu.

Perhatikan bahwa jika Anda menggunakan templat hack untuk membuat TemplateData secara dinamis, maka TemplateData-nya tidak bisa diperiksa galatnya sebelum disimpan.

Perhatikan bahwa setiap satuan informasi diapit dengan tanda kutip (kecuali untuk true dan false), dan dipisahkan dari satuan selanjutnya dengan tanda koma (kecuali yang terakhir).

Parameter tipe

Parameter "type" dimaksudkan untuk memberitahu penyunting templat sifat dari nilai suatu parameter. In some cases, template editors have been programmed to modify the user interface for a certain parameter according to this TemplateData 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 "unknown" value is the default type value if no type is set. It can also be set manually by typing "type": "unknown".

Effects

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "unknown" has no visible effects compared to a template without TemplateData.

number

The "number" value is intended for numerical values, including negative values and decimals.

Effects

  • In VisualEditor and the 2017 wikitext editor, "number" has no visible effect.
  • In the 2010 wikitext editor with TemplateWizard, "number" causes the input box to display a "+" and "-" button on either side, which can raise or lower a number value in the input box, and the user can only type numbers into the box.
The buttons can also lower the number into negatives.

With other parameters

  • In the 2010 wikitext editor with TemplateWizard, "number" overrides the effects of "autovalue"; the value of "autovalue" will not be automatically placed in the input box if the parameter type is "number".
string

The "string" value is intended for any string of plain text.

Effects

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "string" has no visible effect compared to "unknown".

line

The "line" value is intended for content that should be forced to stay on one line.

Effects

  • In VisualEditor and the 2017 wikitext editor, "line" prevents a parameter's input box from allowing new lines, which are usually possible in these editors.
  • In the 2010 wikitext editor with TemplateWizard, "line" has no visible effect (input boxes do not allow new lines by default in this editor).
boolean

The "boolean" value is intended for a value that is either true, false or unknown. This is intended by the manual to be represented by a "1", "0" or blank value.

Effects

As of February 2020, none of the main Wikimedia editors (VisualEditor, 2017 wikitext editor or the 2010 wikitext editor with TemplateWizard) make use of this value. It has no visible effects.

With the autovalue:0 checkbox appears in the VisualEditor, which can be switched on and off.

date

The "date" value is intended for a date in the YYYY-MM-DD (ISO 8601) format; for example, 2014-05-22. The TemplateData manual also designates it as being intended for ISO 8601 date–time combinations, such as 2014-05-22T16:01:12Z", but in practice no major editing interface as of February 2020 uses it in this fashion, and almost all major Wikimedia template parameters take dates and times separately.

Effects

  • In VisualEditor and the 2017 wikitext editor, "date" has no visible effect.
  • In the 2010 wikitext editor with TemplateWizard, "date" makes the parameter input box about a third shorter and adds a dropdown calendar, allowing the user to choose a date input. It also displays the grey example text in the input box "YYYY-MM-DD". If an input does not conform to this standard, the box glows red, however the editor will always output a date conforming to the standard (if numbers are entered) or nothing (if only text or nothing is entered).

With other parameters

  • In the 2010 wikitext editor with TemplateWizard, "date" overrides the effects of "autovalue"; the value of "autovalue" will not be automatically placed in the input box if the parameter type is "date".
url

The "url" value is intended for a URL, with Internet protocol (e.g., "https://" or "//") included.

Effects

  • In VisualEditor and the 2017 wikitext editor, "url" makes the input box display an external link icon (a square with arrow pointing out of it) in the left hand side of the box and makes the box glow red when the user clicks away without entering a URL value that includes a valid Internet protocol (e.g., "https://", "ftp://" or "//") followed by some text.
This second effect is similar to that of the "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").
  • In the 2010 wikitext editor with TemplateWizard, "url" has no visible effect.

With other parameters

  • In VisualEditor and the 2017 wikitext editor, "autovalue" overrides the visible effects of "url": when both are set, the input box will not contain a URL icon nor glow red when the user clicks away without entering a valid URL.
wiki-page-name

The "wiki-page-name" value is intended for a page name on a wiki.

Effects

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "wiki-page-name" makes the parameter input box show a suggestion dropdown menu containing a list of pages on the wiki, such as articles on Wikipedia, which can be selected. Namespaces can also be defined in the search. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-page from being inputted.

wiki-file-name

The "wiki-file-name" value is intended for a file name hosted either locally on a wiki or on Wikimedia Commons.

Effects

  • In VisualEditor and the 2017 wikitext editor, "wiki-file-name" has no visible effect.
  • In the 2010 wikitext editor with TemplateWizard, "wiki-file-name" makes the parameter input box show a suggestion dropdown menu containing a list of files hosted both locally and on Wikimedia Commons, which can be selected.
The file names do not contain the "File:" namespace prefix. The dropdown menu also shows the thumbnail of the files. It has no other visible effect and doesn't prevent a non-file from being inputted.
wiki-template-name

The "wiki-template-name" value is intended for the name of a template.

Effects

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "wiki-template-name" makes the parameter input box show a suggestion dropdown menu containing a list of templates, which can be selected. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-template from being inputted.

wiki-user-name

The "wiki-user-name" value is intended for a username on a wiki.

Effects

In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "wiki-user-name" makes the parameter input box show a suggestion dropdown menu containing a list of actual users' names, which can be selected. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-username from being inputted.

content

The "content" value is intended for wikitext of page content, for example, links, images or text formatting.

Effects

  • In VisualEditor and the 2017 wikitext editor, "content" has no visible effect.
  • In the 2010 wikitext editor with TemplateWizard, "content" makes the parameter input box one line taller and allows new lines, which regular input boxes in the 2010 wikitext editor do not.
unbalanced-wikitext

The "unbalanced-wikitext" value is intended for wikitext that cannot stand alone, i.e. it lacks an opening or closing tag or refers to other parts of wikitext.

Effects

  • In VisualEditor and the 2017 wikitext editor, "unbalanced-wikitext" has no visible effect.
  • In the 2010 wikitext editor with TemplateWizard, "unbalanced-wikitext" makes the parameter input box one line taller and allows new lines, which regular input boxes in the 2010 wikitext editor do not.

Format ubahsuaian

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 \n for new lines).
  • | - pipe (separates parameters)
  • = - equals sign (precedes the value of a parameter)
  • \n or pressing the enter key - new line (this will display as in the entry field)
  • - space (can be used with \n to 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.

Contoh format yang dapat Anda gunakan
Yang ingin dicapai Teks format Keluaran
Pemformatan satu baris {{_|_=_}}
inline
{{Foo|bar=baz|qux=quux}}{{Bar}}
Pemformatan blok {{_\n| _ = _\n}}
block
{{Foo
| bar = baz
| qux = quux
}}{{Bar}}
Tanpa spasi sebelum nama parameter, tiap templat memiliki barisnya sendiri \n{{_\n|_ = _\n}}\n
{{Foo
|bar = baz
|qux = quux
}}
{{Bar}}
Inden pada setiap parameter {{_\n |_ = _\n}}
{{Foo
 |bar = baz
 |qux = quux
}}{{Bar}}
Sejajarkan semua nama parameter ke panjang tertentu {{_\n|_______________ = _\n}}\n
{{Foo
|bar             = baz
|qux             = quux
|veryverylongparameter = bat
}}
{{Bar}}
Karakter pipa di akhir baris sebelumnya {{_|\n _______________ = _}}
{{Foo|
  bar             = baz|
  qux             = quux}}{{Bar}}
Gaya satu baris dengan beberapa spasi, harus merupakan awal baris \n{{_ | _ = _}}
{{Foo | bar = baz | qux = quux}}
{{Bar }}
Templat berada di awal baris, parameter disejajarkan dengan inden, pipa di baris sebelumnya \n{{_ |\n _______________ = _}}
{{Foo |
  bar             = baz |
  qux             = quux}}
{{Bar}}

Papan cetakan kosong

Anda dapat menyalin papan cetakan kosong di bawah ini untuk menambahkan DataTemplat baru ke dalam templat. Hanya tag yang paling umum yang disertakan.

<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "",
            "description": "",
            "type": ""
        },
        "2": {
            "label": "",
            "description": "",
            "type": ""
        }
    }
}
</templatedata>

Errors

Galat sintaks pada JSON. / Bad JSON format

These errors occur when saving TemplateData, usually manually edited, with invalid JSON code (duplicate keys/parameters, trailing or missing commas, etc.) in VisualEditor or the 2017 wikitext editor.

"Galat sintaks pada JSON." appears in VisualEditor and the 2017 wikitext editor; "Bad JSON format" appears when editing in the TemplateData 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 TemplateData 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 "Kesalahan internal" messages. To fix these errors, your best bet is to use a JSON validator (see above).

Required property "paramOrder(number)" not found.

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.

Invalid value for property "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.

Property "params.parametername.required" is expected to be of type "boolean".

This error occurs if you put quotation marks around the value of either "required" or "suggested".

"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 "Properti "format" seharusnya berupa "inline", "block", atau suatu teks 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.

Unexpected property "parametername".

This error occurs if you state a parameter that does not exist in TemplateData. This is probably due to spelling mistakes.

<templatedata>
{
    "description": "",
    "format": "inline",
    "params": {
        "1": {
            "label": "",
            "descriptino": "", // <-- spelling mistake
            "type": ""
        }
    }
}
</templatedata>

It also occurs if you state a parameter in any TemplateData 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 TemplateData object under another object that it doesn't belong to.

For example, you might have written the parameter "label" under the root TemplateData 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 TemplateData object. You can check which parameters exist for an object in the section #TemplateData parameters.

Required property "params" not found.

This error occurs if there is no "params" object in the TemplateData. 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.

Batasan dan umpan balik

  • Fitur yang hilang – DataTemplat adalah sebuah contoh perkakas yang dibuat untuk umum dengan sedikit fitur, dengan harapan pengguna akan membantu memandu pengembangan fitur yang mereka inginkan. Jika Anda ingin meminta fitur baru untuk TemplateData, silakan https://phabricator.wikimedia.org/maniphest/task/edit/form/102/?projects=MediaWiki-extensions-TemplateData beri tahu kami
  • Keterlambatan saat menampilkannya dalam templat – Setelah menambahkan DataTemplat pada templat, metadatanya seharusnya segera muncul saat templat tersebut dibuka di penyunting visual. Namun, nyatanya mungkin perlu waktu beberapa jam sebelum metadatanya muncul. Anda dapat memaksa pembaruan dengan membuat suntingan kosong ke halaman templatnya sendiri bukan halaman dokumentasinya. Untuk melakukan penyuntingan kosong, buka halaman templat untuk disunting, lalu simpan halaman tersebut tanpa membuat perubahan apa pun dan tanpa menambahkan ringkasan suntingan.
  • Masalah saat ini – Daftar kekutu dan permintaan fitur saat ini tersedia phabricator:maniphest/query/qXa9bowMj3nX/#R di pelacak Wikipedia

Perkakas lainnya

Help:Extension:TemplateWizard
Sebuah jendela dialog bilah alat untuk memasukkan teks wiki templat melalui formulir yang dibuat berdasarkan DataTemplat.
TemplateData Wizard
Sebuah perkakas yang menghasilkan DataTemplat melalui antarmuka interaktif.
Skeleton TemplateData generator
Sebuah perkakas yang membaca kode wiki sumber dari templat, mencoba menemukan semua parameter yang digunakan, dan mengeluarkan dokumen kerangka dengan parameter yang tercantum.
JSONLint
Sebuah perkakas yang memungkinkan Anda untuk memvalidasi JSON yang ditulis secara manual untuk membantu menemukan galat dalam sintaks.