Benutzer:PerfektesChaos/js/WikiSyntaxTextMod/usage/object
WikiSyntaxTextMod → Benutzung → Objekt
Ab Mitte 2012 wurden alle Optionen und Benutzerkonfigurationen in einem Objekt zusammengefasst.
Das soll die Übersicht über globale Variablen (etwa bei Debugger-Listen) erleichtern.
Auch die API-Funktionen lassen sich über das Objekt aufrufen.
Definition
Das Objekt kann einmalig wie folgt vereinbart werden:
mw.libs.WikiSyntaxTextMod = { config: { } };
configist das für die Benutzerkonfiguration vorgesehene Teil-Objekt; alle Angaben sind optional.
Besser ist es, bei dieser Definition auch gleich leere Komponenten von config zu definieren oder diese auch noch zu füllen:
mw.libs.WikiSyntaxTextMod = { config: { format: { },
lang: { },
load: { },
mod: { },
page: { },
portlet: { },
warn: { }
}
};
Sicherheitshalber sollte die Definition vor dem Aufruf von mw.loader.load() erfolgen, da moderne Browser überraschend schnell sein können.
Erst nachdem einmal ein leeres Grundgerüst definiert wurde, können ihm einzelne Komponenten zugewiesen werden wie etwa
mw.libs.WikiSyntaxTextMod.config.diffpage = false;
Komponenten
.config | Typ | Bemerkung |
|---|---|---|
.diffPage | boolean | |
.errorlimit | number | |
.config.format | ||
.galleryIndent | number | |
.config.lang | ||
.accept | String | |
.config.load | ||
.after | function | |
.inhibit | boolean | |
.updater | String | |
.config.mod | ||
.comment | Array | |
.hook | function | |
.plain | Array | |
.template | Array | |
.summary | String | |
.tested | boolean | |
.url | Array | |
.wikilink | Array | |
.config.page | ||
.exclude | Array | |
.include | Array | |
.oldid | boolean | |
.support | Array boolean | |
.config.portlet | Object boolean | |
.scope | String | |
.show | String | |
.stick | String | |
.swift | String | |
.config.warn | Object | Benutzerdefinierte Warnungen: Detektion verdächtiger Elemente |
.attribute | Array | Attribute mit speziellem Wert |
.entity | Array | Entities |
.parserfun | Array | Namen von Parserfunktion |
.property | Array | Namen von Attributen |
.tag | Array | XML-Tags |
.templateParamDup | boolean | Vorlagenparameter wiederholt |
.url | Array | Domains |
.config.Werkzeugleiste | boolean | deutschsprachige Wikipedia: Werkzeugleisten-Fehlklicks |
.config.data | Benutzerdefinierte Angaben | |
| Reserviert etwa für ein Objekt oder Array mit einschlägigen Informationen. Sie können beispielsweise beim Suchen und Ersetzen benutzt werden. | ||
.api | API-Funktionen | |
.edit() | ||
.isAppropriate() | (nicht publiziert) | |
.load() | ||
.run() | WikiSyntaxTextMod_Run() | |
.setContext() | ||
.textMod() | ||
Lesebeispiel: mw.libs.WikiSyntaxTextMod.config.load.inhibit=true; | ||
Tipp:
Durch eine persönliche globale Variable (oder beschränkt innerhalb einer Funktion) lassen sich mehrfache Zuweisungen abgekürzt darstellen:
window.WSTM = mw.libs.WikiSyntaxTextMod;
