title

<title text>

A title for the topic.

Title Tags

toctitle

<toctitle text>

A title for your topic in the TOC in all output formats.

Title Tags

titleimg

<titleimg imagefile>

The name of an image file that represents the title. For more information about images, see Images.

Titleimg Tag

flag

<flag text1,text2>

Using the flag tag you can add any kind of generic properties to a topic.

Flag Tag

keywords

<keywords keyword1/subentry1, keyword2/subentry2>

Using the keywords tag you can add any number of additional index entries and subentries for a topic. Keywords are separated from their optional subentry by "/".

Keyword Tags

fkeywords

<fkeywords keyword1, keyword2>

Using the fkeywords tag you can add additional keywords used for the context index in Help 2. This index is generated automatically in parallel to the index you can browse and is used by the Help system when looking for context help on symbols during editing in Microsoft Visual Studio and CodeGear RAD Studio.

Keyword Tags

alias;aliasof

<alias topicid>, <aliasof topicid1,topicid2>

Using the alias tag, you can specify a topic from which the documentation is copied. The aliasof tag is the reversal of alias. Using aliasof you can instruct Doc-O-Matic to copy the comment of the current topic to a certain topic.

Multiple Use of Topics

combine; combinewith

<combine topicid>, <combinewith topicid1,topicid2>

Using the combine tag you can also provide documentation for other topics. In addition, the declaration source code parts from all combined topics are concatenated together. The combinewith tag acts as if there was a combine ID directive in all topics in the list (where ID is the topic ID of the topic being described).

Multiple Use of Topics

copy; copyto

<copy topicid>,
<copyto topicid1, topicid2>

Using the copy tag you can copy the content of another topic to the current topic. Copyto is the reverse operation. You list all topics to which you want to copy the content of the current topic.

Multiple Use of Topics

versionspecific

<versionspecific [+|-] versionnumber>

The versionspecific tag allows you to apply version checks on a per-topic basis. When the topic is exported and the version-checking feature is turned on Doc-O-Matic compares the tag value with the version info of the project and issues a warning if the topic does not match the version number indicated by [+|-] versionnumber.

Version Specific Tag

autolink

<autolink on|off >

Using this tag you can override the project default configuration for autolinking on a per-topic basis.

Autolink Tag

implementation

<implementation on|off>

Using this tag you can override the project default configuration for copying the implementation source code to the output on a per-topic basis.

Implementation Tag

unfinished

<unfinished>

Using this tag you can change the documentation status of symbols and topics.

Unfinished Tag

externalhtml

<externalhtml, _html_filename_nopath_>

Using this tag you can provide an external source for the current topic in your HTML output. You can find out more about including information from HTML files in HTML Files.

External Source Tags

externalpdf

<externalpdf, _image_filename_nopath>

Using this tag you can provide a graphic as external source for the current topic in your PDF output.

External Source Tags

b

<b> </b>

Text contained within bold tags is made bold in the output.

Character Formatting

i

<i> </i>

Text contained within italic tags is made italic in the output.

Character Formatting

u

<u> </u>

Text contained within underlined tags is underlined in the output.

Character Formatting

c

<c> </c>

Text contained within code tags is formatted as code. Text is not white space - reduced and Doc-O-Matic uses a fixed pitch font.

Character Formatting

sub



Text contained within subscript tags is formatted as subscript in the output.

Character Formatting

sup



Text contained within superscript tags is formatted as superscript in the output.

Character Formatting

color

<color namelvalue> </color>

Text contained within the color tags is rendered with a different color. The name references a defined color name or a hex RGB value. In Windows Help colors can be referenced by their name only.

Color Tag

label

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

Text contained within the label tags is labeled. Within a label you can enter any text with character formatting but no label tag.

Label Tag

p

<p>

The paragraph tag forces a new paragraph to be created. Another method is to insert a blank line in the comment block.

Paragraph Formatting

pre

<pre> </pre>

Text that is contained within a pre block is not white space - reduced. Doc-O-Matic copies text including all line feeds, spaces and tabs to the output. All formatting you have applied in the block is preserved. Pre tags cannot be nested.

Paragraph Formatting

code

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

Text that is contained within code tags is handled exactly as text contained in pre tags. Additionally Doc-O-Matic formats the text using a fixed pitch font. If you add a language attribute the corresponding syntax highlighter will be used for the code block. This setting overrides the project setting for the syntax highlighter.

Code Blocks

![CDATA[
]]>

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

Text in CDATA tags is escaped. Doc-O-Matic ignores any tags inside those blocks (any but </code> and </pre>, which automatically terminate the block. CDATA is valid within code pre blocks only. The editor will convert CDATA blocks into conventional Doc-O-Matic escaped text.

Code Blocks

align

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

Use these tags to align a paragraph to the left or right and to center or justify it.

Paragraph Formatting

link

<link topicid[, linktext] >

Link tags are replaced by a hyperlink to the given topic. The topic ID refers to any topic within the project (symbol and generic topics) or topic IDs in an added link database. If linktext is provided, the link will display this text; otherwise the topic ID appears.

Link Tag

extlink

<extlink _linktarget_> </

Adds an external link. The difference to the link tag is that Doc-O-Matic does not verify the _linktarget_. For this reason you have to ensure that the target is valid and Doc-O-Matic understands how to create a hyperlink to it.

Link Tag

image

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

Inserts an image into the text. Name is the name of the image file without path and extension. Doc-O-Matic will search for the file on the Image Path and append appropriate filename extensions (that are filename extensions that can be used in the output format). For this reason omit extensions if possible.

Image Tag

table

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

Text contained within a table tags is interpreted as tabular information. To insert tables without borders use the noborder attribute. To insert HTML tables use the htmltable attribute.

Table Tags

emit

<emit html_code>

Replaces the whole tag by the HTML code in your HTML output.

Including HTML Code

include

<include _filename_>

Replaces the whole tag by the content of _filename_. _filename_ can contain no, a relative, or a fully qualified path.

Including External Files