Textbausteine [ThoSch:Wiki]

Benutzer-Werkzeuge

Webseiten-Werkzeuge


thoschwiki:dokuwiki:textbausteine

Textbausteine

In diesem Dokument wird beschrieben, wie unter Verwendung des Include Plugins im DokuWiki eine zentrale Ablage von wiederverwendbaren, zentral gepflegten Textbausteine aufgebaut werden kann.

Anwendungsfälle

Bei den Überlegungen für die weitere Ausgestaltung dieses Dokumentationssystems traten immer wieder Konstellationen auf, bei denen gleichlautende Textpassagen in mehreren Dokumenten Verwendung finden werden.

  • Anwendungen werden sowohl in einem künftigen Bereich Software als auch – im Hinblick auf den Betrieb unter Docker – im Bereich Docker beschrieben werden. Beide Dokumente sollten eine identische grundlegende Beschreibung der Anwendung enthalten.
  • Im Bereich Docker werden sich bei den Dokumenten zu unterschiedlichen Anwendungen, die unter Verwendung von Images der Projektes Linuxserver.io betrieben werden, bestimmte Textpassagen (z.B. zur Updatestrategie) wiederholen.

Umsetzung

Für die Umsetzung bietet sich das Include Plugin an. Mit diesem Plugin können ganze Seiten oder Abschnitte aus Seiten übernommen werden.

Für die skizzierten Anwendungsfälle wäre die Übernahme von ganzen Abschnitten als kleinste Einheit zu grobgranular. Im ersten Anwendungsfall dürften jeweils die ersten ein bis drei Absätze identisch sein und sich danach andere Textpassagen anschließen. Damit scheidet die direkte Übernahme von Inhalten aus der Seite A (z.B. allgemeine Anwendungsbeschreibung) in die Seite B (z.B. Implementierung der Anwendung mit Docker) mangels der notwendigen Flexibilität aus.1)

Als Lösung bietet es sich an, die gemeinsamen Textpassagen in einem dritten Dokument jeweils in eigenen Abschnitten abzulegen und von dort jeweils diese Abschnitte (ohne Abschnittsüberschrift) in die Zieldokumenten zu übernehmen. In den Zieldokumenten kann dann nach den übernommenen Textpassagen im gleichen Abschnitt weiterer individueller Text angefügt werden.

Für die Umsetzung wurde ein Ansatz gewählt, bei dem Textbausteine in einem eigenen Namespace abgelegt werden.2)

Die Einbindung der Textbausteine erfolgt dann mit dem folgenden DokuWiki-Markup:

{{page>thoschwiki:bricks:THEMA#BAUSTEIN&noheader}}
Element Bedeutung
{{page> … }} Einbinden einer Seite mit dem Include Plugin
thoschwiki:bricks: Hier gewählter Namespace für die Bausteine
THEMA Seitennamen der Seite mit dem gewünschten Baustein.
Die Bausteine sollen hier thematisch in einzelnen Seiten gesammelt werden. Dies erleichtert den Verweis aus dem Bausteindokument auf die Inhaltsseiten, falls ein Leser versehentlich auf eine Bausteinseite navigiert hat.
BAUSTEIN Name des Abschnitts mit dem gewünschten Textbaustein.

Den Dokumenten mit den Textbausteinen ist jeweils der folgende Hinweis vorangestellt:

Das ist kein Inhaltsdokument.

Es handelt sich um ein Dokument mit Textbausteinen für die Wiederverwendung in anderen Seiten.

Die Textbaustine aus diesem Dokument werden in den folgenden Seiten verwendet:

  • Seite A
  • Seite B

Mit diesem Hinweis, soll ein Leser, der versehentlich auf eine Bausteinseite navigiert hat, darauf hingewiesen werden, dass hier keine Inhalte, sondern Textbausteine abgelegt sind. Am Ende werden die Seiten aufgeführt, in denen die Textbausteine verwendet werden und somit für den Leser interessant sein dürften.

Für die Umsetzung dieser Hinweise werden zwei weitere Plugins benötigt:

  • Backlinks Plugin - Anzeige der Backlinks auf die Seiten, in denen die Textbausteine verwendet werden.
  • Note Plugin - Darstellung als farbiger Notizzettel
<note>
**Das ist kein Inhaltsdokument.**

Es handelt sich um ein Dokument mit Textbausteinen für die Wiederverwendung in anderen Seiten.

Die Textbaustine aus diesem Dokument werden in den folgenden Seiten verwendet:

{{backlinks>.}}

</note>
1)
Natürlich könnte man versuchen jeweils den gesamten Abschnitt zu übernehmen und die abweichenden Passagen in einen nachfolgenden Abschnitt einzufügen, jedoch würde dies zu unschönen Kompromissen bei der Textegestaltung und Gliederung führen.
2)
Diese Struktur stößt dann an ihre Grenzen, wenn die Textbausteine in mehreren Namespaces mit unterschiedlichen Autorengruppen genutzt werden sollen.
thoschwiki/dokuwiki/textbausteine.txt · Zuletzt geändert: 10.10.2020 19:58 von thosch