API:Localisation/de

Diese Seite dokumentiert Dinge, die bei der Lokalisation der MediaWiki Action API spezifiziert werden müssen. Siehe Lokalisation für allgemeine Informationen zur Lokalisation von MediaWiki.



Nachrichtendateien
Lokalisierungsnachrichten für den MediaWiki-Kern befinden sich unter.

Für Erweiterungen sollten sich die Nachrichten, die nur von der API-Dokumentation genutzt werden und von den meisten Benutzern nicht gesehen werden, in einer separaten Datei befinden und den normalen Mechanismus für mehrere Dateien nutzen. Siehe die Lokalisierungs-Dokumentation zum Hinzufügen neuer Nachrichten.



Benennung
Die Hilfenachrichten für API-Module nutzen als Namenspfad den "Modul-Pfad", wobei es sich um die Zeichenkette handelt, die für den Parameter action=help des "Moduls" genutzt wird. Für zu hinzugefügte Module ist dies der gleiche Schlüssel, der in dem Array genutzt wird, während für zu,  oder  hinzugefügte Module der Schlüssel das Präfix "query+" erhält.


 * Die Beschreibungsnachricht, früher über die Methode [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a49b8857e40e254e0af27fd281f3a2230 getDescription] ausgegeben, wurde auf zwei aufgeteilt: eine Nachricht  mit einer einzeiligen Beschreibung des Moduls und eine , die zusätzliche Modul-Level-Dokumentation enthält. Diese kann über entsprechende Methoden überschrieben werden, was jedoch nur in seltenen Fällen erforderlich ist.
 * Vor 1.30 wurde eine Beschreibung  genutzt. Dies wurde durch Implementation der Methode [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#aa0c499873fba5c934b98aae65e61a33d getDescriptionMessage] überschrieben, wobei dies nur in seltenen Fällen benötigt wurde.
 * Die Parameterbeschreibungsnachrichten, früher über die Methode [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a1d9406dc4a7b6e5b69554c492ee464f6 getParamDescription] ausgegeben, sind  (wobei   der Schlüssel aus [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams] ist). Dies kann durch Setzen eines Wertes für   in der aus [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams] ausgegebenen Datenstruktur überschrieben werden.
 * Parameter mit einer Beschreibung, die "Wenn weitere Ergebnisse verfügbar sind, nutze dies, um fortzufahren" ähnelt, sollten api-help-param-continue nutzen, statt eine doppelte Nachricht neu zu definieren.
 * Sortierungparameter, die Werte "neuer" und "älter" übernehmen (mit entsprechenden Parametern "Start" und "Ende"), sollten api-help-param-direction nutzen, statt eine doppelte Nachricht neu zu definieren.
 * Module, die CSRF-Token durch Implementation von  nutzen, müssen den Parameter token nicht dokumentieren; dies erfolgt automatisch über ApiBase.
 * Zur Nutzung in [//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams] sind viele zusätzliche Konstanten verfügbar; siehe ApiBase für Details.
 * Parameter mit einem Array für  können   nutzen, um zu spezifizieren, dass jeder Wert individuell dokumentiert ist. Diese Nachrichten sind standardmäßig  . Wenn die Nachrichten nicht nach dem Standardverfahren benannt sind, ist es nicht nötig, Nachrichten zu Werten im Array  zu erfassen (es muss weiterhin existieren, kann aber leer bleiben).
 * Alle Beispiele müssen einen beschreibenden Text haben. Nachrichten sollten sich an den Zeilen von  befinden.



Nachrichtendokumentation
Nutze die folgenden Vorlagen zur Dokumentation der Nachrichten in :


 * doc-apihelp-summary
 * doc-apihelp-description
 * doc-apihelp-extended-description
 * doc-apihelp-param
 * doc-apihelp-paramvalue
 * doc-apihelp-paraminfo
 * doc-apihelp-example



Nachrichtenformatierung
Alle Nachrichten sollten mit einem Punkt enden und vollständige Sätze sein. Für Parameter, die standardmäßig an Nachrichten übergeben werden, siehe die unter #Nachrichtendokumentation verlinkten Vorlagen.

Verwenden Sie semantisches Wikitext-Markup in Nachrichten:


 * für die Erwähnung von Parameterschlüsseln und auch Verweise auf Variablen wie $wgMiserMode.
 * für die möglichen Werte von Parametern, Erwähnung von Parametern mit Werten (darunter Verweise auf andere Module) und die Erwähnung von Eingabewerten in der Beispieldokumentation.
 * für die Erwähnung von Schlüsseln oder Werten in der API-Ausgabe.
 * für jeden anderen Computer-Code, z.B. "der -Header" oder "die Seite ".
 * Du musst keine zusätzlichen Anführungszeichen bei der Nutzung von semantischem Markup verwenden.

Wenn du auf andere API-Module verweisen musst, setze einen Link zu Special:ApiHelp und der Hilfe-Formatierer wird das richtige tun. Zum Beispiel wird " " in der Dokumentation für unterschiedliche token -Parameter genutzt. Der Link Special:ApiHelp wird als interner Anker-Link verwendet, wenn er sich auf der gleichen Seite befindet (Beispiel). Damit vergleichbar sollten Verweise auf die MediaWiki-Konfigurationsvariablen wie $wgMiserMode auf die Dokumentation auf mediawiki.org verlinken.

In Beispielen aufgeführte Verweise sollten generell nicht verlinkt werden, da diese Seiten in vielen Wikis nicht existieren werden.



Fehler und Warnungen
Fehler werden durch Anrufen von  angezeigt und die Nachrichten können wie üblich lokalisiert werden. Ähnliches gilt für Warnungen mit. Siehe für Details.

Gewöhnliche API-Fehlernachrichten haben Nachrichtenschlüssel, die mit  beginnen und Warnungen, die mit   beginnen. Du kannst in der Nachrichten-Dokumentation doc-apierror nutzen.



Text in API-Antworten
ApiBase und somit alle API-Module sind auch Verweisquellen. Auf Nachrichten sollte allgemein durch Nutzung von zugegriffen werden und das API-Modul selbst sollte allgemein übergeben werden, wenn eine IContextSource benötigt wird.

Nachrichten sollten nicht willkürlich in die Ausgabe aufgenommen werden, da ein Client sie nützlich findet.



Verbesserung der Lokalisierung in translatewiki
Du kannst Übersetzungen von API-Hilfenachrichten auf translatewiki.net hinzufügen und verbessern, genau wie andere MediaWiki-Kernnachrichten. Die relevante Nachrichtengruppe enthält


 * MediaWiki-Aktions-API
 * Verwendung von API-Funktionen



Siehe auch

 * – Entwurf eines Dokuments von 2014 mit Informationen zur Konvertierung alter API-Module in das aktuelle System.