Benutzer:PerfektesChaos/js/WikiSyntaxTextMod/usage

Benutzung

Einbindung

In die persönlichen JS-Einstellungen sind die Zeilen

// [[Benutzer:PerfektesChaos/js/WikiSyntaxTextMod]]
mw.loader.load( "https://en.wikipedia.org/w/index.php?title=User:PerfektesChaos/js/WikiSyntaxTextMod/r.js&action=raw&bcache=1&maxage=604800&ctype=text/javascript",
                "text/javascript" );

einzufügen. Dies reicht für die Basisversion schon aus. (Die erste Zeile ist ein Kommentar mit einem fiktiven Wikilink, durch das mit „Links auf diese Seite“ die Einbindungen zurückverfolgt werden können und Anwender über Neuerungen informiert werden könnten.) Die Heimatbasis ist die englischsprachige Wikipedia; die deutschsprachige Wikipedia enthält eine funktionsgleiche Kopie (nicht immer genauso aktuell).

Früher wurde empfohlen:

importScript("Benutzer:PerfektesChaos/js/WikiSyntaxTextMod/r.js");

Ab Mitte 2011 neu entwickelte Browserversionen haben damit jedoch zunehmend Probleme, die Funktion importScript ist inzwischen veraltet, und die deutschsprachige Wikipedia ist nicht die wirkliche Basis.

JavaScript muss im Browser für die Wikipedia aktiviert sein, was meist bereits der Fall sein wird.

Daraufhin wird die automatische Syntaxpolitur aktiv. Hat sie beim Öffnen eines Artikels zur Bearbeitung Ersetzungen vorgenommen, wird zur Kontrolle eine DiffPage angezeigt, mit der man die Änderungen kontrollieren kann.

Wenn der bearbeitete Artikel ungesichtet war, wird dessen DiffPage Versionsvergleich mit der letzten gesichteten Version nach kurzer Anzeige überdeckt. Beim Speichern des Artikels erscheint sie aber ohnehin erneut, sofern nicht Markieren angeklickt wurde. Insofern wird man so oder so darauf hingewiesen, dass man eine ungesichtete Seite bearbeitet.

Sind schwerwiegende Syntaxfehler gefunden worden, die nicht oder nicht völlig sicher zu beheben waren, wird über der DiffPage eine auffällige Benachrichtigung angezeigt.

Fliegelflagel

Über fliegelflagel@Schnark kann WikiSyntaxTextMod ebenfalls und nur durch ein Häkchen aktiviert und wieder deaktiviert werden.

Disclaimer: This script comes with absolutely no warranty. If your text gets scrambled, and if you save that and catch a VM – don’t blame me.

Benutzerdefinierte Ersetzungen und Warnungen

Über die automatisierte Syntaxpolitur hinaus lassen sich eigene Ersetzungsausdrücke formulieren; mehr dazu hier.
Außerdem lässt sich vor verdächtigen Elementen warnen; mehr dazu hier.

Kontrollseite der Syntaxpolitur unterdrücken

Das Skript ist dazu gedacht, automatisiert und ohne Benutzerintervention still im Hintergrund zu arbeiten.

Standardmäßig werden vorgenomene Ersetzungen angezeigt, nachdem ein Artikel zur Bearbeitung geöffnet wurde; dieses Verhalten lässt sich jedoch abschalten und das Skript arbeitet völlig diskret.

Wenn du dem Skript bis zu einem gewissen Grad traust, kannst du vor dem mw.loader.load einfügen:

mw.libs.WikiSyntaxTextMod  =  { config:  { diffPage: false }  };

Die Diff-Seite wird dann für Korrekturen an der Basis-Syntax nicht angezeigt.

Hat einer deiner selbst definierten Ersetzungsausdrücke zu einer Veränderung geführt, lässt sich die Kontrollseite jedoch nicht unterdrücken. Bei bestimmten Korrekturen von schwereren Syntaxfehlern erscheint die Kontrollseite sicherheitshalber trotzdem.

Bei der Vereinbarung handelt es sich um eine Komponente des Anwendungsobjekts. Wenn du mehrere Optionen setzen möchtest, wäre nach Definition des Anwendungsobjekts vor import/load zu schreiben:

mw.libs.WikiSyntaxTextMod.config.diffPage = false;

Link auf der Portalseite

In die Links auf der Portalseite kann ein Aufruf von WikiSyntaxTextMod eingefügt werden, das nur angezeigt wird, wenn ein solcher Aufruf auch möglich und sinnvoll ist. Mit integrierter Definition des Anwendungsobjekts wäre die Standardlösung:

   mw.libs.WikiSyntaxTextMod  =  { config:  { portlet: true }  };

Bei der Vector-Skin wird in das ausklappbare Menü eingefügt, bei allen anderen in der Werkzeugbox am linken Rand.

Der Tooltip des Werkzeug-Links zeigt die Versionsnummer(n) an.

An individuelle Wünsche angepasst werden kann statt dessen mit den Mitteln von addPortletLink():

`.portlet.scope`	Elementgruppe, zu der hinzugefügt werden soll. `p-cactions` oder `p-tb` oder andere; siehe Skin/GUI.
`.portlet.show`	Linktitel
`.portlet.swift`	Möglichst eindeutiger einzelner Buchstabe (oder anderes Zeichen) zur Bildung einer Tastenkombination.
`.portlet.stick`	Bezeichner eines anderen Elements im selben Container, vor dem das neue Element eingefügt werden soll.
Der Bezeichner des neuen Elements lautet "`ca-WSTM-run`".

Beispiel für ein Link in der Werkzeugbox an linken Rand:

   mw.libs.WikiSyntaxTextMod  =  { config:  { portlet: {scope:"p-tb"} }  };

Es gibt auch die Möglichkeit des selbst programmierten Manuellen Starts.

Steuerparameter

Durch Definition der nachstehenden Variablen lässt sich das Verhalten des Skripts beeinflussen. Optimal ist die vorbeugende Definition, bevor Fliegelflagel oder loader.load ausgeführt werden.

.config.diffPage: →Kontrollseite der Syntaxpolitur unterdrücken
.config.mod.plain: →Benutzerdefinierte Ersetzungen
.config.mod.link: →Benutzerdefinierte Ersetzung von Linkzielen (veraltet)
.config.mod.comment: →Benutzerdefinierte Ersetzung von Kommentaren
.config.mod.template: →Benutzerdefinierte Ersetzungen in Vorlagen
.config.mod.tested: →Benutzerdefinition ist ausgetestet
.config.mod.summary: →Bearbeitungskommentar anhängen
.config.page.include: Weitere Namensräume und/oder Seitentitel einbeziehen; →Fortgeschrittene Option
.config.page.exclude: Namensräume und/oder Seitentitel ausschließen; →Fortgeschrittene Option
.config.page.support: Namensräume und/oder Seitentitel in manuelle Aktionen einbeziehen; →Fortgeschrittene Option
.config.page.oldid: Frühere Artikelversionen einbeziehen; →Fortgeschrittene Option
.config.load.inhibit: Lade Skript ohne es auszuführen; →Fortgeschrittene Option
.config.load.updater: Aktualisiere Modulversions-Cookies; →Fortgeschrittene Option

Codes und Stammseite

Das Skript ist eigentlich auf der englischsprachigen Wikipedia beheimatet; in der deutschsprachigen Wikipedia steht eine funktionsgleiche Kopie.

Die Stammseite ist en:User:PerfektesChaos/js/WikiSyntaxTextMod mit:

Quellcode	siehe Technische Interna
ResourceLoader	`user:PerfektesChaos/WikiSyntaxTextMod` für mw:Extension:Gadgets Dependencies: `user`, `user.options`, `mediawiki.user`, `mediawiki.util`
Namensräume	ANR; sowie alle geradzahligen Namensräume `-1` (`Gadgets`)
Cookies	(`WikiSyntaxTextMod_rvIDs` – [eine Woche] falls localStorage nicht verfügbar) sessionStorage: `WikiSyntaxTextMod_errors` – aktuelle Fehlermeldung localStorage: `WikiSyntaxTextMod_rvIDs` – Versionsverwaltung `preferencesGadgetOptions` – Optionen für nicht angemeldete Benutzer
`mw.libs`	`WikiSyntaxTextMod`