Визуален редактор/Инструмент за източници

Инструментът за цитиране на Визуалния редактор позволява на потребителите да използват шаблони за източници от уикито си вътре в самия редактор. За да активирате инструмента, е нужно следното: работеща инсталирана версия на Визуален редактор и Parsoid ; шаблони за източници във вашето уики, които използват TemplateData , който посочва как те са използвани; и специално .json съобщение, за да се свържете Визуалния редактор и шаблоните заедно.

Внасяне на шаблони за източници

Ще имате нужда от шаблони за цитиране в базата данни на вашето уики, за да използвате функциите за източници. Ако нямате (например след инсталиране) ще трябва да ги вземете. Копирането от Уикипедия е най-лесният начин да го направите. Ако вече имате шаблони, може да пропуснете тези стъпки.

1. Инсталиране на Extension:Scribunto , Extension:ParserFunctions , Extension:Cite , Extension:TemplateData . Повечето шаблони за цитиране на Уикипедия използват езика за програмиране Lua, който е достъпен благодарение на Scribuntо, и също така използват парсерните функции на разширенията. Разширението Cite ви позволява да използвате таговете ‎<ref>. Всички Уикипедии и други уикита на Фондация Уикимедия вече са инсталирали всички тези неща.
2. Експортиране на шаблони за цитиране от Уикипедия: Manual:Using content from Wikipedia . Добри места за начало са w:Template:Cite web, w:Template:Cite news, w:Template:Cite journal, w:Template:Cite book Последните версии на тези шаблони в английската Уикипедия, както и някои други, също изискват поддръжка на Lua модули.
3. Качете вашите шаблони с помощта на Специални:Внасяне на страници във вашето уики.

Template data

Ще имате нужда от Extension:TemplateData , за да може инструмента за цитиране да зареди данните на шаблона в полетата в режима на Визуалния редактор, и всеки шаблон трябва да има дефинирани шаблонни данни. За повече информация как да дефинирате шаблонните данни при цитиране и да видите скрийншоти как изглежда прозореца за цитиране с и без дефинирани шаблонни данни, вижте: Wikipedia:VisualEditor/TemplateData

Дефиниране на инструмента за цитиране

За да активирате инструмента за цитиране на Визуалния редактор на уикито си, трябва да създадете специално конфигурационно съобщение на вашето уики: MediaWiki:Cite-tool-definition.json. Това е така, защото всяко уики е различно и затова е нужно да персонализирате кои функции то да използва; например, имената на шаблоните, използвани в уикито ви може да са различни от тези в друго.

Цел на конфигуриращото съобщение

Конфигурационното съобщение:

• Посочва кои шаблони за стандартно цитиране използва вашето уики (може да посочите до 5).
  • Имайте предвид, че всеки шаблон трябва да има дефиниран TemplateData или ще бъде много трудно за потребителите да разберат системата. Ако уикито ви в момента не използва шаблони за цитиране, като добър общ комплект можете да копирате шаблоните от английската Уикипедия.
• Посочва какви описания искате да използвате за всеки вид цитиране.
  • Има четири стандартни, "web", "book", "news" и "journal", които съответстват на MediaWiki:Visualeditor-cite-tool-name-web и т.н.
• Посочва каква икона искате да използвате за всеки вид цитиране.
  • Има четири стандартни, "ref-cite-web", "ref-cite-book", "ref-cite-news" и "ref-cite-journal", които съответстват на CSS класове с икона като SVG фоново изображение, наречени съответно oo-ui-icon-ref-cite-news и т.н.

След като е създадено конфигурационното съобщение MediaWiki:Cite-tool-definition.json, инструментът за цитиране ще бъде достъпен за всички потребители на Визуалния редактор на вашето уики в рамките на няколко минути.

Допълнителни видове

Ако обмисляте добавянето на допълнителен вид шаблон, разработващият екип би искал първо да говори с вас - за да даде съвет, да помогне при създаването на подходяща икона и за да можем да обмислим дали другите уикита също биха искали този шаблон да е дефиниран за всички уикита.

За да добавите допълнителен вид, трябва да:

1. Решете какъв вид искате да създадете
   • В този пример, да кажем, че искате да имате база данни за източници, можете да наречете вида "база данни".
2. Създадете негово описание
   • В примера, бихте могли да сложите името "db" и да добавите описание MediaWiki:Visualeditor-cite-tool-name-db със стойност "база данни". Това трябва да бъде направено на езика на съдържанието на вашето уики. Ако уикито използва множество езици или скриптове, може да се наложи да създадете няколко от тези описания.
3. Създадете негова икона
   • В примера, бихте могли да направите икона на описанието "ref-cite-dbase" и да създадете иконата като SVG файл, качен в Общомения, да създадете класа на иконата "oo-ui-icon-ref-cite-dbase" в MediaWiki:Common.css и добавите иконата, която искате с "background-image:url(//upload.wikimedia.org/wikipedia/commons/1/12/VisualEditor_-_Icon_-_Ref_db.svg)" или подобен линк.

Примери

Можете да видите примерни съобщения за дефиниране на Уикипедия на английски, Уикипедия на полски, Уикипедия на френски, Уикипедия на италиански език. Copy the code to your wiki and adapt the names to the local context.

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.

"Citation needed" tool

The "citation needed" tool.

"Citation needed" templates can be configured to show an "Add a citation" button in the editor by configuring MediaWiki:Visualeditor-template-tools-definition.json with a citationNeeded key.

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"
			}
		}
	]
}

See the example definition on English Wikipedia.

Отстраняване на проблеми

Ако отидете до Специални:Версия и имате инсталиран TemplateData, но полетата не се показват в прозореца за редактиране, може да се наложи да отворите в режим на редактиране шаблона за цитиране, да направите празна промяна, и отново да го съхраните. Това се дължи на бъг, при който TemplateData е вграден (т.е. присъстващ в Шаблон:Cite_web/doc вместо директно върху Шаблон:Cite_web) и не се зарежда в базата данни, докато не се редактира шаблона родител; вижте task T52372.

Моля, имайте предвид, че работата на потребителя ще се различава леко, когато използва свои собствени шаблони, различни от стандартните четири. Така например, в диалоговия прозорец за редактиране няма да се появява първоначално списък с полета, но ще можете да потърсите списъка чрез натискане на бутон.