Verwendung des Glossars
Diese Seite ist ein Teil der IsyFact-Standards.
Alle Inhalte der Seite, insbesondere Texte und Grafiken, sind urheberrechtlich geschützt.
Alle urheberrechtlichen Nutzungs- und Verwertungsrechte liegen beim Bundesverwaltungsamt.
Die Nutzung ist unter den Lizenzbedingungen der Creative Commons Namensnennung 4.0 International gestattet.
Das Glossar enthält zentrale Begriffe und Definitionen der IsyFact in Form von Glossareinträgen. Es besitzt ein Statusmodell, mit dem Änderungen an Glossareinträgen abgebildet werden. Das Glossar ermöglicht es, einzelne Definitionen im Text einzubinden oder auf Glossareinträge zu verweisen.
Dieser Guide beschreibt den strukturellen Aufbau des Glossars, das Statusmodell der Einträge sowie das Einbinden von Definitionen und Verweisen auf Einträge.
1. Aufbau des Glossars
Das Glossar ist alphabetisch sortiert und befindet sich in einem eigenen Antora-Modul. Es besteht aus einer Liste von Glossareinträgen, die eine Überschrift, Informationen zum Status und eine Definition bzw. eine Begriffsklärung enthalten.
[[begriff]] (1)
=== Begriff (Abkürzungen) (2)
[.status] (3)
[.release]#xref:4.0.x@isyfact-standards-doku:einstieg:einstieg.adoc[≥ IsyFact 4]#
// tag::begriff-definition[] (4)
Definition des Begriffs.
// end::begriff-definition[]
Weitere Informationen zum Begriff, z.B. Zusammenhänge zu anderen Begriffen.| 1 | Anker des Begriffs. |
| 2 | Nennung des Begriffs und ggf. gängiger Abkürzungen. |
| 3 | Statusinformationen, falls sich der Begriff ändert. |
| 4 | Tags zur Einbindung der Definition in Texte. |
Der Anker sollte immer dem Begriff selbst entsprechen. Leerzeichen müssen durch Bindestriche ersetzt und Umlaute umgeschrieben werden.
Die Statusinformationen und die Tags zur Einbindung der Definition sind optional und sollten dann gesetzt werden, wenn sie gebraucht werden.
2. Statusmodell
Das Statusmodell erlaubt es, Änderungen an den Begriffen konsistent in Glossareinträgen abzubilden. Es kennt die folgenden Status: "vorgeschlagen", "überarbeitet", "abgelöst" und "veraltet". Zusammen bilden die Status einen Lebenszyklus, der im Folgenden dargestellt ist.
2.1. Status "vorgeschlagen"
Wenn ein Begriff ins Glossar aufgenommen werden soll, dessen Bedeutung noch nicht abschließend geklärt ist, befindet er sich im Status "vorgeschlagen". Der Glossareintrag enthält eine Auszeichnung des Status und einen Hinweis, ab welcher Version der IsyFact er gültig wird.
[.status]
[.release]#xref:x.y.z@isyfact-standards-doku:einstieg:einstieg.adoc[≥ IsyFact x]#
[.proposed]#vorgeschlagen#2.2. Status "überarbeitet"
Wenn ein Begriff im Glossar seine Bedeutung verändert, befindet er sich im Status "überarbeitet". Der Glossareintrag enthält eine Auszeichnung des Status.
[.status]
[.revised]#überarbeitet#Ebenso enthält er eine Gegenüberstellung der alten und der neuen Definition des Begriffs mit dem Hinweis, für welche Versionen der IsyFact sie gültig sind.
[cols="1a,1a",options="header"]
|===
^|xref:x.y.z@isyfact-standards-doku:einstieg:einstieg.adoc[≥ IsyFact x]
^|xref:a.b.c@isyfact-standards-doku:einstieg:einstieg.adoc[≤ IsyFact a]
|Neue Definition
|Alte Definition
|===2.3. Status "abgelöst"
Wenn ein Begriff im Glossar durch einen anderen ersetzt wird, befindet er sich im Status "abgelöst". Der Glossareintrag enthält eine Auszeichnung des Status, einen Verweis auf den neuen Begriff und einen Hinweis, bis zu welcher Version der IsyFact der Begriff gültig bleibt.
[.status]
[.release]#xref:x.y.z@isyfact-standards-doku:einstieg:einstieg.adoc[≤ IsyFact x]#
[.superseded]#<<neuer-begriff,abgelöst>>#2.4. Status "veraltet"
Wenn ein Begriff im Glossar ersatzlos gestrichen wird, befindet er sich im Status "veraltet". Der Glossareintrag enthält eine Auszeichnung des Status und einen Hinweis, bis zu welcher Version der IsyFact der Begriff gültig bleibt.
[.status]
[.release]#xref:x.y.z@isyfact-standards-doku:einstieg:einstieg.adoc[≤ IsyFact x]#
[.deprecated]#veraltet#2.5. Entfernung der Statusinformationen
Die Statusinformationen referenzieren stets konkrete Releases der IsyFact. Wenn das Release, das referenziert wird, nicht mehr Teil der Online-Dokumentation ist, wird auch die Statusinformation entfernt.
| Dies ist gut dadurch sichtbar, das nach Entfernung des Releases "tote Links" entstehen. |
3. Einbinden von Definitionen und Einträgen
Das Glossar ermöglicht zwei Arten der Einbindung. Ein direkter Verweis auf einen Eintrag dient dazu, auf die festgelegte Bedeutung eines Begriffs hinzuweisen. Die Einbindung einer Definition ist immer dann sinnvoll, um die Definition nicht an anderer Stelle wiederholen zu müssen.
3.1. Direkter Verweis
Ein direkter Verweis auf einen Glossareintrag erfolgt über das xref-Makro von Antora. Da die Einträge über Anker referenziert werden, muss zwischen den eckigen Klammern zwingend ein Text stehen - meistens der Begriff selbst.
xref:glossary::terms-definitions.adoc#isyfact[IsyFact]3.2. Einbindung einer Definition
Wenn in einem Text eine Definition aus dem Glossar wiedergegeben werden soll, geschieht dies über eine Einbindung. Dazu muss die Definition im Glossar von entsprechenden Tags umgeben sein.
Die Einbindung geschieht nun über eine Einbindung der Inhalte zwischen den Tags.
include::glossary::terms-definitions.adoc[tag=begriff-definition]