VisualEditor/Strumenti citazioni

Lo strumento citazioni di VisualEditor permete agli utenti di utilizzare i template di citazione della tua wiki all'interno di VisualEditor. Per abilitare lo strumento, ti servono i seguenti: un'installazione funzionante di VisualEditor e Parsoid , template di citazione sulla tua wiki che utilizzano TemplateData per specificare come devono essere invocati e uno speciale messaggio .json per agganciare VisualEditor e i template.

Importare i template citazione

Ti serviranno i template citazione nel database della tua wiki, per utilizzare una qualsiasi funzionalità delle citazioni. Se al momento non hai template citazione nella tua wiki (per esempio nel caso di una nuova installazione) dovrai aggiungerli. Copiarli da un'altra Wikipedia è il modo più facile per farlo. Se hai già i template citazione sulla tua wiki, puoi saltare questi passaggi.

1. Install Extension:Scribunto , Extension:ParserFunctions , Estensione:Cite , Extension: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. Tutte le Wikipedia e le altre wiki WMF hanno già tutte queste cose installate.

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.

Versioni recenti di questi template nella Wikipedia Inglese ed altre, richiedono i moduli Lua.

1. Carica i template utilizzando la pagina Special:Import sulla tua wiki (per esempio: http://localhost/index.php/Special:Import)

Template data

Ti servirà Extension:TemplateData per far sì che lo strumento di citazione sia in grado di caricare i dati del TemplateData in VisualEditor e ogni template deve avere il proprio TemplateData compilato. Per maggiori informazioni su come definire i TemplateData per le citazioni e per vedere immagini su come una finestra di citazione dovrebbe essere con e senza TemplateData, vedi: Wikipedia:VisualEditor/TemplateData

Definizione dello strumento citazione

Per abilitare lo strumento citazione VisualEditor sulla tua Wiki, devi creare un messaggio speciale sulla tua wiki: MediaWiki:Cite-tool-definition.json. Questo perché ogni wiki è differente e quindi necessita la personalizzazione delle funzionalità che si vogliono utilizzare; per esempio, i nome dei template utilizzati nella tua wiki potrebbero essere differenti da quelli di wiki in altre versioni linguistiche.

Scopo del messaggio di configurazione

Il messaggio:

• Informa quali template utilizza la tua wiki per le citazioni standard (puoi nominarne fino a 5).
  • Nota che ogni template deve avere il proprio TemplateData definito o il sistema sarà molto difficile per gli utenti da comprendere. Se la tua wiki non utilizza correntemente i template citazione, è pratica comune copiare i template dalla WIkipedia in inglese.
• Indica quali etichette vorresti utilizzare per ogni tipo di citazione.
  • Ci sono quattro nomi standard, "web", "book", "news" e "journal" che corrispondono a MediaWiki:Visualeditor-cite-tool-name-web "ecc."
• Indica quale icona vorresti utilizzare per ogni tipo di citazione.
  • Ce ne sono quattro standard, "ref-cite-web", "ref-cite-book", "ref-cite-news" e "ref-cite-journal", che corrispondono alle classi CSS con l'icona come un'immagine di sfondo SVG chiamata oo-ui-icon-ref-cite-news "ecc."

Una volta che il messaggio di configurazione MediaWiki:Cite-tool-definition.json è creato, lo strumento citazione sarà disponibile per tutti gli utenti VisualEditor sulla tua wiki in pochi minuti.

Ulteriori tipi

Se stai pensando di aggiungere ulteriori tipi di citazione, il team di sviluppo preferirebbe prima parlarne con te, darti consigli, creare un'icona appropriata e così può anche essere presa in considerazione la possibilità che anche altre wiki possano volere quel tipo di citazione.

Per aggiungere un ulteriore tipo, dovrai:

1. Decidere quale tipo creare
   • In questo esempio, supponiamo che volessi aggiungere una citazione per un database che potresti chiamare tipo database.
2. Crea un'etichetta
   • Per esempio, potresti creare l'etichetta db e aggiungere l'etichetta MediaWiki:Visualeditor-cite-tool-name-db con il valore database. Questo dovrebbe essere indicato nella lingua utilizzata dalla tua wiki. Se la tua wiki utilizza più di una lingua o più di un alfabeto, dovrai creare molte etichette.
3. Crea un'icona
   • Per esempio, potresti creare l'icona etichetta "ref-cite-dbase" e creare un file SVG caricato su commons, creare la classe icona "oo-ui-icon-ref-cite-dbase" nel MediaWiki:Common.css e aggiungere l'incona che vuoi con un "background-image:url(//upload.wikimedia.org/wikipedia/commons/1/12/VisualEditor_-_Icon_-_Ref_db.svg)" o simile.

Esempi

Puoi vedere un esempio di messaggio sulla Wikipedia in inglese e la Wikipedia in polacco. 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.

Risoluzione dei problemi

Se navighi in Special:Versione e TemplateData è installato, ma i parametri non vengono mostrati nella finestra di dialogo, dovrai aprire il template citaizone come se volessi modificarlo, non effettuare alcuna modifica e salvare. Questo è causato da un bug per cui il TemplateData che è inclusa (per esempio presente in Template:Cite_web/doc invece che direttamente in Template:Cite_web) non viene caricato nel database fino a che il template principale viene modificato; vedi task T52372.

Per favore fai attenzione che l'impatto sull'utente potrebbe differire quando utilizza un template che non sia uno dei 4 standard. Per esempio, una lista di parametri potrebbe non mostrarsi inizialmente nella finestra di dialogo, ma sarà possibile richiedere una lista di tutti i parametri disponibili cliccando su un pulsante.