Editando Módulo:String/doc (sección)

== Funciones ==
=== len ===
Devuelve la longitud de la cadena. Sintaxis:
* <code><nowiki>{{#Invoke:String|len|cadena}}</nowiki></code>
* <code><nowiki>{{#Invoke:String|len|s=cadena}}</nowiki></code> 

'''Parámetros:'''
* <code>s</code>: La cadena a encontrar su longitud

=== sub ===
Devuelve una subcadena de la cadena indicada en los índices especificados. Sintaxis:
* <code><nowiki>{{#Invoke:String|sub|cadena|índice inicial|índice final}}</nowiki></code>
* <code><nowiki>{{#Invoke:String|sub|s=cadena|i=índice inicial|j=índice final}}</nowiki></code> 

'''Parámetros:'''
* <code>s</code>: la cadena donde extraer la subcadena
* <code>i</code>: índice inicial de la subcadena, por defecto 1, el primer carácter de la cadena.
* <code>j</code>: í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:
* <code><nowiki>{{#Invoke:String|match|cadena|patrón|índice inicial|número coincidencia|indicador texto limpio|texto no coincidencia}}</nowiki></code>
* <code><nowiki>{{#Invoke:String|match|s=cadena|pattern = patrón|start=índice inicial|match=número coincidencia|plain=indicador texto limpio|nomatch=texto no coincidencia}}</nowiki></code> 

'''Parámetros:'''
* <code>s</code>: Cadena donde se hace la búsqueda
* <code>pattern</code>: Patrón o cadena a buscar.
* <code>start</code>: Índice de la cadena dónde empezar a buscar, por defecto 1, el primer carácter.
* <code>match</code>: 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.
* <code>plain</code>: Indica si el patrón debe interpretarse como texto limpio, por defecto 'false'.
* <code>nomatch</code>: 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:
* <code><nowiki>{{#Invoke:String|pos|cadena|índice}}</nowiki></code> 
* <code><nowiki>{{#Invoke:String|pos|target=cadena|pos=índice}}</nowiki></code> 

'''Parámetros:'''
* <code>target</code>: Cadena donde buscar
* <code>pos</code>: Í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.
* <code><nowiki>{{#Invoke:String|find|cadena|búsqueda|índice inicial|indicador texto limpio}}</nowiki></code>
* <code><nowiki>{{#Invoke:String|find|source=cadena|target=búsqueda|start=índice inicial|plain=indicador texto limpio}}</nowiki></code> 

'''Parámetros:'''
* <code>source</code>: Cadena donde buscar
* <code>target</code>: Cadena a buscar o patrón de búsqueda
* <code>start</code>: Índice de la cadena fuente donde empezar a buscar, por defecto 1, el primer carácter.
* <code>plain</code>: Í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:
* <code><nowiki>{{#Invoke:String|replace|cadena|patrón|reemplazo|contador|indicador texto limpio}}</nowiki></code>

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

<includeonly>
[[Categoría:Wikipedia:Módulos de manipulación de cadenas de texto]]
</includeonly>