Erweiterungen :

• Installation and upgrade
• Development
• Registration
• Translation
• Alle
• Kategorie
• Erweiterungen FAQ

Wer Erweiterung auf Wikimedia-Websites bereitstellen möchte, sollte Writing an extension for deployment lesen.

This page is a guide to developing extensions for MediaWiki. Before you start, browse the complete list in: Category:Extensions by category ^{de[[::Category:Extensions by category| ]]} to see if an extension already exists for your use case.

Extension development consists of these parts:

1. Einrichtung
2. Implementation
3. Lokalisierung
4. Publication

Einrichtung

MyExtension/extension.json

Speichert die setup-Anleitung. Der Dateiname muss "extension.json" lauten. (Vor MediaWiki 1.25 befanden sich die Setup-Anweisungen in einer MyExtension/MyExtension.php-Datei, die nach der Erweiterung benannt wurde. Viele Erweiterungen halten in dieser PHP-Datei noch Abwärtskompatibilitäten bereit.)

MyExtension/includes/ (or MyExtension/src/)

Enthält den auszuführenden PHP-Code für die Erweiterung.

MyExtension/resources/ (or MyExtension/modules/)

Speichert die clientseitigen Ressourcen wie JavaScript, CSS und LESS für die Erweiterung.

MyExtension/i18n/*.json

Enthält Lokalisierungsinformation für die Erweiterung.

MyExtension/README.md

Eine gute Praxis ist es, eine README Datei mit grundlegenden Informationen über die Installation und Konfiguration der Erweiterung hinzuzufügen. Use either plain text or Markdown. Siehe zum Beispiel die Phabricator Diffusion Seite für die Erweiterung:Seitenformulare . Wenn Markdown verwendet wird, füge die Dateierweiterung .md hinzu. Siehe zum Beispiel die Datei README.md für Parsoid auf Phabricator Diffusion.

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.^[1]

The extension.json file contains the configuration data for the extension. Here is an example of a minimal extension.json:

{
	"name": "MyExtension",
	"author": "John Doe",
	"url": "https://www.mediawiki.org/wiki/Extension:MyExtension",
	"description": "This extension is an example.",
	"version": "1.5",
	"license-name": "GPL-2.0-or-later",
	"type": "validextensiontype",
	"manifest_version": 2
}

Viele der Felder sind optional, aber es wird immer noch empfohlen, sie auszufüllen. For a more complete example of extension.json, see the BoilerPlate extension.

Das manifest_version bezieht sich auf die Version des Schemas, gegen die die extension.json Datei geschrieben wird. Die verfügbaren Versionen sind 1 und 2. Eine Dokumentation zu dieser Funktion findet sich hier. Wenn du nicht eine ältere Version von MediaWiki unterstützen musst, wähle die neueste Version.

Once you have an extension.json file set up for your extension, the extension will appear on your local Special:Version page.

• GNU General Public License, Version 2 oder neuer (GPL-2.0-or-later)
• MIT-Lizenz (MIT)
• BSD-Lizenz (BSD-3-Clause)
• Apache License 2.0 (Apache-2.0)

For extensions that have a compatible license, you can request developer access to the MediaWiki source repositories for extensions. To specify the licence in code and with "license-name" a key should be used to provide its short name, e.g. "GPL-2.0-or-later" or "MIT" adhering to the list of identifiers at spdx.org.

wfLoadExtension( 'MyExtension' );

wfLoadExtension( 'MyExtension' );
$wgMyExtensionConfigThis = 1;
$wgMyExtensionConfigThat = false;

{
	"config": {
		"BoilerPlateEnableFoo": {
			"value": true,
			"description": "Enables the foo functionality"
		}
	}
}

{
	"AutoloadClasses": {
		"MyExtension": "includes/MyExtension.php"
	}
}

Angenommen, eine Erweiterung erfordert das Vorhandensein einer anderen Erweiterung, z.B. weil Funktionalitäten oder Datenbanktabellen genutzt werden sollen und Fehlermeldungen bei Nichtvorhandensein vermieden werden sollen.

Zum Beispiel erfordert die Erweiterung CountingMarker für bestimmte Funktionen das Vorhandensein der Erweiterung HitCounters .

Eine Möglichkeit, dies anzugeben, wäre die Verwendung des Schlüssels requires in extension.json .

Eine andere Möglichkeit ist die Verwendung von ExtensionRegistry (verfügbar seit MW 1.25):

	if ( ExtensionRegistry::getInstance()->isLoaded( 'HitCounters', '>=1.1' ) {
		/* do some extra stuff, if extension HitCounters is present in version 1.1 and above */
	}

Currently (as of February 2024, MediaWiki 1.41.0) the name of the extension-to-be-checked needs to exactly match the name in their extension.json.^[2][3]

Example: if you want to check the load status of extension OpenIDConnect, you have to use it with a space

	if ( ExtensionRegistry::getInstance()->isLoaded( 'OpenID Connect' ) {
    ...
	}

MediaWiki core provides several ways for extensions to change the behavior, functionality, and appearance of a wiki. Most extensions use more than one of these extension points. For a complete list of extension points supported in extension.json, see the schema reference .

• Hooks : Inject custom code at key points in MediaWiki core code, such as when a user logs in or saves a page. Extensions can also define new hooks.
• Domain events : React to changes to the wiki's state, such as when a page is edited. Extensions can also define their own events. 1.44
• API modules : Define API modules based on the Action API or REST API . These modules can be called by bots or clients.
• Jobs : Add jobs to MediaWiki's JobQueue to perform process-intensive tasks asynchronously, such as sending notification emails.

• Display a special page : Special pages provide dynamically generated content, often based on system state, database queries, and user inputs.
• Perform a page action : The action URL parameter generates a custom page based on the current page, usually to provide information (such as page history) or to perform an action (such as edit the page). In addition to the default actions provided by MediaWiki core, extensions can define a new page action.
• Add a tracking category : Help users find pages with similar characteristics by automatically adding pages to custom categories.

• Extend wiki markup : Extensions can add custom functionality to MediaWiki's wikitext markup using template syntax ({{...}}) or tags (‎<example />). These customizations are used to generate content and to interact with MediaWiki during page rendering.
• Support a content model : By default, wiki pages can be stored using a few standard content models, such as wikitext and JSON. Extensions can provide support for new content models by adding a content handler.
• Support a media type : Extensions can add to the default set of supported media file types by adding a media handler.

• Log a user or system action : On wiki, actions are tracked for transparency and collaboration. To support this feature, extensions can add custom entries and functionality to Special:Log.
• Add a recent-changes flag : Extensions can add custom flags to the following special pages to help moderators track page changes: Special:RecentChanges, Special:Watchlist, Special:RecentChangesLinked
• Add a revision tag : Extensions can add annotations associated with a revision or log entry, such as for edits made using the VisualEditor extension.

• Add a provider : Extensions can add support for new login mechanisms and session management methods.

Datenbank Tabellen hinzufügen

Stelle sicher, dass die Erweiterung die Hauptdatenbanktabellen nicht verändert. Stattdessen sollte die Erweiterung neue Tabellen mit Fremdschlüsseln zu den entsprechenden MW-Tabellen erstellen.

Warnung:

Wenn deine Erweiterung in einem produktiven, von WMF gehosteten Wiki verwendet wird, befolge bitte die Schema Änderungsanleitung.

Wenn deine Erweiterung ihre eigenen Datenbanktabellen hinzufügen muss, verwende den Haken LoadExtensionSchemaUpdates . Weitere Informationen zur Verwendung finden Sie auf der Handbuchseite.

Lokalisierung

Localisation – Erläutert die MediaWiki-Lokalisierungs-Engine. Insbesondere gibt es eine Liste von Funktionen, die lokalisiert werden können, und eine Überprüfung der an der Lokalisierung beteiligten MediaWiki-Quellcodeklassen. Neue Nachrichten erstellen Localization checks – Erläutert häufig auftretende Probleme mit lokalisierten Nachrichten Namensräume

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

{
	"myextension-desc": "Adds the MyExtension great functionality.",
	"myextension-action-message": "This is a test message"
}

{
	"myextension-desc": "The description of MyExtension used in Extension credits.",
	"myextension-action-message": "Adds 'message' after 'action' triggered by user."
}

{
	"MessagesDirs": {
		"MyExtension": [
			"i18n"
		]
	}
}

wfMessage( 'myextension-addition', '1', '2', '3' )->parse()

Veröffentlichung

Um die Dokumentation deiner bestehenden Erweiterung automatisch zu kategorisieren und zu standardisieren, beachte bitte Vorlage:Erweiterung . So fügen Sie Ihrem Wiki Ihre neue Erweiterung hinzu:

Ein Entwickler, der sein Code im MediaWiki-Coderepositorium teilt, sollte folgendes erwarten:

Rückmeldung / Kritik / Code-Überprüfungen

Review and comments by other developers on things like framework use, security, efficiency and usability.

Developer tweaking

Other developers modifying your submission to improve or clean-up your code to meet new framework classes and methods, coding conventions and translations.

Improved access for wiki sysadmins

If you do decide to put your code on the wiki, another developer may decide to move it to the MediaWiki code repository for easier maintenance. You may then create a Entwicklerkonto to continue maintaining it.

Zukünftige Versionen von anderen Entwicklern

New branches of your code being created automatically as new versions of MediaWiki are released. You should backport to these branches if you want to support older versions.

Incorporation of your code into other extensions with duplicate or similar purposes — incorporating the best features from each extension.

Credit

Credit for your work being preserved in future versions — including any merged extensions.

Similarly, you should credit the developers of any extensions whose code you borrow from — especially when performing a merger.

Any developer who is uncomfortable with any of these actions occurring should not host in the code repository. You are still encouraged to create a summary page for your extension on the wiki to let people know about the extension, and where to download it.

Es gibt zwei weit verbreitete Konventionen zur Unterstützung älterer Versionen von MediaWiki Core:

• Master: Der Master Branch der Erweiterung ist mit so vielen alten Versionen von Core wie möglich kompatibel. Dies führt zu einem gewissen Wartungsaufwand (Abwärtskompatibilitäts-Hacks müssen lange aufrechterhalten werden, und Änderungen an der Erweiterung müssen mit mehreren MediaWiki-Versionen getestet werden), Websites, die alte MediaWiki-Versionen ausführen, profitieren jedoch von den kürzlich hinzugefügten Funktionen der Erweiterung.
• Veröffentlichungszweige: Die Veröffentlichungszweige der Erweiterung sind mit den entsprechenden Zweigen des Kerns kompatibel, d.h. Websites, die MediaWiki 1.43 verwenden, müssen den REL1_43 Branch der Erweiterung verwenden. (Für Erweiterungen, die auf Gerrit gehostet werden, werden diese Branches automatisch erstellt, wenn neue Versionen von MediaWiki veröffentlicht werden). Dies führt zu saubererem Code und schnellerer Entwicklung, jedoch profitieren Nutzer alter Kernversionen nicht von Bugfixes und neuen Funktionen, es sei denn, sie werden manuell backported.

Die Betreuer von Erweiterungen sollten mit dem Parameter compatibility policy der Vorlage {{Erweiterung }} angeben, welcher Konvention sie folgen.

Erweiterungsentwickler sollten ein Konto bei Wikimedia {Phabricator eröffnen und ein neues Projekt für die Erweiterung anfordern. Dies bietet einen öffentlichen Ort, an dem Benutzer Probleme und Vorschläge einreichen können, und Sie können mit Benutzern und anderen Entwicklern zusammenarbeiten, um Fehler zu ermitteln und Funktionen Ihrer Erweiterung zu planen.

Siehe auch

• Manual:Erweiterungsregistrierung – provides further developer documentation on how to register extensions and skins.
• API:Erweiterungen – erklärt, wie Ihre Erweiterung Clients eine API bereitstellen kann
• Manual:Extending wiki markup
• Manual:Kodierungskonventionen
• Beste Praktiken für Erweiterungen
• ResourceLoader

• Erweiterung:Examples – implementiert einige Beispielfunktionen mit umfangreicher Inline-Dokumentation
  • Beispiele Git Repo mit diesem und anderen Beispielcode
• Extension:BoilerPlate – Eine funktionierende Boilerplate-Erweiterung, die als Ausgangspunkt für Ihre eigene Erweiterung dient (git repo).
  • Lesen Sie die Beispielerweiterung und stützen Sie Ihren eigenen Code auf die BoilerPlate-Erweiterung.
• cookiecutter-mediawiki-extension – eine cookiecutter Vorlage, die eine Boilerplate-Erweiterung generiert (mit Variablen usw.)
  • Ermöglicht es Ihnen, mit Ihrer eigenen Erweiterung schnell loszulegen.
  • Kann auch die BoilerPlate-Erweiterung generieren.
• List of simple extensions – Kopieren Sie bestimmten Code von ihnen

Einzelnachweise