Benutzer:Schnark/js/wikieditor/Extern
Diese Hilfeseite erklärt Programmierern, wie sie externe Funktionen für meine Toolbar-Konfiguration schreiben können.
Grundgerüst[Bearbeiten | Quelltext bearbeiten]
// externe Funktion für [[Benutzer:Schnark/js/wikieditor.js]] <nowiki>
wikieditor.addSection_fn['XY'] = function (name) {
};
wikieditor.addGroup_fn['XY'] = function (wo, name) {
};
wikieditor.addChars_fn['XY'] = function (wo, name) {
};
wikieditor.addTable_fn['XY'] = function (wo, name) {
};
wikieditor.addButton_fn['XY'] = function (wo, name) {
};
wikieditor.addSelect_fn['XY'] = function (wo, name) {
};
wikieditor.addSection_fnd = function (was, name) {
};
wikieditor.addGroup_fnd = function (wo, was, name) {
};
wikieditor.addChars_fnd = function (wo, was, name) {
};
wikieditor.addTable_fnd = function (wo, was, name) {
};
wikieditor.addButton_fnd = function (wo, was, name) {
};
wikieditor.addSelect_fnd = function (wo, was, name) {
};
//</nowiki>
Die ersten Befehle belegen jeweils ein bestimmtes Kürzel mit einer Funktion, die jeweils den Ort und optional einen Alternativnamen übergeben bekommt, und von der erwartet wird, dass sie im Erfolgsfall true, andernfalls false zurückgibt. Freundlicherweise solltest du eventuell prüfen, ob das Kürzel schon belegt ist, statt es einfach zu überschreiben.
Die letzten Befehle geben Funktionen an, die mit dem Ort, dem Kürzel (das dann noch nicht belegt ist) und optional einem Alternativnamen aufgerufen werden und von denen ebenso ein boolscher Rückgabewert erwartet wird. Hier solltest du erst recht nicht einfach überschreiben, besser geeignet wäre etwa
altes_wikieditor_addSection_fnd = wikieditor.addSection_fnd;
wikieditor.addSection_fnd = function (was, name) {
var ret = false;
if (typeof altes_wikieditor_addSection_fnd == 'function') ret = altes_wikieditor_addSection_fnd(was, name);
if (ret) return true;
switch (was) {
case 'XY': ...; ret = true; break;
}
return ret;
}
Ein Beispiel findest du unter Benutzer:Schnark/js/wikieditor.js/smileys.js oder auch Benutzer:Schnark/js/wikieditor.js/de.js.
Dokumentation: Einleitung • Teil 1 • Teil 2 • Teil 3 • Teil 4 • Teil 5
Skripte: wikieditor.js • wikieditor.js/basic.js • wikieditor.js/de.js • Benutzer:Schnark/js/wikieditor.js/global.js • Liste von Beispielanwendungen
Alternativen: Beschreibung der Toolbar-API (englisch) • ähnliches, wesentlich kompakteres Skript von Benutzer:Krinkle (englisch) • alte Version des Skripts