Help:TemplateData/id



Apa itu DataTemplat?
DataTemplat adalah sebuah cara penyimpanan informasi mengenai sebuah templat dan parameter-parameternya sehingga VisualEditor dapat mengambil dan menampilkannya di penyunting templat, yang akan mempermudah penyuntingan 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.



Penyunting DataTemplat
Terdapat sebuah alat tertanam untuk menyunting DataTemplat dengan cara yang lebih sederhana.

Untuk menggunakan penyunting DataTemplat, bukalah halaman templat tersebut (atau subhalaman dokumentasinya) lalu tekan tombol "Sunting". Hal tersebut akan memberikan Anda sebuah tombol bertulsikan "", tepat di atas jendela penyuntingan yang terbuka: Klik tombol tersebut untuk memasuki alat GUI (antarmuka pengguna grafis) untuk menyunting DataTemplat. Penyunting memperbolehkan Anda menambahkan satu baris per parameter templat dan mengatur atribut yang paling umum. Jika halaman yang Anda sunting sudah memuat blok DataTemplat, maka informasi yang sudah didokumentasikan akan secara otomatis ditampilkan ketika Anda membuka halaman yang tepat di penyunting DataTemplat. Pada kotak pertama, Anda dapat menambahkan atau memperbarui keterangan singkat mengenai templat tersebut dalam teks biasa. Setelah itu, Anda dapat menggunakan tombol "Impor parameter" dan "Tambah parameter" untuk mendokumentasikan nama dan atribut dari parameter-parameter yang digunakan oleh templat tersebut.

Anda dapat mendaftarkan nama parameter, alias parameter, label dan keterangan yang akan ditampilkan ke pengguna. Satu-satunya bidang yang diperlukan adalah Nama (bidang pertama pada setiap barisnya), di mana Anda perlu mencatatkan nama parameter secara tepat dan cocok dengan kapitalisasinya di dalamnya. Pada menu sembul, Anda dapat memilih jenis isi yang harus diterima oleh parameter, seperti kata (untuk jawaban teks polos), halaman (untuk pranala ke halaman lainnya), maupun tanggal. Jika templat akan menghasilkan galat saat parameter ini dibiarkan kosong, tolong tandailah sebagai "Wajib diisi". Jika parameter ini umum dipakai atau disarankan, maka tandailah sebagai "Disarankan". Tombol "Hapus" akan menghilangkan entri parameter tersebut dari DataTemplat.

Ketika Anda sudah selesai mendokumentasikan setiap parameter yang ada, tekan "Terapkan" untuk menyisipkan DataTemplat yang terpraformat ke dalam kotak penyuntingan yang terbuka. Anda tetap harus menyimpan, menggunakan tombol "Simpan" biasa yang berada di bawah jendela penyuntingan.

Peringatan: Penyunting DataTemplat akan menempatkan DataTemplat pada halaman templat atau pada subhalaman dokuemntasi. Anda dapat menentukan di mana DataTemplat akan ditambahkan dengan membuka (menyunting) halaman tempat Anda ingin menempatkan DataTemplat tersebut. Bagaimana pun juga, jika terdapat beberapa blok DataTemplat yang ditempatkan pada templat yang sama, hanya salah satu blok DataTemplat yang akan digunakan. Jika pada suatu halaman sudah terdapat DataTemplat, maka Anda perlu menyunting halaman di mana DataTemplat itu diletakkan sebelumnya untuk menghindari pembuatan beberapa blok DataTemplat secara tidak sengaja.



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.", "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.



Nilai otomatis
Anda dapat menentukan sebuah "nilai otomatis" untuk sebuah parameter. Ketika pengguna menambahkan templat ke sebuah halaman, nilai ini akan ditambahkan secara otomatis. Sebagai contoh, banyak templat pemeliharaan memerlukan penambahan tanggal; jika Anda menentukan nilai otomatis untuk parameter tanggal pada templat tersebut, maka tanggal tersebut akan terisi secara otomatis.

Untuk menambahkan informasi ini pada DataTemplat, cukup tambahkan autovalue ke dalam informasi parameter. Anda mungkin akan ingin menggunakan  (atau  ) untuk membuat nilai tersebut tetap:



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 — DataTemplat adalah contoh yang sangat cocok sebagai alat yang tersedia dengan sedikit fitur, dengan harapan pengguna akan membantu memandu pengembangan fitur yang mereka inginkan. Jika Anda ingin meminta fitur baru untuk Data Templat, silakan beritahu kami.
 * Keterlambatan penampilan dalam templat — Setelah menambahkan DataTemplat ke dalam templat, metadata seharusnya langsung terlihat ketika templat tersebut dibuka di VisualEditor. Namun, bisa saja perlu beberapa jam sebelum metadata tersebut tampil. Anda dapat memaksa pembaruan dengan membuat suntingan kosong pada halaman templat tersebut (bukan subhalaman dokumentasinya). Untuk membuat suntingan kosong, buka halaman templat untuk penyuntingan, lalu simpan halamannya tanpa membuat perubahan apa pun.
 * Masalah terkini — Daftar bug dan permintaan fitur terkini tersedia di bugzilla.



Alat lainnya

 * 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.
 * List of all templates with TemplateData on this wiki