API:Localisation/es

Esto documenta cosas específicas para la localización de la API de acción de MediaWiki (api.php). 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 [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#ab3a6e8b6e7cfbaf4f8bf4339a13d76c5  ] 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 [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a9bd9dd747c20665d94b5939373b3f40c ] 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.
 * Parameters with an array for [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a345d7963199abd8893bd88015f7d4ed6 ] may use [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a5a023b82d4aa17a44e33c1e8e2abdd6b  ] to specify that each value is individually documented. These messages are by default  . If the messages are named according to the default, there is no need to map messages to values in the   array (it still has to exist but can be left empty).
 * All examples must have a descriptive text. Message names should be along the lines of.

Documentación de los mensajes
When documenting the messages in, use the following templates:

Formato de los mensajes
All messages should end with a period, and be grammatical sentences. For parameters passed to the messages by default, see the templates linked from #Message documentation.

Use semantic wikitext markup in messages:


 * for mention of parameter keys, and also references to variables like $wgMiserMode.
 * for the possible values of parameters, mention of parameters with values (including references to other modules), and the mention of the input values in example docs.
 * for mention of keys or values in the API output.
 * for anything else that's computer code, e.g. "the  header" or "the page ".
 * You don't need additional quotation marks when using semantic markup.

If you need to reference other API modules, pipe a link to Special:ApiHelp and the help formatter will do the right thing. For example, " " is used in the documentation for various token parameters. The Special:ApiHelp link properly renders as an in-page anchored link if it's on the same help page (example). Similarly, reference to MediaWiki configuration variables such as $wgMiserMode should link to the documentation on mediawiki.org.

Pages referenced in examples should generally not be linked, as these links are unlikely to exist on many wikis.

Errores y alertas
Errors are raised by calling  and the message can be localized in the usual way. Likewise for warnings with. See for details.

Customarily API error messages have message keys starting with  and warnings with.

Texto en respuestas de API
ApiBase, and thus all API modules, are also context sources. Messages should generally be accessed using, and the API module itself should generally be passed when an IContextSource is needed.

Messages should not be arbitrarily included in the output because a client might find it useful.

Mejorar las regionalizaciones en Translatewiki
You can add and improve API help message translations on translatewiki.net, in the same manner as other core MediaWiki messages. The relevant message groups include


 * MediaWiki action API
 * API feature usage

Véase también

 * API/Architecture_work/i18n – Draft document with information for converting old API modules to the new system.