Manual:Developing extensions/es



Cada extensión consta de tres partes:


 * 1) Configuración
 * 2) Ejecución
 * 3) Localización

Una extensión mínima constará de tres archivos, uno por cada parte:


 * MyExtension/extension.json: Almacena las instrucciones de instalación. El nombre del archivo debe ser «extension.json». (En versiones anteriores a MediaWiki 1.25, las instrucciones de instalación estaban en un archivo MyExtension/MyExtension.php con el nombre de la extensión. Muchas extensiones tienen funcionalidades retrocompatibles en este archivo PHP.)
 * MyExtension/MyExtension_body.php: Almacena el código de ejecución de la extensión. Existe la convención de llamar a este archivo «MyExtension_body.php», pero no es obligatorio. If your extension is complex and involves multiple PHP files, you should follow the convention to put its implementation code in a subdirectory named MyExtension/includes (although the Example and BoilerPlate extensions do not follow this convention). For example, see the extension.
 * MyExtension/i18n/*.json: Almacena información de localización de la extensión.

En un principio, las extensiones eran archivos únicos. Es posible que aún encuentres algunos ejemplos de este estilo obsoleto.

Cuando desarrolles una extensión, reemplaza «MyExtension» en los nombres anteriores con el nombre de tu extensión. Usa nombres en UpperCamelCase para el directorio y el o los archivos PHP. Esta es la convención general de nombres de archivo. (The is a good starting point for your extension. Also check out the cookiecutter template for MediaWiki extensions on GitHub.)

The three parts of an extension, setup, execution, and, localisation as well as extension types and licensing and publishing your extension are described in the following sections of this page.

While developing, you may want to disable caching by setting  and , otherwise system messages and other changes may not show up.

Configuración
Cuando programes la parte de la instación, tu objetivo es consolidar la instalación de modo que los usuarios que instalen la extensión solo tengan que incluir el archivo de instalación en su archivo, así:

Si quieres hacer que tu extensión sea configurable, debes definir y documentar algunos parámetros de configuración. El código que los usuarios tendrán que introducir para instalar la extensión será algo así:

Para llegar a esta simplicidad, tu archivo de instalación debe cumplir una serie de tareas (que se describirán en detalle en las secciones siguientes):


 * register any media handler, parser function, special page, custom XML tag, and variable used by your extension.
 * define and/or validate any configuration variables you have defined for your extension.
 * prepare the classes used by your extension for autoloading
 * determine what parts of your setup should be done immediately and what needs to be deferred until the MediaWiki core has been initialized and configured
 * define any additional hooks needed by your extension
 * create or check any new database tables required by your extension.
 * set up localisation for your extension

Registrar funcionalidades con MediaWiki
MediaWiki enumera todas las extensiones que se han instalado en su página. Por ejemplo, puedes ver todas las extensiones instaladas en este wiki en Special:Version. Es buena práctica asegurarse de que tu extensión también está presente en esta página. To do this, you will need to add an entry to for each media handler, parser function, special page, custom XML tag, and variable used by your extension. The entry will look something like this:

See for full details on what these fields do. Many of the fields are optional, but it's still good practice to fill them out. se refiere a la versión del esquema usado por el archivo. As of now the only supported version is 1 (MediaWiki 1.26.x and 1.27.x).

In addition to the above registration, you must also "hook" your feature into MediaWiki. The above only sets up the Special:Version page. The way you do this depends on the type of your extension. For details, please see the documentation for each type of extension:

Making your extension user configurable
If you want your user to be able to configure your extension, you'll need to provide one or more configuration variables. It is a good idea to give those variables a unique name. They should also follow MediaWiki naming conventions (e.g. global variables should begin with $wg).

For example, if your extension is named "Very silly extension that does nothing", you might want to name all your configuration variables to begin  or. It doesn't really matter what you choose so long as none of the MediaWiki core begins its variables this way and you have done a reasonable job of checking to see that none of the published extensions begin their variables this way. Users won't take kindly to having to choose between your extension and some other extensions because you chose overlapping variable names.

It is also a good idea to include extensive documentation of any configuration variables in your installation notes.

Here is an example boiler plate that can be used to get started:

Preparing classes for autoloading
If you choose to use classes to implement your extension, MediaWiki provides a simplified mechanism for helping PHP find the source file where your class is located. In most cases this should eliminate the need to write your own  method.

To use MediaWiki's autoloading mechanism, you add entries to the field. The key of each entry is the class name; the value is the file that stores the definition of the class. For a simple one class extension, the class is usually given the same name as the extension, so your autoloading section might look like this (extension is named MyExtension):

The filename is relative to the directory the extension.json file is in.

Defining additional hooks
Véase.

Adding database tables
If your extension needs to add its own database tables, use the hook. Véase la página del manual para más información en uso.

Instalar localización
Véase:
 * Localización (resumen)
 * Localización (detallado)
 * Namespaces

Añadir registros
En MediaWiki, todas las acciones por los usuarios en wiki está seguido para transparencia y colaboración. Ver para cómo hacerlo.

Ejecución
La técnica para escribir la porción de implementación depende de la parte del sistema de MediaWiki que desees extender:
 * Marcado wiki: Extensions that extend wiki markup will typically contain code that defines and implements custom XML tags, parser functions and variables.
 * Reporte y administración: Extensions that add reporting and administrative capabilities usually do so by adding special pages. Para más información véase.
 * Automatización de artículo e integridad: Extensions that improve the integration between MediaWiki and its backing database or check articles for integrity features, will typically add functions to one of the many hooks that affect the process of creating, editing, renaming, and deleting articles. Para más información sobre estos ganchos y cómo para sujetar tu código a ellos, por favor véase.
 * Apariencia y experiencia: Las extensiones que proporcionan a MediaWiki una nueva apariencia y experiencia se agrupan en temas. Para más información sobre cómo producir tus propios temas, véase y.
 * Seguridad: Las extensiones que limiten su uso a determinados usuarios deberían integrarse con el sistema de permisos de MediaWiki. Para aprender más sobre ese sistema, véase . Algunas extensiones también permiten a MediaWiki hacer uso de mecanismos externos de autentificación. Para más información, véase . Además, si tu extensión trata de limitar la lectura de determinados artículos, comprueba los trucos que se comentan en.

Véase también ,

Localización
While developing, you may want to disable both cache by setting  and , otherwise your system message changes may not show up.

If you want your extension to be used on wikis that have a multi-lingual readership, you will need to add localisation support to your extension.

Store messages in .json
Store message definitions in a localisation JSON-file, one for each language key your extension is translated in. The messages are saved with a message key and the message itself using standard JSON format. Each message id should be lowercase and may not contain spaces. An example you can find e.g. in extension MobileFrontend. Here is an example of a minimal JSON file (in this case en.json:

en.json

Store message documentation in qqq.json
The documentation for message keys can be stored in the JSON file for the pseudo language with code qqq. Una documentación del ejemplo puede ser:

qqq.json:

Definir mensajes

 * Asigna a cada mensaje un identificador de mensaje único, en minúsculas y sin espacios; p. ej.uploadwizard-desc
 * Para cada cadena de texto que se muestre al usuario, define un mensaje.
 * MediaWiki permite usar mensajes parametrizados. Esta característica debería utilizarse cuando un mensaje dependa de cierta información generada en tiempo de ejecución. Los marcadores de posición ( placeholders ) de los parámetros se indican con $n, donde n representa el índice del marcador; p. ej.

Definir la documentación de los mensajes
Each message you define needs to have an associated message documentation entry Message documentation; in qqq.json e.g.

Cargar el archivo de localización
In your setup routine, define the location of your messages files (e.g. in directory i18n/):

Uso wfMessage en PHP
In your setup and implementation code, replace each literal use of the message with a call to. In classes that implement (as well as some others such as subclasses of SpecialPage), you can use   instead. Ejemplo:

Uso de mw.message en Javascript
También se pueden usar funciones de internacionalización en Javascript. Véase para más información.

Tipos de extensión
Las extensiones pueden ser categorizadas en base de las técnicas de programación para conseguir su efecto. Extensiones más complejas que utilizan más de una de estas técnicas:
 * Subclasificar: MediaWiki expects certain kinds of extensions to be implemented as subclasses of a MediaWiki-provided base class:
 *  – Subclases del la clase suele páginas de complexión cuyo contenido es dinámicamente generado en una combinación del estado de sistema actual, parámetros de entrada del usuario, y consultas de base de datos. Ambos informes y formas de entrada del dato pueden ser generados. They are used for both reporting and administration purposes.
 *  – Skins change the look and feel of MediaWiki by altering the code that outputs pages by subclassing the MediaWiki class.
 *  – A technique for injecting custom php code at key points within MediaWiki processing. They are widely used by MediaWiki's parser, its localization engine, its extension management system, and its page maintenance system.
 *  – XML style tags that are associated with a php function that outputs HTML code. You do not need to limit yourself to formatting the text inside the tags. Ni siquiera necesitas mostrarlo. Many tag extensions use the text as parameters that guide the generation of HTML that embeds google objects, data entry forms, RSS feeds, excerpts from selected wiki articles.
 *  – A technique for mapping a variety of wiki text string to a single id that is associated with a function. Both variables and parser functions use this technique. All text mapped to that id will be replaced with the return value of the function. The mapping between the text strings and the id is stored in the array $magicWords. The interpretation of the id is a somewhat complex process – see  for more information.
 *  – Variables are something of a misnomer. They are bits of wikitext that look like templates but have no parameters and have been assigned hard-coded values. Standard wiki markup such as or  are examples of variables. They get their name from the source of their value: a php variable or something that could be assigned to a variable, e.g. a string, a number, an expression, or a function return value.
 *  – .  Similar to tag extensions, parser functions process arguments and returns a value. Las extensiones de las etiquetas son diferentes, el resultado de las funciones es el wikitexto.
 *  – you can add custom modules to MediaWiki's "action" web API, that can be invoked by JavaScript, bots or third-party clients.

Apoyar otras versiones de núcleo
You can visit the extension support portal to keep on top of changes in future versions of MediaWiki and also add support for older versions that are still popular.

Publicación
Para autocategorizar y estandarizar la documentación de tu extensión existente, véase. Para añadir tu nueva extensión a esta Wiki:

Desplegando y registrando
Consultar. Si tu extensión añade espacio de nombres, puede que quieras registrar su espacio de nombres predeterminado; asimismo, si añade tablas o campos a la base de datos, puede que quieras registrarlos en.

Documentación de ayuda
You should provide public-domain help documentation for features provided by your extension. es un buen ejemplo. You should give users a link to the documentation via the function.

Proporcionando soporte / colaboración
Extension developers should open an account on Wikimedia's, and request a new project for the extension. This provides a public venue where users can submit issues and suggestions, and you can collaborate with users and other developers to triage bugs and plan features of your extension.

Véase también

 * – implements some example features with extensive inline documentation
 * – a functioning boilerplate extension, useful as a starting point for your own extension
 * Read the Example extension, base your own code on the BoilerPlate extension.
 * cookiecutter-mediawiki-extension – a template for the python tool cookiecutter to generate a boilerplate extension (with variables etc.)
 * Allow you to get going quickly with your own extension. Can also generate the BoilerPlate extension.
 * - copy specific code from them
 * – explains how your extension can provide an API to clients
 * – explains how your extension can provide an API to clients