6 Inhalte

Jeder Inhalte-Knoten enthält drei grundlegende Merkmale.

• Titel
  Der Titel kann leer bleiben, enthält er jedoch Text, wird dieser als Überschrift in einem gesonderten Format dargestellt. Bei Zwischenüberschriften sind standardmäßig Kapitälchen (soweit vom Ausgabeformat unterstützt) und oder Fettschrift eingestellt.
• Id
  Jede vergebene Id muss einmalig sein. Sie dient als Referenz für Querverweise, siehe Querverweise. Ist das Feld leer wird bei Bedarf automatisch eine neue generiert. Die Id darf keine Sonder- oder Leerzeichen enthalten!
• Export
  Damit lassen sich Teile vom Export ausschließen. Der Ausschluss gilt immer auch für etwaige Unter-Knoten.

6.1 Artikel

Der normale Fließtext wird in Artikeln eingegeben. Ein Artikel kann mehrere Absätze, Auflistungen und Bilder enthalten.

6.1.1 Sonderzeichen u. Co

Für die Gestaltung bzw. Positionierung von Text gibt es 2 "Sonderzeichen":

• Das feste Leerzeichen '□'
  - wird mit s eingegeben,
  - wird auch als solches dargestellt,
  - verhindert einen Umbruch an seiner Position,
  - eignet sich bei Festbreiten-Schriftarten zum tabulieren.
• Das klassische Tabulatorzeichen →
  - wird mit st eingegeben,
  - wird vom verwendeten Richttext-Modul (von MS) nicht dargestellt,
  - entspricht beim Export 4 festen Leerzeichen.

6.2 Code

Ein Code Abschnitt unterscheidet sich von einem Artikel, nur in zwei Punkten:

• Für das Zielformat wird als Wunscheigenschaft die Ausgabe aller enthaltenen Zeichen angegeben!
  Damit werden mehrere aufeinanderfolgende Leerzeichen auch mehrfach ausgegeben.
• Die Standard-Schrift ist eine nicht-proportionale Schrift; alle Zeichen benötigen den gleichen Platz.

private void RichTextEditor_Load (object sender, EventArgs e) {
  if (Setting.Designtime)
    return;
  (ParentForm as xForm).CmdKeyPressed += RichTextEditor_CmdKeyPressed;
}

6.3 Bilder im Fließtext

Bilder und lassen sich direkt in den fließenden Text nutzen. Einfügen und Löschen geht wie gewohnt. Die Größe lässt sich mit der Maus jederzeit anpassen.

• Setzen Sie die Einfügemarke direkt vor das Bild oder klicken Sie es an.
• Drücken Sie auf - oder + , oder auf dem Nummernblock [+] / [-].

Hinweise

• Es wird immer das eingefügte originale Bild im Dokument gespeichert.
• Für den Export wird die Grafik skaliert, das heißt ungerechnet in eine passende Auflösung.

6.4 Figuren

Figuren ist ein Begriff, der von XeTeX übernommen wurde. Er bezeichnet Grafiken oder Bilder, die mit einer Unterschrift, also einem Bildtitel unter dem Bild, versehen sind.

• Figuren lassen sich in einem eigenen Verzeichnis auflisten.
• Auf Figuren lassen sich Querverweise setzen, zum Beispiel Logo von diub.

Abbildung 6.1: Logo von diub

6.5 Querverweise

Einen Querverweis auf ein anderes Kapitel oder einen anderen Abschnitt innerhalb des Dokumentes besteht aus drei Teilen.

• Titel
  Eine Über- oder Unterschrift für das Zitat.
• Id
  Geben Sie dem Kapitel, dem Text, der Grafik eine eindeutige Id (oben rechts).
• Verweis im Text
  Den eigentlichen Querverweis tragen Sie einfach in der folgenden Form ein
  (Tilde Tilde Id Tilde Tilde): Id

Das Ergebnis sieht so aus: Querverweise .

6.6 Indexe

Die Index-Funktionalität ist derzeit auf CHM-(Hilfe-)Dateien beschränkt!

Index-Typen

Indexe sind häufig ein starkes Hilfsmittel um Zugang zu einem Text oder einer Dokumentation zu finden. Sie unterscheiden sich jedoch ebenso voneinander wie die Inhalte selbst. Grundsätzlich gibt es zwei Typen.

• Stichwort-Seiten-Index
  bekannt aus Büchern
• Themen-Abschnitt-Index
  Online-Dokumentationen

Eine weitere Unterscheidung lässt sich über die Art treffen.

• 1:N Index
  ein Index-Eintrag verweist auf mehrere Fundstellen; klassisch zum Beispiel der Stichwort-Seiten-Index.
• M:1 Index
  mehrere Index-Einträge verweisen auf die selbe Fundstelle. Bei einem Themen-Abschnitt-Index die Regel.
• M:N Index
  In Büchern oft als Zusatz / Ergänzung in der Form "Stichwort A → Stichwort B" bzw. "Stichwort A: siehe Stichwort B" realisiert.

Vom Ansatz her unterstützt Documenter (derzeit) nur einen M:1 Index. Der Index kann aber mehrstufig aufgebaut werden, womit indirekt auch eine 1:N Funktionalität abgebildet werden kann.

Schlüssel-Worte

Index-Einträge lassen sich für Kapitel und Artikel (mit Titel!) anlegen.

Die Schlüsselwörter werden einfach als Text im Feld Schlüssel eingetragen.

• Einfache Schlüsselwörter
  zum Beispiel "Indexe", "Inhalte"
• Hierarchische Schlüsselwörter werden mit Punkten geschrieben
  zum Beispiel "Indexe.Typen", "Indexe.Beispiele"
• Mehrere Schlüsselwörter werden durch Kommata getrennt.
  zum Beispiel "Indexe.Beispiele, Indexe.Examples"

Im Text

Schlüssel-Worte lassen sich auch direkt im Text platzieren, indem sie mit doppelten Zirkumflex einfasst werden: Indexe.Im Text.

Wichtiger Hinweis

Alle Index-Einträge müssen eindeutig sein! Die mehrfache Verwendung eines Schlüsselwortes führt nicht zur mehrfachen Auflistung. Documenter unterstützt derzeit keinen 1:N Index!

Beispiele

Verwendete Schlüsselwörter:

• Indexe
• Indexe.Beispiele,Indexe.Examples
• Indexe.Schlüssel
• Indexe.Typen
• Indexe.Wichtiger Hinweis

6.7 Links

Ein Link auf externe Inhalte benötigt zwingend ein führendes http:// oder https:// . Die Adresse wird einfach in doppelte Rauten eingeschlossen:

https://www.diub.de ergibt https://www.diub.de .

Optional lässt sich ein Text — abgetrennt durch ein Pipeline-Symbol '|' oder '¦'— anstelle der Adresse ausgeben:

https://www.diub.de|diub's Home ergibt .

Hinweis

Aufgefallen ist es mir Ende 2024: MS hat irgendwann wieder einmal herumgepfuscht und die Tastaturbelgeung geändert. Die wird den meißten wohl so nicht auffallen, doch führt das in verschiedenen Programmen zu Fehlern.

Die Taste mit dem '¦' hat 40 Jahre auch das Zeichen '¦' geliefert. Es wurde gemeinhin als Pipe-Symbol bezeichnet.

Nun nicht mehr. Man muss schon aufmerksam hinsehen, um den Unterschied zu bemerken und ihn nicht nur als kosmetischen Effekt abzutun. ¦ vs |

Tatsächlich tragt das neue Symbol '|' im UTF Raum offiziell den Namen Pipe. Es gibt sogar bereits Tastaturen mit dem neuen Symbol.

Was der Stink-Käse soll, wissen die Verantwortlichen wohl selber nicht. Oder doch. Künstliche Obsoleszenz, genau wie der Prozessor-Terror bei WIndows 11, mit dem Ziel, den Kunden zu schröpfen. Bedenken Sie: Windows-Lizenzen werden praktisch nur mit neuen PCs verkauft. Da ist es für MS logisch, dafür zu sorgen, das PCs immer wieder ersetzt werden müssen, obschon kein echter technischer Grund dafür vorliegt.

6.8 Tabellen

Tabellen werden derzeit leider nicht unterstützt. Dafür gibt es mehrere Gründe:

• das genutzte RichText-Modul erlaubt keine Bearbeitung von Tabellen
• Tabellen müssen - anders als der normale Fließ-Text - Layout-treu dargestellt werden