Modul:DokuTools/Doku

Zweck

Das Modul stellt kleine Hilfsfunktionen für Dokumentationsseiten bereit. Aktuell enthält es eine Funktion, um Links zur Cirrus-Suche zu erzeugen, die alle Seiten anzeigt, welche die aktuelle Vorlage/Seite transkludieren.

Dies ist vor allem in Dokumentations- oder Wartungskontexten nützlich, z. B. vor Änderungen an Vorlagen oder Modulen.

Verfügbare Funktionen

transcludesUrl()

Gibt die reine URL zur Cirrus-Suche zurück.

Ergebnis kann direkt in Vorlagen oder Modulen weiterverwendet werden.

transcludesLink

Gibt einen formatierter Link zurück.

Eignet sich für die direkte Einbindung in Dokumentations- und Footerboxen.

Nutzung

Das Modul unterstützt sowohl die Ausgabe als einen kompletten, anpassbaren Link, als auch die Ausgabe der eigentlichen „Helferfunktion“ um nur die URL — zum Beispiel für die Weiterverwendung in einem Button oder komplexeren Vorlagen zu ermöglichen.

Ausgabe eines Links

{{#invoke:DokuTools|transcludesLink}} Das Standardlabel „Einbindungen suchen“ wird gesetzt.

Optional kann das Label angepasst werden:

{{#invoke:DokuTools|transcludesLink|label=Verwendungen anzeigen}}

Nutzung ohne Link (nur URL)

{{#invoke:DokuTools|transcludesUrl}}

Technische Hinweise

• Wenn die Dokumentationsseite den Suffix /Doku trägt, wird dieser automatisch entfernt.
• Die Namensraumbezeichnung wird berücksichtigt (z. B. Vorlage:Name, Modul:Name).
• Die erzeugte Cirrus-Suchanfrage nutzt hastemplate:.

Siehe auch

• Modul:Dokumentation – Hauptmodul für Dokumentationen
• Vorlage:Dokumentation – Vorlage zur Verwendung des Dokumentationsmoduls