VisualEditor/Alat kutipan

Alat kutipan VisualEditor memungkinkan para pengguna untuk menggunakan tempat kutipan wiki Anda dari dalam VisualEditor. Untuk mengaktifkan alat ini, Anda memerlukan hal-hal berikut: instalasi VisualEditor dan Parsoid yang bekerja, templat kutipan di wiki Anda yang menggunakan TemplateData untuk menetapkan cara memanggilnya, dan pesan .json istimewa untuk menghubungkan VisualEditor dan templatnya.

Mengimpor templat kutipan

Anda akan memerlukan templat rujukan di basis data wiki Anda agar dapat menggunakan fitur rujukan. Jika Anda belum punya templat rujukan di wiki Anda (misalnya, dalam instalasi yang masih baru) Anda perlu mendapatkannya. Menyalin dari Wikipedia adalah cara paling mudah untuk melakukan ini. Jika Anda sudah punya templat rujukan di wiki Anda, Anda bisa melewati tahap-tahap ini.

1. Instal Ekstensi:Scribunto , Extension:ParserFunctions , Extension:Cite , Extension:TemplateData . Kebanyakan templat rujukan di Wikipedia menggunakan bahasa pemrograman Lua yang disediakan oleh Scribunto, dan menggunakan fungsi parser ekstensi. Ekstensi Cite memungkinkan Anda menggunakan tag ‎<ref>. Semua Wikipedia dan wiki WMF lainnya sudah memasang semua hal ini.
2. Ekspor templat rujukan dari Wikipedia: Manual:Using content from Wikipedia . Mengekspor w:Template:Cite web, w:Template:Cite news, w:Template:Cite journal, w:Template:Cite book adalah langkah yang bagus untuk memulai. Versi terbaru dari templat-templat ini di Wikipedia bahasa Inggris dan beberapa wiki lain juga membutuhkan dukungan modul Lua.
3. Unggah templat Anda menggunakan halaman Special:Import di wiki Anda (sebagai contoh, http://localhost/index.php/Special:Import).

Data templat

Anda akan membutuhkan Extension:TemplateData agar perkakas rujukan dapat memuat data templat ke isian di VisualEditor dan setiap templat harus memiliki data templat yang didefinisikan. Untuk informasi lebih lanjut mengenai cara mendefinisikan data templat untuk rujukan, dan untuk melihat cuplikan layar jendela rujukan dengan dan tanpa didefinisikan data templat, lihat: Wikipedia:VisualEditor/TemplateData

Definisi alat kutipan

Untuk mengaktifkan alat kutipan VisualEditor di wiki Anda, Anda perlu membuat sebuah pesan konfigurasi istimewa di wiki Anda: MediaWiki:Cite-tool-definition.json. Ini dikarenakan setiap wiki berbeda-beda dan akibatnya perlu menyesuaikan fitur mana yang ingin digunakan; sebagai contoh, nama templat yang digunakan di wiki Anda mungkin berbeda dari yang ada di wiki lain.

Tujuan pesan konfigurasi

Pesan konfigurasi:

• Katakan templat apa yang wiki Anda gunakan untuk rujukan standar (Anda bisa menyebutkan paling banyak 5).
  • Perhatikan bahwa setiap templat harus memiliki Data Templat yang telah didefinisikan atau sistem akan sangat menyulitkan pengguna yang ingin memahaminya. Jika wiki Anda tidak mendukung templat kutipan saat ini, cukup umum untuk menyalin templat dari Wikipedia bahasa Inggris sebagai kumpulan dasar yang baik.
• Katakan labal mana yang Anda ingin gunakan untuk setiap tipe rujukan.
  • Ada empat rujukan standar, "web", "book", "news" dan "journal", yang bersesuaian dengan MediaWiki:Visualeditor-cite-tool-name-web dst.
• Katakan ikon mana yang Anda ingin gunakan untuk masing-masing tipe rujukan.
  • Ada empat ikon standar, "ref-cite-web", "ref-cite-book", "ref-cite-news" dan "ref-cite-journal", yang bersesuaian dengan kelas-kelas CSS dengan ikon tersebut merupakan gambar SVG latar belakang yang disebut oo-ui-icon-ref-cite-news dst.

Begitu pesan konfigurasi MediaWiki:Cite-tool-definition.json dibuat, alat kutipan akan tersedia bagi semua pengguna VisualEditor di wiki Anda dalam beberapa menit.

Jenis tambahan

Jika Anda mempertimbangkan untuk menambahkan jenis tambahan, tim pengembangan akan dengan senang hati berbicara dengan Anda terlebih dahulu, memberikan nasihat, membantu membuat ikon yang cocok, dan agar kami bisa mempertimbangkan apakah wiki lain mungkin juga memerlukannya agar jenis ini didefinisikan untuk semua wiki.

Untuk menambah jenis tambahan, Anda harus:

1. Memutuskan jenis apa yang akan dibuat
   • Dalam contoh ini, misalkan Anda ingin punya referensi basis data, Anda bisa menyebutnya jenis "database".
2. Buat labelnya
   • Sebagai contoh, Anda bisa membuat nama label "db" dan menambahkan sebuah label di MediaWiki:Visualeditor-cite-tool-name-db dengan nilai "database". Ini sebaiknya dalam bahasa konten wiki Anda. Jika wiki Anda menggunakan beberapa bahasa atau skrip, Anda mungkin perlu membuat beberapa label.
3. Buat ikonnya
   • Sebagai contoh, Anda bisa membuat label ikon "ref-cite-dbase", dan membuat ikon berupa berkas SVG yang diunggah ke commons, membuat ikon kelas "oo-ui-icon-ref-cite-dbase" di MediaWiki:Common.css dan menambahkan ikon yang Anda inginkan dengan "background-image:url(//upload.wikimedia.org/wikipedia/commons/1/12/VisualEditor_-_Icon_-_Ref_db.svg)" atau sejenisnya.

Contoh

Anda bisa melihat contoh pesan definisi di Wikipedia bahasa Inggris, Wikipedia bahasa Polandia, Wikipedia bahasa Prancis, Wikipedia bahasa Italia. Salin kodenya ke wiki Anda dan sesuaikan namanya dengan konteks lokal.

Template type mapping

In addition to MediaWiki:Cite-tool-definition.json, you also need to create MediaWiki:Citoid-template-type-map.json to specify which types of citations map to which templates. You can see an example on the English Wikipedia.

Perkakas "Butuh rujukan"

Perkakas "butuh rujukan".

Templat "Butuh rujukan" bisa diatur untuk menampilkan sebuah tombol "Tambahkan rujukan" di penyunting dengan mengatur MediaWiki:Visualeditor-template-tools-definition.json dengan kunci citationNeeded.

The configuration value lists templates (which can contain multiple titles for redirects) and parameter mappings. Currently supported keys are:

• reason - shows the reason a citation is needed in the context item
• date - shows the date "citation needed" template was added in the context item
• encapsulate - text which has been wrapped by the template, and which should be unwrapped when a citation is added

The value of these mappings is the name of the parameter(s) in the local template:

{
	"citationNeeded": [
		// This key is always "citationNeeded" in every language
		// Each item of this list represents a single template
		{
			"title": [
				// Title can be a string, or list of redirects
				"Citation needed",
				"Cn",
				...
			],
			"params": {
				"reason": "reason",
				"date": "date"
			}
		},
		// This template is defined separately as it supports the
		// "encapsulate" param. On some wikis this is the same
		// template as the one above.
		{
			"title": [
				"Citation needed span",
				"Cite needed span",
				...
			],
			"params": {
				// Parameters can be a string or list of aliases
				"encapsulate": [ "1", "text" ],
				"reason": "reason",
				"date": "date"
			}
		}
	]
}

Lihat contoh definisi di Wikipedia bahasa Inggris.

Pemecahan masalah

Jika Anda pergi ke Special:Version dan TemplateData sudah dipasang, tetapi isiannya tidak muncul di dialog rujukan, Anda mungkin perlu membuka templat rujukan untuk menyunting, tanpa mengubah apapun, lalu menyimpannya lagi. Ini disebabkan sebuah kutu di mana TemplateData yang ditransklusikan (diletakkan di Template:Cite_web/doc bukannya secara langsung di Template:Cite_web) tidak dimuat ke dalam basis data hingga templat induknya disunting; lihat task T52372.

Tolong perhatikan bahwa pengalaman pengguna akan sedikit berbeda ketika menggunakan templat Anda sendiri di luar keempat templat standar. Contohnya, daftar isian awalnya tidak akan muncul dalam dialog rujukan, tetapi Anda bisa meminta daftar semua isian dengan menekan sebuah tombol.