EditorVisual/Eina de citació

L'eina de citació de l'EditorVisual permet als usuaris emprar les plantilles de citació del vostre wiki des de dintre de l'EditorVisual (VisualEditor). Per habilitar l'eina, us caldran aquests elements: una instal·lació en marxa de l'EditorVisual i Parsoid , plantilles de citació al vostre wiki que utilitzin TemplateData per especificar com s'invoquen i un missatge .json especial per enganxar l'EditorVisual amb les plantilles.

Importar les plantilles de citació

Per poder utilitzar les funcions de citació necessitareu tenir plantilles de citació a la base de dades del vostre wiki. Si actualment no en teniu (per exemple, perquè es tracta d'una instal·lació nova), les haureu d'obtenir. La manera més fàcil de fer-ho és copiar-les de la Wikipèdia. Si en canvi ja en teniu, podeu saltar-vos aquests passos.

1. Instal·leu les extensions següents Extension:Scribunto , Extensió:ParserFunctions , Extension:Cite , Extension:TemplateData . La majoria de plantilles de citació de la Wikipèdia utilitzen el llenguatge de programació Lua proporcionat per Scribunto i també les funcions d'analitzador de l'extensió. L'extensió Cite us permet emprar les etiquetes ‎<ref>. Totes les Wikipèdies i els altres wikis de WMF ja tenen instal·lat tot això.
2. Exporteu les plantilles de citació des de la Wikipèdia: Manual:Using content from Wikipedia . Podeu començar exportant w:ca:Plantilla:Ref-web, w:ca:Plantilla:Ref-notícia, w:ca:Plantilla:Ref-publicació i w:ca:Plantilla:Ref-llibre. Les versions recents d'aquestes plantilles que hi ha a la Wikipèdia anglesa i d'altres també requereixen els mòduls Lua suplementaris.
3. Pugeu les plantilles mitjançant la pàgina Special:Import del vostre wiki (per exemple, http://localhost/index.php/Special:Import).

Dades de plantilla

Perquè l'eina de citació pugui pujar les dades de plantilla als camps de l'EditorVisual, necessitareu l' Extension:TemplateData i que cada plantilla tingui definides les dades de plantilla. Si voleu més informació sobre com es defineixen les dades de plantilla per a les citacions i veure captures de pantalla de l'aspecte que ha de tenir una finestra de citació amb les dades de plantilla definides i sense, mireu Wikipedia:VisualEditor/TemplateData.

Definició de l'eina de citació

Per habilitar l'eina de citació de l'EditorVisual al vostre wiki, heu de crear un missatge especial al vostre wiki: MediaWiki:Cite-tool-definition.json. El motiu és que cada wiki és diferent i per tant necessita personalitzar quines característiques vol utilitzar; per exemple, els noms de les plantilles emprades en el vostre wiki podrien ser diferents dels d'altres wikis.

Propòsit del missatge de configuració

El missatge de configuració:

• Diu quines plantilles utilitza el vostre wiki per a les citacions estàndard (en podeu declarar fins a 5).
  • Tingueu present que cada plantilla ha de tenir TemplateData definit o el sistema serà molt difícil d'entendre per als usuaris. Si el vostre wiki actualment no utilitza plantilles de citació, la pràctica habitual és copiar les plantilles de la Wikipèdia anglesa com a conjunt general prou bo.
• Diu quina etiqueta voleu utilitzar per a cada tipus de citació.
  • N'hi ha quatre d'estàndard: "web", "book", "news" i "journal" (web, llibre, article de diari i revista científica), que es corresponen amb MediaWiki:Visualeditor-cite-tool-name-web, etc.
• Diu quina icona voleu utilitzar per a cada tipus de citació.
  • N'hi ha quatre d'estàndard: "ref-cite-web", "ref-cite-book", "ref-cite-news" i "ref-cite-journal", que es corresponen amb les classes de CSS amb la icona com a imatge SVG de fons anomenades oo-ui-icon-ref-cite-news, etc.

Un cop creat el missatge de configuració MediaWiki:Cite-tool-definition.json, l'eina de citació serà disponible en pocs minuts per a tots els usuaris de l'EditorVisual del vostre wiki.

Tipus addicionals

Si esteu considerant la possibilitat d'afegir cap tipus addicional, a l'equip de desenvolupament li agradaria molt parlar amb vós abans, per aconsellar-vos, per ajudar-vos a crear una icona adient i perquè puguem pensar si altres wikis podrien voler que aquest tipus estigués definit en tots els wikis.

Per afegir un tipus addicional, heu de seguir aquests passos:

1. Decidir quin tipus voleu crear
   • En aquest exemple, suposem que voleu tenir una referència de base de dades i que anomeneu el tipus "database".
2. Creeu-li una etiqueta
   • En l'exemple, podríeu crear l'etiqueta "db" i afegir una etiqueta a MediaWiki:Visualeditor-cite-tool-name-db amb el valor "database". Això hauria de ser en la llengua del contingut del vostre wiki. Si el vostre wiki utilitza diverses llengües o scripts, podríeu haver de crear diverses d'aquestes etiquetes.
3. Creeu-li una icona
   • En l'exemple, podríeu crear l'etiqueta d'icona "ref-cite-dbase" i crear la icona com a fitxer SVG pujat a Commons, crear la classe d'icona "oo-ui-icon-ref-cite-dbase" a MediaWiki:Common.css i afegir la icona que voleu amb "background-image:url(//upload.wikimedia.org/wikipedia/commons/1/12/VisualEditor_-_Icon_-_Ref_db.svg)" o similar.

Exemples

Podeu veure exemples de missatges de definició a la Wikipèdia anglesa, la Wikipèdia polonesa, la Wikipèdia francès, la Wikipèdia italià. 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.

Solució de problemes

Si visiteu Special:Version i TemplateData està instal·lat però els camps no apareixen al diàleg de citació, podríeu haver d'obrir la plantilla de citació i prémer "modifica", no fer-hi cap modificació i desar-la. Això és per un error informàtic que fa que TemplateData, que és transclòs (és a dir, és a Template:Cite_web/doc en lloc de directament a Template:Cite_web), no es carregui a la base de dades fins que la plantilla mare es modifica; vegeu task T52372.

Tingueu present que l'experiència d'usuari amb les plantilles pròpies serà una mica diferent que amb les quatre estàndard. Per exemple, al principi no es mostrarà una llista de camps al diàleg de citació, però clicant a un botó podreu mostrar una llista de tots els camps possibles.