Візуальний редактор/Інструмент цитування

Інструмент цитування у Візуальному редакторі дозволяє користувачам використовувати типові для Вашої вікі шаблони цитування (шаблони посилань на джерела) прямо у Візуальному редакторі. Аби увімкнути цей інструмент, Вам необхідне наступне: робоча інсталяція Візуального редактора та Parsoid 'а, шаблони цитування у Вашій вікі, що містять блок TemplateData , завдяки якому Візуальний редактор дізнається, як ці шаблони коректно викликати, а також спеціальна сторінка у форматі .json, яка пов'язує Візуальний редактор та відповідні шаблони між собою.

Імпортування шаблонів цитування

У базі даних Вашої вікі мають бути шаблони цитування, щоб можна було використовувати будь-яку з функцій цитування у ВР. Якщо у Вашій вікі зараз немає ніяких шаблонів цитування (наприклад, у випадку нової інсталяції), тоді Вам треба створити їх. Найпростіше це можна зробити шляхом копіювання їх із Вікіпедії. Якщо ж Ви вже маєте шаблони цитування у своїй вікі, тоді можете пропустити ці кроки.

1. Встановіть Extension:Scribunto, Extension:ParserFunctions, Extension:Cite, та Extension:TemplateData. Більшість шаблонів цитування у Вікіпедії використовують мову програмування Lua, використання якої уможливлюється розширенням Scribunto, а також вони використовують функції парсера цього розширення. Розширення Cite дає змогу використовувати теги Extension:Scribunto , Extension:ParserFunctions , Extension:Cite , Розширення:TemplateData .

Most citation templates on Wikipedia use the programming language Lua which Scribunto makes available, and they also use the extension's parser functions. The Cite extension allows you to use the ‎<ref> tags. Усі Вікіпедії та інші вікі WMF вже мають усі ці елементи.

1. Експортувати шаблони цитат з Вікіпедії: Manual:Using content from Wikipedia . Експорт w:Template:Cite web, w:Template:Cite news, w:Template:Cite journal, w:Template:Cite book — гарне місце для початку . Останні версії цих шаблонів в англійській Вікіпедії та деяких інших також вимагають підтримки модулів Lua.
2. Завантажте відповідні шаблони, використовуючи сторінку Special:Import у Вашій вікі (наприклад, http://localhost/index.php/Special:Import).

TemplateData

Вам буде потрібне розширення Розширення:TemplateData для того, аби інструмент цитування міг завантажити дані шаблону у відповідні поля Візуального редактора, при чому кожен шаблон повинен мати заповнений блок TemplateData. Якщо Вам треба більше інформації щодо того, яким чином заповнювати TemplateData для шаблонів цитувань, а також щоб переглянути скріншоти, де показано, як має виглядати вікно інструменту цитування з TemplateData та без, перегляньте сторінку Вікіпедія: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. Вирішити, який саме тип Ви хочете створити
   • У цьому прикладі, скажімо, Ви хотіли б мати посилання на базу даних, і могли б назвати цей тип «database».
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)" чи щось подібне.

Приклади

Можна переглянути сторінки конфігурації в англійській та польській, французькій та італійській вікіпедіях. Скопіюйте код у свою вікі та адаптуйте назви до локального контексту.

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.

Інструмент «Потрібна цитата».

Інструмент «Потрібна цитата».

Шаблони «Потрібне цитування» можна налаштувати для відображення кнопки «Додати цитату» в редакторі, налаштувавши MediaWiki:Visualeditor-template-tools-definition.json ключем 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"
			}
		}
	]
}

Дивіться приклад визначення в англійській Вікіпедії.

Виправлення помилок

Якщо Ви зайдете на сторінку Спеціальна:Версія і побачите, що TemplateData встановлено, однак поля не відображаються в діалоговому вікні цитування, Вам, найімовірніше, треба відкрити шаблон цитування в редакторі вікірозмітки, і зберегти сторінку, не здійснивши жодної зміни. Ця проблема пов'язана з помилкою, при якому інформація з TemplateData, коли вона включена у шаблон (тобто присутня на підсторінці документації Template:Cite_web/doc, а не на самій сторінці шаблону Template:Cite_web), не вантажиться у базу даних, аж доки батьківський шаблон не буде відредагований; див. завдання T52372.

Будь ласка, зверніть увагу, що користувацький досвід дещо відрізнятиметься при використанні набору шаблонів, відмінного від набору із чотирьох стандартних шаблонів. Зокрема, список полів початково не відображатиметься у діалоговому вікні цитування — натомість Ви отримаєте змогу викликати список усіх можливих полів, натиснувши відповідну кнопку.