Help:Extension:ParserFunctions/de

Die Erweiterung bietet elf zusätzliche Parserfunktionen, um die "Magic words" zu ergänzen, die es in MediaWiki bereits gibt. (Sie kann konfiguriert werden, um zusätzliche Parser-Funktionen zur Vearbeitung von Strings zur Verfügung zu stellen, diese sind dokumentiert.) Alle Funktionen, die diese Erweiterung unterstützt, haben folgende Form:

#expr
Diese Funktion berechnet einen mathematischen Ausdruck und gibt den errechneten Wert aus. Diese Funktion steht über die -Funktion auch in  zur Verfügung.



Die verfügbaren Operatoren sind rechts aufgelistet, in der Reihenfolge ihrer Anwedung. Siehe Help:Calculation (englisch) für nähere Details über die Funktion der einzelnen Operatoren. Genauigkeit und Format des ausgegebenen Ergebnisses hängen vom Betriebssystem des Wikiservers sowie dem Zahlenformat der eingestellten Sprache ab.

Bei Nutzung der Booleschen Algebra ergibt 0 immer  und jeder andere Wert, ob positiv oder negativ, immer  :



Ein leerer eingegebener Ausdruck erzeugt eine leere Ausgabe. Ungültige Ausdrücke erzeugen eine von mehreren möglichen Fehlermeldungen, die durch Nutzung der Funktion  abgefangen werden können:



Die Reihenfolge der Additions- und Subtraktionsoperanden vor oder nach einer Zahl ist bedeutend und kann als positiver oder negativer Wert eingesetzt werden anstelle eines Operanden mit fehlerhafter Eingabe:



Note, if using the output of magic words, you must raw-format them in order to remove commas and translate the numerals. For example, results in, where we want 0, which can be obtained using. This is especially important in some languages, where numerals are translated. For example, in Bengali, produces ৩০,০৬১.



Runden
Rundet die Zahl links auf ein vielfaches von 1/10 hoch den gekürzten Wert der Zahl rechts.

Um auf- oder abzurunden benutze  bzw. .

Strings
Die Ausdrücke funktionieren nur mit zahlenähnlichen Werten, denn sie können nicht Funktionen oder Zeichen vergleichen. kann stattdessen verwendet werden.



#if
Diese Funktion wertet einen Testring aus und stellt fest, ob er leer ist oder nicht. Ein Teststring, der nur Leerzeichen enthält, wird als leer betrachtet.





Diese Funktion testet zuerst, ob der erste Parameter nicht leer ist. Wenn der erste Parameter nicht leer ist, zeigt die Funktion den zweiten Parameter. Wenn der erste Parameter leer ist oder nur Weißraumzeichen enthält (Leerzeichen, neue Zeilen etc.), wird der dritte Parameter ausgegeben.



Der Testausdruck wird immer als reiner Text interpretiert, also werden mathematische Ausdrücke nicht evaluiert:



Der letzte Parameter (false) kann weggelassen werden:



The function may be nested. To do so, nest the inner #if function in its full form in place of a parameter of the enclosing #if function. Up to seven levels of nesting is possible, although that may depend on the wiki or a memory limit.

You can also use a parameter as the test string in your #if statement. You need to ensure you add the  (pipe symbol) after the name of the variable. (So that if the parameter does not have a value, it evaluates to an empty string instead of the string " ".)



Siehe für weitere Beispiele zu dieser Parserfunktion.

#ifeq
This parser function compares two input strings, determines whether they are identical, and returns one of two strings based on the result. If more comparisons and output strings are required, consider using.



Wenn beide Ausdrücke gültige numerische Werte sind, werden die Ausdrücke zahlenmäßig verglichen:



Andernfalls wird der Vergleich textmäßig vollzogen, dieser Vergleich beachtet die Groß- und Kleinschreibung:


 * →  (vergleiche mit dem ähnlichen Beispiel oben, aber ohne Anführungszeichen)
 * →  (vergleiche mit dem ähnlichen Beispiel oben, wo   eine gültige erste Zahl anzeigt)
 * →  (vergleiche mit dem ähnlichen Beispiel oben, aber ohne Anführungszeichen)
 * →  (vergleiche mit dem ähnlichen Beispiel oben, wo   eine gültige erste Zahl anzeigt)

As a practical example, consider an existing   using the parser to choose between two standard times, short and long. It takes the parameter as the first input to compare against the string "short" – there is no convention for the order, but it is simpler to read if the parameter goes first. The template code is defined as:



the following ensue:


 * → 20
 * → 40
 * → 40

#iferror
Diese Funktion überprüft, ob der eingegebene Ausdruck einen Fehler erzeugt. Die Funktion gibt  aus, wenn der Ausdruck ein HTML-Objekt mit   enthält, wie es z.B. von den Funktionen ,   und   bei Fehlern ausgegeben wird. Auch Vorlagenfehler wie Rekursionsschleifen werden erkannt.



Die Ausgabe-Parameter können auch weggelassen werden. Wenn der Parameter für  weggelassen wird, wird der zu überprüfende Ausdruck ausgegeben, sofern er keinen Fehler enthält. Wenn der Ausdruck für  ebenfalls weggelassen wird, wird bei einem Fehler nichts ausgegeben.


 * → &zwnj;
 * → &zwnj;
 * → &zwnj;
 * → &zwnj;
 * → &zwnj;
 * → &zwnj;

#ifexpr
Diese Funktion berechnet einen mathematischen Ausdruck und gibt – abhängig vom Wahrheitswert des Ergebnisses – einen von zwei Werten aus.



Für den Ausdruck  gelten dabei dieselben Regeln wie bei. Nach der Berechnung überprüft die Funktion, ob das Ergebnis ungleich Null ist (Boolesch: true = 1/false = 0).

Eine leere Eingabe führt zur Ausgabe :



Wie gesagt führt das Ergebnis Null zur Ausgabe, jeder andere Wert hingegen zur Ausgabe. Es handelt sich also praktisch um eine Kombination von  und  :



außer für einen leeren oder falsch eingegebenen Ausdruck (eine Fehlermeldung wird wie ein leerer Ausdruck behandelt; es ist nicht gleich Null, also bekommen wir ).

vergleichend

Beide Parameter können auch weggelassen werden, in diesem Fall wird jeweils nichts ausgegeben:



#ifexist
Diese Funktion überprüft, ob eine bestimmte Seite im Wiki existiert, und gibt je nachdem einen von zwei Parametern aus.



Die Funktion überprüft nur, ob die Seite existiert , und nicht, ob sie irgendeine Form von Inhalt enthält. Auch Weiterleitungen werden als existente Seiten gewertet. Gelöschte Seiten gelten als nicht existent.



MediaWiki-Systemnachrichten gelten so lange als nicht existent , bis sie bearbeitet werden. Auch die Existenz von Spezialseiten kann überprüft werden.



Wenn eine Seite A die Existenz einer Seite B mittels  überprüft, taucht Seite A auf der Spezialseite |Spezial:Links auf diese Seite für Seite B auf. Wenn also im Artikel Bla der Code   steht, wird auf Spezial:Links auf diese Seite/Blubb die Seite Bla aufgelistet.

In Wikis, die eine gemeinschaftliche Bilddatenbank nutzen (z.B. Wikimedia Commons), kann  benutzt werden, um zu überprüfen, ob Dateien im lokalen Wiki oder in der externen Bilddatenbank hochgeladen wurden.

Wenn die lokale Bildbeschreibungsseite angelegt wurde, ist das Resultat für all diese Tests existiert.

funktioniert nicht bei Interwiki-Links.

Grenzen von ifexist
wird als „aufwendige Parserfunktion“ eingestuft; nur eine bestimmte Anzahl von ihnen kann auf einer bestimmten Seite eingebunden werden (Funktionen in eingebundenen Vorlagen eingeschlossen). Wenn dieses Limit überschritten wird, geben weitere -Funktionen automatisch falsch zurück, unabhängig davon ob die Zielseite existiert oder nicht, und die Seite wird in Category: eingeordnet. Der Name der kann von der Inhaltssprache deines Wikis abhängen.

For some use cases it is possible to emulate the ifexist effect with css, by using the selectors  (to select links to unexisting pages) or   (to select links to existing pages). Furthermore, since the number of expensive parser functions that can be used on a single page is controlled by, one can also increase the limit in LocalSettings.php if needed.

ifexist and wanted pages
A page that does not exist and is tested for using #ifexist will end up on the Wanted Pages.

#rel2abs
Diese Funktion konvertiert einen relativen Pfad zu einem absoluten Pfad.



Within the  input, the following syntax is valid:
 * → the current level
 * → "go up one level"
 * → "go down one level into the subdirectory /foo"

If the  is not specified, the full page name of the page will be used instead:



Invalid syntax, such as  or , is ignored. Since no more than two consecutive full stops are permitted, sequences such as these can be used to separate successive statements:



#switch
This function compares one input value against several test cases, returning an associated string if a match is found.

Beispiele:




 * 1) switch with partial transclusion tags can effect a configuration file that enables an editor unfamiliar with template coding to view and edit configurable elements.

Default
The  is returned if no   string matches the  :



In this syntax, the default result must be the last parameter and must not contain a raw equals sign (an equals sign without ). If it does, it will be treated as a case comparison, and no text will display if no cases match. This is because the default value has not been defined (is empty). If a case matches however, its associated string will be returned.



Alternatively, the default result may be explicitly declared with a  string of " ".

Default results declared in this way may be placed anywhere within the function:



If the  parameter is omitted and no match is made, no   is returned:



Ergebnisse gruppieren
It is possible to have 'fall through' values, where several  strings return the same   string. This minimizes duplication.

Here cases 2, 3 and 4 all return ; cases 6 and 7 both return. The " " in the last parameter may be omitted in the above case.

Use with parameters
The function may be used with parameters as the test string. In this case, it is not necessary to place the pipe after the parameter name, because it is very unlikely that you will choose to set a case to be the string " ". (This is the value the parameter will default to if the pipe is absent and the parameter doesn't exist or have a value. See .)



In the above case, if  equals , the function will return. If it equals, the function will return. If the parameter is empty or does not exist, the function will return.

As in the section above, cases can be combined to give a single result.



Here, if  equals ,   or  , the function will return. If it equals, the function will return. If the parameter is empty or does not exist, the function will return.

Additionally, the default result can be omitted if you do not wish to return anything if the test parameter value does not match any of the cases.



In this case, the function returns an empty string unless  exists and equals   or , in which case it returns   or  , respectively.

This has the same effect as declaring the default result as empty.



If for some reason you decide to set a case as " ", the function will return that case's result when the parameter doesn't exist or doesn't have a value. The parameter would have to exist and have a value other than the string " " to return the function's default result.


 * (when  doesn't exist or is empty):
 * →  Foo 
 * (when  has the value " "):
 * →  Bar 
 * (when  has the value " "):
 * →  Foo 

In this hypothetical case, you would need to add the pipe to the parameter.

Vergleiche
As with, the comparison is made numerically if both the comparison string and the case string being tested are numeric; or as a case-sensitive string otherwise:





A  string may be empty:

Once a match is found, subsequent  are ignored:

Ist-Gleich-Zeichen
"Case" strings cannot contain raw equals signs. To work around this, create a template = containing a single equals sign:, or replace equals sign with html code.

Beispiel:





#ifeq ersetzen
can be used to reduce expansion depth.

Zum Beispiel: ist gleichbedeutend mit i.e. deep nesting, linear:

On the other hand, the switch replacement could be complicated/impractical for IFs nested in both branches (shown with alternatives of indentation, indented on both sides), making full symmetrical tree:

#time
Dies Parserfunktion nimmt ein Datum und/oder eine Zeit (im Gregorianischen Kalender) und formatiert es gemäß der gegebenen Syntax. Eine Datum/Zeit-Einheit kann bestimmt werden, der Standardwert ist der Wert des magischen Worts  – d.h. die Zeit, als die Seite zuletzt in HTML übersetzt wurde.



Die Liste der gültigen Formate ist der Tabelle rechts zu entnehmen. Jedes Zeichen im formatierten String, das nicht erkannt wird, wird unverändert ausgegeben; dies betrifft auch Leerzeichen (das System braucht diese nicht für das Interpretieren des Codes). Es gibt zwei Wege, Zeichen innerhalb des Formatierungs-Strings zu umgehen: Zusätzlich wird der Digraph  als einzelnes buchstäbliches "x" interpretiert.
 * 1) Ein linksseitiger Schrägstrich (Backslash) wird als einzelnes buchstäbliches Zeichen interpretiert
 * 2) Zeichen innerhalb doppelten Anführungszeichen werden als buchstäbliche Zeichen interpretiert und die Anführungszeichen entfernt.



Die  kann in jedem von der PHP-Funktion strtotime akzeptierten Format sein. Sowohl absolute (z.B. ) als auch relative (z.b.  ) Zeiten werden akzeptiert.


 * &rarr; 
 * &rarr; 
 * &rarr; 
 * &rarr; 
 * &rarr; 
 * &rarr; 
 * &rarr; 

Der  in ISO 639-3 (?) erlaubt die Anzeige der Zeichenkette in der gewählten Sprache



The  parameter specifies if the date/time object refers to the local timezone or to UTC.

This is a boolean parameters: its value is determined by casting the value of the argument (see the official PHP documentation for details on how string are cast to boolean values).

See the following examples for details:





Unix Zeitstempel können in Datumsrechnungen verwendet werden, indem ein  Symbol vorangestellt wird.



Es können vollständige oder Teile von absoluten Datumsangaben angegeben werden, die Funktion "füllt" die fehlenden Datumsteile mit den aktuellen Werten:



Eine 4-stellige Zahl wird immer als Jahr interpretiert, nie als Stunden und Minuten:



Eine sechsstellige Zahl wird wenn möglich als Stunden, Minuten und Sekunden interpretiert, aber andernfalls als Fehler (nicht z.B. als Jahr und Monat):


 * →  Die Eingabe wird als Zeit behandelt statt Jahr- & Monats-Code.
 * →  Obwohl 19:60:09 keine gültige Zeitangabe ist, wird 196009 nicht als September 1960 interpretiert.

Die Funktion führt eine gewisse Menge an Datums-Rechnungen durch:



Die Gesamtlänge der Formatierungszeichenkette der Funktion  ist auf 6000 Zeichen beschränkt.

Zeitzonenprobleme
There is a bug in this #time parser function (more specifically in PHP DateTime) that does not allow the passing-in of non-integers as relative time zone offsets. This issue does not apply when using an on-the-hour time zone, such as EDT. For example:


 * &rarr;

However, India is on a +5.5 hours time offset from UTC, and thus using its time zone will not normally allow the correct calculation of a relative time zone offset. Here's what happens:


 * &rarr;

To workaround this issue, simply convert the time into minutes or seconds, like this:


 * &rarr;
 * &rarr;

(Tim Starling, the developer of this function, provided the exact syntax for this solution.)

#timel
This function is identical to, when the   parameter is set to  , so it always uses the local time of the wiki (as set in ).

Syntax of the function is:





For instance, see the following examples:





#titleparts
This function separates a page title into segments based on slashes, then returns some of those segments as output.



If the number of segments to return parameter is not specified, it defaults to "0", which returns all the segments from the first segment to return (included). If the first segment to return parameter is not specified or is "0", it defaults to "1":


 * →  See also.
 * →  See also.

Negative values are accepted for both values. Negative values for the number of segments to return parameter effectively 'strips' segments from the end of the string. Negative values for the first segment to return translates to "start with this segment counting from the right":


 * →  Strips one segment from the end of the string. See also.
 * →   Strips all 4 segments from the end of the string
 * →   Strips 5 segments from the end of the string (more than exist)
 * →   Returns last segment. See also.
 * →   Strips one segment from the end of the string, then returns the second segment and beyond
 * →   Start copying at the second last element; strip one segment from the end of the string

Before processing, the pagename parameter is HTML-decoded: if it contains some standard HTML character entities, they will be converted to plain characters (internally encoded with UTF-8, i.e. the same encoding as in the MediaWiki source page using this parser function).


 * For example, any occurrence of,  , or   in pagename will be replaced by.
 * No other conversion from HTML to plain text is performed, so HTML tags are left intact at this initial step even if they are invalid in page titles.

Then the decoded pagename is canonicalized into a standard page title supported by MediaWiki, as much as possible:


 * 1) All underscores are automatically replaced with spaces:
 * →  Not bah_boo, despite the underscore in the original.
 * 1) The string is split a maximum of 25 times; further slashes are ignored and the 25th element will contain the rest of the string. The string is also limited to 255 characters, as it is treated as a page title:
 * If for whatever reason you needed to push this function to its limit, although very unlikely, it is possible to bypass the 25 split limit by nesting function calls:
 * 1) Finally the first substring is capitalized according to the capitalization settings of the local wiki (if that substring also starts by a local namespace name, that namespace name is also normalized).
 * 1) Finally the first substring is capitalized according to the capitalization settings of the local wiki (if that substring also starts by a local namespace name, that namespace name is also normalized).
 * 1) Finally the first substring is capitalized according to the capitalization settings of the local wiki (if that substring also starts by a local namespace name, that namespace name is also normalized).

{{Warning|1= Certain characters that are illegal in a page title will cause #titleparts to not parse the string:


 * → {{#titleparts: {one/two} | 1 | 1 }}. Führt nicht zum erwarteten: {one
 * → {{#titleparts: page/123 | 1 | 2 }}. Does not work because brackets are illegal in page titles and this parser function does not process links embedded in its input pagename parameter, even when they use the MediaWiki syntax, or any other HTML or MediaWiki tags.
 * → "{{#titleparts: red/#00FF00/blue| 1 | 3 }}". Does not work because "#" is also illegal in page titles.

}}

StringFunctions
All of these functions are now integrated into the ParserFunctions extension, but are only available if an administrator sets   in.

All of these functions operate in O(n) time complexity, making them safe against DoS attacks.

#len:
The #len function returns the length of the given string. The syntax is:

The return value is always a number of characters in the source string (after expansions of template invocations, but before conversion to HTML). If no string is specified, the return value is zero.

#pos:
The #pos function returns the position of a given search term within the string. The syntax is:

The offset parameter, if specified, tells a starting position where this function should begin searching.

If the search term is found, the return value is a zero-based integer of the first position within the string.

If the search term is not found, the function returns an empty string.

#rpos:
The #rpos function returns the last position of a given search term within the string. The syntax is:

If the search term is found, the return value is a zero-based integer of its last position within the string.

If the search term is not found, the function returns -1.

#sub:
The #sub function returns a substring from the given string. The syntax is:

The start parameter, if positive (or zero), specifies a zero-based index of the first character to be returned.

Example: returns.

returns.

If the start parameter is negative, it specifies how many characters from the end should be returned.

Example: returns.

The length parameter, if present and positive, specifies the maximum length of the returned string.

Example: returns.

If the length parameter is negative, it specifies how many characters will be omitted from the end of the string.

Example: returns.

If the start parameter is negative, it specifies how many characters from the end should be returned. The length parameter, if present and positive, specifies the maximum length of the returned string from the starting point.

Example: returns.

#replace:
The #replace function returns the given string with all occurrences of a search term replaced with a replacement term.

If the search term is unspecified or empty, a single space will be searched for.

If the replacement term is unspecified or empty, all occurrences of the search term will be removed from the string.

Currently the syntax doesn't provide a switch to toggle case-sensitivity setting. But you may make use of magic words of formatting (e.g. your_string_here ) as a workaround. For example, if you want to remove the word "Category:" from the string regardless of its case, you may type:
 * Case-insensitive replace

But the disadvantage is that the output will become all lower-case. If you want to keep the casing after replacement, you have to use multiple nesting levels (i.e. multiple replace calls) to achieve the same thing.

#explode:
The #explode function splits the given string into pieces and then returns one of the pieces. The syntax is:

The delimiter parameter specifies a string to be used to divide the string into pieces. This delimiter string is then not part of any piece, and when two delimiter strings are next to each other, they create an empty piece between them. If this parameter is not specified, a single space is used. The limit parameter is available in ParserFunctions only, not the standalone StringFunctions version, and allows you to limit the number of parts returned, with all remaining text included in the final part.

The position parameter specifies which piece is to be returned. Pieces are counted from 0. If this parameter is not specified, the first piece is used (piece with number 0). When a negative value is used as position, the pieces are counted from the end. In this case, piece number -1 means the last piece. Examples:


 * returns.
 * returns.
 * returns.
 * returns.

The return value is the position-th piece. If there are fewer pieces than the position specifies, an empty string is returned.

Limits
This module defines three global settings:


 * 
 * 
 * 

These are used to limit some parameters of some functions to ensure the functions operate in O(n) time complexity, and are therefore safe against DoS attacks.

$wgStringFunctionsLimitSearch
This setting is used by #pos, #rpos, #replace, and #explode. All these functions search for a substring in a larger string while they operate, which can run in O(n*m) and therefore make the software more vulnerable to DoS attacks. By setting this value to a specific small number, the time complexity is decreased to O(n).

This setting limits the maximum allowed length of the string being searched for.

The default value is 30 multibyte characters.

$wgStringFunctionsLimitReplace
This setting is used by #replace. This function replaces all occurrences of one string for another, which can be used to quickly generate very large amounts of data, and therefore makes the software more vulnerable to DoS attacks. This setting limits the maximum allowed length of the replacing string.

The default value is 30 multibyte characters.

Substitution
Parser functions can be substituted by prefixing the hash character with :


 * → the code   will be inserted in the wikitext since the page exists.

Substitution does not work within, you can use &hellip;  for this purpose.

Weiterleitungen
Especially   could be handy in  to pages including dates, but this does not work.

Escaping pipe characters in tables
Parser functions will mangle syntax and pipe characters, treating all the raw pipe characters as parameter dividers. To avoid this, most wikis used a template    :! with its contents only a raw pipe character, since MW 1.24 a  replaced this kludge. This 'hides' the pipe from the MediaWiki parser, ensuring that it is not considered until after all the templates and variables on a page have been expanded. It will then be interpreted as a table row or column separator. Alternatively, raw HTML table syntax can be used, although this is less intuitive and more error-prone.

You can also escape the pipe character for display as a plain, uninterpreted character using an HTML entity:.

Stripping whitespace
Whitespace, including newlines, tabs, and spaces, is stripped from the beginning and end of all the parameters of these parser functions. If this is not desirable, comparison of strings can be done after putting them in quotation marks.



To prevent the trimming of then and else parts, see m:Template:If. Some people achieve this by using &lt; &gt;  &lt; /nowiki &gt; instead of spaces.


 * → foofoo
 * → foofoo

However, this method can be used to render a single whitespace character only, since the parser squeezes multiple whitespace characters in a row into one.




 * || → || foofoo 
 * }

In this example, the  style is used to force the whitespace to be preserved by the browser, but even with it the spaces are not shown. This happens because the spaces are stripped by the software, before being sent to the browser.

It is possible to workaround this behavior replacing whitespaces with  (breakable space) or   (non-breakable space), since they are not modified by the software:


 * →  foofoo 
 * → foofoo

Siehe auch

 * m:Help:Calculation
 * m:Help:Newlines and spaces
 * m:Help:Comparison between ParserFunctions syntax and TeX syntax
 * Module:String löst ab
 * Module:String löst ab
 * Module:String löst ab