diub - Dipl.-Ing. Uwe Barth
 

Documenter - Online-Dokumentation


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.
  • 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.

Bereits mit diesen einfachen Mitteln lässt sich zum Beispiel Quellcode recht gut darstellen.

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

6.2 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.
  • Die Skalierung erfolgt gemäß
    ◦ dem Skalierungsfaktor in den Exporteinstellungen des jeweiligen Formats
    ◦ der Größe der Darstellung auf dem Bildschirm, die mit der Maus änderbar ist
    ◦ einem fest im Programm hinterlegten Faktor zu jedem Format, der sich nach den Ansprüchen des Formats richtet.

6.3 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 (XeTeX, PDF via XeTeX).
  • Auf Figuren lassen sich Querverweise setzen, zum Beispiel Logo von diub.


Abbildung 6.1: Logo von diub

6.4 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 oder Tabelle 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 .

Links der Form http://www.diub.de werden im Editor-Fenster als Internet-Links formatiert dargestellt.

  • Auf Papier macht dies freilich keinen Sinn.
  • Nicht immer ist ein Klick-barer Link erwünscht (Haftungsgründe usw.)

Daher gibt Documenter zur Zeit Links in allen Medien als normalen Text aus. Für eine spätere Version ist eine Möglichkeit zur Unterscheidung angedacht.