Modul:string/doc

E modulnak az a célja, hogy alapvető string függvényeket biztosítson unikódban kódolt stringekre. Ezeket az {{#invoke: String|stringfüggvény neve| paraméter | paraméter...}} sablonnal tudjuk aktiválni. A paraméterek száma, neve a függvény nevével összefüggésben változó.

A legtöbb itt bemutatott funkció nevesített, névtelen paraméterekkel, illetve ezek keverékével hívható meg. A névvel adott paraméterek jellemzője, hogy a paraméter karakterei előtt és után álló szóköz értékű (whitespace) karaktekreket lehántolja a paraméterről a MediaWiki. Azonban a felhasználó szándékától függően előnyös lehet, ha ezeket a MediaWiki nem távolítja el. Erre szolgál: a(z esetleg implicite) számozott paramétereknél nincs semmiféle lehántolás, a bevezető és követő szóközök változatlanul a paraméter részei maradnak.

Globális opciók:

• ignore_errors: Ha értéke true vagy 1, akkor nem hibaüzenettel tér vissza a függvény, hanem a hibát ignorálva üres stringet ad vissza.
• error_category: Hiba esetén meghatározza a hibaüzenetbe beépítendő hibakategória nevét. Az alapértelmezett kategória a Kategória:Errors reported by Module String.
• no_category: Ha értéke true vagy 1, akkor nem fog kategória szerepelni a hibaüzenetben.