Syntax- und API-Referenz

Referenz aller öffentlichen Elemente des Plugins wkacmenu: Wiki-Syntax, Order-Seite, Konfiguration, AJAX-Endpunkte, PHP-API, CSS-Klassen, Cookie. Einführung und Konzepte: Überblick.

Signatur:

{{wk:acmenu>}}
{{wk:acmenu>parameter=wert|parameter=wert|...}}

Zusammenfassung: Rendert das Akkordeon-Menü an der Stelle des Aufrufs (üblich: in einer Sidebar-Seite, zusammen mit ~~NOCACHE~~).

Parameter (pipe-getrennt; das > nach wk:acmenu ist Pflicht, sonst greift DokuWikis Media-Syntax und rendert einen kaputten Link):

Anmerkungen:

• Ohne ns/startns sucht das Plugin aufwärts nach einer sidebar*-Seite und beginnt das Menü an diesem Namespace.
• In den fokussierten Modi (ns=auto, startns=current) wird eine Sammlung nie Menü-Basis; die Basis verlagert sich zum Eltern-Namespace der äußersten Sammlung.
• Die Namespace-Genealogie der aktuellen Seite wird immer server-seitig vorgeladen — ein offener Knoten auf dem aktuellen Pfad zeigt seine Kinder auch jenseits der dynamic-Tiefe.
• Ohne dynamic entscheidet die Einstellung default_depth (Vorgabe 1): eine Ebene server-seitig, tiefere Namespaces werden beim Anklicken nachgeladen. Unbegrenzt heißt, bei jedem Seitenaufruf den ganzen Seitenbestand zu durchlaufen — das Menü ist bewusst nicht zwischengespeichert, weil es von aktueller Seite, Rechten und Aufklapp-Zustand abhängt.
• Bei sneaky_index werden geschützte Zwischen-Namespaces mit lesbarem Inhalt darunter als partial angezeigt: Beschriftung ohne Link, aufklappbar.

Beispiel:

~~NOCACHE~~
{{wk:acmenu>ns=auto|icons=fa|dynamic=1}}

Signatur:

{{wk:title>Titeltext}}
{{wk:title>de:Text|en:Text}}

Zusammenfassung: Hinterlegt einen unsichtbaren Menü-Titel in den Metadaten der Seite.

Wert: beliebiger Text; optional ein eingebetteter ...-Ausdruck (Plugin wki18n).

Anmerkungen: Titel-Priorität im Menü: Titel-Marker vor erster Überschrift (useheading) vor Seiten-ID. Wirkt nach dem nächsten Rendern der Seite.

Beispiel: siehe How to: Menü-Titel ohne sichtbare Überschrift setzen.

Signatur:

~~COLLECTION~~

Zusammenfassung: Markiert — auf der start-Seite eines Namespace — den Namespace als Seitensammlung.

Wert: keiner; Leerraum vor dem schließenden ~~ wird toleriert.

Anmerkungen: Wirkung (Ikone, Klickverhalten, Menü-Basis-Verlagerung, kein start-Kind-Blatt): How to: Einen Namespace als Seitensammlung führen. Der Marker liegt nur in den aktuellen Metadaten — nach Entfernen und erneutem Rendern ist er weg. In Markdown-Seiten wird er nicht erkannt.

Beispiel: siehe How to: Einen Namespace als Seitensammlung führen.

Signatur: Seite <ns>:<orderpagename> (Standard: <ns>:order), Klartext:

# Kommentar
eintragsname
weiterer-eintragsname

Zusammenfassung: Legt die Reihenfolge der Menü-Einträge einer Namespace-Ebene fest.

Werte: ein Eintragsname je Zeile — Seitenname oder Name des Unter-Namespace, relativ zum Namespace, keine vollen IDs; Leerzeilen und #-Kommentare werden ignoriert; Duplikate zählen einmal.

Anmerkungen: Gelistete Einträge führen in Dateireihenfolge, ungelistete folgen in der Standard-Sortierung (Namespaces vor Seiten, alphabetisch, start zuerst). Die Seite wird ohne ACL-Prüfung gelesen (Sortier-Konfiguration), erscheint nie als Menü-Eintrag und sollte per hidepages verborgen sein. Schreibbar per Hand oder per Drag & Drop.

Beispiel: siehe How to: Menü-Reihenfolge festlegen.

Seit Version 1.6.0 (Design-System-Vereinheitlichung) rendert das Rendering durchgehend über wkfluentuis geteilte tree()-Komponente (API-Referenz) — beide Endpunkte unten spiegeln das in ihrem Antwortformat.

Signatur: GET lib/exe/ajax.php?call=plugin_wkacmenu_load&ns=<ns>&icons=<0|1>

Zusammenfassung: Liefert eine Ebene eines Namespace als HTML (Lazy Loading). Die darin enthaltenen Namespaces sind ihrerseits Nachlade-Knoten, scripts/treeview.js verdrahtet sie im eingefügten Ausschnitt erneut.

Antwort: rohes HTML-Fragment (Content-Type: text/html), ein einzelnes <ul class=„wk-tree“>…</ul> — kein JSON mehr. scripts/treeview.js (Plugin wkfluentui) lädt die URL direkt per fetch() und ersetzt damit den leeren Platzhalter-Knoten; das Plugin selbst enthält dafür keinen JavaScript-Code mehr. Fehlerfälle liefern einen leeren Body mit Nicht-2xx-Status (400 fehlender ns-Parameter, 403 ACL, 503 wkfluentui nicht verfügbar) statt eines JSON-Fehlerobjekts.

Anmerkungen: Verlangt Leserecht auf die start-Seite des Namespace; die gelieferten Einträge sind ACL-gefiltert.

Signatur: POST lib/exe/ajax.php?call=plugin_wkacmenu_order mit wk-tree-move (bewegte Seiten-/Namespace-Start-ID), wk-tree-ref (Ziel-ID), wk-tree-pos (before/after), sectok (JSINFO.plugins.wkfluentui.sectok, nicht mehr ein plugin-eigenes Token).

Zusammenfassung: Schreibt die Order-Seite des Namespace anhand einer einzelnen Verschiebe-Operation, ausgelöst von tree()s eingebautem nativen HTML5-Drag&Drop (scripts/treeview.js). Der Server leitet die betroffene Namespace-Ebene selbst aus den beiden vollen, eindeutigen IDs her (syntax_plugin_wkacmenu::orderOwnerNs()) und lehnt Verschiebungen über Ebenen hinweg ab — anders als vor 1.6.0 wird kein Namespace-String mehr vom Client entgegengenommen.

Antwort: kein JSON mehr — echter Formular-POST (natives <form>-Submit von treeview.js, kein Hintergrund-fetch()), die Antwort ist eine HTTP-Weiterleitung auf die aufrufende Seite. Bei Erfolg ohne weiteren Hinweis (die neu einsortierte Position nach dem Neuladen ist die Bestätigung — keine Gold-Flash-Animation mehr); bei Fehler mit einer roten Fehlermeldung auf der Zielseite (der Fehlergrund reist als geprüfter Query-Parameter wkacmenu_order_msg mit, da DokuWikis msg() eine Weiterleitung nicht übersteht).

Anmerkungen: Nur Superuser; POST-only; CSRF-Token wird geprüft; jeder abgeleitete Eintragsname wird server-seitig re-validiert (cleanID, einteilig); Sperr-Prüfung der Order-Seite; jeder Aufruf erzeugt eine Wiki-Revision. Die Client-Reihenfolge ist Präsentation, nie Autorisierung. Das Weiterleitungsziel wird gegen den eigenen Host geprüft (kein offener Redirect über einen gefälschten Referer-Header).

Öffentliche Methoden der Klasse syntax_plugin_wkacmenu für andere Plugins/Templates:

Seit 1.6.0 kommt die Basisoptik (Baumstruktur, Links, aktiver Zustand, Container-Tönung) aus wkfluentui/style.csss .wk-tree*-Klassen (Sidebar/Auxbar-Kontrakt „Dokument“, Styles-Contract v16). wkacmenu/style.css liefert nur noch die plugin-eigene Verfeinerung:

Entfallen (kein Ersatz nötig, native <details>-Semantik übernimmt): .acmenu-up (Nach-oben-Eintrag ist ein regulärer Knoten), .open/ .closed (der open-Attributzustand von <details>), .curid (ersetzt durch .wk-tree__link–active), .acmenu-drag/ .acmenu-sort-placeholder/.acmenu-saved (natives HTML5-Drag&Drop, kein Griff-Element, keine Speicher-Flash-Animation mehr).

Geöffnete Knoten liegen im Cookie plugin_wkacmenu_open_items (JSON-Array von Seiten-IDs). Das Plugin liest ihn server-seitig beim Rendern und lädt die dort verzeichneten Knoten vor — der Menüzustand übersteht Seitenwechsel ohne Flackern. Seit 1.6.0 schreibt script.js den Cookie über das native toggle-Ereignis von <details> statt über einen Klick-Handler; das ist die einzige verbliebene JavaScript-Aufgabe dieses Plugins — Baum-Rendering, Lazy-Load und Drag & Drop laufen vollständig über wkfluentui/scripts/treeview.js.

Der Weg einer Menü-Ausgabe, vom Auslöser bis zum fertigen Baum. Die Schritte 2 bis 5 gehören dem Plugin, 6 bis 8 dem Bausatz — das ist die Grenze, die seit Version 1.6.0 gilt: Datenbeschaffung hier, Darstellung dort (siehe Versionsgeschichte).