Módulo:String/probas/uso

Obxectivo

Aquest mòdul proporciona accés a funcions bàsiques sobre cadenes (strings).

La majoria d'aquestes funcions es poden invocar amb paràmetres amb nom, sense nom o una barreja. Si s'usen paràmetres amb nom cal tenir en compte que el Mediawiki elimina els espais en blanc inicials i finals del valor del paràmetre. Segons l'ús previst pot ser convenient tant conservar-los com eliminar-los.

Algunes funciones admeten paràmetres amb patrons Lua que són una mena d'expressions regulars. Vegeu en el manual: patterns i Ustring patterns.

Opcions globals:

• ignore_errors: posat a 'true' o 1, en cas d'error retorn una cadena buida en lloc del missatge d'error.
• error_category: si es detecta un error especifica el nom de la categoria a incloure amb el missatge d'error. Per defecte és Categoria:Errors detectats pel mòdul String.
• no_category: posat a 'true' o 1, no afegeix cap categoria si es genera un error.

Funcions

len

Retorna la longitud de la cadena. >>> Es pot cridar amb {{Str len}}. ++++++++++++ ok en versión GL ++++++

Sintaxi

{{#invoke:string/probas|len|cadena}}

{{#invoke:string/probas|len|s=cadena}}

Paràmetres:

s: La cadena a trobar la seva longitud

Exemples

{{str len|}} retorna 0

{{str len| }} retorna 1

Compta correctament la longitud, fins i tot si la cadena conté espais, sembla un nombre, o té caràcters especials:

{{str len| ab cde }} retorna 8

{{str len| 1234567 }} retorna 9

{{str len| café åäö }} retorna 10

{{str len| 499-caràcters... }} retorna 499

{{str len| 1000-caràcters... }} retorna 1000

sub

Retorna una subcadena de la cadena indicada en els índex especificats. >>> Es pot cridar amb {{Str sub}}. +++++++ KO en versión GL ++++

Sintaxi

{{#invoke:string/probas|sub|cadena|índex inicial|índex final}}

{{#invoke:string/probas|sub|s=cadena|i=índex inicial|j=índex final}}

Paràmetres:

s: la cadena on extraure la subcadena

i: índex inicial de la subcadena, per defecte 1, el primer caràcter de la cadena.

j: índex final de la subcadena, per defecte la longitud total, fins l'últim caràcter.

Si qualsevol dels dos índexs tenen valor negatiu llavors comptarà des del final de la cadena. Així, -1 és l'índex de l'últim caràcter de la cadena. Si els índexs són superiors a la longitud de la cadena llavors reportarà un error. Exemples:

• {{str sub|1234567890|3|7}} = 34567
• {{str sub|1234567890|3|-3}} = 345678
• {{str sub|1234567890|3}} = 34567890
• {{str sub|1234567890|12}} =
• {{str sub|1234567890|6|2}} =

match

Retorna una subcadena de la cadena indicada que coincideixi amb un patró especificat.

Sintaxi

{{#invoke:string/probas|match|cadena|patró|índex inicial|número coincidència|indicador text net|text no coincidència}}

{{#invoke:string/probas|match|s=cadena|pattern=patró|start=índex inicial|match=número coincidència|plain=indicador text net|nomatch=text no coincidència}}

Paràmetres:

s: cadena on es fa la cerca

pattern: patró o cadena a cercar.

start: índex de la cadena on començar a cercar, per defecte 1, el primer caràcter.

match: si es troben múltiples coincidències, especifica quina d'elles retornar. Per defecte és 1, la primera coincidència trobada. Un número negatiu compta des del final, per tant match=-1 és l'última coincidència.

plain: indica si el patró s'ha d'interpretar com a text net, per defecte 'false'.

nomatch: en cas de no trobar cap coincidència, retorna el valor de "nomatch" en lloc d'un error.

Si el número match o l'índex start estan fora del rang de la cadena, llavors la funció genera un error. També genera un error si no troba cap coincidència. Amb el paràmetre global ignore_errors=true se suprimeix l'error i retorna una cadena buida.

Exemples

{{#invoke:string/probas|match|john-smith-1|[a-z][a-z-]+[a-z0-9]}} >>> john-smith-1

{{#invoke:string/probas|match|s=/john-smith|pattern=[a-z][a-z-]+[a-z0-9]}} >>> john-smith

pos

Retorna el caràcter de la cadena que es troba en la posició indicada. {{Str index}}

Sintaxi

{{#invoke:string/probas|pos|cadena|índex}}

{{#invoke:string/probas|pos|target=cadena|pos=índex}}

Paràmetres:

target: cadena on cercar

pos: índex del caràcter a retornar

El primer caràcter té l'índex 1. L'últim és -1, comptant des del final. Si età fora del rang de la cadena llavors retornarà un error.

Exemple

• {{str index|0123456789ABCDEF|0}} →
• {{str index|0123456789ABCDEF|1}} → 0
• {{str index|0123456789ABCDEF|15}} → E
• {{str index|0123456789ABCDEF|18}} →

find

Retorna la posició on es troba una cadena o patró cercant en una altra cadena. >>> Es pot cridar amb {{Str find}}.

Sintaxi

{{#invoke:string/probas|find|cadena|cerca|índex inicial|indicador text net}}

{{#invoke:string/probas|find|source=cadena|target=cerca|start=índex inicial|plain=indicador text net}}

Paràmetres:

source: cadena on cercar

target: cadena a cercar o patró de cerca

start: índex de la cadena font on començar a cercar, per defecte 1, el primer caràcter.

plain: indica si la cerca s'ha d'interpretar com a text net, en cas contrari com a patró Lua. Per defecte és 'true'.

Retorna el primer índex, major o igual que "start", on "target" s'ha trobat a "source". Si no el troba retorna 0. Si "source" o "target" estan buits o indefinits també retorna 0. Se suposa que funciona bé amb cadenes UTF-8.

Exemples

• {{str find|abcdef|bcd}}      → 2
• {{str find|Fast Forward (film)|(}}    → 14
• {{str find|Fast Forward Longer (film)|(}} → 21

• {{str find|A Funny Thing Happened on the Way to the Forum (film)|(}}    → 48

• {{str find|abcdef|x}}    → 0
• {{str find|abcdef|xyz}}    → 0

replace

Permet reemplaçar una cadena o patró en una altra cadena. >>> Es pot cridar amb {{Str rep}}.

Sintaxi

{{#invoke:string/probas|replace|cadena|patró|reemplaçament|comptador|indicador text net}}

{{#invoke:string/probas|replace|source=cadena|pattern=patró|replace=reemplaçament|count=comptador|plain=indicador text net}}

Paràmetres:

source: cadena on cercar

pattern: cadena de cerca o patró a cercar

replace: text de reemplaçament

count: número d'ocurrències a reemplaçar, per defecte totes.

plain: indica si la cerca s'ha d'interpretar com a text net, en cas contrari com a patró Lua. Per defecte és 'true'.

Exemple

• {{str rep|Dogs chase cats|chase|love}} = Dogs love cats

rep

Repeteix la cadena un número de vegades.

{{#invoke:string/probas|rep|cadena|vegades}} {{loop}}

Paràmetres:

cadena: cadena a repetir

vegades: número de vegades a repetir

Exemple

• {{loop|n|4}} produeix nnnn
• {{loop|test|25 }} produeix testtesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttesttest
• {{loop|1==|2=9}} produeix ========= (el "1=" ha de ser present)

strip

Suprimeix caràcters de la cadena. >>> Es pot cridar amb {{Str strip}}.

Sintaxi

{{#invoke:string/probas|strip|cadena|caràcters|text_pla}}

{{#invoke:string/probas|strip|source=cadena|chars=caràcters|plain=text_pla}}

Paràmetres:

source: La cadena a tractar

chars: El patró o llista de caràcters a suprimir de la cadena

plain: Indicador sobre si el paràmetre chars ha de ser entès com a text pla (si és true) o si ha de ser entès com a expressió regular de tipus Lua (si és false). Per defecte és true.

Els espais en blanc del principi i el final també se suprimeixen de la cadena.

split

Trosseja una cadena segons un separador, i retorna el tros n-èssim, segons l'índex donat. >>> Es pot cridar amb {{Str split}}.

Sintaxi

{{#invoke:string/probas|split|cadena|separador|índex}}

{{#invoke:string/probas|split|source=cadena|separator=separador|count=índex}}

Paràmetres:

source: La cadena a tractar

separator: El separador pel qual s'ha de trossejar la cadena

count: L'índex del tros a retornar

exemple

• {{String split |This is a piece of text to be split |" "}} → This
• {{String split |This is a piece of text to be split |" "| 4}} → piece

Lua patterns can allow splitting at classes of characters such as punctuation:

• {{String split |Apples, pears, oranges; Cats, dogs|"%p"| 2 |false}} →
• {{String split |Apples, pears, oranges; Cats, dogs|"%p"| 4 |false}} →

A negative index will count back from the end of the text:

• {{String split |txt=This is a piece of text to be split |sep=" " |idx=-1}} →

isNumber

Estableix si la cadena és un nombre. >>> Es pot cridar amb {{Str IsNumber}}.

Sintaxi

{{#invoke:string/probas|isNumber|cadena}}

{{#invoke:string/probas|isNumber|source=cadena}}

Paràmetres:

source: La cadena a tractar

count

{#invoke:string/probas|count|aabbcc|a}}: 2 --nombre de a

{#invoke:string/probas|count|aabbcc|z}} :0 --nombre de z

{#invoke:string/probas|count|aabbcc|[ac]|plain=false}} : 4 --nombre de a ou de c

{#invoke:string/probas|count|11-aa-2587|[0-9]|plain=false}} : 6 --nombre de chiffres

{#invoke:string/probas|count|Il était une fois| |plain=true}} : 3 --nombre de blancs

{#invoke:string/probas|count|Il était une fois|[ ]|plain=false}} : 3 --nombre de blancs

join

Une as cadeas pasadas como argumentos nunha cadea, tratando o primeiro parámetro como separador

Uso

{{#invoke:String|join|separator|string1|string2|...}}

Exemplos

• "{{#invoke:String|join|x|foo|bar|baz}}" → "fooxbarxbaz"
• "{{#invoke:String|join||a|b|c|d|e|f|g}}" → "abcdefg"
• "{{#invoke:String|join|,|a|b|c|d|e|f|g}}" → "a,b,c,d,e,f,g"
• "{{#invoke:String|join|, |a|b|c|d|e|f|g}}" → "a, b, c, d, e, f, g"
• "{{#invoke:String|join| – |a|b|c|d|e|f|g}}" → "a – b – c – d – e – f – g"

endswith

Devolve "yes" se a cadea fonte termina co padrón indicado.

Uso

{{#invoke:String|endswith|source_str|pattern_string}}

OU

{{#invoke:String|endswith|source= source_string |pattern= pattern_string}}

Exemplos

• "{{#invoke:String|endswith|xxxyyy|y}}" → "yes"
• "{{#invoke:String|endswith|xxxyyy|z}}" → ""

casos extremos

• "{{#invoke:String|endswith||}}" → "yes"
• "{{#invoke:String|endswith|| }}" → ""
• "{{#invoke:String|endswith| |}}" → "yes"