Help:TemplateData/id



Apa itu DataTemplat?
TemplateData adalah sebuah cara penyimpanan informasi mengenai sebuah templat dan parameter-parameternya sehingga VisualEditor dapat mengambil dan menampilkannya di penyunting templat, yang akan mempermudah menyunting templat.

DataTemplat memperbolehkan pengguna untuk menulis sedikit data terstruktur ke dalam sebuah halaman templat, atau ditransklusikan ke dalam halaman templat tersebut (seperti pada halaman dokumentasi). Ketika sebuah templat memiliki data terstruktur ini, data ini dapat ditampilkan dengan tepat di VisualEditor. Hal ini mungkin kedengarannya rumit, namun sebenarnya sangat mudah.



Struktur DataTemplat
Struktur DataTemplat dibuat berdasarkan standar JSON, dan sangat sederhana. Harap diperhatikan bahwa semua penjelasan di DataTemplat harus dalam teks polos (tanpa teks wiki, tanpa pranala, dll.).

Hal pertama yang harus dilakukan adalah mengetikkan sepasang tag, di bagian mana pun pada subhalaman dokumentasi templat, seperti:

Hal ini akan memberitahukan peranti lunak bahwa segala sesuatu di antara dua tag ini adalah DataTemplat, dan harus direferensikan saat templat tersebut digunakan.



Contoh
Penjelasan di dalam DataTemplat mengikuti tata letak standar; misal Anda memiliki sebuah templat bernama "Commons" untuk menambahkan pranala ke kategori di Commons mengenai suatu topik. Templat ini memerlukan satu parameter wajib: nama kategori tersebut di Commons. Maka, DataTemplatnya akan berupa seperti ini:

Hal ini akan menghasilkan, di templat, seperti: {       "description": "Sebuah templat untuk menambahkan pranala ke kategori di Commons mengenai sebuah artikel", "params": { "1": {                       "label": "Kategori di Commons", "description": "Kategori di Commons yang ingin Anda tambahkan pranalanya di artikel ini.", "default": "Category:CommonsRoot", "type": "string", "required": true }       } }



Deskripsi dan parameter
Setelah selesai, klik "simpan". Jika Anda membuat kesalahan, peranti lunak tidak akan memperbolehkan Anda menyimpan (hal ini sedikit mengganggu, namun berarti Anda tidak dapat merusak apa pun). Jika Anda menemui masalah, jelaskan di halaman umpan balik apa yang Anda coba lakukan, dan kami dengan senang hati akan membantu.

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



Alias parameter
Beberapa templat memperbolehkan sebuah parameter yang sama memiliki beberapa nama yang berbeda.

Misalnya  dapat ditulis juga menjadi   atau.

Untuk menambahkan informasi ini ke DataTemplat, Anda cukup menambahkan alias ke dalam informasi parameter.



Parameter berganda
Jika Anda memiliki parameter berganda, cukup ulang setiap bagian (dimulai dari tag "1") dan isi informasinya bila perlu. Perhatikan bahwa jika sebuah templat memiliki parameter berganda, Anda harus memisahkan parameter tersebut dengan koma di DataTemplat-nya, seperti:



Parameter serupa
Saat sebuah templat memiliki beberapa parameter, terkadang beberapa parameter tersebut sebenarnya serupa. Dalam kasus ini, Anda hanya perlu menyediakan properti lengkap untuk paramter pertama, sedangkan parameter yang lainnya dapat "mewarisi" properti dari parameter pertama



Cetakan kosong
Anda dapat menyalin cetakan kosong di bawah untuk menambahkan DataTemplat baru di sebuah templat. Hanya tag yang paling umum saja yang disertakan.



Batasan dan pertanyaan

 * Fitur yang kurang — TemplateData is very much an example of 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 TemplateData, please let us know.
 * Keterlambatan penampilan dalam templat — After adding TemplateData to a template, the metadata should be visible immediately when the template is opened in VisualEditor. However, it is possible that it takes hours before the metadata 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.
 * Masalah terkini — A list of current bugs and feature requests is available in bugzilla.



Alat

 * TemplateDataEditor — A user script that makes the process of adding TemplateData easier. It currently exists in French (contains English, Italian, Japanese and Korean translations), and can easily be translated into other languages.
 * TemplateData Wizard — A tool that generates TemplateData 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.