Kopiervorlage für neue Seiten

= Titel der Seite

include::documentation-guide::partial$licence.adoc[]

// tag::template[]
[[formatierung]]
== Formatierung

Der Quelltext einer Seite bricht gemäß der Regel _one sentence per line_ nach jedem Satz um.

Mehr zu Zeilenumbrüchen xref:documentation-guide::guides/bearbeitung-antora.adoc#ein-satz-pro-zeile[hier].

[[formatierung-verweise]]
=== Verweise

Es folgen Beispiele für seiteninterne Verweise auf eine <<formatierung,Überschrift>>, ein <<beispiel-abbildung>>, ein <<beispiel-tabelle>> oder ein <<beispiel-listing>>.

Verweise auf Seiten innerhalb derselben Dokumentation sind auf drei Ebenen möglich: innerhalb desselben Moduls, zwischen zwei Modulen und zwischen zwei Komponenten.
Verweise enthalten nur die absolut nötigsten Informationen, um das Ziel aufzulösen.

Es folgt ein Beispiel für einen Verweis:

* innerhalb desselben Moduls: xref:/kopiervorlage.adoc[],
* zwischen zwei Modulen: xref:glossary::terms-definitions.adoc[].

Alle Verweise auf andere Seiten derselben Dokumentation nutzen die Syntax des Xref-Makros von Antora.

[NOTE]
====
Die https://docs.antora.org/antora/latest/page/xref/#structure[Beschreibung der Struktur des Xref-Makros] zeigt weitere, interessante Anwendungsfälle für diese Art von Verweisen.
====

Mehr zu Querverweisen xref:documentation-guide::guides/bearbeitung-antora.adoc#querverweise[hier].

==== Glossar

Verweise auf das xref:glossary::terms-definitions.adoc[] dürfen nur bei der ersten Verwendung eines entsprechenden Begriffs geschehen.
Alle weitere Vorkommen eines Begriffs werden aus Gründen des Leseflusses nicht mit einem Verweis hinterlegt.
Es folgt ein Beispiel für den Eintrag des xref:glossary::terms-definitions.adoc#backend[Backends] im Glossar.

Mehr zur Verwendung des Glossars xref:documentation-guide::glossary.adoc[hier].

[[formatierung-abbildungen]]
=== Abbildungen

[[beispiel-abbildung]]
.Beispiel einer Abbildung
image::glossary::glossar-software-factory.png[]

Mehr zu Abbildungen xref:documentation-guide::guides/bearbeitung-antora.adoc#bilder[hier].

[[formatierung-tabellen]]
=== Tabellen

[[beispiel-tabelle]]
.Beispiel einer Tabelle
[cols="1s,1,1,1",options="header"]
|===
|Spalte 1|Spalte 2|Spalte 3|Spalte 4

|Zelle 11|Zelle 12|Zelle 13|Zelle 14
|Zelle 21|Zelle 22|Zelle 23|Zelle 24
|Zelle 31|Zelle 32|Zelle 33|Zelle 34
|===

Mehr zu Tabellen xref:documentation-guide::guides/bearbeitung-antora.adoc#tabellen[hier].

[[formatierung-listings]]
=== Listings

[[beispiel-listing]]
.Beispiel eines Listings
[source,java]
----
public class HalloWelt {
    public static void main(String[] args) {
        System.out.println("Hallo Welt");
    }
}
----

Mehr zu Listings xref:documentation-guide::guides/bearbeitung-antora.adoc#listings[hier].

[[formatierung-admonitions]]
=== Admonition Blocks

[NOTE]
====
Optionale Ergänzungen des Textes wie weiterführende Links, Dokumente, Artikel, etc.
====

[TIP]
====
Optionale Inhalte, die eigene Erfahrungswerte (Good / Best Practices, Tipps & Tricks, ...) einbringen.
====

[IMPORTANT]
====
Allgemeine Vorgaben der IsyFact.
====

[WARNING]
====
Typische Fallstricke bei der Nutzung der IsyFact.
====

[CAUTION]
====
Typische Fehler bei der Nutzung der IsyFact.
====

.icon:cogs[title=Anforderung] Anforderung
****
Anforderungen an die Entwicklung von Anwendungen und IT-Systemen.
****

.icon:university[title=Architekturregel] Vorgabe
****
Regeln für die Architektur von Anwendungen und IT-Systemen.
****

.icon:shield[title=Sicherheit] Vorgabe
****
Regeln für die Sicherheit von IT-Systemen.
****

.icon:paint-brush[title=Bedienkonzept] Vorgabe
****
Regeln zur Gestaltung von grafischen Oberflächen.
****

Mehr zu Admonition Blocks xref:documentation-guide::guides/bearbeitung-antora.adoc#admonition-blocks[hier].

Mehr zu Status-Auszeichnungen der Dokumentation wie Deprecation, "in Erstellung" xref:documentation-guide::guides/content-changes.adoc[hier].

// end::template[]