ÉditeurVisuel/Outils de citation

L'outil de citation de l'Éditeur Visuel permet aux utilisateurs de votre Wikipedia d'utiliser des modèles de citations depuis l'Éditeur Visuel. Pour activer l'outil, vous devez être équipé de ce qui suit : une installation fonctionnelle de l'Éditeur Visuel et de Parsoid , des modèles de citation contenant des TemplateData , et un message .json spécifique afin de lier le modèle et l'ÉditeurVisuel.

Importer des modèles de citation

Vous devez avoir des modèles de citation dans la base de données de votre wiki pour pouvoir utiliser une fonctionnalité de citation. Si vous n'en avez pas encore (installation vierge par exemple) vous devez les obtenir. Les copier de Wikipédia est le moyen le plus simple. Si vous en avez, vous pouvez passer à la suite.

1. Installer Extension:Scribunto , Extension:ParserFunctions , Extension:Cite , Extension:TemplateData . La plupart des modèles de citation Wikipedia utilisent le langage de programmation Lua disponible à partir de Scribunto, et utilisent également les fonctions d'analyse de l'extension. L'extension Cite vous permet d'utiliser les balises ‎<ref>. Toutes les Wikipedias ainsi que les autres wikis de la WMF ont déja tous ces éléments installés.
2.  Exporter les modèles de citation depuis Wikipédia: Manual:Using content from Wikipedia . Exporter w:Template:Cite web, w:Template:Cite news, w:Template:Cite journal, w:Template:Cite book est un bon moyen pour commencer. Les versions récentes de ces modèles de la Wikipedia anglophone plus quelques autres, nécessitent tous la présence des modules Lua.
3. Téléversez vos modèles en utilisant la page Special:Import de votre wiki (par exemple http://localhost/index.php/Special:Import).

Données du modèle (TemplateData)

Vous aurez besoin de Extension:TemplateData pour que l'outil de citation puisse charger les données des modèles dans les champs de l'Editeur Visuel et chaque modèle doit avoir ses TemplateData définies. Pour plus d'informations sur la manière de définir un modèle de données pour les citations, et pour voir des captures d'écran d'une fenêtre de citation avec et sans les TemplateData voir : Wikipedia:VisualEditor/TemplateData

Définition des outils de citation

Pour activer l'outil de citation dans VisualEditor sur votre wiki, vous devez créer un message de configuration spécial sur votre wiki : MediaWiki:Cite-tool-definition.json. En effet, chaque wiki est différent et doit donc personnaliser les fonctionnalités qu'il souhaite utiliser ; par exemple, les noms des modèles utilisés sur votre wiki peuvent être différents de ceux des autres wikis.

But du message de configuration

Le message de configuration :

• Indique quel modèle est utilisé par votre wiki pour les citations habituelles (vous pouvez en donner jusqu'à 5).
  • Notez que chaque modèle doit avoir ses TemplateData définies ou alors le système sera très difficile à comprendre pour les utilisateurs. Si votre wiki n'utilise pas encore de modèles de citation, il est pratique de copier les modèles de la Wikipédia en anglais comme un jeu de modèles généraux.
• Indique les intitulés à utiliser pour chaque sorte de citation.
  • Il en existe quatre standards : "web", "book", "news" et "journal" (web, livre, article de journal, journal scientifique) qui correspondent à MediaWiki:Visualeditor-cite-tool-name-web etc.
• Indique l'icône à utiliser pour chaque type de citation.
  • Il existe quatre standards, "ref-cite-web", "ref-cite-book", "ref-cite-news" and "ref-cite-journal" qui correspondent aux classes des feuilles de style CSS avec l'icône en image de fond (format SVG) appelée oo-ui-icon-ref-cite-news etc.

Une fois que le message de configuration MediaWiki:Cite-tool-definition.json est créé, l'outil de citation sera en ligne pour tous les utilisateurs de l'Editeur Visuel de votre wiki après quelques minutes.

Types supplémentaires

Si vous envisagez d'ajouter un nouveau type de citation, l'équipe de développement souhaite vraiment en parler avec vous au préalable, pour vous donner des conseils, vous aider à créer une icône appropriée, et pour que nous puissions envisager la possibilité de l'intégrer sur tous les wikis selon la demande.

Pour ajouter un type de citation, vous devrez :

1. Décider du type que vous souhaitez créer
   • Dans cet exemple, on suppose que vous souhaitez référencer une base de données, vous pourriez appeler ce type "database".
2. Créez un intitulé approprié
   • Pour notre exemple, vous pourriez choisir nom d'intitulé db et ajouter un intitulé pour MediaWiki:Visualeditor-cite-tool-name-db avec la valeur base de données. Il devrait être dans la langue du contenu de votre wiki. Si votre wiki utilise plusieurs langages ou alphabets, vous pourriez avoir à créer plusieurs de ces intitulés.
3. Créez une icône appropriée
   • Dans notre exemple, on choisit comme intitulé pour l'icône "ref-cite-dbase" et on téléverse l'icône créée sous la forme d'un fichier SVG sur Commons, on crée la classe d'icône "oo-ui-icon-ref-cite-dbase" en MediaWiki:Common.css et on ajoute l'icône souhaitée avec "background-image:url(//upload.wikimedia.org/wikipedia/commons/1/12/VisualEditor_-_Icon_-_Ref_db.svg)" ou similaire.

Exemples

Vous pouvez voir des exemples de messages de définition sur les sites suivants : Wikipedia anglophone, Wikipedia polonaise, Wikipedia française, Wikipedia italienne. Copiez le code sur votre wiki et adaptez les noms au contexte local.

Correspondance du type de modèle

En plus de l'ajout dans MediaWiki:Cite-tool-definition.json, vous devez aussi créer MediaWiki:Citoid-template-type-map.json pour indiquer les modèles, auxquels les types des cartes de citations sont associés. Un exemple vous est donné sur la Wikipedia anglophone.

Outil « Citation nécessaire »

L'outils Citation nécessaire.

Les modèles Citation nécessaire peuvent être configurés pour afficher un bouton Add a citation afin d'ajouter une citation dans l'éditeur, en configurant MediaWiki:Visualeditor-template-tools-definition.json avec un clé citationNeeded.

La valeur de configuration liste les modèles (pouvant contenir plusieurs titres pour les redirections) et la correspondance des paramètres. Clés actuellement reconnues :

• reason - affiche la raison pour qu'une citation soit nécessaire dans l'élément du contexte
• date - affiche la date citation needed à laquelle le modèle a été ajouté à l'élément de contexte
• encapsulate - texte inclus par le modèle et devant être extrait lorsque la citation est ajoutée

La valeur de ces correspondances est le nom du ou des paramètres, dans le modèle local :

{
	"citationNeeded": [
		// Cette clé vaut toujours ''citationNeeded'' dans toutes les langues
		// Chaque élément de cette liste représente un modèle unique
		{
			"title": [
				// Le titre peut être une chaîne de caractères, ou une liste de redirections
				"Citation needed",
				"Cn",
				...
			],
			"params": {
				"reason": "reason",
				"date": "date"
			}
		},
		// Ce modèle est défini séparément car il prend en charge le
		// paramètre "encapsulate" param. Pour certains wikis c'est le même
		// modèle que celui ci-dessus.
		{
			"title": [
				"Citation needed span",
				"Cite needed span",
				...
			],
			"params": {
				// Le paramètres peuvent être une chaîne de caractères ou une liste d'alias.
				"encapsulate": [ "1", "text" ],
				"reason": "reason",
				"date": "date"
			}
		}
	]
}

Voir la définition à titre d'exemple sur la Wikipedia anglophone.

Dépannage

Si vous naviguez vers Special:Version et que TemplateData est installé, mais que les champs ne sont pas montrés dans le dialogue de citation, vous pourriez devoir ouvrir le modèle de citation en modification et le sauvegarder sans rien changer. C'est à cause d'un bogue qui survient quand TemplateData est transclus (présent dans Template:Cite_web/doc et pas directement dans Template:Cite_web par exemple) mais pas chargé dans la base de données tant que le modèle n'est pas édité ; voir tâche T52372.

Veuillez aussi noter que l'expérience utilisateur va être légèrement différente lorsque vous utilisez vos propres modèles, en dehors des 4 standards. Par exemple, une liste de champs ne s'affichera pas d'emblée dans la boîte de dialogue de citation, mais un bouton vous permettra de demander la liste de tous les champs possibles.