VisualEditor/Citation tool/ru

Инструмент цитирования VisualEditor позволяет пользователям использовать шаблоны цитирования вашей вики из VisualEditor. Чтобы включить этот инструмент, вам потребуется следующее: работающая установка VisualEditor и Parsoid , шаблоны цитирования в вашей вики, использующие TemplateData для указания того, как они вызываются, и специальное сообщение .json для подключения VisualEditor и шаблоны вместе.

Импорт шаблонов цитирования

Вам понадобятся шаблоны цитирования в базе данных вашей вики, чтобы использовать любые функции цитирования. Если у вас в настоящее время нет шаблонов цитирования на вашей вики (например, в случае новой установки), вам необходимо их получить. Скопировать их из Википедии — самый простой способ сделать это. Если у вас уже есть шаблоны цитирования на вашей вики, вы можете пропустить эти шаги.

1. Установите Расширение:Scribunto , Расширение:Функции парсера , Расширение:Цитата , Расширение:TemplateData . Большинство шаблонов цитирования в Википедии используют язык программирования Lua, который предоставляет Scribunto, а также функции парсера расширения. Расширение Цитата позволяет использовать теги ‎<ref>. Во всех Википедиях и других вики-сайтах Фонда Викимедиа (WMF) все это уже установлено.
2. Экспорт шаблонов цитирования из Википедии: Manual:Using content from Wikipedia . Экспорт w:ru:Template:Cite web, w:ru:Template:Cite news, w:ru:Template:Cite journal, w:ru:Template:Cite book — хорошее место для начала. Для последних версий этих шаблонов в английской Википедии и некоторых других также требуются поддерживающие модули Lua.
3. Загрузите свои шаблоны, используя страницу Special:Import в вашей вики (например, http://localhost/index.php/Special:Import).

Данные шаблона

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

Определение инструмента цитирования

Чтобы включить Инструмент цитирования VisualEditor в вашей вики, вам нужно создать специальное конфигурационное сообщение в вашей вики: 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 инструмент цитирования будет запущен для всех пользователей VisualEditor в вашей вики в течение нескольких минут.

Дополнительные типы

Если вы планируете добавить дополнительный тип, команда разработчиков хотела бы сначала поговорить с вами, чтобы дать совет, помочь создать соответствующую иконку, и поэтому мы можем рассмотреть вопрос о том, могут ли другие вики также захотеть, чтобы этот тип был определен для всех вики.

Чтобы добавить дополнительный тип, вам необходимо:

1. Решите, какой тип вы хотите создать
   • Например, вы хотите иметь ссылку на базу данных, вы можете назвать тип "database".
2. Создайте для него метку
   • Например, вы можете сделать имя метки "db" и добавить метку в MediaWiki:Visualeditor-cite-tool-name-db со значением "database". Это должно быть на языке содержимого вашей вики. Если ваша вики использует несколько языков или скриптов, вам может понадобиться создать несколько таких меток.
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"
			}
		}
	]
}

См. пример определения в английской Википедии.

Разрешение проблем

Если вы перейдете к Special:Version и TemplateData установлен, но поля не отображаются в диалоговом окне цитирования, вам может потребоваться открыть шаблон цитирования для редактирования, не вносить изменений и снова сохранить его. Это связано с ошибкой, из-за которой включенные данные TemplateData (т.е. присутствующие в Template:Cite_web/doc вместо непосредственно в Template:Cite_web) не загружаются в базу данных до тех пор, пока не будет отредактирован родительский шаблон; см. задача T52372.

Обратите внимание, что пользовательский интерфейс будет немного отличаться при использовании ваших собственных шаблонов, отличных от стандартного 4. Например, список полей изначально не будет отображаться в диалоговом окне цитирования, но вы сможете запросить список всех возможных поля, нажав на кнопку.