Benutzer:PerfektesChaos/js/pageLinkHelper

JavaScript-Benutzerskript – verschiedene kleine Helferlein für Links im Zusammenhang mit Wiki-Seiten:

• Difflink – als Wikilink formatierter Quelltext zum C&P.
• Permalink – als Wikilink formatierter Quelltext zum C&P.
• Purge – Link zum Purgen des Server-Cache in die Benutzeroberfläche einfügen.
• Weiterleitung – Eintrag in die Browser-History einfügen, falls über ein Weiterleitungslink hierher gelangt.

Einbindung

• Wenn das Projekt dieses Gadget bereits registriert haben sollte, genügt ein Häkchen auf der Seite Einstellungen („Helferlein“).
• Sonst wären die folgenden Zeilen in die persönlichen JS-Einstellungen einzufügen:

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

Difflink-Quelltext

Wenn ein Versionsvergleich aufgerufen wird, mit dem zwei Versionen derselben Seite gegenübergestellt werden, dann wird in der rechten oberen Ecke der Quelltext für ein Wikilink zum C&P dargestellt, ungefähr wie folgt.

[[Special:Diff/-]]

Solch ein Special:Diff/- ist viel kürzer als eine URL und funktioniert auch im Bearbeitungskommentar oder als Begründung für sonstige Aktionen, wo URL nicht ausgewertet werden.

Die in der Adresszeile des Browsers sichtbare URL wird nach Möglichkeit so umgestaltet, dass sie die Spezialseite zeigt, woraus sich auch im Nachhinein Wikiinks leicht extrahieren lassen.

Das generierte Element hat zwei Selektoren:

• .pageLinkHelper
• #pageLinkHelperDifflink

Es wird die URL der aufgerufenen Seite ausgewertet; auf welchem Weg man dorthin gelangte, ist nicht ermittelbar.

Zusätzlich wird auf der Diffpage zu den Metadaten jeder der beiden Versionen ein Permalink-Quelltext dargestellt. Dieses hat zwei Selektoren:

• .pageLinkHelper
• .pageLinkHelperDiffRev

Permalink-Quelltext

Wenn eine ältere Version einer Seite aufgerufen wird, dann wird in der rechten oberen Ecke der Quelltext für ein Wikilink zum C&P dargestellt, ungefähr wie folgt.

[[Special:PermaLink/-]]
[[Special:Redirect/page/8497652]]

Solche Wikilinks sind viel kürzer als eine URL und funktionieren auch im Bearbeitungskommentar oder als Begründung für sonstige Aktionen, wo URL nicht ausgewertet werden.

Das erste Permalink führt zur Seitenversion, das zweite verweist immer auf dieselbe Seite, auch wenn diese zwischenzeitig umbenannt wurde. In dem Kopiermuster ist eine Verlinkung eingebracht, der sich eine URL mitsamt dem rein informativen Parameter title= und dem Seitennamen entnehmen lässt.

Auf manchen Seiten ist (links) in der Werkzeugbox ein Link auf „Permanenter Link“ vorhanden. Die Funktion dieser Verlinkung wird dahingehend umgewandelt, dass auf jeder dieser Seiten die eben genannten Wikilink-Quelltexte eingefügt werden.

Das generierte Element hat zwei Selektoren:

• .pageLinkHelper
• #pageLinkHelperPermalink

Purgen des Server Cache

Der Benutzeroberfläche wird ein Link hinzugefügt, um die momentane Seite im Server-Cache zu aktualisieren (Purgen).

Beim „Vector“-Skin wird dies an das Menü angefügt, das sich unter dem ▼ oben auf der Seite ausklappen lässt. Weiter sind keine Maßnahmen erforderlich.

Bei allen anderen Skins – oder wenn ein anderer Ort für den Link gewünscht wird – ist eine Spezifikation notwendig durch eine Zeile etwa wie folgt:

mw.libs.pageLinkHelper = { purge: "p-tb" };

Dies sollte auf der common.js, global.js oder Skin-abhängigem JS stehen, und zwar möglichst vor dem Aufruf mw.loader.load() wie im Abschnitt „Einbindung“ beschrieben.

Der zugewiesene Code gibt an, wo der Link platziert werden soll:

• "p-cactions" – Ende der content actions (meist horizontales Menü oben auf der Seite) – Vorgabe;
• "p-tb" – Ende der Werkzeugbox (meist in der linken Spalte des Portals) – siehe Beispiel;
• "p-navigation" – Ende der Navigationsbox (meist in der linken Spalte des Portals);
• "ca-history" – jedes ausgewählte Portlet-Element dieser Boxen, nach dem der Purge-Link eingefügt werden soll.

Der generierte Link hat je nach Kontext einen Selektor wie:

• #ca-purge (Vorgabe)
• #n-purge
• #t-purge

Ausblenden ist auch möglich; etwa weil aus einem anderen Skript bereits entsprechende Möglichkeiten vorhanden sind:

mw.libs.pageLinkHelper = false;

Purgen für Experten: forcelinkupdate forcerecursivelinkupdate

Weitergehende Aktualisierungen als durch das einfache Purgen einer Seite können mit diesen Features erreicht werden. Das Ergebnis könnte allerdings verwirren. Es ist deshalb standardmäßig nicht aktiv. Experten wissen, wann es anzuwenden wäre und welche Auswirkungen das hätte.

Mit

mw.libs.pageLinkHelper = { forcelinkupdate: true,
                           forcerecursivelinkupdate: true };

(Vector) oder aber den gleichen Identifikatoren wie unter Purgen dargestellt kann in die portlet-Container ein Link eingefügt werden, das per API auf die gleiche Seite ein link update startet.

Der generierte Link hat je nach Container einen Selektor wie:

• #ca-purgeLinkUpd #n-purgeLinkUpd #t-purgeLinkUpd
• #ca-purgeLinkUpdRec #n-purgeLinkUpdRec #t-purgeLinkUpdRec

Weiterleitungen in der Browser-History

Wenn man einem Weiterleitungs-Link gefolgt war, erhält man eine kleine Notiz in der linken oberen Ecke der Seite; dazu ein Link auf die Weiterleitungsseite. Arbeitet man nun weiter, insbesondere wenn die Seite bearbeitet wird, dann ist bei der Rückkehr auf die Zielseite die Notiz verschwunden. Sie steht auch nicht in der Browser-History, sodass sie auch nicht über die Zurück-Funktion erreichbar wäre (schließlich war man ja auch nie wirklich auf dieser Weiterleitungsseite gewesen). Es gibt dann keinen einfachen Weg, um die Weiterleitungsseite zu erreichen, falls man dort etwas ändern möchte.

Dieses Gadget fügt in die Browser-History einen Zwischenschritt ein, wenn eine Weiterleitung verarbeitet worden war. Die dargestellte Seite ist immer noch dieselbe Zielseite; aber einen Eintrag zurück erscheint im Adressfeld des Browsers die URL, über die man direkt auf die Weiterleitungsseite gelangt. Klickt man nun das Adressfeld an, so wird die Weiterleitungsseite dargestellt und könnte bearbeitet werden.

Erforderliche Browser

Die Funktionalität ist vom Browser abhängig und bedarf relativ jüngerer Versionen: Chromium 5, Firefox 4, Gecko 2, IE 10, Opera 11.50, Safari 5.0.

Adresszeilen bis 2014

Bis Sommer 2014 stand in der Adresszeile die URL der Weiterleitungsseite, wenn man über eine Weiterleitung dorthin gelangt war.

Wenn dieses Verhalten weiterhin simuliert werden soll, kann die nachstehende Option gesetzt werden:

mw.libs.pageLinkHelper  =  {  redirect: { legacy: true }  };

Dies sollte auf der common.js, global.js oder Skin-abhängigem JS stehen, und zwar möglichst vor dem Aufruf mw.loader.load() wie im Abschnitt „Einbindung“ beschrieben.

Beobachtungsliste, Benutzerbeiträge, Versionsgeschichte, Letzte Änderungen

Hier stehen zu Beginn jedes Eintrags Links auf den Versionsunterschied und die Version, die sich schlecht in Wikilinks umformatieren lassen. Das Gadget ersetzt diese URL durch solche auf die entprechenden Spezialseiten, die sich sehr viel einfacher weiterverwenden lassen.

qqx – Systemnachrichten sichtbar machen

Eher von Techies benötigt wird ein zusätzliches Feature, das bei der Wartung der Systemkonfiguration hilft; es macht die Bezeichner der Systemnachrichten in einer Seite sichtbar. Es ist deshalb standardmäßig nicht aktiv.

Mit

mw.libs.pageLinkHelper = { slangQQX: true };

(Vector) oder aber den gleichen Identifikatoren wie unter Purgen dargestellt kann in die portlet-Container ein Link auf die gleiche Seite eingefügt werden, das mit uselang=qqc ausgestattet ist.

Der generierte Link hat je nach Container einen Selektor wie:

• #ca-langQQX #n-langQQX #t-langQQX

Mehrere Benutzeroptionen

Wenn mehrere Optionen angegeben werden sollen, muss ein etwas anderes Format gewählt werden, da man sich sonst gegenseitig überschreibt. Etwas professioneller sieht das wie folgt aus:

if ( typeof mw.libs.pageLinkHelper !== "object" ) {
   mw.libs.pageLinkHelper = { };
}
mw.libs.pageLinkHelper.purge = "p-tb";
mw.libs.pageLinkHelper.redirect = { legacy: true };

Dies sollte auf der common.js, global.js oder Skin-abhängigem JS stehen, und zwar möglichst vor dem Aufruf mw.loader.load() wie im Abschnitt „Einbindung“ beschrieben.

Sprachkonfiguration

Die grundsätzliche Funktionalität ist auf jedem Wiki gegeben.

Die optische Darstellung kann für jede Sprache und ggf. auf jedem einzelnen Wiki individuell angepasst werden. Wenn keine gesonderte Spezifikation bekannt ist, fällt die Umsetzung in die englische Sprache zurück.

Zurzeit sind für „Deutsch“ standardmäßig Anpassungen vorhanden; auch bei der Benutzeroberfläche von mutmaßlich deutsch verstehenden Benutzern.

Weitere Übersetzungen können auf Wunsch zentral eingepflegt werden.

Individuell können Programmierer mittels einer Objektdefinition

mw.libs.pageLinkHelper.config = { /* ... */ };

jederzeit die Textkomponenten variieren, indem Komponenten analog zur lokalen Config vorgegeben werden.

Code und Stammseite

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

Quellcode	JavaScript – Komprimierter Code zum Laden Kommentiertes Skript – zum Lesen durch Menschen und Debuggen
ResourceLoader	ext.gadget.pageLinkHelper für mw:Extension:Gadgets Dependencies: user, mediawiki.util
Namensraum	-1   *   Contributions Watchlist (Gadgets) sowie Diff falls das jemals vorkommen sollte Jeder inhaltliche Namensraum.
mw.libs	pageLinkHelper