Sie sind hier: Weitere Informationen > Spezielle Aufgaben
Spezielle Aufgaben
Technische Referenz
> Dokumentieren ohne Editor > Eigenschaften-Tags > Themenhierarchie
Close
Doc-O-Matic 10
Themenhierarchie

Sie können Ihre Dokumentation strukturieren indem Sie die Group-, Topicorder- und Contentsentry-Tags in Ihren Sourcecode oder in externe Dokumentationsdateien schreiben.

Beachten Sie bitte: Es gibt keine XML kompatiblen Tags für diese Befehle.

  1. In Doc-O-Matic gibt es Gruppenthemen. Gruppenthemen bestehen aus einem Thema, dem andere Themen zugeordnet sind.
  2. Um ein Thema zu einer Gruppe zuzuordnen, geben Sie den Group-Tag gefolgt von dem Namen des Themas dem Sie das Thema zuordnen wollen, ein.
    Beachten Sie bitte: Jedes Thema das einer Gruppe zugeordnet ist, kann wiederum als Gruppenthema fungieren.
  1. Eine andere Methode Ihre Dokumentation zu strukturieren, ist die Verwendung von Ordnern. Ordner sind Gruppierungsebenen, deren Text nicht dargestellt wird. In den Ausgabeformaten scheinen die Inhaltsverzeichniseinträge nur im Inhaltsverzeichnis und als Überschriften im PDF- und RTF-Dokument auf.
  2. Um einen Ordner zu erzeugen schreiben Sie den Contentsentry-Tag in Ihr Thema.

In den automatisch erzeugten Überblicksseiten der Symbole werden Ordner als zusätzlich Einteilungskategorie verwendet. Wenn zum Beispiel in einer Klasse die Konstruktoren in einem Ordner mit Namen Konstruktoren geordnet werden, werden die Symbole dieser Klasse nicht nur nach den automatisch erzeugten Kategorien sortiert (Mitglieder, Funktionen usw) sondern die Konstruktoren werden in der Kategorie Konstruktoren angezeigt.

Copyright © 2000-2020 toolsfactory software inc. Alle Rechte vorbehalten.