title

<title text>

Ein Titel für ein Thema. Standard gemäß ist der Titel für Symbolthemen der Name des Symbols (für Methods zum Beispiel Klassenname::Name der Method). Der Titel der allgemeinen Themen ist die Themen-ID.

Title-Tags

toctitle

<toctitle text>

Ein Titel für Ihr Thema im Inhaltsverzeichnis aller Ausgaben. Wenn Sie diesen Tag nicht verwenden, erscheint der Titel des Themas im Inhaltsverzeichnis.

Title-Tags

titleimg

<titleimg imagefile>

Der Name einer Grafikdatei, die den Titel darstellt. Kann verwendet werden, um eine Grafik für Kontrollklassen oder Komponenten in Bibliothekendokumentationen zur Verfügung zu stellen.

Titleimg-Tag

flag

<flag text1,text2>

Mit Hilfe des Flag-Tags können Sie einem Thema eine allgemeine Eigenschaft geben. Flags können als Auswahlkriterium für die Erzeugung von Berichten über Ihr Projekt verwendet werde.

Flag-Tag

keywords

<keywords keyword1/subentry1, keyword2/subentry2>

Mit Hilfe des Keyword-Tag können Sie eine beliebige Anzahl von Indexeinträgen und untergeordneten Indexeinträgen für ein Thema hinzufügen. Schlüsselwörter werden von Ihren untergeordneten Schlüsselwörtern (fakultativ !) durch einen Schrägstrich getrennt "/".

Keyword-Tags

fkeywords

<fkeywords keyword1, keyword2>

Mit Hilfe des FKeywords-Tags können Sie zusätzliche Schlüsselwörter für die kontextebezogene Help 2 Hilfe hinzufügen. Der Index wir automatisch zusätzlich zu dem Index, in dem Sie blättern können, erzeugt und wird von den Hilfesystemen für die kontextbezogene Hilfe für Symbole verwendet während Sie diese in Microsoft Visual Studio und CodeGear RAD Studio bearbeiten.

Keyword-Tags

alias;aliasof

<alias topicid>, <aliasof topicid1,topicid2>

Mit Hilfe des Alias-Tag, können Sie ein Thema definieren von dem die Dokumentation kopiert wird. Der Aliasof-Tag ist das Gegenstück zum Alias-Tag. Mit Hilfe des Aliasof-Tag können Sie auswählen in welche Themen die Dokumentation dieses Themas kopiert wird.

Mehrfache Verwendung von Themen

combine; combinewith

<combine topicid>, <combinewith topicid1,topicid2>

Wenn Sie den Combine-Tag verwenden wird die Deklaration aller Themen zusammengefügt. Der Beschreibungstext wird von dem im Tag genannten Thema genommen. Der Combinewith-Tag bewirkt, dass Doc-O-Matic annimmt, dass in allen Themen die aufgezählt sind, ein Combine-ID Befehl enthalten wäre.

Mehrfache Verwendung von Themen

copy; copyto

<copy topicid>,
<copyto topicid1, topicid2>

Indem Sie den Copy-Tag verwenden, können Sie den Inhalt eines anderen Themas zum akutuellen Thema kopieren. Im Copyto-Tag, führen Sie alle Themen an, zu denen Sie den Inhalt des aktuellen Themas kopieren möchten.

Mehrfache Verwendung von Themen

versionspecific

<versionspecific [+|-] Versionnumber>

Dieser Tag ermöglicht es Ihnen die Version Ihres Programmes in jedem Thema zu kontrollieren. Wenn das Thema exportiert wird und das Feature Versionskontrolle eingeschalten ist, wird der Wert im Versions-Tag mit der Versionsinformation des Projektes verglichen und eine Warnung ausgegeben, wenn das Thema den Versionskriterien, die mit [+|-] VersionNumber angegeben werden, nicht entspricht.

Versionspecific-Tag

autolink

<autolink on|off >

Mit Hilfe dieses Tags können Sie die Projektkonfiguration für das Feature automatische Hyperlinks für jedes Thema überschreiben.

Autolink-Tag

implementation

<implementation on|off>

Mit Hilfe dieses Tags können Sie die Projektkonfiguration, die bestimmt, ob die Implementierung mit ausgegeben wird, für jedes Thema einzeln überschreiben.

Implementation-Tag

unfinished

<unfinished>

Mit Hilfe dieses Tags, können Sie den Dokumentationsstatus von Symbolen und Themen verändern.

Unfinished-Tag

externalhtml

<externalhtml, _html_filename_nopath_>

Mit Hilfe dieses Tags können Sie eine externe Quelle für das aktuelle Thema in Ihrer HTML-Ausgabe zur Verfügung stellen.

Tags für externe Quellen

externalpdf

<externalpdf, _image_filename_nopath>

Mit Hilfe dieses Tags können Sie eine Grafik als externe Quelle für das aktuelle Thema in Ihrer PDF-Ausgabe zur Verfügung stellen.

Tags für externe Quellen

b

<b> </b>

Text innerhalb der Bold-Tags wird in der Ausgabe fett formatiert.

Buchstabenformatierungen

i

<i> </i>

Text innerhalb der Italic-Tags wird in der Ausgabe kursiv formatiert.

Buchstabenformatierungen

u

<u> </u>

Text innerhalb der Underlined-Tags wird in der Ausgabe unterstrichen formatiert.

Buchstabenformatierungen

c

<c> </c>

Text innerhalb des Code-Tags wird als Code formatiert. Es werden keine Leerzeichen entfernt und er wird mit einer Festbreitenschrift formatiert.

Buchstabenformatierungen

sub



Text innerhalb der Subscript-Tags wird in der Ausgabe tiefgestellt.

Buchstabenformatierungen

sup



Text innerhalb der Superscript-Tags wird in der Ausgabe hochgestellt.

Buchstabenformatierungen

color

<color namelvalue> </color>

Text innerhalb der Color-Tags wird in einer anderen Farbe ausgeben. Der Name bezieht sich auf einen definierten Farbennamen oder einen hexadezimalen RGB Wert.

Color-Tag

label

<label name="MyLabel">
</label>

Text zwischen den Label-Tags wird mit dem entsprechenden Label markiert.

Label Tag

p

</ p>

Der P-Tag erzeugt einen neuen Absatz. Er hat denselben Effekt wie eine leere Zeile im Kommentarblock.

Absatzformatierungen

pre

<pre> </pre>

Bei Text innerhalb von Pre-Tags werden die Leerzeichen nicht entfernt. Das bedeutet, dass alle Leerzeichen, Zeilenvorschübe und Tabulatoren genau so in der Ausgabe wiedergegeben werden. Die Formatierungen, die Sie in diesem Text vorgenommen haben, werden bewahrt. Pre-Tags können nicht von anderen Tags eingeschlossen werden. Weitere

Absatzformatierungen

code

<code [lang= "text" | "c++" | "delphi" | "c#" | "vb.net" | "java" | "idl" | "javascript" | "matlab" | "php" ]> </code>

Text innerhalb von Code-Tags wird genauso behandelt, wie Text innerhalb von Pre-Tags. Zusätzlich formatiert Doc-O-Matic den Text unter Verwendung einer Schriftart mit fixen Abständen. Sourcecode, der in der Ausgabe aufscheinen soll, sollte so formatiert werden. Wenn Sie eine Attribut für eine Programmiersprache hinzufügen, wird die Syntax im Code-Absatz entsprechend dieser Programmiersprache hervorgehoben, unabhängig von der Projekteinstellung für die Hervorhebung der Syntax.

Absatzformatierungen

![CDATA[
]]>

<![CDATA[ ... begins a CDATA block
]]> ... terminates CDATA block.

Text in CDATA-Tags wird ausgenommen. Doc-O-Matic ignoriert alle Tags innerhalb dieser Blöcke (alle außer </code> und </pre>, die beenden den Block automatisch. CDATA ist nur innerhalb von Codeabsätzen und vorformatierten Absätzen gültig. Der Editor konviertiert CDATA-Blöcke in normalen escapten Doc-O-Matic-Text.

Codeabsatz

align

<align left | center | right | justify> </align>

Verwenden Sie diese Tags, um Absätze nach links oder nach rechts auszurichten, zu zentrieren oder in Blocksatz zu formatieren.

Codeabsatz

link

<link topicid[, linktext] >

Link-Tags werden ersetzt durch einen Hyperlink zu dem angegebenen Thema. Die Themen-ID bezieht sich auf ein Thema im Projekt. Wenn der linktext angegeben wird, zeigt den Hyperlink diesen Text an ansonsten wird die Themen-ID angezeigt.

Link-Tags

extlink

<extlink _linktarget_> </extlink>

Fügt einen externen Hyperlink hinzu. Im Unterschied zum Link-Tag, überprüft Doc-O-Matic das linktarget nicht. Daher müssen Sie sicherstellen, dass das Sprungziel existiert und gültig ist und die Ausgabeformate dorthin einen Hyperlink erstellen können.

Link-Tags

image

<image imagename [,{float|} [,{topicid|} [,Hint Text]]]>

Fügt eine Grafik in den Text. Imagename ist der Dateiname der Grafik ohne Pfadangabe und Erweiterung. Doc-O-Matic sucht nach der Datei auf dem Image Path und fügt die passende Dateierweiterung hinzu (das ist jene Dateierweiterung, die vom jeweiligen Ausgabeformat dargestellt werden kann). Daher wird empfohlen, die Dateierweiterung wegzulassen.

Image-Tag

table

<table[noborder] [htmltable]></table>

Text zwischen Table-Tags wird als tabularische Information interpretiert. Um Tabellen ohne Rahmen zu schreiben, verwenden Sie das noborder Attribut.

Table-Tags

emit

<emit html_code>

Ersetzt in der Ausgabe den gesamten Tag durch den angegebenen HTML-Code.

HTML-Code einbeziehen

include

<include _filename_>

Ersetzt den gesamten Tag durch den Inhalt von _filename_. _filename_ kann keinen, einen relativen oder eine vollständigen Pfadnamen enthalten. Der Topic Processor löst den Pfad der Include-Dateien mit Hilfe des Topic Include File Path auf.

Externe Dateien Einbeziehen