Redigerer Modul:String/dok

{{Dokumentasjonsunderside}}
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandkasse||{{#ifeq:{{SUBPAGENAME}}|dok||{{Beskyttet side
| grunn = sentral modul
| liten = ja
}}
{{Mye brukt mal|over 230 000}}}}}}</includeonly>
Denne modulen er tenkt å gi tilgang til grunnleggende ''string''-funksjoner.

De fleste funksjonene gitt av denne modulen kan kalles med navngitte parametre, ubenevnte parametre, eller en blanding. Hvis navngitte parametre brukes, vil Mediawiki automatisk fjerne eventuelle mellomrom før eller etter parameteren. Avhengig av bruksområde, kan det være fordelaktig å enten bevare eller fjerne denne type mellomrom.

{{#invoke:convert/tester|compare|str}}

== Globale valg ==
; ignore_errors
: Hvis satt til 'true' eller '1', vil en feilsituasjon returnere en tom tekststreng fremfor en feilmelding
; error_category
: Hvis en feil oppstår, angis navnet til en kategori som skal inkluderes med feilmeldingen. Standardkategorien er [[:Kategori:Feilmeldinger fra String-modulen]].
; no_category
: Hvis satt til 'true' eller '1', vil det ikke returneres noen kategori når en feil genereres.

Testside for denne modulen finnes på [[Modul:String/testtilfeller]].

== len ==
:Denne funksjonen returnerer lengden for målstrengen.

Bruk:

: <code><nowiki>{{#invoke:</nowiki>String|len|''målstreng''}}</code>

eller

: <code><nowiki>{{#invoke:</nowiki>String|len|s= ''målstreng'' }}</code>

Parametre:

; s
: Strengen hvis lengde skal returneres

== sub ==
:Denne funksjonen returnerer en substreng av målstrengen ved gitte indekser.

Bruk:

: <code><nowiki>{{#invoke:</nowiki>String|sub|''målstreng''|''startindeks''|''sluttindes''}}</code>

eller

: <code><nowiki>{{#invoke:</nowiki>String|sub|s= ''målstreng'' |i= ''startindeks'' |j= ''sluttindeks'' }}</code>

Parametre:

; s
: Strengen som det skal returneres en del av
; i
: Første indeks av substrengen som skal returneres. Standard er satt til 1.
; j
: Siste indeks av substrengen som skal returneres. Standard er siste tegn.

Det første tegnet i strengen er gitt en indeks på 1. Hvis enten ''i'' eller ''j'' har negativ verdi, tilsvarer det å velge et tegn ved å telle fra slutten og mot starten av strengen. Det vil si at en verdi på -1 er det samme som å velge det siste tegnet i strengen.


Hvis de forespurte indeksene er utenfor rekkevidde for den gitte strengen, genereres det en feilmelding.

== sublength ==

This function implements the features of {{tl|Str sub old}} and is kept in order to maintain these older templates.

== match ==

This function returns a substring from the source string that matches a specified pattern.

Usage:

: <code><nowiki>{{#invoke:</nowiki>String|match|''source_string''|''pattern_string''|''start_index''|''match_number''|''plain_flag''|''nomatch_output''}}</code>

OR

: <code><nowiki>{{#invoke:</nowiki>String|match|s= ''source_string'' |pattern= ''pattern_string'' |start= ''start_index''|match= ''match_number''|plain= ''plain_flag'' |nomatch= ''nomatch_output'' }}</code>

Parameters:

; s
: The string to search
; pattern
: The pattern or string to find within the string
; start
: The index within the source string to start the search.  The first character of the string has index 1.  Defaults to 1.
; match
: In some cases it may be possible to make multiple matches on a single string.  This specifies which match to return, where the first match is match= 1.  If a negative number is specified then a match is returned counting from the last match.  Hence match = -1 is the same as requesting the last match.  Defaults to 1.
; plain
: A flag indicating that the pattern should be understood as plain text.  Defaults to false.
; nomatch
: If no match is found, output the "nomatch" value rather than an error.

If the match_number or start_index are out of range for the string being queried, then this function generates an error.  An error is also generated if no match is found.
If one adds the parameter ignore_errors=true, then the error will be suppressed and an empty string will be returned on any failure.

For information on constructing [[w:en:Lua (programming language)|Lua]] patterns, a form of [[w:en:regular expression|regular expression]], see:

* [[mw:Extension:Scribunto/Lua_reference_manual#Patterns|Scribunto patterns]]
* [[mw:Extension:Scribunto/Lua_reference_manual#Ustring_patterns|Scribunto Unicode string patterns]]

== pos ==

This function returns a single character from the target string at position pos.

Usage:

: <code><nowiki>{{#invoke:</nowiki>String|pos|''target_string''|''index_value''}}</code>

OR

: <code><nowiki>{{#invoke:</nowiki>String|pos|target= ''target_string'' |pos= ''index_value'' }}</code>

Parameters:

; target
: The string to search
; pos
: The index for the character to return

The first character has an index value of 1.

If one requests a negative value, this function will select a character by counting backwards
from the end of the string.  In other words pos = -1 is the same as asking for the last character.

A requested value of zero, or a value greater than the length of the string returns an error.

== str_find ==

This function duplicates the behavior of {{tl|str_find}}, including all of its quirks. This is provided in order to support existing templates, but is NOT RECOMMENDED for new code and templates.  New code is recommended to use the "find" function instead.

Returns the first index in "source" that is a match to "target".  Indexing is 1-based, and the function returns -1 if the "target" string is not present in "source".

Important Note: If the "target" string is empty / missing, this function returns a value of "1", which is generally unexpected behavior, and must be accounted for separatetly.

== find ==

This function allows one to search for a target string or pattern within another string.

Usage:

: <code><nowiki>{{#invoke:</nowiki>String|find|''source_str''|''target_string''|''start_index''|''plain_flag''}}</code>

OR

: <code><nowiki>{{#invoke:</nowiki>String|find|source= ''source_str'' |target= ''target_str'' |start= ''start_index''|plain= ''plain_flag'' }}</code>

Parameters:

; source
: The string to search
; target
: The string or pattern to find within source
; start
: The index within the source string to start the search, defaults to 1
; plain
: Boolean flag indicating that target should be understood as plain text and not as a [[w:en:Lua (programming language)|Lua]]-style [[w:en:regular expression|regular expression]], defaults to true

This function returns the first index >= "start" where "target" can be found within "source".  Indices are 1-based.  If "target" is not found, then this function returns 0.  If either "source" or "target" are missing / empty, this function also returns 0.

This function should be safe for UTF-8 strings.

== replace ==

This function allows one to replace a target string or pattern within another string.

Usage:

: <code><nowiki>{{#invoke:</nowiki>String|replace|''source_str''|''pattern_string''|''replace_string''|''replacement_count''|''plain_flag''}}</code>

OR

: <code><nowiki>{{#invoke:</nowiki>String|replace|source= ''source_string'' |pattern= ''pattern_string''|replace= ''replace_string'' |count= ''replacement_count'' |plain= ''plain_flag'' }}</code>

Parameters:

; source
: The string to search
; pattern
: The string or pattern to find within source
; replace
: The replacement text
; count
: The number of occurrences to replace; defaults to all
; plain
: Boolean flag indicating that pattern should be understood as plain text and not as a [[mw:Extension:Scribunto/Lua reference manual#Ustring patterns|Scribunto ustring pattern]] (a unicode-friendly [[w:en:Lua (programming language)|Lua]]-style [[w:en:regular expression|regular expression]]); defaults to true

== rep ==

Repeats a string ''n'' times. A simple function to pipe string.rep to templates.
Usage:

: <code><nowiki>{{#invoke:</nowiki>String|rep|''source''|''count''}}</code>

Parameters:

; source
: The string to repeat
; count
: The number of repetitions.

Example <code><nowiki>{{#invoke:String|rep|hello|3}}</nowiki></code> gives {{#invoke:String|rep|hello|3}}<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||

[[Kategori:Metamoduler|String, {{PAGENAME}}]]

}}</includeonly>