Editor visual/Menú de citas

La herramienta de citas del Editor visual permite a los usuarios usar las plantillas de citas de tu wiki desde adentro del Editor visual. Para activar la herramienta, necesitarás lo siguiente: una instalación en funcionamiento del Editor visual y Parsoid , plantillas de citas en tu wiki que usen TemplateData para especificar cómo se invocan, y un mensaje .json especial con el fin de conectar al Editor visual con las plantillas.

Importar plantillas de citas

Necesitarás plantillas de citas en la base de datos de tu wiki con el fin de utilizar las funciones de citas. Si actualmente no tienes plantillas de citas en tu wiki (por ejemplo, en el caso de una nueva instalación) tendrás que conseguirlas. La forma más fácil de hacer esto es copiarlos de Wikipedia. Si ya dispones de plantillas de citas en tu wiki, puedes omitir estos pasos.

1. Instala Extensión:Scribunto , Extensión:ParserFunctions , Extensión:Cite , Extensión: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. Todas las wikipedias y otras wikis WMF ya tienen todos estos elementos instalados

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.

Versiones recientes de estas plantillas en la Wikipedia en inglés y algunos otros también requieren los módulos de soporte Lua.

1. Sube tus plantillas desde la página Special:Import en tu wiki (por ejemplo, http://localhost/index.php/Special:Import)

Información de plantilla

Necesitarás el Extensión:TemplateData para que la herramienta de citas sea capaz de cargar la información de plantilla dentro de los campos en el Editor Visual y cada plantilla debe tener información de plantilla definida. Para más información en cómo definir información de plantilla para las citas y para ver capturas de pantalla de cómo debiera verse una ventana de cita con y sin plantilla definida, mira: Wikipedia:VisualEditor/TemplateData

Definición de herramienta de cita

Para activar la herramientas de citas del Editor visual en tu wiki, necesitas crear un mensaje especial en tu wiki: MediaWiki:Cite-tool-definition.json. Esto es porque cada wiki es diferente y por lo tanto tiene que personalizar que funcionalidades quiere utilizar; por ejemplo, los nombres de las plantillas usadas en tu wiki pueden ser diferentes de los de otras wikis.

Propósito del mensaje de configuración

El mensaje:

• Indica qué plantillas usa tu wiki para citas estándar (puedes agregar hasta 5).
  • Nota que cada plantilla debe tener TemplateData definido o el sistema será muy difícil de entender para los usuarios. Si actualmente tu wiki no usa plantillas de citación, es común copiar las plantillas de la Wikipedia en inglés como regla general.
• Indica qué etiqueta te gustaría usar para cada tipo de cita.
  • Hay cuatro estándar, "web", "book", "news" y "journal", los cuales corresponden a MediaWiki:Visualeditor-cite-tool-name-web etc.
• Indica qué icono te gustaría usar para cada tipo de cita.
  • Hay cuatro estándar, "ref-cite-web", "ref-cite-book", "ref-cite-news" y "ref-cite-journal", los cuales corresponden a clases CSS con el icono como una imagen SVG de fondo llamada oo-ui-icon-ref-cite-news etc.

Una vez que esté creado el mensaje de configuración MediaWiki:Cite-tool-definition.json, la herramienta de citas estará disponible para todos los usuarios del Editor visual de tu wiki en cuestión de minutos.

Tipos adicionales

Si consideras agregar un tipo adicional, el equipo de desarrollo querría platicar contigo primero, para dar consejos, ayudar a crear un iconno apropiado y así podamos considerar si otros wikis también quisieran este tipo definido para todos los wikis.

Para agregar un tipo adicional, necesitarás

1. Decide qué tipo quieres crear
   • En este ejemplo, digamos que quieres tener una referencia de base de datos, llamarías a este el tipo "database".
2. Crear una etiqueta para tu tipo
   • Para el ejemplo, podrías hacer que la etiqueta se llamara "db" y agregar una etiqueta en MediaWiki:Visualeditor-cite-tool-name-db con el valor "database". Esto debería estar en tu lenguaje de contenido de wiki. Si tu wiki utiliza múltiples idiomas o scripts, puedes necesitar cerar varias de estas etiquetas.
3. Crear un ínco para tu tipo
   • Para el ejemplo, podrías hacer una etiqueta de icono "ref-cite-dbase" y crear el icono como un archivo SVG subido a commons, crear la clase de icono "oo-ui-icon-ref-cite-dbase" en MediaWiki:Common.css y agregar el icono que quieras con "background-image:url(//upload.wikimedia.org/wikipedia/commons/1/12/VisualEditor_-_Icon_-_Ref_db.svg)" o alguno similar.

Ejemplos

Puedes ver los mensajes de definición ejemplo en la Wikipedia en inglés y la Wikipedia en polaco. 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ón de problemas

Si navegas a Special:Version y TemplateData está instalado, pero los campos no se están mostrando en el diálogo de citas, puede que necesites abrir la plantilla de cita para editar, sin hacer cambios, y guardarla de nuevo. Esto es debido a un bug donde el TemplateData el cual es incluido (por ejemplo, presente en Template:Cite_web/doc en lugar de directamente en Template:Cite_web) no se carga dentro de la base de datos hasta que la plantilla padre se edita; mira task T52372.

Por favor nota que el usuario con experiencia diferirá ligeramente cuando utilice tus propias plantillas diferentes de las cuatro estándar. Por ejemplo, una lista de campos no se mostrarán inicialmente en el diálogo de citas, pero serás capaz de solicitar una lsita de todos los posibles campos presionando un botón.