Benutzer:Schnark/js/wikieditor/Referenz
In diesem Teil der Dokumentation sind sämtliche Variablen und Funktionen des Skripts erläutert. Beachte, dass wikieditor
noch eine globale Variable ist, aber besser als mw.libs.wikieditor
bzw. einen lokalen Alias angesprochen werden sollte.
Externe Variablen[Bearbeiten | Quelltext bearbeiten]
usersignature[Bearbeiten | Quelltext bearbeiten]
string, optional, wird nach wikieditor.sig
übertragen
customEditButtons[Bearbeiten | Quelltext bearbeiten]
string, optional, wird nur verwendet, wenn keine benutzerdefinierte Konfigurationsfunktion vorhanden ist, Dokumentation siehe Wikipedia:Helferlein/Extra-Editbuttons
rmEditButtons[Bearbeiten | Quelltext bearbeiten]
string oder object, optional, wird nur verwendet um die Schaltfläche für Formeln zu unterdrücken, falls customEditButtons
verwendet wird, Dokumentation siehe Wikipedia:Helferlein/Extra-Editbuttons
Externe Funktionen[Bearbeiten | Quelltext bearbeiten]
newtoolbar_config[Bearbeiten | Quelltext bearbeiten]
sollte Konfiguration durch Benutzer enthalten, wird vom Skript aufgerufen um Leiste zu modifizieren, optional (sonst Standardverhalten), veraltet
Variablen[Bearbeiten | Quelltext bearbeiten]
wikieditor.sig[Bearbeiten | Quelltext bearbeiten]
string, Benutzersignatur, Standardwert --~~~~
, verwendet in allen Unterschriften
wikieditor.addSection_fn[Bearbeiten | Quelltext bearbeiten]
object, für jeden Code wird die Funktion gespeichert, die über addSection aufgerufen werden kann
wikieditor.addGroup_fn[Bearbeiten | Quelltext bearbeiten]
object, für jeden Code wird die Funktion gespeichert, die über addGroup aufgerufen werden kann
wikieditor.addChars_fn[Bearbeiten | Quelltext bearbeiten]
object, für jeden Code wird die Funktion gespeichert, die über addChars aufgerufen werden kann
wikieditor.addTable_fn[Bearbeiten | Quelltext bearbeiten]
object, für jeden Code wird die Funktion gespeichert, die über addTable aufgerufen werden kann
wikieditor.addButton_fn[Bearbeiten | Quelltext bearbeiten]
object, für jeden Code wird die Funktion gespeichert, die über addButton aufgerufen werden kann
wikieditor.addSelect_fn[Bearbeiten | Quelltext bearbeiten]
object, für jeden Code wird die Funktion gespeichert, die über addSelect aufgerufen werden kann
Funktionen[Bearbeiten | Quelltext bearbeiten]
Hilfsfunktionen[Bearbeiten | Quelltext bearbeiten]
wikieditor.ID[Bearbeiten | Quelltext bearbeiten]
Parameter:
- name
- string, Name eines beliebigen Elements oder Leerstring
- standard
- string, Standardwert
Rückgabe: string, sonderzeichenbereinigte Version des Namens oder Standardwert (bei Leerstring)
Bereinigung von Sonderzeichen wahrscheinlich überflüssig, Aufruf durch außen sollte nur in Ausnahmefällen erfolgen
wikieditor.action[Bearbeiten | Quelltext bearbeiten]
Parameter:
- vorne
- string, Text, der vor Cursor eingefügt werden soll
- mitte
- string, Beispieltext, der markiert eingefügt werden soll
- hinten
- string, Text, der hinter Cursor eingeführt werden soll
- opt
- object, optional, zusätzliche Parameter, etwa
ownline
odersplitlines
, beide boolean - func
- function, optional, Funktion, die zusätzlich ausgeführt werden soll
Rückgabe: object, enthält die Parameter geeignet für die Toolbar-API codiert
Aufruf durch außen sollte nicht erfolgen
wikieditor.addComment[Bearbeiten | Quelltext bearbeiten]
Parameter
- zuq
- string, Text der in Zusammenfassungszeile eingefügt werden soll
Rückgabe: function, Funktion, die den Text in die Zusammenfassungszeile einfügt
Aufruf für den Funktionsparameter bei wikieditor.addMy(Button|Select)
gedacht
wikieditor.CSSSelect[Bearbeiten | Quelltext bearbeiten]
Parameter:
- wo
- string, Angabe des Orts der Auswahlliste
- name
- string, Name der Auswahlliste
- liste
- array, Einträge sind Arrays der Form
['Name des Punktes', 'Pfad zum Icon']
Rückgabe: keine
fügt CSS-Code zur Formatierung der Auswahlliste hinzu
wikieditor.addSection_fnd[Bearbeiten | Quelltext bearbeiten]
Parameter:
- was
- string, Kürzel der section
- name
- string, optional, eigener Name für die section
Rückgabe:
boolean, true
, falls (vermutlich) etwas eingefügt wurde, false
, falls definitiv nichts eingefügt wurde
wird aufgerufen, wenn für das Kürzel keine section definiert wurde
wikieditor.addGroup_fnd[Bearbeiten | Quelltext bearbeiten]
Parameter:
- wo
- string, Angabe des Orts der Gruppe
- was
- string, Kürzel der Gruppe
- name
- string, optional, eigener Name für die Gruppe
Rückgabe:
boolean, true
, falls (vermutlich) etwas eingefügt wurde, false
, falls definitiv nichts eingefügt wurde
wird aufgerufen, wenn für das Kürzel keine Gruppe definiert wurde
wikieditor.addChars_fnd[Bearbeiten | Quelltext bearbeiten]
Parameter:
- wo
- string, Angabe des Orts der Zeichentabelle
- was
- string, Kürzel der Zeichentabelle
- name
- string, optional, eigener Name für die Zeichentabelle
Rückgabe:
boolean, true
, falls (vermutlich) etwas eingefügt wurde, false
, falls definitiv nichts eingefügt wurde
wird aufgerufen, wenn für das Kürzel keine Zeichentabelle definiert wurde
wikieditor.addTable_fnd[Bearbeiten | Quelltext bearbeiten]
Parameter:
- wo
- string, Angabe des Orts der Tabelle
- was
- string, Kürzel der Tabelle
- name
- string, optional, eigener Name für die Tabelle
Rückgabe:
boolean, true
, falls (vermutlich) etwas eingefügt wurde, false
, falls definitiv nichts eingefügt wurde
wird aufgerufen, wenn für das Kürzel keine Tabelle definiert wurde
wikieditor.addButton_fnd[Bearbeiten | Quelltext bearbeiten]
Parameter:
- wo
- string, Angabe des Orts der Schaltfläche
- was
- string, Kürzel der Schaltfläche
- name
- string, optional, eigener Name für die Schaltfläche
Rückgabe:
boolean, true
, falls (vermutlich) etwas eingefügt wurde, false
, falls definitiv nichts eingefügt wurde
wird aufgerufen, wenn für das Kürzel keine Schaltfläche definiert wurde
wikieditor.addSelect_fnd[Bearbeiten | Quelltext bearbeiten]
Parameter:
- wo
- string, Angabe des Orts der Auswahlliste
- was
- string, Kürzel der Auswahlliste
- name
- string, optional, eigener Name für die Auswahlliste
Rückgabe:
boolean, true
, falls (vermutlich) etwas eingefügt wurde, false
, falls definitiv nichts eingefügt wurde
wird aufgerufen, wenn für das Kürzel keine Auswahlliste definiert wurde
Funktionen zum Hinzufügen[Bearbeiten | Quelltext bearbeiten]
wikieditor.addMySection[Bearbeiten | Quelltext bearbeiten]
Parameter
- name
- string, Name der neuen section
- art
- boolean,
true
für toolbar,false
für booklet
Rückgabe: keine
fügt eine neue section mit dem angegebenen Namen in die Leiste ein
wikieditor.addMyGroup[Bearbeiten | Quelltext bearbeiten]
Parameter
- wo
- string, Name der toolbar, in die die Gruppe eingefügt werden soll, Standard bei Leerstring ist
main
- name
- string, Name der Gruppe
Rückgabe: keine
fügt eine neue Gruppe mit dem angegebenen Namen in die angegebene Werkzeugleiste ein
wikieditor.addMyChars[Bearbeiten | Quelltext bearbeiten]
Parameter
- wo
- string, Name des Booklets (Standard bei Leerstring ist
characters
) bzw. Name des Booklets+ '/' +
Name der Zeichentabelle (Standard bei'/'
istcharacters/symbols
, in die die Zeichen eingefügt werden sollen - name
- string, Name der Zeichentabelle (falls nicht in bestehende Tabelle eingefügt wird)
- zeichen
- array, einzelne Elemente sind entweder vom Typ string (für einfache Zeichen), oder vom Typ array, in einer der Formen
['zeige', 'schreibe'], ['vorne', 'mitte', 'hinten']
- rtl
- boolean, optional, bei
true
wird von rechts nach links geschrieben, Standard istfalse
Rückgabe: keine
fügt eine Zeichentabelle ein
wikieditor.addMyTable[Bearbeiten | Quelltext bearbeiten]
Parameter
- wo
- string, Name des Booklets, in das die Tabelle eingefügt werden soll, Standard bei Leerstring ist
help
- name
- string, Name der Tabelle
- tabelle
- array, erstes Element ist Array mit Überschriften, nächste Elemente sind Arrays mit den Zellen der einzelnen Zeilen
Rückgabe: keine
fügt eine Tabelle ein
wikieditor.addMyButton[Bearbeiten | Quelltext bearbeiten]
Parameter
- wo
- string, Name der Leiste (
main
bei Leerstring)+ '/' +
(kann entfallen, falls Leerstring danach) Name der Gruppe (insert
bei Leerstring), dort wird der Button eingefügt - icon
- string, URL des Icons
- tooltip
- string, Tooltip
- vorne
- string, siehe wikieditor.action
- mitte
- string, siehe wikieditor.action
- hinten
- string, siehe wikieditor.action
- opt
- object, optional, siehe wikieditor.action
- func
- function, optional, siehe wikieditor.action
Rückgabe: keine
fügt einen Button ein
wikieditor.addMySelect[Bearbeiten | Quelltext bearbeiten]
Parameter
- wo
- string, siehe wikieditor.addMyButton
- name
- string, Name der Auswahlliste
- liste
- array, einzelne Elemente sind Arrays der Form
[name, vorne, mitte, hinten, opt, funktion]
, wobei name die Bezeichnung des Punktes ist und die anderen Parameter mit denen von wikieditor.addMyButton übereinstimmen
Rückgabe: keine
fügt eine Auswahlliste ein
wikieditor.addInternalTool[Bearbeiten | Quelltext bearbeiten]
Parameter:
- wo
- string, siehe wikieditor.addMyButton
- section
- string, interner Name der section des Tools
- group
- string, interner Name der group des Tools
- name
- string, interner Name des Tools selbst
Rückgabe:
boolean, true
Fügt ein Standard-Tool an der vorgegebenen Stelle ein. Da die Funktion nicht fehlertolerant ist, sollte der Aufruf am besten über wikieditor.add(Button|Section)
erfolgen.
Funktion zum Entfernen[Bearbeiten | Quelltext bearbeiten]
wikieditor.remove[Bearbeiten | Quelltext bearbeiten]
Parameter
- was
- string, Bezeichnung für das zu entfernende Objekt, entweder (Ebene 1) ein String ohne Schrägstriche (
main
undcharacters
als Standard bei Leerstring) oder (Ebene 2) ein String für Ebene 1 gefolgt von einem Schrägstrich und einem Bezeichner für Ebene 2 (insert
als Standard) oder (Ebene 3) ein String für Ebene 1 und 2 gefolgt von einem weiteren Schrägstrich und einem Bezeichner für Ebene 3 (Name eines Button/Selects/Zeichen). - art
- boolean,
true
für toolbar,false
für booklet
Rückgabe: keine
entfernt das angegebene Element
Funktionen zu vordefinierten Elementen[Bearbeiten | Quelltext bearbeiten]
aus Benutzer:Schnark/js/wikieditor.js/de.js
wikieditor.addSection[Bearbeiten | Quelltext bearbeiten]
Parameter
- was
- string, Kürzel für die section
- name
- string, optional, eigener Name für die section
Rückgabe:
boolean, true
, falls (vermutlich) etwas eingefügt wurde, false
, falls definitiv nichts eingefügt wurde
fügt eine vordefinierte section ein
wikieditor.addGroup[Bearbeiten | Quelltext bearbeiten]
Parameter
- wo
- string, siehe wikieditor.addMyGroup
- was
- string, Kürzel für die Gruppe
- name
- string, optional, eigener Name für die Gruppe
Rückgabe:
boolean, true
, falls (vermutlich) etwas eingefügt wurde, false
, falls definitiv nichts eingefügt wurde
fügt eine vordefinierte Gruppe ein
wikieditor.addChars[Bearbeiten | Quelltext bearbeiten]
Parameter
- wo
- string, siehe wikieditor.addMyChars
- was
- string, Bezeichnung der Zeichentabelle
- name
- string, optional, eigener Name für die Zeichentabelle
Rückgabe:
boolean, true
, falls (vermutlich) etwas eingefügt wurde, false
, falls definitiv nichts eingefügt wurde
fügt eine vordefinierte Zeichentabelle ein (nur gibt es keine vordefinierten Zeichentabellen)
wikieditor.addTable[Bearbeiten | Quelltext bearbeiten]
Parameter
- wo
- string, siehe wikieditor.addMyTable
- was
- string, Bezeichnung der Tabelle
- name
- string, optional, eigener Name für die Tabelle
Rückgabe:
boolean, true
, falls (vermutlich) etwas eingefügt wurde, false
, falls definitiv nichts eingefügt wurde
fügt eine vordefinierte Tabelle ein
wikieditor.addButton[Bearbeiten | Quelltext bearbeiten]
Parameter
- wo
- string, siehe wikieditor.addMyButton
- was
- string, Bezeichnung des Buttons
- name
- string, optional, eigener Name für den Button (könnte als Tooltip verwendet werden, wird aber ignoriert)
Rückgabe:
boolean, true
, falls (vermutlich) etwas eingefügt wurde, false
, falls definitiv nichts eingefügt wurde
fügt einen vordefinierten Button ein
wikieditor.addSelect[Bearbeiten | Quelltext bearbeiten]
Parameter
- wo
- string, siehe wikieditor.addMySelect
- was
- string, Bezeichnung der Auswahlliste
- name
- string, optional, eigener Name für die Auswahlliste
Rückgabe:
boolean, true
, falls (vermutlich) etwas eingefügt wurde, false
, falls definitiv nichts eingefügt wurde
fügt eine vordefinierte Auswahlliste ein
wikieditor.standard[Bearbeiten | Quelltext bearbeiten]
Parameter: keine, Rückgabe: keine
führt eine Standardkonfiguration durch
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