Definitionsliste
Eine Definitionsliste beschreibt eine Auflistung von Definitionen. Jeder Eintrag einer Definitionsliste enthält einen Begriff, eine Definition und optional Klassifikatoren.
Definitionslisten können auf verschiedene Arten verwendet werden:
- Als Wörterbuch oder Glossar. Der Begriff ist das Wort selbst, ein Klassifikator kann verwendet werden, um die Verwendung des Begriffs zu kennzeichnen (Substantiv, Verb etc.), und die Definition folgt.
- Zur Beschreibung von Programmvariablen. Der Begriff ist der Variablenname, ein Klassifikator kann verwendet werden, um den Typ der Variablen (String, Integer usw.) anzugeben, und die Definition beschreibt die Verwendung der Variablen im Programm.
Eigenschaften
- Ein Begriff ist ein einfaches einzeiliges Wort oder eine Phrase.
- Eine Definition ist ein Block, der relativ zum Begriff eingerückt ist (die minimale Einrückung beträgt ein Leerzeichen) und kann mehrere Absätze und andere Körperelemente enthalten.
- Optionale Klassifikatoren können dem Begriff auf derselben Zeile folgen, jeweils nach einem „
:“ (Leerzeichen, Doppelpunkt, Leerzeichen).
Prinzip
+--------------------------+
|term[" : "classifier]* |
+----+---------------------+
|definition |
|(body elements) |
+---------------------+
Beispiel
Das Beispiel zeigt eine Definitionsliste mit Begriffen, Klassifikatoren und Definitionen.
(Im Beispielprojekt: B_DocuElements\Lists\FB_Libdoc_DefinitionList)
- Innerhalb der Definitionsliste werden weitere Textkörperelemente verwendet (Absatz, ungeordnete Listeneinträge).
- Zwischen einer Begriffszeile und einem Definitionsblock darf keine Leerzeile vorhanden sein (dies unterscheidet Definitionslisten von Blockzitaten).
- Vor dem ersten und nach dem letzten Listeneintrag der Definitionsliste sind Leerzeilen notwendig, können aber auch dazwischen eingefügt werden.
(*
Term 1
Definition 1.
Term 2
Definition 2, paragraph 1.
Definition 2, paragraph 2.
Term 3 : classifier
Definition 3.
Term 4 : classifier one : classifier two
- Item 1
- Item 2
*)
|
