< Document optionsHistory >

STML reference

Commands

:title <title text>

Document title. Each document must have one and it must be the first content. The title text is put verbatim in the document title and at the beginning of the document body.

:author <author name>

Name of the document's author. Each document can have one. It should be given directly after the :title command. The author of the opening document is assumed to be the main author of the help set.

Note that :author information is currently only used by the LaTeX output.

:options <option>|<option>|...

Defines document options. Used while processing the document. Known options:

:h1 <title text>
:h2 <title text>
:h3 <title text>
:h4 <title text>

Section and subsection title. Section titles (“:h1”) are printed in the same shape as the document title.

:image <filename>|<image title>|<reference label>

Insert an image as own part into the document. The image is taken from the file with the given name. It is centered in the document and gets the image title below. The reference label can be used to reference this picture in the text.

:hr

Horizontal line.

:label <label name>

Gives the document a label which can be used to reference it from elsewhere. A document should only have one label and for the sake of readability, it should be put directly after the :title tag.

:anchor <anchor name>

Inserts an anchor into the document which can be used as link target in the middle of the document. A document may have an arbitrary number of anchors. The anchor is internally assigned to the following element of the document.

:div <division name>
:/div

Marks a part of the text as being a special division. This actual result is dependant on the output format. For HTML-derived output formats, the division name is assigned to a style sheet class. LaTeX-based output uses environments of the same name, if defined.

:macro <macro name>[|<parameter name>|<parameter name>...]
:/macro

Defines a macro which can be referenced lateron. Parameters are not mandatory.

:rem <rest of the line>

Ignores the complete line in all output formats. Allows comments or remarks in the STML source.

Text markup

<blank line>

Seperates paragraphs.

“~~” (two tilde characters)

Explicit line break within a paragraph.

“_” (underscore)

Non-breakable space. If given at paragraph begin or after an explicit line break, text is indented.

**<bold text>**
//<italic text>//
::<typewriter text::

Begins and ends a specially marked up text section. Bold, italic and typewriter text may contain each other but must not overlap their respective boundaries. Neiter of them can cross paragraphes.

##<filename>|<alternative text>##

An inline image. It is put into the paragraph just at the current position.

<< <link target>|<link text> >>

Reference. Inserts a link to the given target, which is written as the given link text.

[[<external URL>|<link text>]]

Reference to an external URL. If the link text is not given, the URL itself is printed.

Text structuring markup

All structuring markups must occur at the beginning of a paragraph.

“-“, “+”, “*”, “#”

Starts a paragraph as item of an unnumbered list. Paragraphes following each other with the same mark are put into the same list. Each paragraph without the sign implicitly ends the list. Paragraphs starting with another sign open a sublist.

“<number>)”, “<number>.”, “<single character>)”, “<single character>.”

Starts a paragraph as item of a numbered list. Paragraphes following each other with the same mark are put into the same list. Each paragraph without the sign implicitly ends the list. Paragraphs starting with another sign open a sublist.

“.”

Starts a paragraph without the list item identifier but on the same list depth level as the paragraph before and keeps the list generally open.

“-.”, “+.”, “*.”, “#.”, “<number>).”, “<number>..”, “<single character>).”, “<single character>..”

Starts a paragraph without the list item identifier but on the same list depth level as the last paragraph above starting with the same markup element without the trailing dot. Needed in stacked lists when a list has to be continued after an inner list.

“((<macro name>[|<parameter value...]))”

Call of a macro. The content of the referenced macro is printed out. If the macro takes parameter, their content is given in the call seperated by “|” from the macro name and from each other.

“{{<parameter name>}}”

Placeholder for a macro's parameter. Only used within a macro definition body, i.e. between “:macro” and “:/macro”.

“->”, “<-“, “$^”, “$v”

Arrow symbols for all directions. Due to limitations in the HTML rendering engine, used for helpsets, helpset export and preview within HelpSetMaker feature only very poor arrow versions. HTML4 and LaTeX export show “real” arrows, though.

\<some character>

Special character escaping. The character immediately after the backslash is always printed “as is” and never interpreted as part of the markup.

< Document optionsHistory >