CatNav/de

CatNav ist ein Werkzeug, mit dem eine erweiterte Auflistung von Kategorie-Mitgliedern durchgeführt wird. Es ist der Wiki-Funktion „Kategorie-Ausstellung“ sehr ähnlich, ermöglicht es jedoch, Seiten aus mehreren Kategorien aufzulisten, sowie Kategorien anzugeben, aus denen man keine Seiten auflisten möchten.

Installation[]

Verwendung[]

Nach der Installation erscheint ein „CatNav“-Link in der unteren Wiki-Leiste. Nach dem Draufklicken gelangt man zu Spezial:CatNav, wo die Funktion zu finden ist.

Die Hauptkomponente von CatNav besteht aus 2 Textbereichen, die jeweils eine durch Leerzeichen getrennte Liste von Kategorie-Namen enthalten:

Ein „Beinhalten“-Textfeld: Hier können Kategorien angeben werden, aus denen man Seiten für die Navigation sammeln möchte. Eine Seite wird nur dann aufgelistet, wenn sie jede der angegebenen Kategorien enthält. Es muss mindestens 1 Kategorie angeben werden.
Ein „Ausschließen“-Textfeld: Wenn es vorgezogen wird, Seiten aus bestimmten Kategorien nicht aufzulisten, kann man diese hier auflisten. Dieses Textfeld ist optional und kann leer gelassen werden.

Nach dem Fertigstellen klicke auf die Schaltfläche „Generieren“. Wenn Ergebnisse gefunden werden, werden sie unterhalb des CatNav-Formulars aufgelistet, wobei jede Seite durch eine quadratische Miniaturansicht mit einem Titel dargestellt wird. Wenn es zu viele Ergebnisse gibt, werden sie in Unterseiten aufgeteilt.

Darüber hinaus gibt es einige zusätzliche Optionen:

Ein „Favoriten“-Menü oberhalb des Textbereiches ermöglicht es, häufig verwendete Kategorien zu deinen Favoriten hinzuzufügen. Immer wenn CatNav in diesem speziellen Wiki aufgerufen wird, werden deine Lieblingskategorien geladen. Nach dem Klicken mit der linken Maustaste auf eine Kategorie, wird diese dem Textfeld „Einschließen“, und mit der rechten Maustaste dem Textfeld „Ausschließen“ hinzugefügt. Elemente können aus den Favoriten hinzugefügt und entfernt werden.
Auswahl der Anzahl der Zeilen für jede Unterseite der Navigation (die Breite richtet sich nach der Bildschirmgröße)
Die Option, nur die Seiten des Hauptbereichs oder die Seiten aller Namensräume aufzulisten (Standard ist Artikel)
Sortieroptionen

Einstellungen[]

Das Skript definiert immer ein window.CatNav Objekt, mit einer init Methode für die Neuinitialisierung der Schnittstelle zu jeder Zeit. Es kann als Funktionsrückruf verwendet werden, oder rufe CatNav.init zu jeder Zeit auf.

Debug-Modus[]

Allgemeine Konsolen-Ereignisse werden in einem lokalen Array protokolliert. Falls daran Interesse besteht, können diese in der Konsole des Browsers angezeigt werden. Füge dazu folgende Zeile über dem Import hinzu:

window.CatNav = {debug: true};

Events[]

Es können benutzerdefinierte DOM-Ereignisse verwendet werden, um zu erfahren, wann etwas auf der CatNav-Seite passiert. Jedes Ereignis soll durch ein bestimmtes Element ausgelöst werden. (Verwendung von addEventListener oder jQuerys .on(), als Beispiel). Die folgenden Ereignisse sind verfügbar:

Ereignis	Ziel	Wenn ausgeführt
`catnavready`	`document.body`	Wenn die Oberfläche von CatNav vollständig geladen ist
`catnavgenerated`	`#catnav`	Wenn CatNav die Erstellung von Inhalten beendet hat
`catnavpageload`	`#catnav`	Immer, wenn der Benutzer eine bestimmte Navigationsseite aufruft. Wenn es gleichzeitig mit `catnavgenerated` ausgelöst wird, hat es eine zusätzliche Eigenschaft von `uponGeneration`, die auf `true` gesetzt ist. Dies kann verwendet werden, damit sich `catnavpageload` anders verhält, wenn das Skript die erste Seite nach der Generierung des Inhalts automatisch öffnet.

Globale Favoriten[]

Es kann auch eine Liste von Lieblingskategorien über Spezial:Meine Benutzerseite/catnav.css in der Community-Zentrale festgelegt werden. Nach dem Klicken auf die Schaltfläche „Importieren“, werden alle mit dem aktuellen Wiki verknüpften Lieblingskategorien in den lokalen Speicher deines Geräts importiert (um die globalen Einstellungen zu ändern, muss die globale Seite bearbeitet werden).

Anmerkung: Wenn du bereits Favoriten-Kategorien in einem bestimmten Wiki hast und dann auf die Schaltfläche „Importieren“ klickst, werden die Favoriten-Kategorien, die nicht in deinen globalen Einstellungen für das betreffende Wiki auftauchen, nicht gelöscht, sondern nur Kategorien hinzugefügt, die vorher noch nicht zu den Favoriten gehörten.

Die Syntax ist die folgende:

  eine Zeile, die mit Leerzeichen beginnt, ist ein Kommentar. Diese Zeile kann auch leer gelassen werden

  um bevorzugte Kategorien zu deklarieren, deklariere zuerst das Wiki, zu dem es gehört
  dazu beginne eine Zeile mit einem „@“, gefolgt von der Subdomain des Wikis
  (verwende das Präfix „<lang>.“, falls erforderlich)
@clubpenguin
  alle Kategorien unter dieser Zeile sind von [[w:c:clubpenguin]]
  um eine Kategorie zu deklarieren, beginne eine Zeile mit einem „#“
#Clothing
  die obere Zeile ist bezogen auf [[w:c:clubpenguin:Category:Clothing]]
#Puffles
#Parties
#Characters/Penguin Band
  ^ Es können auch Unterkategorien verwendet werden


  um Kategorien für ein anderes Wiki zu deklarieren, deklariere die Subdomain neu. z. B. das spanische Runescape-Wiki:
@es.runescape
#Armaduras Híbridas

Hinweise[]

Es können Wikis zweimal deklariert werden, aber es ist ratsam, alle Kategorien für jedes Wiki zusammen zu speichern, um die Verwaltung der Kategorien zu erleichtern.
Achte darauf, dass keine Kategorien aufgelistet werden, ohne vorher die zugehörigen Wikis anzugeben.
Vergewissere dich, dass die Subdomain des angegebenen Wikis gültig ist. Ungültige URL-Zeichen führen zu einer Fehlermeldung, aber ungültige Wiki-Subdomains können stillschweigend akzeptiert werden.
Kommentare können geschrieben werden, indem man die Zeile mit jedem Zeichen außer „@“ oder „#“ beginnt, aber bitte nur Leerzeichen als Kommentar-Zeilenbeginn verwenden, um andere Zeichen für mögliche zukünftige Updates zu reservieren. Die Verwendung anderer Zeichen für Kommentare könnte in Zukunft ein unerwartetes Verhalten hervorrufen.

Für den Fall, dass das Wiki, in dem deine Lieblingskategorien gespeichert werden, nicht die Community-Zentrale ist (mehr Infoformationen im Globale Favoriten Abschnitt), kann man das importieren/exportieren folgendermaßen definieren:

window.CatNav = window.CatNav || {};
window.CatNav.storage = [wikiUrl, scriptPath];

wikiUrl ist die vollständige Wiki-URL (z. B. "https://community.fandom.com/de")
scriptPath ist der URL-Pfad zum Skript auf dem Wiki (leere Zeichenkette im Fall von Fandom). Es kann mit wgScriptPath überprüft werden.

Beachte, dass CatNavs Funktionalität auf Fandoms API beruht, sodass es aktuell nicht auf nicht-Fandom Wikis funktioniert (z. B. Wikimedia Wikis, wie u. a. Wikipedia und Commons).

Credits und besonderer Dank[]

Chiến Thần Vương - schlug vor, Sortieroptionen und Lieblingskategorien hinzuzufügen und einige kleine Skript-Änderungen vorzunehmen
Dai ca superman - zum Senden mehrerer wichtiger Fehlerberichte
RianL110 - zum Senden von Fehlerberichten
Aspallar - Benachrichtigung und Bereitstellung einer API-Syntax-Korrektur, wenn die UCP implementiert ist
CrescentHusky12 - Senden eines Fehlerberichts im Zusammenhang mit nicht-alphabetischen Sortiermethoden
Magiczocker - implementing i18n & major cleanup

Versionsgeschichte[]

Date	Description
March 17, 2015	Prototype release in the Club Penguin Wiki.
September 9, 2015	Script improvements and official release in the Dev wiki.
September 3, 2016	Adding favorite categories and sorting options. Also, now adding empty lines no longer returns an error. Minor changes in the interface and some other code tweaks.
September 18, 2016	Providing global favorites importing to the current wiki in the current device. Some small CSS changes.
October 7, 2016	Added sorting by popularity (uses standard Category Exhibition order, due to limitations of the current popular pages API available in Fandom and MediaWiki) and the ability to get the exported syntax for your current wiki. Added monobook selectors and added support for wikis with a different "Special:" prefix.
October 8, 2016	syntax fixes, fixing sorting issues with sorting by popularity, and extra updates for the export interface.
October 10, 2016	Providing global `CatNav` object. Making script path wiki-specific.
October 15, 2016	Solving issue with global imports.
October 28, 2016	Adding sorting by article comments.
November 19, 2016	Adding results counter and the `catnavpageload` event.
November 19, 2016	Giving a contrast to the results counter, and adding the `catnavready` and `catnavgenerated` events.
May 26, 2017	Fixed crash that occurs if any of the pages in the currently-viewed CatNav page contains commas in its title.
April 1, 2018	Fixed contrast of results counter.
June 9, 2020	Fixed script compatibility for non-English wikis after an update in their URL path syntax across Fandom.
June 22, 2020	Fixed text contrast issues for wikis with a non-hexadecimal page background value.
June 23, 2020	Adapting the API requests to the MediaWiki version of the Unified Community Platform.
October 31, 2020	Updating lines that relied on UFC-deprecated `wg` parameters.
June 26, 2021	Adding FandomDesktop compatibility (special thanks to Original Authority), as well as making it compatible with non-FandomDesktop Gamepedia wikis. Making the script compatible with UCP wikis that have numerous language versions. Removing sorting options that relied on the now-defunct article comment and category exhibition features. Adding title filtering options. Most console logs/errors will now only be visible on debug mode. Some UI and other small, miscellaneous changes.
July 1, 2021	Fixing bug related to updating the browser's tab title.
August 2, 2021	Fixing issue with large results when selecting non-alphabetic sorting modes (special thanks to CrescentHusky12).
August 14, 2022	Implementing i18n and major cleanup (special thanks to Magiczocker)
August 20, 2022	Updating variables, fixing minor issues with the number of results
September 26, 2022	Fixing issue with large requests sorted by non-alphabetical order, small i18n change