Issue-Tracker: [[phab:tag/{{{phabricator}}}/|#{{{phabricator}}}]]

Vorlage:Erweiterung

From mediawiki.org
Jump to navigation Jump to search
This page is a translated version of the page Template:Extension and the translation is 98% complete.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Nederlands • ‎Scots • ‎Tiếng Việt • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎galego • ‎italiano • ‎magyar • ‎norsk bokmål • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎suomi • ‎svenska • ‎čeština • ‎Ελληνικά • ‎беларуская (тарашкевіца)‎ • ‎български • ‎македонски • ‎русский • ‎українська • ‎հայերեն • ‎العربية • ‎فارسی • ‎کوردی • ‎मराठी • ‎हिन्दी • ‎বাংলা • ‎မြန်မာဘာသာ • ‎ᱥᱟᱱᱛᱟᱲᱤ • ‎中文 • ‎日本語 • ‎粵語 • ‎ꯃꯤꯇꯩ ꯂꯣꯟ • ‎조선말 • ‎한국어
Vorlagendokumentation

Diese Erweiterung sollte für alle Erweiterungs-Seiten in diesem Wiki (jedoch nur für die jeweiligen Hauptseiten) verwendet werden. Sie erzeugt eine nützliche Infobox (siehe unten) und kategorisiert die Erweiterung in Kategorie:Alle Erweiterungen , zusammen mit den passenden Status- und Implementationstypen- Kategorien.

Verwendung

Kopieren und Einfügen:

{{Extension |templatemode =
|name                 = 
|status               = 
|type1                = 
|type2                = 
|hook1                = 
|hook2                = 
|newhook1             = 
|newhook2             = 
|username             = 
|author               = 
|description          = 
|image                = 
|imagesize            = 
|version              = 
|update               = 
|version preview      = 
|update preview       = 
|compatibility policy =
|mediawiki            = 
|php                  = 
|needs-updatephp      = 
|composer             =
|table1               = 
|table2               = 
|license              = 
|download             = 
|readme               = 
|changelog            = 
|example              = 
|namespace            = 
|parameters           = 
|tags                 = 
|rights               = 
|compatibility        = 
|bugzilla             = 
|phabricator          =
|vagrant-role         = 
}}
Für Hilfe bei den Parameterwerten, siehe unten.
MediaWiki-Erweiterungen
OOjs UI icon advanced.svg
{{{name}}}
Freigabestatus: unbekannt
Placeholder.png
Einbindung {{{type1}}}, {{{type2}}}
Beschreibung {{{description}}}
Autor(en) SomeAuthor (SomeUserDiskussion)
Letzte Version {{{version}}} ({{{update}}})
Letzte Vorschauversion {{{version preview}}} ({{{update preview}}})
Kompatibilitätspolitik ungültig
MediaWiki {{{mediawiki}}}
PHP {{{php}}}
Datenbankänderungen {{{needs-updatephp}}}
Composer {{{composer}}}
Tabellen [[Special:MyLanguage/Template:Extension/{{{table1}}} table|{{{table1}}}]][[:Template:Extension/{{{table1}}} table| ]]
[[Special:MyLanguage/Template:Extension/{{{table2}}} table|{{{table2}}}]][[:Template:Extension/{{{table2}}} table| ]]
Lizenz {{{license}}}
Herunterladen {{{download}}}
{{{readme}}}
{{{changelog}}}
Beispiel {{{example}}}
{{{namespace}}}
{{{parameters}}}
{{{tags}}}

{{{rights}}}

{{{compatibility}}}
Übersetze die Extension-Erweiterung, wenn sie auf translatewiki.net verfügbar ist
Vagrant-Rolle {{{vagrant-role}}}
Probleme [[phab:tag/{{{phabricator}}}|Offene Aufgaben]] · Einen Fehler melden

Inhalts-Parameter

In diesem Abschnitt werden Parameter beschrieben, die den Infobox-Inhalt steuern. Hilfe zu templatemode und anderen Steuerparametern finden Sie unter Steuerparameter.

== Inhalts-Parameter ==
Parameter Beschreibung
nameName der Erweiterung
status

aktueller Freigabestatus Eine aus:

  • unstable - defekt - verwenden Sie diese Erweiterung nicht
  • experimental - im Frühstadium der Entwicklung, könnte sich erheblich ändern
  • beta - stabil, aber nicht vollständig getestet
  • stable - stabile Version
  • unmaintained - galt zuvor als stabil, wird nicht mehr gewartet
  • archive - archiviert - veraltet oder mit einer anderen Erweiterung zusammengeführt
  • unknown - Voreinstellung

Wenn der Status anders als oben beschrieben angegeben wird, wird er ignoriert und stattdessen der Standardwert 'Unbekannt' in der Vorlage angezeigt. In Fällen, in denen der Wert weggelassen wird, wird als unbekannt kategorisiert. In Fällen, in denen der Wert ungültig ist, wird in eine spezielle Kategorie einkategorisiert, damit der Fehler gefunden und behoben werden kann.

type1
type2
type3
type4
type5
type6
Implementationstyp

Die Implementationsstrategie(n), die in dieser Erweiterung genutzt werden. Dieser Parameter wird genutzt, um Kategorien zu erstellen, die Programmierern helfen, Beispiele für verschiedene MediaWiki-spezifische Implementationsstrategien oder -muster zu finden. Obwohl die Werte dieses Parameters teilweise mit den Benutzungsfällen oder dem Zweck einer Erweiterung übereinstimmen, ist dies nicht der Grund für diesen Parameter. Wenn die von dir für diesen Parameter ausgewählten Werte den Zweck oder mögliche Anwendungsfälle nicht ausreichend angeben, empfehlen wir weitere Kategorielinks.

Erlaubte Werte für die Parameter type1, type2, ... sind:

  • parser - für unkategorisierte Parsererweiterungen. Wenn du eine Parsererweiterung geschrieben hast, nutze bitte einen der spezifischeren Typen:
  • access - für User access extensions , also Erweiterungen, die Benutzerrechte erstellen, authetifizieren, vergeben oder entziehen oder die Aktivität von Benutzern aufzeichnen. Wenn du eine Zugriffserweiterung geschrieben hast, nutze bitte einen der spezifischeren Typen:
    • user activity - Erweiterungen, die Benutzeraktivitäten aufzeichnen (Logins, Logouts, Benutzerkontenerstellungen, etc.)
    • user identity - Erweiterungen, die Benutzerkonten erstellen oder löschen und/oder die Identität eines Benutzers verifizieren
    • user rights - Erweiterungen für das Rechte-Management, z.B. Änderungen in der Rechtevergabe, API, Entwicklungswerkzeuge (umfasst nicht Erweiterungen, die lediglich Rechte benennen, die für die Nutzung der Funktionen dieser Erweiterung erforderlich sind; nutze für diesen Zweck den Parameter Rechte)
  • interface - für unkategorisierte Benutzeroberflächenerweiterungen.
    • media - Erweiterungen, die die Einbindung von Multimedia-Inhalten auf Wikiseiten durch die Registrierung einer Datei-Erweiterung mit $wgMediaHandlers ermöglichen.
    • mywiki - Erweiterungen, die eine Infrastruktur anbieten, mit der Benutzer ihre MediaWiki-Erfahrungen personalisieren können und/oder bei der Verwaltung dieser Infrastruktur helfen
    • notify - Erweiterungen, die Emails an Benutzer versenden, Nachrichten übermitteln und andere Formen der Benachrichtigung der Gemeinschaft anbieten
    • page action - Erweiterungen, die page action s verbessern oder verändern. Dies umfasst alle Implementierungen von Aktionen, die eine Seite lesen, schreiben, nach ihr suchen, sie erstellen, umbenennen, löschen, weiterleiten oder diskutieren. Es umfasst nicht Rechte (nutze user rights) oder Logbücher (nutze user activity).
    • search - Erweiterungen, die Suchen durchführen und Seiten für Benutzer auswählen.
    • skin - Erweiterungen, die CSS oder JavaScript hinzufügen oder Hook-Funktionen zur Änderung des Aussehens über das Skin-Framework implementieren.
    • ajax - Erweiterungen, die Ajax-Programmiertechniken nutzen.
    • special - Erweiterungen, die Seiten der SpecialPage-Klasse verwenden, einen ihrer Hooks nutzen oder eine oder mehrere Funktionen aus SpecialPage.php verändern. Siehe Special pages für weitere Informationen.
  • other
    • api - Erweiterungen, die neue API-Module hinzufügen oder existierende API-Kernmodule erweitern.
    • hook - Hook-Erweiterung - definiert eine neue Hook - siehe hook1, etc. weiter unten, wenn du Hooks definieren möchtest, die von deiner Erweiterung genutzt werden
    • database - fügt der Datenbank Tabellen und/oder Felder hinzu, die eine MediaWiki-Installation unterstützen
    • data extraction - Daten-Extraktion
    • filerepo - Erweiterung, die neue Datei-Repositorien-Typen als Datei-Backend hinzufügt
    • example - Keine echte Erweiterung, aber ein Beispiel dafür, wie eine geschrieben wird

Jeder andere Wert für 'type' ist ungültig und wird dazu führen, dass die Erweiterung in Category:Extensions with invalid or missing type/de aufgeführt wird.

Anmerkung: Viele Erweiterungen haben mehr als einen Typ, wenn dies auf deine Erweiterung zutrifft, ersetze |type= durch |type1=|type2=|type3=.... Du kannst bis zu sechs Typen für eine Erweiterung definieren.
hook1
hook2
hook3
hook4
...
Name jedes von der Erweiterung verwendeten Hooks

Die Eingabe von Werten in dieses Feld ist eine gute Möglichkeit, um deine Erweiterung bekannt zu machen und anderen Entwicklern zu helfen. Jeder dokumentierte Hook fügt die Erweiterung automatisch einer Kategorie hinzu, in der Erweiterungen aufgelistet sind, die diesen Hook verwenden. Diese Kategorie wird automatisch mit jeder Hook-Seite verknüpft, sodass Programmierer leicht Beispiele für Erweiterungen finden können, die einen bestimmten Hook verwenden.

Für built-in hooks:

  • verwende nur den Hook-Namen. Siehe Manual:Hooks für Werte (lasse jedoch das einleitende '/' weg).

Für benutzerdefinierte Hooks, die durch Erweiterungen definiert sind:

  • benutze extensionName/hookName. Eine unvollständige Liste der benutzerdefinierten Hooks befindet sich unter Extension hook registry.
Weise bei mehreren Hooks der ersten Hook hook1, der zweiten Hook hook2 und so weiter zu.
newhook1
newhook2
newhook3
newhook4
...
newhook90
Name jedes von der Erweiterung bereitgestellten Hooks Möglicherweise möchtest du die Hooks auch zu Extension hook registry hinzufügen.
usernameBenutzername des Autors auf MediaWiki.org (wenn er einen hat). Kann weggelassen werden; sofern vorhanden, wird er genutzt, um auf die Benuzerseite und die Diskussionsseite des Autors zu verlinken. Sollte ohne Namensraum und [[]]s angegeben werden.
authorName des Autors der Erweiterung, sofern vom MediaWiki.org-Benutzernamen verschieden. Freier Text. Sofern der Parameter weggelassen wird, wird das Feld 'Benutzername' genutzt (falls vorhanden).
descriptionkurze Beschreibung
imageScreenshot oder Logo der Erweiterung. Sollte ohne Namensraum und [[]]s angegeben werden.
imagesizefakultativ, Größe des Bildes (Standardgröße sind 220px)
versionletzte Version
updateDatum des letzten Updates
compatibility policyKompatibilitätsrichtlinie (akzeptierte Werte sind master, rel und ltsrel). (Rückstand )
mediawikierforderliche MediaWiki-Version
phperforderliche PHP-Version
needs-updatephpyes bedeutet, dass die Erweiterung die Änderung des Tabellenschemas der Datenbank oder eine ähnliche Aktion erfordert, bevor MediaWiki laufen kann. Dies ist häufig eine Gefahr: MediaWiki wird ins Stocken geraten, wenn du vergisst, update.php laufen zu lassen - wenn die Erweiterung dies erfordert. no sollte als Wert gesetzt werden, da so sichergestellt wird, dass die Erweiterung nicht verlangt, dass update.php läuft, wodurch Unsicherheiten vermieden werden

Erweiterungen, die die MediaWiki-Erweiterungsstandards erfüllen, besitzen ein Schema-Änderungsskript, das manuell gestartet werden muss (einmalig), bevor du MediaWiki starten und über deinen Browser darauf zugreifen kannst. Nachdem du alle Erweiterungsdateien nach $IP/extensions/ExtensionName kopiert und wfLoadExtension( "ExtensionName"); in "LocalSettings.php" eingefügt hast, führe über die Kommandozeile aus:

cd path/to/wiki_install_directory
cd maintenance
php update.php
$IP steht für den Installationspfad (oder "Verzeichnis") deiner MediaWiki-Installation, dem selben Verzeichnis das die LocalSettings.php , index.php etc. beinhaltet.
composerSofern vorhanden, sollten der Name des "Anbieters" und das "Paket" im Format vendor/package eingegeben werden, z.B. mediawiki/semantic-media-wiki, um direkt auf packagist.org zu verweisen, das als Paket-Archiv dient.
table1
table2
table3
table4
...
table30
Name jeder von der Erweiterung genutzten nicht-Core-Tabelle Verlinkt auf eine Unterseite deiner Erweiterungsseite. Zum Beispiel verlinkt "table1 = cu_changes" auf Extension:CheckUser nach Extension:CheckUser/cu_changes table . Liste keine Core-Tabellen wie page oder revision auf; liste nur Tabellen auf, die durch die Erweiterungen hinzugefügt werden.
licenseLizenz dieser Erweiterung, Teil des Codes aus https://spdx.org/licenses/, z.B. GPL-2.0-or-later, GPL-2.0-only oder GPL-3.0-or-later, etc.
downloadDownloadlink: Git, {{WikimediaDownload/de}}.
repoName des Gerrit-Repositoriums, in dem der Code der Erweiterung gespeichert ist, sofern vom Seitennamen verschieden. Durch Setzen des Parameters wird automatisch |download= gesetzt und der Vorlage wird erlaubt, automatisch Daten aus der entsprechenden extension.json-Datei zu laden.
readmeexterner Link auf die readme-Datei, z.B. https://phabricator.wikimedia.org/r/browse/mediawiki/extensions/Flow;master;README
changelogexterner Link auf die Änderungslogbuch-Datei, z.B. Extension:LDAP Authentication/Changelog
parametersverfügbare Parameter für LocalSettings.php
tagsalle Tags, die deine Erweiterung nutzt (z.B. <tag1>, <tag2>).
rightsDurch die Erweiterung hinzugefügte Rechte. Nicht zu verwechseln mit der Lizenz! Rechte sind beispielsweise makebot oder desysop , nicht GFDL, LGPL oder GPL - das sind Lizenzen!
namespaceNamensraum, in dem die Erweiterung genutzt wird
exampleBeispiel, Webseite oder Screenshot der funktionierenden Erweiterung
compatibilityZusätzliche Kompatibilitätsinformationen, beispielsweise Kompatibilitätstabellen (früher wurde Template:Extension Testing genutzt). Es wird empfohlen, auch alle Client-seitigen Kompatibilitätsinformationen hier anzugeben, insbesondere wenn es unterschiedliche Unterstützungen für Browser gibt.
translateOptionaler Parameter, um auf die genaue Seite, auf der (mit der Nachrichtengruppen-ID) die Erweiterung im translatewiki.net übersetzt werden kann, sofern dies aktiviert ist, zu verlinken. Der Standardlink ist falsch und muss manuell geändert werden:
  • ext-LOWERCASE(NOSPACES(Label wie definiert in config)), aka
  • den Parameter, den du in der URL erhältst nach
bugzillaKomponentenname der Erweiterung im MediaWiki-Bugzilla
phabricatorName des Phabricator-Projekts
CheckUsageNameOverrideüberschreibt den Seitennamen, der für den Benutzungsprüfungs-Link verwendet wird.

Kontrollparameter

Kontrollparameter
Parameter Beschreibung
templatemodeKontrolliert die automatische Kategorisierung der Hauptseite.

Normalerweise freigelassen. Alternative Werte sind:

  • nocats - unterdrückt die Kategorisierung und den 'Benutzungsprüfungs'-Link. Nutze diesen Wert, wenn du die Vorlage auf Unterseiten einer Erweiterung oder der Dokumentation von Erweiterungen verwendest. Beispielsweise wird in dem Bild oben templatemode=nocats gesetzt, da es sich um keine Seite einer Erweiterung handelt und wir diese Seite deshalb nicht dort kategorisieren wollen.
  • nousage - unterdrückt den 'Benutzungsprüfungs'-Link. Der Link wird auch unterdrückt, wenn es sich um eine Unterseite handelt, sich die Seite nicht im Extension-Namensraum befindet oder wenn sie durch 'templatemode=nocats' unterdrückt wird
Wenn dies leer gelassen wird, fügt diese Vorlage die Hostseite zu Category:All extensions/de und zu einer oder mehreren zusätzlichen Kategorien hinzu, abhängig von den Werten, die den Inhaltsparametern zugewiesen sind.

Benutzung der Infobox

Vorhandene Erweiterungs-Seiten

Wenn du die Infobox zu einer vorhandenen Seite hinzufügen möchten, kopiere den Code und füge ihn oben auf dieser Seite ein.

Erstelle eine neue Erweiterungs-Seite

Wenn du eine neue Erweiterungs-Seite erstellen möchtest, gebe den Namen unten ein und klicke auf die Schaltfläche. Eine neue Seite wird mit der bereits vorhandenen Infobox-Vorlage erstellt.


A developer sharing their code in the MediaWiki code repository should expect:

Feedback / Criticism / Code reviews
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.
Future versions by other developers
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.

Verbessere diese Vorlage

Vielen Dank, wenn du diese Vorlage verbessern möchtest! Dies ist eine komplizierte Vorlage, daher hier etwas Hilfe:

Der Knopf zum Erstellen einer Erweiterung

Um das Verhalten des Knopfs zum Erstellen einer Erweiterung zu verbessern:

Infobox-Parameter

Allgemein:

  • Um die Vorlage einfach benutzen zu können, verlinkt jede Bezeichnung in der Infobox auf die Dokumentation der angezeigten Vorlagenparameter. Wenn du Parameter hinzufügst, stelle bitte sicher, sie auch zur Inhalts-Parameter-Dokumentation hinzuzufügen und von der Bezeichnung auf die Dokumentation zu verlinken.

Um die Implementationstypen-Parameter zu ändern/korrigieren/ergänzen:

  • Überprüfe die Diskussionsseite - über dieses Feld gab es bereits einige ausführliche Diskussionen.
  • Die gültigen Typen und wohin sie verlinken, ist auf Module:Extension definiert

Um das Verhalten der Haupt-Parameter zu ändern:

Test

Sieh dir an, ob die folgenden Seiten in Ordnung sind, nachdem du die Vorlage bearbeitet hast.

TemplateData

Maintenance: vulnerabilities, archived