Módulo:String/doc

Este módulo proporciona acceso a funciones básicas sobre cadenas (strings).

La mayoría de estas funciones se pueden invocar con parámetros con nombre, sin nombre o una mezcla. Si se usan parámetros con nombre hay que tener en cuenta que MediaWiki elimina los espacios en blanco iniciales y finales del valor del parámetro. Según el uso previsto puede ser conveniente tanto conservarlos como eliminarlos.

Algunas funciones admiten parámetros con patrones Lua que son una especie de expresiones regulares. Véase en el Manual de patrones Ustring.

Opciones globales

• ignore_errors: Puesto a 'true' o 1, en ​​caso de error retorno una cadena vacía en lugar del mensaje de error.

• error_category: Si se detecta un error especifica el nombre de la categoría a incluir con el mensaje de error. Por defecto es Categoría:Wikipedia:Errores detectados por el módulo String.

• no_category: puesto a 'true' o 1, no añade ninguna categoría si se genera un error.

Funciones

len

Devuelve la longitud de la cadena. Sintaxis:

• {{#Invoke:String|len|cadena}}
• {{#Invoke:String|len|s=cadena}}

Parámetros:

• s: La cadena a encontrar su longitud

sub

Devuelve una subcadena de la cadena indicada en los índices especificados. Sintaxis:

• {{#Invoke:String|sub|cadena|índice inicial|índice final}}
• {{#Invoke:String|sub|s=cadena|i=índice inicial|j=índice final}}

Parámetros:

• s: la cadena donde extraer la subcadena
• i: índice inicial de la subcadena, por defecto 1, el primer carácter de la cadena.
• j: índice final de la subcadena, por defecto la longitud total, hasta el último carácter.

Si cualquiera de los dos índices tienen valor negativo entonces contará desde el final de la cadena. Así, -1 es el índice del último carácter de la cadena. Si los índices son superiores a la longitud de la cadena entonces reportará un error.

match

Devuelve una subcadena de la cadena indicada que coincida con un patrón especificado. Sintaxis:

• {{#Invoke:String|match|cadena|patrón|índice inicial|número coincidencia|indicador texto limpio|texto no coincidencia}}
• {{#Invoke:String|match|s=cadena|pattern = patrón|start=índice inicial|match=número coincidencia|plain=indicador texto limpio|nomatch=texto no coincidencia}}

Parámetros:

• s: Cadena donde se hace la búsqueda
• pattern: Patrón o cadena a buscar.
• start: Índice de la cadena dónde empezar a buscar, por defecto 1, el primer carácter.
• match: Si se encuentran múltiples coincidencias, especifica cuál de ellas devolver. Por defecto es 1, la primera coincidencia encontrada. Un número negativo cuenta desde el final, por lo tanto match = -1 es la última coincidencia.
• plain: Indica si el patrón debe interpretarse como texto limpio, por defecto 'false'.
• nomatch: En caso de no encontrar ninguna coincidencia, devuelve el valor de «nomatch» en lugar de un error.

Si el número match o el índice start están fuera del rango de la cadena, entonces la función genera un error. También genera un error si no encuentra ninguna coincidencia. Con el parámetro global ignore_errors = true se suprime el error y devuelve una cadena vacía.

pos

Devuelve el carácter de la cadena que se encuentra en la posición indicada. Sintaxis:

• {{#Invoke:String|pos|cadena|índice}}
• {{#Invoke:String|pos|target=cadena|pos=índice}}

Parámetros:

• target: Cadena donde buscar
• pos: Índice del carácter a devolver

El primer carácter tiene el índice 1. El último es -1, contando desde el final. Si está fuera del rango de la cadena entonces devolverá un error.

find

Devuelve la posición donde se encuentra una cadena o patrón buscando en otra cadena.

• {{#Invoke:String|find|cadena|búsqueda|índice inicial|indicador texto limpio}}
• {{#Invoke:String|find|source=cadena|target=búsqueda|start=índice inicial|plain=indicador texto limpio}}

Parámetros:

• source: Cadena donde buscar
• target: Cadena a buscar o patrón de búsqueda
• start: Índice de la cadena fuente donde empezar a buscar, por defecto 1, el primer carácter.
• plain: Índica si la búsqueda debe interpretarse como texto limpio, de lo contrario como patrón Lua. Por defecto es 'true'.

Devuelve el primer índice, mayor o igual que «start», donde «target» se ha encontrado en «source». Si no lo encuentra devuelve 0. Si «source» o «target» están vacíos o indefinidos también devuelve 0. Se supone que funciona bien con cadenas UTF-8.

replace

Permite reemplazar una cadena o patrón en otra cadena. Sintaxis:

• {{#Invoke:String|replace|cadena|patrón|reemplazo|contador|indicador texto limpio}}

Parámetros:

• source: Cadena donde buscar
• pattern: Cadena de búsqueda o patrón a buscar
• replace: Texto de reemplazo
• count: Número de ocurrencias a reemplazar, por defecto todas.
• plain: Indica si la búsqueda debe interpretarse como texto limpio, de lo contrario como patrón Lua. Por defecto es 'true'.