VisualEditor/Ferramenta de citações

A ferramenta de citação do VisualEditor permite que os usuários usem os modelos de citação do seu wiki a partir de VisualEditor. To enable the tool, you'll need the following: a working installation of VisualEditor and Parsoid , citation templates on your wiki that use TemplateData to specify how they are invoked, and a special .json message in order to hook VisualEditor and the templates together.

Importação de predefinições de citação

Você precisará de predefinições de citação na base de dados da sua wiki para que você possa usar qualquer funcionalidade para citações. Caso você não tenha atualmente predefinições de citação em sua wiki (por exemplo, no caso de uma instalação nova), deverá obtê-las. Copiá-las da Wikipédia é o jeito mais fácil para fazer isso. Caso você já tenha predefinições desse tipo em sua wiki, poderá pular estas etapas.

1. Instale Extension:Scribunto, Extension:ParserFunctions, Extension:Cite, e Extension:TemplateData. A maioria das predefinições de citação da Wikipédia usam a linguagem Lua, a qual Scribunto torna disponível, e elas também usam as funções de parsing da extensão. A extensão Cite permite-lhe usar as tags <ref>.

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. All Wikipedias and other WMF wikis already have all of these things installed.

1. Export citation templates from Wikipedia: Manual:Using content from Wikipedia . Exporting w:Template:Cite web, w:Template:Cite news, w:Template:Cite journal, w:Template:Cite book is a good place to start.

Recent versions of these templates at the English Wikipedia and some others also require the supporting Lua modules.

1. Envie suas predefinições utilizando a página Special:Import de sua wiki (por exemplo, http://localhost/index.php/Special:Import)

Dados da predefinição

Você precisará de Extension:TemplateData para que a ferramenta de citações possa carregar dados de predefinição dentro dos campos do Editor Visual, e cada predefinição deve ter dados definidos. Para mais informações sobre como definir dados de predefinição para citações, e para ver capturas de tela de como uma janela de citação deve aparentar com ou sem dados definidos, veja: Wikipédia:Editor Visual/TemplateData

Definição da ferramenta de citações

Para habilitar a ferramenta de citações do Editor Visual em sua wiki, precisa criar uma mensagem especial em sua wiki: MediaWiki:Cite-tool-definition.json. Isto se deve ao fato de que cada wiki é diferente, e por isso se precisa definir quais funcionalidades ela deseja usar; por exemplo, os nomes das predefinições usadas na sua wiki podem ser diferentes dos de outras wikis.

Objetivo da mensagem de configuração

A mensagem:

• Diz quais predefinições sua wiki utiliza para citações-padrão (você pode definir até 5).
  • Note que cada predefinição deve ter TemplateData definido ou o sistema não poderá ser facilmente entendido pelos usuários. Se sua wiki não usa atualmente predefinições de citação, é comum copiá-las da Wikipédia em inglês como um bom conjunto geral.
• Diz qual etiqueta você quer usar a cada tipo de citação.
  • Há quatro etiquetas-padrão, "web", "book" (livro), "news" (notícias) e "journal" (jornal), que correspondem a MediaWiki:Visualeditor-cite-tool-name-web etc.
• Diz qual ícone você quer usar a cada tipo de citação.
  • Há quatro ícones-padrão, "ref-cite-web", "ref-cite-book", "ref-cite-news" e "ref-cite-journal", que correspondem às classes CSS que possuem o ícone como uma imagem de fundo SVG chamada oo-ui-icon-ref-cite-news etc.

Uma vez que a mensagem de configuração MediaWiki:Cite-tool-definition.json é criada, a ferramenta de citações será publicada a todos os usuários de Editor Visual em sua wiki dentro de alguns minutos.

Tipos adicionais

Se você considera adicionar um tipo de citação adicional, a equipe de desenvolvimento gostaria muito de falar com você primeiro, para lhe dar alguns conselhos e ajudá-lo a criar um ícone apropriado, e então poderemos considerar se outras wikis podem também querer esse tipo de citação definido a todas as wikis.

Para adicionar um tipo de citação adicional, você deverá:

1. Decidir que tipo você deseja criar
   • Neste exemplo, digamos que você queira ter uma referência a um banco de dados, e então você chamaria o tipo de database.
2. Criar uma etiqueta para isso
   • Para o exemplo, você poderia criar uma etiqueta de nome "db" e adicioná-la a MediaWiki:Visualeditor-cite-tool-name-db com o valor "database". Isto deve ser na linguagem do conteúdo de sua wiki. Se sua wiki usa scripts e linguagens múltiplas, você deve criar várias etiquetas como essas.
3. Criar um ícone para isso
   • Para o exemplo, você poderia criar um ícone de etiqueta "ref-cite-dbase", e criar o ícone como um arquivo SVG enviado ao commons, criando, então, a classe "oo-ui-icon-ref-cite-dbase" em MediaWiki:Common.css e adicionando o ícone que você deseja com "background-image:url(//upload.wikimedia.org/wikipedia/commons/1/12/VisualEditor_-_Icon_-_Ref_db.svg)" ou similar.

Exemplos

Você pode ver exemplos de mensagens na Wikipédia em inglês e na Wikipédia em polonês. 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.

Solução de problemas

Se você for até Special:Version e TemplateData está instalado, mas os campos não aparecem no diálogo de citações, você deverá abrir a janela de edição da predefinição de citação, fazer nenhuma mudança, e salvar novamente. Isso se deve a um bug, em que TemplateData interpolado (isto é, presente em Template:Cite_web/doc em vez de estar diretamente em Template:Cite_web) não é carregado no banco de dados até que a predefinição parente seja editada; ver tarefa T52372.

Por favor perceba que a experiência do usuário poderá diferir um pouco ao usar suas próprias predefinições no lugar das quatro predefinições-padrão. Exemplificando, suponha que uma lista de campos não será exibida inicialmente no diálogo de citações, mas você poderá pedir por uma lista de todos os campos possíveis clicando um botão.