Modulo:String/doc
Iste modulo forni functionalitate basic pro manipular catenas de characteres (strings).
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
[modificar fonte]- ignore_errors
- Si 'true' o 1, un error produce un catena 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
[modificar fonte]Iste function retorna le longitude de un catena.
Usage:
{{#invoke:String|len|catena_a_tractar}}
O
{{#invoke:String|len|s= catena_a_tractar }}
Parametros:
- s
- Le catena cuje longitude reportar
sub
[modificar fonte]- Iste function retorna un subcatena de un catena a base del indices specificate.
Usage:
{{#invoke:String|sub|catena_a_tractar|position_de_initio|position_de_fin}}
OR
{{#invoke:String|sub|s= catena_a_tractar |i= position_de_initio |j= position_de_fin }}
Parametros:
- s
- Le catena del qual retornar un subcatena
- i
- Le prime indice del subcatena a retornar, predefinite a 1.
- j
- Le ultime indice del subcatena a retornar, predefinite al ultime character.
Le prime character del catena 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 catena. Per exemplo, un valor de -1 selige le ultime character del catena, -2 le penultime, -3 le antepenultime, etc.
Si un indice excede le dimension del catena, un error se produce.
match
[modificar fonte]Iste function retorna un subcatena ab le catena de origine que corresponde a un expression regular specificate.
Usage:
{{#invoke:String|match|catena_de_fonte|expression_regular|position_de_initio|numero_del_correspondentia|marcator_de_texto_simple|sortita_si_necun_correspondentia}}
OR
{{#invoke:String|match|s= catena_de_fonte |pattern= expression_regular |start= position_de_initio|match= numero_del_correspondentia|plain= marcator_de_texto_simple |nomatch= sortita_si_necun_correspondentia }}
Parameters:
- s
- Le catena in le qual cercar
- pattern
- Le expression o catena a cercar intra le catena
- start
- Le indice intra le catena de origine al qual comenciar a cercar. Le prime character del catena ha le indice 1. Predefinite a 1.
- match
- In alcun casos es possibile cercar un sol catena 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 numero_del_correspondentia or position_de_initio excede le dimension del catena a cercar, o si nulle resultato es trovate, un error se produce. Le parametro ignore_errors=true supprime omne message de error e un catena vacue se retorna in su loco.
Pro information sur construer expressiones regular de Lua, vide:
pos
[modificar fonte]Iste function retorna un character singule ab le catena al position pos.
Usage:
{{#invoke:String|pos|catena_a_tractar|valor_de_indice}}
O
{{#invoke:String|pos|target= catena_a_tractar |pos= valor_de_indice }}
Parametros:
- target
- Le catena 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 catena. Per exemplo, pos = -1 selige le ultime character.
Un valor de zero, o que excede le dimension del catena, produce un error.
find
[modificar fonte]Iste function permitte cercar un catena o expression intra un altere catena.
Usage:
{{#invoke:String|find|catena_de_origine|catena_a_tractar|position_de_initio|marcator_de_texto_simple}}
O
{{#invoke:String|find|source= catena_de_origine |target= target_str |start= position_de_initio|plain= marcator_de_texto_simple }}
Parametros:
- source
- Le catena a cercar
- target
- Le catena 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 catenas a codification UTF-8.
replace
[modificar fonte]Iste function permitte reimplaciar un catena o expression intra un altere catena.
Usage:
{{#invoke:String|replace|catena_de_origine|expression_regular|catena_a_reimplaciar|numero_de_reimplaciamentos|marcator_de_texto_simple}}
O
{{#invoke:String|replace|source= catena_de_fonte |pattern= expression_regular|replace= catena_a_reimplaciar |count= numero_de_reimplaciamentos |plain= marcator_de_texto_simple }}
Parametros:
- source
- Le catena a cercar
- pattern
- Le catena 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
[modificar fonte]Repete un catena n vices. Un function simple pro connecter catena.rep a patronos. Usage:
{{#invoke:String|rep|origine|numero}}
Parametros:
- origine
- Le catena a repeter
- numero
- Le numero de repetitiones
Exemplo: {{#invoke:String|rep|hello|3}} da hellohellohello
