Inyoka-Wiki-Makros
Die Basis-Software Inyoka des Wiki von ubuntuusers.de (Ikhaya) stellt einige Makros bereit, die ähnlich wie die Textbausteine (Vorlagen) angewendet werden können und deren Benutzung im folgenden erläutert wird.
Hinweis:
Diese Seite richtet sich an erfahrene Autoren von Artikeln im Wiki und an das Wikiteam, die für ihre Arbeit technische Details zur Funktionsweise der Wiki-Software benötigen.
Was ist ein Makro?¶
Ein Makro im Sinne dieses Artikels wird beim Rendern einer Seite ausgeführt und liefert dann ein Ergebnis, welches als Text formatiert in den Artikel eingefügt wird. Es kann sich dabei um eine möglicherweise parametrierbare Abfrage aus den Datenbeständen des Wiki handeln, oder es wird (wie beim Makro Vorlage) eine andere Seite (die Textvorlage) interpretiert.
Alle Textbausteine verwenden beispielsweise das Makro
Vorlage.Die Einbindung von Bildern in eine Seite im Wiki geschieht über das Makro
Bild.Weitere Makros listet die folgende Tabelle.
Welche Makros gibt es?¶
| Tabelle 1: Makros zur Verwendung in Artikeln des Wiki | |||
| Bereich | Makroname Alias | Parameter | Beschreibung |
| Wiki | PageCount Seitenzahl | --- | Ermittelt die Anzahl aller Seiten im Wiki. Das sind 6681. |
| Wiki | PageList Seitenliste | pattern case_sensitive shorten_title | Listet als Block alle Seiten im Wiki, deren Titel dem Muster im Parameter pattern entspricht. Das Muster kann * als Wildcard enthalten. Der Parameter case_sensitive kann die Werte True (Vorgabe) oder False annehmen und steuert, ob die Suche Groß-/Kleinschreibung beachtet oder nicht. Der Parameter shorten_title kann die Werte True oder False (Vorgabe) annehmen und steuert, ob der Name auf seinen letzten Teil (nach dem letzten /) gekürzt wird oder nicht. Die boolschen Werte True und False soll man als Ziffern 1 bzw. 0 angeben; andere Werte ergeben möglicherweise unerwartete Ergebnisse. |
| Wiki | TagList TagListe | tag | Listet als Block alle Seiten mit dem über den Parameter tag angegebenen Schlagwort. |
| Wiki | PageName Seitenname | --- | Zeigt den Namen der aktuellen Seite. Das funktioniert nicht immer, sondern nur dann, wenn der Renderer den Namen auch kennt. |
| Forum Ikhaya Wiki | Template Vorlage | erforderlich | Inkludiert die mit dem ersten Parameter angegebene andere Seite in die aktuelle Seite und ruft einen Parser mit den weiteren Parametern auf. Die einzubindende Seite muss relativ zu Wiki/Vorlagen angegeben werden und kann ein ausführbares Programm in der Vorlagensprache enthalten – dies ist die technische Grundlage für die Textbausteine. Abhängig von der verwendeten Textvorlage sind dafür weitere Parameter möglich bzw. erforderlich. |
| Wiki | Attachment Anhang | attachment text | Erzeugt einen Download-Link für den mit dem Parameter attachment angegebenen Anhang. Man kann den Anhang relativ zus aktuellen Seite oder als absoluten Link angeben. Der Download-Link wird im Artikel als der mit dem Parameter text angegebene Text anklickbar dargestellt. |
| Ikhaya Wiki | Picture Bild | picture size align alt title | Das mit dem Parameter picture angegebene Bild wird auf der Seite angezeigt. Das Bild kann aus externer Quelle stammen oder ein Anhang der aktuellen Seite sein. Ein Vorschaubild wird automatisch erzeugt. Sofern angegeben, wird das Bild für die Anzeige gemäß Parameter size skaliert und gemäß Parameter align zum Text seines Kontextes angeordnet. Der Parameter alt (Vorgabe: None) spezifiziert einen Text, der alternativ zum Bild gezeigt werden kann. Parameter title (Vorgabe: None) gibt den Text an, der beim Zeigen auf das Bild als schwebender Text angezeigt wird. Für ein Bild aus einem Anhang wird ein Metadatum der Art X-Attach erzeugt. |
Hinweis:
Es gibt noch weitere im Wiki zwar verwendbare Makros, die aber keine keine Wiki-Makros sind, sondern nur die Darstellung steuern und in der Dokumentation zu Inyoka dokumentiert sind. Dazu gehören u.a. [[BR]], [[Anker()]] und [[Inhaltsverzeichnis()]].
Die Angaben für die Parameter page und picture sind stets absolute Pfade. (Der Parser weiß nicht, auf welcher Seite er arbeitet.)
Wo kann ein Makro verwendet werden?¶
Dies kann man der ersten Spalte der Makroliste entnehmen:
| Wiki | Alle in diesem Artikel vorgestellten Makros verwendbar. |
| Forum | Nur Makro Vorlage erlaubt. |
| Ikhaya | Nur Makros Bild und Vorlage möglich. |
Wie wird ein Makro verwendet ?¶
Zur Verwendung eines Makros muss man im Rohtext den MAKRONAME und ggf. Pflichtparameter in einer PARAMETERLISTE in einer speziellen Schreibweise angeben:
[[MAKRONAME]] | Aufruf ohne Parameter, nur möglich, wenn es keine Pflichtparameter gibt. |
[[MAKRONAME()]] | Alternative mit leerer PARAMETERLISTE |
[[MAKRONAME(PARAMETERLISTE)]] |
MAKRONAME ist ein interner Name oder dessen deutsche Entsprechung gemäß der 2. Spalte der Makroliste, dabei muss die Groß-/Kleinschreibung wie angegeben genau beachtet werden.
PARAMETERLISTE ist ein einzelner Parameter oder eine mit Kommata getrennte Liste von Parametern. Jeder Parameter ist eine Zeichenfolge, wenn diese Leerzeichen oder andere Sonderzeichen enthält, muss sie quotiert werden. Die für ein Makro zulässigen Parameter stehen in der 3. Spalte der Makroliste. Bei Makros, die mehrere Parameter ermöglichen, bestimmt entweder die Position in der PARAMETERLISTE oder der angegebene Name des Parameters, wie der Parameter im Makro verwendet wird.
Siehe Beispiel für Bild.
Beispiele¶
Seitenliste¶
Die Übersichtsseiten Wiki/Vorlagen und Baustelle wenden beispielsweise dieses Makro an.
TagListe¶
Die Übersichtsseite Kategorien wendet beispielsweise dieses Makro an.
Seitenname¶
Dies ist ein Artikel im Wiki von ubuntuusers.de und sein Name (Titel) ist: Wiki/Inyoka-Wiki-Makros
Der vorstehende Inhalt dieses Abschnitts entsteht aus folgendem Rohtext:
Dies ist ein Artikel im Wiki von ubuntuusers.de und sein Name (Titel) ist: [[Seitenname]]
Vorlage¶
Alle Textbausteine wenden das Makro Vorlage der Basis-Software an.
Anhang¶
Der Anhang „Wiki/Inyoka-Wiki-Makros/inyoka-wiki-macros.txt“ dieser Seite kann hier ⮷ herunter geladen werden.
Der vorstehende Inhalt dieses Abschnitts entsteht aus folgendem Rohtext:
Der Anhang „[[Seitenname]]/inyoka-wiki-macros.txt“ dieser Seite kann [[Anhang(text=hier, inyoka-wiki-macros.txt ) ]] {dl} herunter geladen werden.
Bitte beachte: Die Kennzeichnung "{dl}" für den direkten Download muss der Autor des Rohtextes selber hinzufügen!
Bild¶
Die Verwendung von Bildern über das Makro Bild wird detailliert im Artikel Wiki/Bilder besprochen.
Dieses Beispiel soll nur die Anwendung von benannten Parametern (Paare Name=Wert) verdeutlichen.
Der vorstehende Teil dieses Abschnitts entsteht aus folgendem Rohtext:
[[Bild(align=right, title='Maskottchen von Linux', size=100, picture=Wiki/Icons/tux.png)]] == Bild == Die Verwendung von Bildern über das Makro `Bild` wird detailliert im Artikel [:Wiki/Bilder:] besprochen. Dieses Beispiel soll nur die Anwendung von benannten Parametern (Paare Name=Wert) verdeutlichen.
Links¶
https://ubuntuusers.de/inyoka/ 🇩🇪 Inyoka aus Sicht von UbuntuUsers