Die Erweiterung ContentEditions ermöglicht es, Wiki-Seiten gesammelt für eine bestimmte Dokumentenversion zu pflegen. Dies ist nützlich zum Beispiel für Software-Dokumentation, bei der es oft sinnvoll ist, parallele Seitenversionen für verschiedene Software-Versionen zu pflegen.
Was ist eine Edition?[Bearbeiten | Quelltext bearbeiten]
Viele Teams dokumentieren ein Produkt, von dem gleichzeitig mehrere Versionen existieren. Während Version 1.0 noch im Einsatz ist, wird bereits an Version 2.0 gearbeitet. Ein einzelner Satz von Seiten kann nicht beide Versionen beschreiben.
ContentEditions verwendet hierfür sogenannte „Editionen“. Eine Edition ist eine Zusammenstellung von Seiten, die zu einem bestimmten Zeitpunkt aus dem Arbeitsbereich (Working Area) kopiert wurden. Jede Edition befindet sich in einem eigenen Namensraum
(Namespace), zum Beispiel Version_1.0:, sodass sich ihre Seiten niemals mit denen einer anderen Edition vermischen. Seiten einer Edition behalten ihren eigenen Textinhalt, selbst wenn jemand später dieselbe Seite im Arbeitsbereich oder in einer anderen Edition ändert.
Der Arbeitsbereich ist der Ort, an dem Sie täglich die aktuelle Dokumentation bearbeiten. Er ist keine Edition. Sobald die Inhalte fertig sind, kann eine Person mit entsprechenden Berechtigungen diese in eine neue Edition kopieren.
Eine Edition befindet sich immer in einem von drei Zuständen: Geplant, Veröffentlicht oder Archiviert.
Geplant bedeutet, dass sich die Inhalte in der Vorbereitung befinden. Veröffentlich bedeutet, dass sie den Lesern zur Verfügung gestellt wurden. Archiviert bedeutet, dass die Inhalte nicht mehr aktiv genutzt, aber weiterhin lesbar sind.
Wie funktionieren Editionen?[Bearbeiten | Quelltext bearbeiten]
[Bearbeiten | Quelltext bearbeiten]
Eine Edition ist ein eigenständiger Stand der Dokumentation, zum Beispiel die Version „1.0“. Wenn Sie eine Seite innerhalb einer Edition aufrufen, zeigt ein Banner am oberen Seitenrand, wo Sie sich befinden. Es lautet etwa: „Diese Seite gehört zur Edition ‚1.0‘ (Veröffentlicht, neueste Edition).“ Das Banner nennt den Namen und den Zustand der Edition und weist darauf hin, wenn es sich um die neueste Edition handelt. Beim Bearbeiten einer Seite und beim Aufrufen ihrer Historie wird es nicht angezeigt.
Im Banner finden Sie außerdem den Editionswechsler (Beschriftung „Edition wechseln“). Damit rufen Sie dieselbe Seite in einer anderen Edition auf, zum Beispiel um zu prüfen, was sich zwischen zwei Versionen geändert hat.
Links und Vorlagen[Bearbeiten | Quelltext bearbeiten]
Links im Text einer Seite führen innerhalb einer Edition zu Seiten derselben Edition, sofern dort eine Kopie des Zielinhalts existiert. Gibt es keine solche Kopie, behält der Link sein ursprüngliches Ziel. Für Vorlagen (Templates) gilt dasselbe: Hat eine Edition eine eigene Kopie einer Vorlage, verwendet die Seite genau diese Kopie.
Direkt zur aktuellen Edition[Bearbeiten | Quelltext bearbeiten]
Leser suchen meist nach „der aktuellen Dokumentation“ und nicht nach einer bestimmten Edition. Dafür gibt es die „Aktuell:“-Adresse. So verweist Aktuell:Installation stets auf die Seite „Installation“ der neuesten Edition. Nach dem Laden zeigt Ihr Browser die Adresse der tatsächlichen Seite an, zum Beispiel Version_1.0:Installation. Ein Hinweis unter dem Seitentitel macht die Weiterleitung kenntlich: „(Weitergeleitet von Aktuell:Installation)“. Da die Adresse immer auf die neueste Edition zeigt, eignet sie sich gut für Lesezeichen und Links, die dauerhaft aktuell bleiben sollen.
Vergleich von Editionen[Bearbeiten | Quelltext bearbeiten]
Über die Seite Special:CompareEditions können Redakteurinnen und Redakteure sehen, welche Seiten sich zwischen zwei Editionen oder zwischen einer Edition und ihrem Arbeitsbereich unterscheiden. Dazu wählt man die ältere und die neuere Seite aus und klickt auf „Vergleichen“. Das Ergebnis ist eine Tabelle, die jede Seite als geändert, verschoben, hinzugefügt oder entfernt kennzeichnet. Bei geänderten und verschobenen Seiten führt der Link „Änderungen anzeigen“ zum üblichen Seitenvergleich des Wikis. Voraussetzung ist das Benutzerrecht „contenteditions-view“, das standardmäßig alle angemeldeten Benutzer besitzen. Beide Seiten müssen zum selben Arbeitsbereich gehören; verglichen werden auch Diskussionsseiten, nicht aber Weiterleitungen. Entscheidend ist allein der Seitentext, nicht, wer die Seite wann gespeichert hat.
Dokumentation[Bearbeiten | Quelltext bearbeiten]
Die derzeitige englischsprachige technische Dokumentation können Sie hier öffnen (PDF, 504 KB).
