property

<property name= "_NAME_" value="_VALUE_" />

Stellt Eigenschaften für Themen wie zum Beispiel einen Titel zur Verfügung.

docsource

<docsource type= "_NAME_" target= "_TARGET_" />

Stellt eine andere Quelle für das Thema zur Verfügung.

unfinished

<unfinished />

Mit Hilfe dieses Tags können Sie den Dokumentationsstatus des Themas oder Symbols auf unbeendet setzen. Weitere Informationen finden Sie in Unfinished und Versionspecific-Tag.

title

<property name= "title" value="_VALUE_" />

Ein Titel für ein Thema.

Title-Tag

toctitle

<property name= "toctitle" value= "_VALUE_" />

Ein Titel für Ihr Thema im Inhaltsverzeichnis aller Ausgaben.

Title-Tag

titleimg

<property name= "titleimg" value= "_VALUE_" />

Der Name einer Grafikdatei, die den Titel darstellt.

Titleimg-Tag

flag

<property name= "flag" value= "_VALUE_" />

Mit Hilfe des Flag-Tag können Sie einem Thema eine allgemeine Eigenschaft geben.

Flag-Tag

keyword

<property name= "keyword" value=" _VALUE_" />

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

fkeyword

<property name= "fkeyword" value=" _VALUE_" />

Mit Hilfe des Fkeyword-Tags können Sie zusätzliche Schlüsselwörter für die kontextbezogene Help2-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

versionspecific

<property name= "versionspecific" value= "_VALUE_" /><contentsentry>

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.Die Versionskontrolle ist in Doc-O-Matic Express nicht verfügbar.

Versionspecific-Tag

autolink

<property name= "autolink" value= "_VALUE_" />

Mit Hilfe dieses Tags können Sie die Projektkonfiguration für das Feature Autolinking für jedes Thema überschreiben.Autolinking ist in Doc-O-Matic Express nicht verfügbar.

Autolinking-Tag

implementation

<property name= "implementation" value= "_VALUE_" />

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

externalhtml

<property name= "externalhtml" value= "_VALUE_" />

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

<property name= "externalpdf" value= "_VALUE_" />

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.Die PDF-Ausgabe ist in Doc-O-Matic Express nicht verfügbar.

Tags für externe Quellen

alias; aliasof

<docsource type= "alias" target= "_TARGET_" />
<docsource type= "aliasof" target= "_TARGET_" />

Mit Hilfe des Alias-Tag, können Sie ein Thema definieren von dem die Dokumentation kopiert wird. Mit Hilfe des Aliasof-Tag können Sie auswählen in welche Themen die Dokumentation dieses Themas kopiert wird. Verwenden Sie einen Docsource-Tag für jedes Zielthema des Aliasof-Tags.

Mehrfache Verwendung von Themen

combine, combinewith

<docsource type= "combine" target= "_TARGET_" />
<docsource type= "combinewith" target= "_TARGET_" />

Wenn Sie den Combine-Tag verwenden wird die Deklaration aller Combined Themen zusammengefügt. Der Beschreibungstext wird von dem im Tag genannten Thema genommen. Der Combinewith-Tag ist das Gegenstück zum Combine-Tag. Verwenden Sie einen Docsource-Tag für jedes Zielthema des Combinewith-Tags.

Mehrfache Verwendung von Themen

copy, copyto

<docsource type= "copy" target= "_TARGET_" />
<docsource type= "copyto" target= "_TARGET_" />

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

Mehrfache Verwendung von Themen

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 der 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

textattr

<textattr color = "_NAME_">_TEXT_</textattr>

Text innerhalb der Textattr-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.

Codeabsatz

![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

parattr

<paraattr align= "[left | right | center | justify]">_TEXT_</paraattr>

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

Absatzformatierungen

xref

<xref target ="_TARGET_" text= "_text_" />

Xref-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-Tag

exref

<exref target= "_TARGET_">_TEXT_</exref>

Fügt einen externen Hyperlink hinzu. Im Unterschied zum Xref-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-Tag

img

<img name= "_NAME_" target= "_TARGET_" text= "_TEXT_" float="yes" />

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

xtable

<xtable border= "no" width= "100%" columnwidths= "30c%,30c%,20c%">
</xtable>

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

Table-Tags

literal

<literal html= "_text_" />

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

HTML-Code einbeziehen

use

<use name= "_NAME_" />

Ersetzt den gesamten Tag durch den Inhalt von _filename_. _filename_ kann keinen, einen relativen oder eine vollständigen Pfadnamen enthalten.

Externe Dateien Einbeziehen

paramref

<paramref name="counter"/>

Doc-O-Matic fügt das Label auto.xml.paramrefauto.xml.paramref zu dem Projekt hinzu, das dazu verwendet werden kann den Inhalt von paramref zu formatieren.

Text Labels