Sie sind hier: Weitere Informationen > Spezielle Aufgaben
Spezielle Aufgaben
Technische Referenz
> Dokumentieren ohne Editor > Allgemeine Themen erstellen
Close
Doc-O-Matic 10
Allgemeine Themen erstellen

Oft ist es nicht ausreichend nur jedes Symbol zu beschreiben, wenn man dem Anwender verständlich machen will, was die Funktionsweise des Codes ist. Daher ist es notwendig auch Themen zum Projekt hinzuzufügen, die keine Dokumentation eines bestimmten Symbols sind sondern eigenständige Themen. 

Allgemeine Themen können an jeder beliebigen Stelle im Sourcecode oder außerhalb der Sourcedatei in einem anderen Typ von Datei, den Sie zu Ihrem Projekt hinzugefügt haben, platziert werden. Sie sehen gleich aus wie Symbolthemen außer, dass Ihre Themen-IDs nicht mit einem Symbolnamen übereinstimmen.

  1. Geben Sie folgendes in Ihrem Sourcecode ein.
//@@Generic_Topic_1 // Here goes the text for generic topic 1.
  1. Die Zeichen @@ sind die Dokumentationszeichen der Standardeinstellung.
  2. Um allgemeine Themen in DTX-Dateien zu erzeugen:
@@topic1 <TITLE Topic One> This is topic one, the topic id of this topic is "topic1".
  1. In der Standardeinstellung sind folgende Zeichen die Themenidentifizierungszeichen:
@@

Um Verwechslungen zwischen allgemeinen und Symbolthemen zu vermeiden, ist es eine gute Idee Themen-IDs zuzuweisen, die keine IDs für Symbole sein können (indem man zum Beispiel Zeichen verwendet, die zur Kennzeichnung von Symbolen nicht erlaubt sind).

Themendateien analysieren

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