API:Localisation/es

Esto documenta aspectos específicos de la localización de la API de acción de MediaWiki. Véase Localisation para ver comentarios generales acerca de MediaWiki localisation.



Archivos de mensajes
Los mensajes de localización para el núcleo de MediaWiki se encuentran debajo de.

Para las extensiones, los mensajes que son solamente usados para la documentación de la API y que la mayoría de los usuarios finales no ven, deben estar en un archivo separado usando los mecanismos normales para tener múltiples archivos. Ver el localización de documentación sobre adición de nuevos mensajes.



Denominación
Los mensajes de ayuda para los módulos API tienen un espacio de nombres usando la "ruta del módulo", que es la cadena utilizada para el parámetro "módulos" de action=help. Para los módulos agregados a, esta va a ser la misma que la clave utilizada en esa matriz, mientras que para los módulos agregados a , o  será esa clave con el prefijo "query +".

que contiene cualquier documentación adicional a nivel-módulo. Estos pueden anularse con los métodos correspondientes, aunque los casos en que es necesario son raros.
 * El mensaje de descripción, anteriormente devuelto por el método [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a49b8857e40e254e0af27fd281f3a2230 getDescription], se ha dividido en dos: un mensaje  con resumen de una-línea del módulo y una
 * Antes de la 1.30, se usaba un  mensaje. Esto se anuló implementando el método [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#aa0c499873fba5c934b98aae65e61a33d getDescriptionMessage], pero los casos donde fué necesario fueron raros.
 * Los mensajes de descripción del parámetro, anteriormente devueltos por el método [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a1d9406dc4a7b6e5b69554c492ee464f6 getParamDescription], es  (dónde $nombre es la llave de [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams]). Esto puede ser borrado configurando un valor   en la estructura de datos devuelta desde [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams]
 * Parámetros con una descripción similar a "Cuándo más resultados estén disponibles, uso esto para continuar" tendría que utilizar api-help-param-continue en vez de redefinir un mensaje duplicado.
 * Clasificando los parámetros que toman los valores "más nuevos" y "más viejos" (con parámetros relacionados de "inicio" y "fin" ) tendría que utilizar api-help-param-direction en vez de redefinir un mensaje duplicado.
 * Los módulos que utilizan CSRF tokens para implementar  no necesitan parámetro para documentar el token ; este es automáticamente manejado por ApiBase.
 * Varias constantes adicionales están disponibles para usar en [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams]; ver ApiBase para más detalles.
 * Los parámetros con una matriz para  pueden usar   para especificar que cada valor esté individualmente documentado. Estos mensajes son por defecto  . Si los mensajes se nombran de acuerdo con el valor por defecto, no es necesario asignar mensajes a valores en la matriz   (todavía tiene que existir pero puede dejarse vacío).
 * Todos los ejemplos tienen que tener un texto descriptivo. Nombres de mensaje tendrían que estar a lo largo de las líneas de.



Documentación de los mensajes
Al documentar los mensajes en, usa las plantillas siguientes:


 * doc-apihelp-summary
 * doc-apihelp-description
 * doc-apihelp-extended-description
 * doc-apihelp-param
 * doc-apihelp-paramvalue
 * doc-apihelp-paraminfo
 * doc-apihelp-example



Formato de los mensajes
Todos los mensajes terminarían con un periodo, y ser frases gramaticales. Para los parámetros pasados a los mensajes por defecto, ver las plantillas enlazadas desde #documentación de Mensaje.

El uso semántico wikitext markup en mensajes:


 * para mención de claves de parámetro, y también referencias a variables como $wgMiserMode.
 * para los valores posibles de parámetros, mención de parámetros con valores (incluyendo referencias a otros módulos), y la mención de los valores de entrada en ejemplo docs.
 * para mención de claves o valores en la salida de la API.
 * para cualquier otra cosa que sea código de computadora, p. Ej. "el encabezado " o "la página ".
 * No necesitas comillas adicionales cuando usas marcado semántico.

Si necesitas referenciar otros módulos API, canaliza un enlace a Special:ApiHelp y la ayuda del formateador hará lo correcto. Por ejemplo, " " es utilizado en la documentación para varios parámetros token. El enlace Special:ApiHelp se representa correctamente como un enlace anclado en la página si está en la misma página de ayuda (ejemplo). Similarmente, la referencia a las variables de configuración de MediaWiki como $wgMiserMode, enlazarían a la documentación en mediawiki.org.

Las páginas referenciadas en los ejemplos generalmente no deberían estar vinculadas, ya que es improbable que estos enlaces existan en muchos wikis.



Errores y alertas
Los errores se generan llamando a  y el mensaje puede ser localizado de la manera habitual. Del mismo modo para advertencias con. Ver para detalles.

Habitualmente, los mensajes de error de API tienen claves de mensaje que comienzan con  y advertencias con. You can use doc-apierror in the message documentation.



Texto en respuestas de API
ApiBase y en consecuencia todos los módulos API, también son fuentes de contexto. Por lo general, se debe acceder a los mensajes usando $código, y el módulo API en sí generálmente debería se pasado cuando un IContextSource es necesitado.

Los mensajes no tendrían que ser arbitrariamente incluidos en la salida porque un cliente lo podría encontrar útil.



Mejorar las regionalizaciones en Translatewiki
Puedes añadir y mejorar API traducciones del mensaje de ayuda en translatewiki.net, de la misma manera que otro núcleo de mensajes de MediaWiki. Los grupos de mensajes relevantes incluyen


 * MediaWiki Acción API
 * API características de uso



Véase también

 * – Borrador del documento de 2014 con información para convertir los antiguos módulos de la API al sistema actual.