Module:String/doc

Iste modulo forni functionalitate basic pro manipular strings (catenas de characteres).

Le major parte del functiones fornite hic pote esser invocate con parametros a nomine, parametros sin nomine, o un mixtura de illos. De parametros a nomine, MediaWiki removera automaticamente le spatios blanc initial o final. Dependente del uso intendite, conservar o remover le spatio blanc pote esser avantagiose.

Optiones global

ignore_errors

Si 'true' o 1, un error produce un string vacue in loco de un message de error.

error_category

Si un error occurre, specifica le nomine de un categoria a includer con le message de error. Le categoria predefinite es Categoria:Errors reported by Module String.

no_category

Si 'true' o 1, nulle categoria essera addite si un error se produce.

len

Iste function retorna le longitude de un string.

Usage:

{{#invoke:String|len|target_string}}

O

{{#invoke:String|len|s= target_string }}

Parametros:

s

Le string cuje longitude reportar

sub

Iste function retorna un substring de un string a base del indices specificate.

Usage:

{{#invoke:String|sub|target_string|start_index|end_index}}

OR

{{#invoke:String|sub|s= target_string |i= start_index |j= end_index }}

Parametros:

s

Le string de que retornar un substring

i

Le prime indice del substring a retornar, predefinite a 1.

j

Le ultime indice del substring a retornar, predefinite al ultime character.

Le prime character del string ha un indice de 1, le secunde de 2, le tertie de 3, etc. Si i o j ha un valor negative, selige un character a partir del fin del string. Per exemplo, un valor de -1 selige le ultime character del string, -2 le penultime, -3 le antepenultime, etc.

Si un indice excede le dimension del string, un error se produce.

match

Iste function retorna un substring ab le string de origine que corresponde a un expression regular specificate.

Usage:

{{#invoke:String|match|source_string|pattern_string|start_index|match_number|plain_flag|nomatch_output}}

OR

{{#invoke:String|match|s= source_string |pattern= pattern_string |start= start_index|match= match_number|plain= plain_flag |nomatch= nomatch_output }}

Parameters:

s

Le string in le qual cercar

pattern

Le expression o string a cercar intra le string

start

Le indice intra le string de origine al qual comenciar a cercar. Le prime character del string ha le indice 1. Predefinite a 1.

match

In alcun casos es possibile cercar un sol string plure vices. Isto specifica le resultato a retornar, ubi le prime resultato es match= 1. Si un numero negative es specificate, un resultato se retorna a partir del ultime resultato. Per exemplo, match = -1 requesta le ultime resultato. Predefinite a 1.

plain

Valor boolean indicante que le expression debe esser interpretate como texto simple e non como un expression regular de stilo Lua. Predefinite a false (pro cambiar lo: plain=true)

nomatch

Si nulle resultato se produce, scribe le valor de "nomatch" in loco de un message de error.

Si le match_number or start_index excede le dimension del string a cercar, o si nulle resultato es trovate, un error se produce. Le parametro ignore_errors=true supprime omne message de error e un string vacue se retorna in su loco.

Pro information sur construer expressiones regular de Lua, vide:

• Scribunto patterns
• Scribunto Unicode string patterns

pos

Iste function retorna un character singule ab le string al position pos.

Usage:

{{#invoke:String|pos|target_string|index_value}}

O

{{#invoke:String|pos|target= target_string |pos= index_value }}

Parametros:

target

Le string a cercar

pos

Le indice del character a retornar

Le prime character ha un indice de 1.

Un valor negative selige un character a partir del fin del string. Per exemplo, pos = -1 selige le ultime character.

Un valor de zero, o que excede le dimension del string, produce un error.

find

Iste function permitter cercar un string o expression intra un altere string.

Usage:

{{#invoke:String|find|source_str|target_string|start_index|plain_flag}}

O

{{#invoke:String|find|source= source_str |target= target_str |start= start_index|plain= plain_flag }}

Parametros:

source

Le string a cercar

target

Le string o expression a trovar intra source

start

Le indice in source pro comenciar le recerca, predefinite a 1

plain

Valor boolean indicante que le expression debe esser interpretate como texto simple e non como un expression regular de stilo Lua. Predefinite a true

Iste function retorna le prime indice >= "start" ubi "target" pote esser trovate intra "source". Le indices ha un base de 1. Si "target" non es trovate, o si "source" o "target" manca o es vacue, iste function retorna 0.

Iste function deberea esser secur pro strings a codification UTF-8.

replace

Iste function permitte reimplaciar un string o expression intra un altere string.

Usage:

{{#invoke:String|replace|source_str|pattern_string|replace_string|replacement_count|plain_flag}}

O

{{#invoke:String|replace|source= source_string |pattern= pattern_string|replace= replace_string |count= replacement_count |plain= plain_flag }}

Parametros:

source

Le string a cercar

pattern

The string o patrono a cercar intra source

replace

Le texto a reimplaciar

count

Le numero de occurrentias a reimplaciar; predefinite a all (totes)

plain

Valor boolean indicante que le expression debe esser interpretate como texto simple e non como un expression ustring de Scribunto (un expression regular de stilo Lua apte pro Unicode). Predefinite a true

rep

Repete un string n vices. Un function simple pro connecter string.rep a patronos. Usage:

{{#invoke:String|rep|source|count}}

Parametros:

source

Le string a repeter

count

Le numero de repetitiones

Exemplo: {{#invoke:String|rep|hello|3}} da hellohellohello