Änderungen an Inhalten
Der Leitfaden bietet die Möglichkeit an, Änderungen an Inhalten über vordefinierte Elemente auszuzeichnen. Er unterstützt die Auszeichnung von Inhalten in Erstellung, in Überarbeitung und in Deprecation.
| Nachdem eine Änderung abgeschlossen ist, muss die Auszeichnung an allen betreffenden Stellen entfernt werden. |
1. Inhalte in Erstellung
Wenn Inhalte neu erstellt werden, geschieht dies meist über einen längeren Zeitraum hinweg. Während der Erstellung sind diese neuen Inhalte in der Regel noch nicht in der ganzen IsyFact berücksichtigt.
Um solche Inhalte auszuzeichnen, bietet der Leitfaden eine allgemeine Variante, eine für Seiten und eine für Bausteine an. Es sollte immer die Variante gewählt werden, die am besten zum Wirkungsbereich (Scope) der Änderung passt.
1.1. Allgemeiner Hinweis
Dieser Hinweis kann an beliebigen Stellen im Text platziert werden. Es empfiehlt sich, ihn direkt nach einer Überschrift zu platzieren.
Markup:
include::documentation-guide::partial$content-new.adoc[]Ergebnis:
1.2. Hinweis für Seiten
Dieser Hinweis sollte als erster Inhalt auf einer Seite stehen.
Markup:
include::documentation-guide::partial$content-new-page.adoc[]Ergebnis:
1.3. Hinweis für Bausteine
Dieser Hinweis sollte auf allen Seiten des Bausteins platziert werden.
Markup:
include::documentation-guide::partial$content-new-building-block.adoc[]Ergebnis:
2. Inhalte in Überarbeitung
Von Zeit zu Zeit werden Inhalte aus diversen Gründen grundlegend überarbeitet. Während der Überarbeitung sind diese Inhalte möglicherweise inkonsistent, sowohl in sich als auch zum Rest der IsyFact.
Um solche Inhalte auszuzeichnen, bietet der Leitfaden eine allgemeine Variante, eine für Seiten und eine für Bausteine an. Es sollte immer die Variante gewählt werden, die am besten zum Wirkungsbereich (Scope) der Änderung passt.
2.1. Allgemeiner Hinweis
Dieser Hinweis kann an beliebigen Stellen im Text platziert werden. Es empfiehlt sich, ihn direkt nach einer Überschrift zu platzieren.
Markup:
include::documentation-guide::partial$content-revised.adoc[]Ergebnis:
2.2. Hinweis für Seiten
Dieser Hinweis sollte als erster Inhalt auf einer Seite stehen.
Markup:
include::documentation-guide::partial$content-revised-page.adoc[]Ergebnis:
2.3. Hinweis für Bausteine
Dieser Hinweis sollte auf allen Seiten des Bausteins platziert werden.
Markup:
include::documentation-guide::partial$content-revised-building-block.adoc[]Ergebnis:
3. Veraltete Inhalte
Gelegentlich veralten Inhalte, werden aber erst zu einem späteren Zeitpunkt aus der Dokumentation entfernt.
Um solche Inhalte auszuzeichnen, bietet der Leitfaden eine allgemeine Variante, eine für Seiten und eine für Bausteine an. Es sollte immer die Variante gewählt werden, die am besten zum Wirkungsbereich (Scope) der Änderung passt.
3.1. Allgemeiner Hinweis
Dieser Hinweis kann an beliebigen Stellen im Text platziert werden. Es empfiehlt sich, ihn direkt nach einer Überschrift zu platzieren.
Markup:
include::documentation-guide::partial$content-deprecated.adoc[]Ergebnis:
3.2. Hinweis für Seiten
Dieser Hinweis sollte als erster Inhalt auf einer Seite stehen.
Markup:
include::documentation-guide::partial$content-deprecated-page.adoc[]Ergebnis:
3.3. Hinweis für Bausteine
Dieser Hinweis sollte auf allen Seiten des Bausteins platziert werden.
Markup:
include::documentation-guide::partial$content-deprecated-building-block.adoc[]Ergebnis:
3.4. Kurzhinweis
Der Kurzhinweis kann in Tabellen, für Verweise oder ähnliche Textstellen verwendet werden.
Markup:
🚫 [.line-through]#(Veralteter Inhalt)#Beispiel:
3.5. Verweis auf stattdessen gültige Inhalte
Auszeichnungen für veraltete Inhalte, bis auf den Kurzhinweis, können optional einen Verweis auf stattdessen gültige Inhalte beinhalten. Dies ist dann sinnvoll, wenn Teile der Dokumentation durch andere ersetzt werden, zum Beispiel bei einem Produktwechsel oder der Ablösung eines Bausteins durch einen anderen.
Markup:
:linkaktuell: xref:<Verweis zur neuen Seite>.adoc[diese Inhalte]
include::documentation-guide::partial$content-deprecated-building-block.adoc[]Ergebnis:
3.6. Auszeichnung veralteter Antora-Komponenten
Die Auszeichnung für veraltete Inhalte kann optional auch auf Ebene der Antora-Komponente erfolgen. Dafür wird sie in der Konfigurationsdatei der Komponente entsprechend gekennzeichnet.
antora.yml)title: Baustein XYZ 🚫| Sind mehrere Versionen der Antora-Komponente veröffentlicht, muss die Anpassung in jeder Version geschehen! |