Manual:Developing extensions/de



Jede extension besteht aus drei Teilen:


 * 1) Einrichtung
 * 2) Ausführung
 * 3) Lokalisierung

Eine minimale Erweiterung besteht aus drei Dateien. Für jeden Bereich eine:


 * MyExtension/extension.json: Speichert die setup-Anleitung. Der Dateiname muss "extension.json" lauten. (Vor MediaWiki 1.25 befanden sich die Setup-Anweisungen in einer -Datei, die nach der Erweiterung benannt wurde. Viele Erweiterungen haben in dieser PHP-Datei noch Abwärtskompatibilitäten.)
 * MyExtension/MyExtension.php: Enthält den auszuführenden Code für die Erweiterung. Der Dateiname MyExtension.php ist üblich, aber nicht zwingend vorgeschrieben. Wenn deine Erweiterung komplex ist und viele PHP-Dateien beinhaltet, solltest du die Konvention einhalten, diesen Code in einem Unterverzeichnis  abzulegen (auch wenn die Erweiterungen Example und BoilerPlate dieser Konvention nicht folgen). Siehe z. B. die SemanticMediaWiki-Erweiterung.
 * MyExtension/i18n/*.json: Enthält Lokalisierungsinformation für die Erweiterung.

Wenn du eine Erweiterung entwickelst, ersetze MyExtension durch den tatsächlichen Namen deiner Erweiterung. Benutze UpperCamelCase-Namen für das Verzeichnis und die PHP-Datei(en); das entspricht der allgemeinen Dateinamenskonvention. (Ein guter Ausgangspunkt für eine eigene Erweiterung ist die . Man kann auch mit MWStew ein Grundgerüst für eine Erweiterung erstellen. Schau dir auch die cookiecutter-Vorlage für MediaWiki-Erweiterungen auf GitHub an.)

Einrichtung
Ihr Ziel beim Schreiben des Setup-Teils ist es, die Installation der Erweiterung so einfach wie möglich zu gestalten, sodass Benutzer diese Zeile nur zu LocalSettings.php hinzufügen müssen:

Wenn Sie Ihren Erweiterungsbenutzer konfigurierbar machen möchten, müssen Sie einige Konfigurationsparameter definieren und dokumentieren. Das Setup Ihrer Benutzer sollte ungefähr so aussehen:

Um diese Einfachheit zu erreichen, muss Ihre Setup-Datei eine Reihe von Aufgaben ausführen (die in den folgenden Abschnitten ausführlich beschrieben werden):


 * Registrieren Sie einen beliebigen Medienhandler, Parser-Funktion,  Spezialseite,  benutzerdefiniertes XML-Tag und  Variable durch Ihre Erweiterung.
 * Definieren und / oder validieren Sie alle Konfigurationsvariablen, die Sie für Ihre Erweiterung definiert haben.
 * Bereiten Sie die von Ihrer Erweiterung verwendeten Klassen für das automatische Laden vor
 * Legen Sie fest, welche Teile Ihres Setups sofort ausgeführt werden sollen und welche zurückgestellt werden müssen, bis der MediaWiki-Kern initialisiert und konfiguriert wurde
 * Definieren Sie alle zusätzlichen hooks, die von Ihrer Erweiterung benötigt werden
 * Erstellen oder überprüfen Sie alle neuen Datenbanktabellen, die für Ihre Erweiterung erforderlich sind.
 * Richten Sie die Lokalisierung für Ihre Erweiterung ein

Registrieren von Funktionen bei MediaWiki
MediaWiki listet alle Erweiterungen auf, die auf der Seite  installiert wurden. Beispielsweise können Sie alle in diesem Wiki installierten Erweiterungen unter Special:Version anzeigen. Es ist eine gute Form, um sicherzustellen, dass Ihre Erweiterung auch auf dieser Seite aufgeführt ist.

Um dies in Versionen zu tun, die älter als MW 1.25 sind, müssen Sie $ ExtensionCredits für  'jedes'  Medienhandler, Parser-Funktion, spezielle Seite, benutzerdefiniertes XML-Tag und Variable, die von Ihrer Erweiterung verwendet werden. Ausführliche Informationen zu den Funktionen dieser Felder finden Sie unter 1$.

Fügen Sie dazu in neueren Versionen die Erweiterungsdetails zu extension.json hinzu. Der Eintrag sieht ungefähr so aus:

Viele der Felder sind optional, aber es wird immer noch empfohlen, sie auszufüllen. Die  bezieht sich auf die Version des Schemas, für das die $ json-Datei geschrieben wurde. Ab sofort (Januar 2018) sind die Versionen 1 und 2 verfügbar. Die Dokumentation zu dieser Funktion finden Sie in hier.

Zusätzlich zu der oben genannten Registrierung müssen Sie Ihre Funktion auch in MediaWiki "einbinden". Das Obige richtet nur die Seite Special: Version ein. Wie Sie dies tun, hängt von dem Typ Ihrer Erweiterung ab. Einzelheiten finden Sie in der Dokumentation zu den einzelnen Erweiterungstypen:

Machen Sie Ihre Erweiterung konfigurierbar
Wenn Ihr Benutzer Ihre Erweiterung konfigurieren kann, müssen Sie eine oder mehrere Konfigurationsvariablen angeben. Es ist eine gute Idee, diesen Variablen einen eindeutigen Namen zu geben. Sie sollten auch MediaWiki Namenskonventionen folgen (z. B. sollten globale Variablen mit $wg beginnen).

Wenn Ihre Erweiterung beispielsweise "Sehr dumme Erweiterung, die nichts tut" heißt, möchten Sie möglicherweise alle Konfigurationsvariablen benennen, um mit  oder   zu beginnen. Es spielt keine Rolle, was Sie auswählen, solange  'none'  'des MediaWiki-Kerns seine Variablen auf diese Weise beginnt und Sie eine vernünftige Arbeit geleistet haben, um zu überprüfen, ob keine der veröffentlichten Erweiterungen ihre Variablen auf diese Weise beginnt. Benutzer müssen sich nicht zwischen Ihrer Erweiterung und einigen anderen Erweiterungen entscheiden, da Sie überlappende Variablennamen ausgewählt haben.

Es ist auch eine gute Idee, eine ausführliche Dokumentation aller Konfigurationsvariablen in Ihre Installationshinweise aufzunehmen.

Hier ist ein Beispiel für eine Kesselplatte, mit der Sie loslegen können:

Beachten Sie, dass nach dem Aufruf von  die globale Variable   nicht vorhanden ist. Wenn Sie die Variable einstellen, z. in  dann den in der

wird nicht verwendet.

Weitere Informationen zur Verwendung globaler Variablen in benutzerdefinierten Erweiterungen finden Sie unter $ 1.

Klassen für das automatische Laden vorbereiten
Wenn Sie Klassen zum Implementieren Ihrer Erweiterung verwenden, bietet MediaWiki einen vereinfachten Mechanismus, mit dem PHP die Quelldatei finden kann, in der sich Ihre Klasse befindet. In den meisten Fällen sollte dies die Notwendigkeit beseitigen, eine eigene $ autoload-Methode zu schreiben.

Um den Autoloading-Mechanismus von MediaWiki zu verwenden, fügen Sie dem Feld $ AutoloadClasses Einträge hinzu. Der Schlüssel jedes Eintrags ist der Klassenname. Der Wert ist die Datei, in der die Definition der Klasse gespeichert ist. Bei einer einfachen Erweiterung mit einer Klasse erhält die Klasse normalerweise denselben Namen wie die Erweiterung, sodass Ihr Abschnitt zum automatischen Laden möglicherweise folgendermaßen aussieht (die Erweiterung heißt "MyExtension"):

Der Dateiname bezieht sich auf das Verzeichnis, in dem sich die Datei extension.json befindet.

Zusätzliche Hooks definieren
Siehe.

Datenbank Tabellen hinzufügen
Make sure the extension doesn't modify the core database tables. Instead, extension should create new tables with foreign keys to the relevant MW tables.

Wenn Ihre Erweiterung eigene Datenbanktabellen hinzufügen muss, verwenden Sie den Hook $ LoadExtensionSchemaUpdates. Weitere Informationen zur Verwendung finden Sie auf der Handbuchseite.

Lokalisierung einrichten
Siehe:
 * Lokalisierung (Zusammenfassung)
 * Lokalisierung (detailliert)
 * Namespaces

Logs hinzufügen
In MediaWiki werden alle Aktionen von Benutzern im Wiki auf Transparenz und Zusammenarbeit hin verfolgt. Siehe $ 1 für die Vorgehensweise.

Lokalisierung
Wenn Sie möchten, dass Ihre Erweiterung in Wikis mit mehrsprachiger Leserschaft verwendet wird, müssen Sie Ihrer Erweiterung Lokalisierungsunterstützung hinzufügen.

Speichern Sie Nachrichten in .json
Speichern Sie Nachrichtendefinitionen in einer Lokalisierungs-JSON-Datei, eine für jeden Sprachschlüssel, in den Ihre Erweiterung übersetzt wird. Die Nachrichten werden mit einem Nachrichtenschlüssel und die Nachricht selbst im Standard-JSON-Format gespeichert. Jede Nachrichten-ID sollte in Kleinbuchstaben geschrieben sein und darf keine Leerzeichen enthalten. Ein Beispiel, das Sie z.B. in Erweiterung MobileFrontend. Hier ist ein Beispiel für eine minimale JSON-Datei (in diesem Fall en.json:

en.json

Speichern Sie die Nachrichtendokumentation in qqq.json
Die Dokumentation für Nachrichtenschlüssel kann in der JSON-Datei für die Pseudosprache mit dem Code qqq gespeichert werden. Eine Dokumentation des obigen Beispiels kann sein:

qqq.json:

Nachrichten definieren

 * Weisen Sie jeder Nachricht eine eindeutige Nachrichten-ID in Kleinbuchstaben und ohne Leerzeichen zu. z.B.uploadwizard-desc
 * For any text string displayed to the user, define a message.
 * MediaWiki supports parameterized messages and that feature should be used when a message is dependent on information generated at runtime. Parameter placeholders are specified with $n, where n represents the index of the placeholder; e.g.

Define message documentation
Each message you define needs to have an associated message documentation entry Message documentation; in qqq.json e.g.

Load the localisation file
In your setup routine, define the location of your messages files (e.g. in directory i18n/):

Use wfMessage in PHP
In your setup and implementation code, replace each literal use of the message with a call to. In classes that implement (as well as some others such as subclasses of SpecialPage), you can use   instead. Beispiel:

Use mw.message in JavaScript
It's possible to use i18n functions in JavaScript too. Look at for details.

Extension types
Extensions can be categorized based on the programming techniques used to achieve their effect. Most complex extensions will use more than one of these techniques:
 * Subclassing: MediaWiki expects certain kinds of extensions to be implemented as subclasses of a MediaWiki-provided base class:
 *  – Subclasses of the class are used to build pages whose content is dynamically generated using a combination of the current system state, user input parameters, and database queries. Both reports and data entry forms can be generated. They are used for both reporting and administration purposes.
 *  – Skins change the look and feel of MediaWiki by altering the code that outputs pages by subclassing the MediaWiki class.
 *  – A technique for injecting custom php code at key points within MediaWiki processing. They are widely used by MediaWiki's parser, its localization engine, its extension management system, and its page maintenance system.
 *  – XML style tags that are associated with a php function that outputs HTML code. You do not need to limit yourself to formatting the text inside the tags. You don't even need to display it. Many tag extensions use the text as parameters that guide the generation of HTML that embeds google objects, data entry forms, RSS feeds, excerpts from selected wiki articles.
 *  – A technique for mapping a variety of wiki text string to a single id that is associated with a function. Both variables and parser functions use this technique. All text mapped to that id will be replaced with the return value of the function. The mapping between the text strings and the id is stored in the array $magicWords. The interpretation of the id is a somewhat complex process – see  for more information.
 *  – Variables are something of a misnomer. They are bits of wikitext that look like templates but have no parameters and have been assigned hard-coded values. Standard wiki markup such as or  are examples of variables. They get their name from the source of their value: a php variable or something that could be assigned to a variable, e.g. a string, a number, an expression, or a function return value.
 *  – .  Similar to tag extensions, parser functions process arguments and returns a value. Unlike tag extensions, the result of parser functions is wikitext.
 *  – you can add custom modules to MediaWiki's action API, that can be invoked by JavaScript, bots or third-party clients.
 *  – If you need to store data in formats other than wikitext, JSON, etc. then you can create a new.

Support other core versions
There are two widespread conventions for supporting older versions of MediaWiki core:

Extension maintainers should declare with the  parameter of the Extension template which convention they follow.
 * Master: the master branch of the extension is compatible with as many old versions of core as possible. This results in a maintenance burden (backwards-compatibility hacks need to be kept around for a long time, and changes to the extension need to be tested with several versions of MediaWiki), but sites running old MediaWiki versions benefit from functionality recently added to the extension.
 * Release branches: release branches of the extension are compatible with matching branches of core, e.g. sites using MediaWiki need to use the  branch of the extension. (For extensions hosted on gerrit, these branches are automatically created when new versions of MediaWiki are released.) This results in cleaner code and faster development but users on old core versions do not benefit from bugfixes and new features unless they are backported manually.

Veröffentlichung
To autocategorize and standardize the documentation of your existing extension, please see. To add your new extension to this Wiki:

Deploying and registering
If you intend to have your extension deployed on Wikimedia sites (including possibly Wikipedia), additional scrutiny is warranted in terms of performance and security. Consult.

If your extension adds namespaces, you may wish to register its default namespaces; likewise, if it adds database tables or fields, you may want to register those at.

Please be aware that review and deployment of new extensions on Wikimedia sites can be extremely slow, and in some cases has taken more than two years.

Help documentation
You should provide public-domain help documentation for features provided by your extension. is a good example. You should give users a link to the documentation via the function.

Providing support / collaboration
Extension developers should open an account on Wikimedia's, and request a new project for the extension. This provides a public venue where users can submit issues and suggestions, and you can collaborate with users and other developers to triage bugs and plan features of your extension.

Siehe auch

 * – implements some example features with extensive inline documentation
 * – a functioning boilerplate extension, useful as a starting point for your own extension
 * Read the Example extension, base your own code on the BoilerPlate extension.
 * cookiecutter-mediawiki-extension – a cookiecutter template which generates a boilerplate extension (with variables etc.)
 * Allows you to get going quickly with your own extension.
 * Can also generate the BoilerPlate extension.
 * - copy specific code from them
 * – explains how your extension can provide an API to clients
 * Best practices for extensions
 * Best practices for extensions
 * Best practices for extensions
 * Best practices for extensions
 * Best practices for extensions