Using the tmdoc style

Besides the copyright information macros and traversal macros, which have been documented before, the tmdoc style comes with a certain number of other macros and functions, which you should use whenever appropriate:

key

This macro is used to indicate keyboard input like C-x C-s. The specialized macros kbd-gen, kbd-text, kbd-math, kbd-symb, kbd-big, kbd-large, kbd-ia, kbd-exec and kbd-table are used for keyboard input corresponding to a specific type of action or mode. For instance, kbd-math corresponds to keyboard shortcuts for mathematical operations, such as A-f, which starts a fraction.

menu

This function with an arbitrary number of arguments indicates a menu like File or Document→Language. Menu entries are automatically translated by this function.

markup

This macro is used in order to indicate a macro or a function like section.

tmstyle

This macro indicates the name of a TeXmacs style file or package like article.

tmpackage

This macro indicates the name of a TeXmacs package like std-markup.

tmdtd

This macro indicates the name of a TeXmacs d.t.d. like number-env.

Notice that the contents of none of the above tags should be translated into foreign languages. Indeed, for menu tags, the translations are done automatically, so as to keep the translations synchronized with the translations of the actual TeXmacs menus. In the cases of markup, styles, packages and d.t.d.s, it is important to keep the original name, because it often corresponds to a file name.

The following macros and functions are used for linking and indexing purposes, although they should be improved in the future:

simple-link

This macro takes an URL x as argument and is a hyperlink with name and destination x.

hyper-link

This macro is a usual hyperlink.

concept-link

This macro takes a concept as argument. Later on an appropriate hyperlink might be created automatically from this and the other documentation.

only-index

Index a simple string.

def-index

Definition of a new concept; the text is printed in italic and indexed.

re-index

Reappearance of an already defined concept; the text is printed in roman and put in the index.

The following tags are also frequently used:

icon

Link to an icon in a central directory like $TEXMACS_PATH/doc/images/pixmaps.

screenshot

Link to a screenshot. The actual screenshots are stored in a central directory like $TEXMACS_PATH/doc/images/screenshots.

scheme

The Scheme language.

cpp

The C++ language.

framed-fragment

For displaying a piece of code in a nice frame.

scheme-fragment

For multi-paragraph Scheme code.

cpp-fragment

For multi-paragraph C++ code.

tm-fragment

For a piece of TeXmacs markup code in Scheme format.

scheme-code

For a short piece of Scheme code.

cpp-code

For a short piece of C++ code.

descriptive-table

For descriptive tables; such tables can be used to document lists of keyboard shortcuts, different types of markup, etc.

The tmdoc style inherits from the generic style and you should use macros like em, verbatim, itemize, etc. from this style whenever appropriate.