Manual:Parser functions/de

Parserfunktionen, die in MediaWiki 1.7 hinzugefügt wurden, sind eine Art Erweiterung, die eng mit dem Parser integrieren. Der Begriff Parserfunktionen, sollte nicht mit Erweiterung:Parserfunktionen verwechselt werden, das ist eine Sammlung von einfachen Parserfunktionen.

Beschreibung
Whereas a Tag extension is expected to take unprocessed text and return HTML to the browser, a parser function can 'interact' with other wiki elements in the page. For example, the output of a parser function could be used as a template parameter or in the construction of a link.

Die typische Syntax für eine Parserfunktion lautet:

For more information, see for. This documentation states:
 * The callback function should have the form:
 * Or with :
 * Or with :

Erstellen einer Parserfunktion ist etwas komplizierter als die Schaffung eines neuen Tag, weil der Name der Funktion ein magisches Wort sein muss — ein Schlüsselwort, das Aliases und Lokalisierung unterstützt.

Einfaches Beispiel
Unten ist ein Beispiel von einer Erweiterung, die eine Parserfunktion erstellt.

Diese Datei sollte ExampleExtension.php genannt werden, wenn der Name Ihrer Erweiterung ExampleExtension ist :

Eine weitere Datei, ExtensionName.i18n.magic.php, sollte enthalten:

Mit dieser Erweiterung aktiviert,



produziert:


 * param1 is hello and param2 is hi and param3 is hey

This magicWords array is not optional. If it is omitted, the parser function simply will not work; the will be rendered as though the extension were not installed.

Mehr Funktionen
Für mehr Funktionen, können Sie die Hook-Funktionen in eine _body.php oder Hooks.php Datei aufteilen und statische Funktionen von einer Klasse machen.

Dann können Sie die Klasse mit $wgAutoloadClasses laden und rufen die statischen Funktionen in den Hooks, z.B.:

Setzen Sie diese in Ihre  Datei: Dann setzen Sie diese in Ihre   Datei:
 * See: writing an event handler for other styles.

Zwischenspeicherung
Wie bei Tag-Erweiterungen, $parser->disableCache kann verwendet werden, um den Zwischenspeicher (Cache) für dynamische Erweiterungen zu deaktivieren.

Steuerung des geparsten der Ausgabe
Um den Wikitext von Ihrer Parserfunktion zurückgegeben zu lassen, vollständig analysiert werden (einschließlich Erweiterung der Vorlagen), setzen Sie die noparse Option auf false bei der Rückkehr Es scheint, der Standardwert für noparse ändert von false auf true, zumindest in einigen Situationen, irgendwann um Version 1.12.

Umgekehrt, damit Ihre Parserfunktion HTML zurückgibt das ungeparsed bleibt, anstatt sie direkt Wikitext zurück gibt, benutzen Sie dies: Allerdings, Dies ist ein Test. produziert so etwas wie das:

This is

param1 ist hallo und param2 ist hi ein Test.

Dies geschieht aufgrund einer fest programmierten "\n\n", die auf der HTML-Ausgabe von Parserfunktionen vorangestellt wird. Um dies zu vermeiden, stellen Sie sicher, dass und der HTML-Code gerendert wird inline mit dem umgebenden Text, können Sie dies nutzen:

Benennung
Standardmäßig fügt MW einen Hash-Zeichen (Anzahlzeichen "#") auf den Namen der jeweiligen Parserfunktion.

Um diese Hinzufügung zu unterdrücken (und eine Parserfunktion ohne "#"-Präfix zu erhalten), gehören die SFH_NO_HASH Konstante in den optionalen Flags-Argument setFunctionHook, wie unten beschrieben.

Bei der Wahl eines Namens ohne einen Hash-Präfix, beachten Sie dass Vorlageneinbindung einer Seite mit einem Namen, der mit diesem Namen der Funktion gefolgt von einem Doppelpunkt nicht mehr möglich ist. Vermeiden Sie insbesondere Funktionsnamen gleich einem Namensraum-Namen. Für den Fall, dass Interwiki Vorlageneinbindung aktiviert ist, vermeiden Sie auch, Funktionsnamen gleich einer Interwiki-Präfix.

Der setFunctionHook Hook
Für weitere Einzelheiten der Schnittstelle in den Parser, sehen Sie in der Dokumentation für setFunctionHook in includes/Parser.php nach. Hier ist eine (möglicherweise datierte) Kopie dieser Stellungnahmen:

function setFunctionHook( $id, $callback, $flags = 0 ) Parameter:


 * string $id - Die magische Wort ID
 * mixed $callback - Die Callback-Funktion (und Objekt) das verwendet werden sollte
 * integer $flags - Optional, set it to the SFH_NO_HASH constant to call the function without "#".

Rückgabewert: Die alte Callback-Funktion für diesen Namen, wenn überhaupt

Create a function, e.g.,. The callback function should have the form:

The callback may either return the text result of the function, or an array with the text in element 0, and a number of flags in the other elements. The names of the flags are specified in the keys. Valid flags are:


 * found : The text returned is valid, stop processing the template. This is on by default.
 * nowiki : Wiki markup in the return value should be escaped
 * noparse : Unsafe HTML tags should not be stripped, etc.
 * noargs : Don't replace triple-brace arguments in the return value
 * isHTML : The returned text is HTML, armour it against wikitext transformation

Named parameters
Parser functions do not support named parameters the way templates and tag extensions do, but it is occasionally useful to fake it. Users are often accustomed to using vertical bars ( | ) to separate arguments, so it's nice to be able to do that in the parser function context, too. Here's a simple example of how to accomplish this.

Your callback function typically looks like this: To fake named parameters, simply omit all the arguments after, and pair it with. Here is an example: