Ver o código fonte de "Módulo:String/probas/uso"

{{Subpáxina de documentación}}
===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: [[mw:Extension:Scribunto/Lua reference manual#Patterns|patterns]] i [[mw:Extension:Scribunto/Lua reference manual#Ustring patterns|Ustring patterns]].

Opcions globals:
* <code>ignore_errors</code>: posat a 'true' o 1, en cas d'error retorn una cadena buida en lloc del missatge d'error.
* <code>error_category</code>: 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]].
* <code>no_category</code>: posat a 'true' o 1, no afegeix cap categoria si es genera un error.

== Funcions ==
=== <code>len</code> ===
Retorna la longitud de la cadena. >>> Es pot cridar amb '''{{tl|Str len}}'''.
;Sintaxi:
:<code><nowiki>{{#invoke:string|len|</nowiki>''cadena''}}</code>
:<code><nowiki>{{#invoke:string|len|s=</nowiki>''cadena''}}</code>
Paràmetres:
:<code>s</code>: La cadena a trobar la seva longitud

;Exemples
:<code><nowiki>{{str len|}}</nowiki></code> retorna  {{#invoke:string|len|}}
:<code><nowiki>{{str len| }}</nowiki></code> retorna {{#invoke:string|len| }}
:<code><nowiki>{{str len|s= }}</nowiki></code> retorna {{#invoke:string|len|s= }}, 

:<code><nowiki>{{str len| ab cde }}</nowiki></code> retorna  {{str len| ab cde }} 
:<code><nowiki>{{str len|1234567}}</nowiki></code> retorna  {{str len|1234567}} 
:<code><nowiki>{{str len|café åäö}}</nowiki></code> retorna  {{str len|café åäö}} 

:<code><nowiki>{{str len| 499-caràcters... }}</nowiki></code> retorna {{str len| abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi }}  
:<code><nowiki>{{str len| 1000-caràcters... }}</nowiki></code> retorna {{str len| abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghi abcdefghij }}

=== <code>sub</code> ===
Retorna una subcadena de la cadena indicada en els índex especificats.  >>> Es pot cridar amb '''{{tl|Str sub}}'''. +++++++ KO en versión GL ++++
;Sintaxi:
:<code><nowiki>{{#invoke:string/probas|sub|</nowiki>''cadena''|''índex inicial''|''índex final''}}</code>
:<code><nowiki>{{#invoke:string/probas|sub|s=</nowiki>''cadena''|i=''índex inicial''|j=''índex final''}}</code>
Paràmetres:
:<code>s</code>: la cadena on extraure la subcadena
:<code>i</code>: índex inicial de la subcadena, per defecte 1, el primer caràcter de la cadena.
:<code>j</code>: í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: 
*<code><nowiki>{{str sub|1234567890|3|7}}</nowiki></code> responde  {{str sub|1234567890|3|7}} 
*<code><nowiki>{{str sub|1234567890|3|-3}}</nowiki></code> responde  {{str sub|1234567890|3|-3}} 
*<code><nowiki>{{str sub|1234567890|3}}</nowiki></code> responde  {{str sub|1234567890|3}} 
*<code><nowiki>{{str sub|1234567890|12}}</nowiki></code> responde   {{str sub|1234567890|12|nocategory=1}} 
*<code><nowiki>{{str sub|1234567890|6|7}}</nowiki></code> responde  {{str sub|1234567890|6|7|nocategory=1}}

=== <code>match</code> ===
Retorna una subcadena de la cadena indicada que coincideixi amb un patró especificat.  
;Sintaxi:
:<code><nowiki>{{#invoke:string/probas|match|</nowiki>''cadena''|''patró''|''índex inicial''|''número coincidència''|''indicador text net''|''text no coincidència''}}</code>
:<code><nowiki>{{#invoke:string/probas|match|s=</nowiki>''cadena''|pattern=''patró''|start=''índex inicial''|match=''número coincidència''|plain=''indicador text net''|nomatch=''text no coincidència''}}</code>
Paràmetres:
:<code>s</code>: cadena on es fa la cerca
:<code>pattern</code>: patró o cadena a cercar.
:<code>start</code>: índex de la cadena on començar a cercar, per defecte 1, el primer caràcter.
:<code>match</code>: 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.
:<code>plain</code>: indica si el patró s'ha d'interpretar com a text net, per defecte 'false'.
:<code>nomatch</code>: en cas de no trobar cap coincidència, retorna el valor de "nomatch" en lloc d'un error.
Si el número <code>match</code> o l'índex <code>start</code> 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 <code>ignore_errors=true</code> se suprimeix l'error i retorna una cadena buida.
;Exemples

*<code><nowiki>{{#invoke:string|match|john-smith-1|[a-z][a-z-]+[a-z0-9]}}</nowiki></code> responde {{#invoke:string|match|john-smith-1|[a-z][a-z-]+[a-z0-9]}}

*<code><nowiki>{{#invoke:string|match|s=/john-smith|pattern=[a-z][a-z-]+[a-z0-9]}}</nowiki></code> responde {{#invoke:string|match|s=/john-smith|pattern=[a-z][a-z-]+[a-z0-9]}}

=== <code>pos</code> ===
Retorna el caràcter de la cadena que es troba en la posició indicada.  {{tl|Str index}}
;Sintaxi:
:<code><nowiki>{{#invoke:string|pos|</nowiki>''cadena''|''índex''}}</code>
:<code><nowiki>{{#invoke:string|pos|target=</nowiki>''cadena''|pos=''índex''}}</code>
Paràmetres:
:<code>target</code>: cadena on cercar
:<code>pos</code>: í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
* <code>{{tlp|str index|0123456789ABCDEF|0}}</code> → {{str index|0123456789ABCDEF|0 |nocategory=true}}
* <code>{{tlp|str index|0123456789ABCDEF|1}}</code> → {{str index|0123456789ABCDEF|1}}
* <code>{{tlp|str index|0123456789ABCDEF|15}}</code> → {{str index|0123456789ABCDEF|15}}
* <code>{{tlp|str index|0123456789ABCDEF|18}}</code> → {{str index|0123456789ABCDEF|18 |nocategory=true}}

=== <code>find</code> ===
Retorna la posició on es troba una cadena o patró cercant en una altra cadena.  >>> Es pot cridar amb '''{{tl|Str find}}'''.
;Sintaxi:
:<code><nowiki>{{#invoke:string/probas|find|</nowiki>''cadena''|''cerca''|''índex inicial''|''indicador text net''}}</code>
:<code><nowiki>{{#invoke:string/probas|find|source=</nowiki>''cadena''|target=''cerca''|start=''índex inicial''|plain=''indicador text net''}}</code>
Paràmetres:
:<code>source</code>: cadena on cercar
:<code>target</code>: cadena a cercar o patró de cerca
:<code>start</code>: índex de la cadena font on començar a cercar, per defecte 1, el primer caràcter.
:<code>plain</code>: 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 
:* {&#123;str find|abcdef|bcd}}  &nbsp;&nbsp;&nbsp;&nbsp;  &rarr; {{Str find0|abcdef|bcd}}
:* {&#123;str find|Fast Forward (film)|(}} &nbsp;&nbsp;  &rarr; {{Str find0|Fast Forward (film)|(}}
:* {&#123;str find|Fast Forward Longer (film)|(}} &rarr; {{Str find0|Fast Forward Longer (film)|(}}

:* {&#123;str find|A Funny Thing Happened on the Way to the Forum (film)|(}} &nbsp;&nbsp;  &rarr; {{Str find0|A Funny Thing Happened on the Way to the Forum (film)|(|1}}

:*  {&#123;str find|abcdef|x}} &nbsp;&nbsp;  &rarr; {{Str find0|abcdef|x}}
:*  {&#123;str find|abcdef|xyz}} &nbsp;&nbsp;  &rarr; {{Str find0|abcdef|xyz}}

=== <code>replace</code> ===
Permet reemplaçar una cadena o patró en una altra cadena.  >>> Es pot cridar amb '''{{tl|Str rep}}'''.
;Sintaxi:
:<code><nowiki>{{#invoke:string/probas|replace|</nowiki>''cadena''|''patró''|''reemplaçament''|''comptador''|''indicador text net''}}</code>
:<code><nowiki>{{#invoke:string/probas|replace|source=</nowiki>''cadena''|pattern=''patró''|replace=''reemplaçament''|count=''comptador''|plain=''indicador text net''}}</code>
Paràmetres:
:<code>source</code>: cadena on cercar
:<code>pattern</code>: cadena de cerca o patró a cercar
:<code>replace</code>: text de reemplaçament
:<code>count</code>: número d'ocurrències a reemplaçar, per defecte totes.
:<code>plain</code>: indica si la cerca s'ha d'interpretar com a text net, en cas contrari com a patró Lua. Per defecte és 'true'.
;Exemple
* <code><nowiki>{{str rep|Dogs chase cats|chase|love}}</nowiki></code> = {{str rep|Dogs chase cats|chase|love}}

=== <code>rep</code> ===
Repeteix la cadena un número de vegades.
:<code><nowiki>{{#invoke:string/probas|rep|</nowiki>''cadena''|''vegades''}}</code>    '''{{tl|loop}}''' 
Paràmetres:
:<code>cadena</code>: cadena a repetir
:<code>vegades</code>: número de vegades a repetir
;Exemple
*<nowiki>{{loop|n|4}}</nowiki> produeix  {{loop|n|4}}
*<nowiki>{{loop|test|25 }}</nowiki> produeix {{loop|test|25}}
*<nowiki>{{loop|1==|2=9}}</nowiki> produeix {{loop|1==|2=9}}  (el "1=" ha de ser present)

=== <code>strip</code> ===
Suprimeix caràcters de la cadena.  >>> Es pot cridar amb '''{{tl|Str strip}}'''.
;Sintaxi:
:<code><nowiki>{{#invoke:string/probas|strip|</nowiki>''cadena''|''caràcters''|''text_pla''}}</code>
:<code><nowiki>{{#invoke:string/probas|strip|source=</nowiki>''cadena''|chars=''caràcters''|plain=''text_pla''}}</code>
Paràmetres:
:<code>source</code>: La cadena a tractar
:<code>chars</code>: El patró o llista de caràcters a suprimir de la cadena
:<code>plain</code>: 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.

=== <code>split</code> ===
Trosseja una cadena segons un separador, i retorna el tros n-èssim, segons l'índex donat.   >>> Es pot cridar amb '''{{tl|Str split}}'''.
;Sintaxi:
:<code><nowiki>{{#invoke:string/probas|split|</nowiki>''cadena''|''separador''|''índex''}}</code>
:<code><nowiki>{{#invoke:string/probas|split|</nowiki>source=''cadena''|separator=''separador''|count=''índex''}}</code>
Paràmetres:
:<code>source</code>: La cadena a tractar
:<code>separator</code>: El separador pel qual s'ha de trossejar la cadena. Quan el separador sigui un espai o algun caràcter wikitext, com ["[", cal indicar-lo entre cometes, que s'ignoren com a part de la selecció.
:<code>count</code>: L'índex del tros a retornar
;exemple
* <code><nowiki>{{Str split |This is a piece of text to be split | }}</nowiki></code> → {{#invoke:string/probas|split|This is a piece of text to be split | }}  → (antigo):{{Str split |This is a piece of text to be split | }} 
* <code><nowiki>{{Str split |This is a piece of text to be split | |4}}</nowiki></code> 
: invoke GL old → {{#invoke:stringFunc|split|This is a piece of text to be split | |4}} 
: str split GL old → {{str split|This is a piece of text to be split | |4}} 
: invoke GL probas → {{#invoke:string/probas|split|This is a piece of text to be split | |4}}
: str split GL probas → {{String/probas |This is a piece of text to be split |" "|4}}
----


* <code><nowiki>{{Str split |Apples, pears, oranges; Cats, dogs|,|2}}</nowiki></code>{{#invoke:string/probas|split |Apples, pears, oranges; Cats, dogs|,|2|}}   → (antigo):{{Str split |Apples, pears, oranges; Cats, dogs|,|2}}
* <code><nowiki>{{Str split |Apples, pears, oranges; Cats, dogs|,|4}}</nowiki></code>{{#invoke:string/probas|split |Apples, pears, oranges; Cats, dogs|,|4|}}  → (antigo):{{Str split |Apples, pears, oranges; Cats, dogs|,|4}}

=== <code>isNumber</code> ===
Estableix si la cadena és un nombre.   >>> Es pot cridar amb '''{{tl|Str IsNumber}}'''.
;Sintaxi:
:<code><nowiki>{{#invoke:string/probas|isNumber|</nowiki>''cadena''}}</code>
:<code><nowiki>{{#invoke:string/probas|isNumber|source=</nowiki>''cadena''}}</code>
Paràmetres:
:<code>source</code>: La cadena a tractar
;Exemple
* <code><nowiki>{{#invoke:string/probas|isNumber|1.327,50}}</nowiki></code> -->  {{#invoke:string/probas|isNumber|1.327,50 }}
* <code><nowiki>{{#invoke:string/probas|isNumber|{{formatnum:1.327,50|R}} }}</nowiki></code> -->  {{#invoke:string/probas|isNumber|{{formatnum:1.327,50|R}} }}
* <code><nowiki>{{#invoke:string/probas|isNumber|9,999 (1950)}}</nowiki></code> -->  {{#invoke:string/probas|isNumber|9,999 (1950)}}
* <code><nowiki>{{#invoke:string/probas|isNumber|9999999999999}}</nowiki></code> -->  {{#invoke:string/probas|isNumber|9999999999999}}
* <code><nowiki>{{#invoke:string/probas|isNumber|500 metres}}</nowiki></code> -->  {{#invoke:string/probas|isNumber|500 metres}}
* <code><nowiki>{{#invoke:string/probas|isNumber|500*500}}</nowiki></code> -->  {{#invoke:string/probas|isNumber|500*500}}
* <code><nowiki>{{#invoke:string/probas|isNumber|e<>pi}}</nowiki></code> -->  {{#invoke:string/probas|isNumber|e<>pi}}
* <code><nowiki>{{#invoke:string/probas|isNumber|9.999e50}}</nowiki></code> -->  {{#invoke:string/probas|isNumber|9.999e50}}
* <code><nowiki>{{#invoke:string/probas|isNumber|1+1}}</nowiki></code> -->  {{#invoke:string/probas|isNumber|1+1}}

=== <code>count</code> ===
:{#invoke:string/probas|count|aabbcc|a}}: {{#invoke:string/probas|count|aabbcc|a}} --nombre de a
:{#invoke:string/probas|count|aabbcc|z}} :{{#invoke:string/probas|count|aabbcc|z}} --nombre de z
:{#invoke:string/probas|count|aabbcc|[ac]|plain=false}} : {{#invoke:string/probas|count|aabbcc|[ac]|plain=false}} --nombre de a ou de c
:{#invoke:string/probas|count|11-aa-2587|[0-9]|plain=false}} : {{#invoke:string/probas|count|11-aa-2587|[0-9]|plain=false}} --nombre de chiffres
:{#invoke:string/probas|count|Il était une fois| |plain=true}} : {{#invoke:string/probas|count|Il était une fois| |plain=true}} --nombre de blancs
:{#invoke:string/probas|count|Il était une fois|[ ]|plain=false}} : {{#invoke:string/probas|count|Il était une fois|[ ]|plain=false}} --nombre de blancs
=== join ===
Une as cadeas pasadas como argumentos nunha cadea, tratando o primeiro parámetro como separador

;Uso:
: <code><nowiki>{{#invoke:</nowiki>String|join|''separator''|''string1''|''string2''|...}}</code>

;Exemplos:
* <code><nowiki>"{{#invoke:String|join|x|foo|bar|baz}}"</nowiki></code> → "{{#invoke:String/probas|join|x|foo|bar|baz}}"
* <code><nowiki>"{{#invoke:String|join||a|b|c|d|e|f|g}}"</nowiki></code> → "{{#invoke:String/probas|join||a|b|c|d|e|f|g}}"
* <code><nowiki>"{{#invoke:String|join|,|a|b|c|d|e|f|g}}"</nowiki></code> → "{{#invoke:String/probas|join|,|a|b|c|d|e|f|g}}"
* <code><nowiki>"{{#invoke:String|join|, |a|b|c|d|e|f|g}}"</nowiki></code> → "{{#invoke:String/probas|join|, |a|b|c|d|e|f|g}}"
* <code><nowiki>"{{#invoke:String|join| &ndash; |a|b|c|d|e|f|g}}"</nowiki></code> → "{{#invoke:String/probas|join| &ndash; |a|b|c|d|e|f|g}}"

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

;Uso:
: <code><nowiki>{{#invoke:</nowiki>String|endswith|''source_str''|''pattern_string''}}</code>

OU

: <code><nowiki>{{#invoke:</nowiki>String|endswith|source= ''source_string'' |pattern= ''pattern_string''}}</code>

;Exemplos:
* <code><nowiki>"{{#invoke:String|endswith|xxxyyy|y}}"</nowiki></code> → "{{#invoke:String/probas|endswith|xxxyyy|y}}"
* <code><nowiki>"{{#invoke:String|endswith|xxxyyy|z}}"</nowiki></code> → "{{#invoke:String/probas|endswith|xxxyyy|z}}"
; casos extremos
* <code><nowiki>"{{#invoke:String|endswith||}}"</nowiki></code> → "{{#invoke:String/probas|endswith||}}"
* <code><nowiki>"{{#invoke:String|endswith||&#32;}}"</nowiki></code> → "{{#invoke:String/probas|endswith||&#32;}}"
* <code><nowiki>"{{#invoke:String|endswith|&#32;|}}"</nowiki></code> → "{{#invoke:String/probas|endswith|&#32;|}}"
<includeonly>
<!-- Coloca as categorías aquí e borra esta liña. Lembra que agora os interwikis van no Wikidata. -->
<!-- [[Category:<nome da categoría>]] -->
</includeonly>