Utilisation du style tmdoc

En plus des macros droits d'auteur et navigation, qui ont déjà été expliquées, le style tmdoc contient un certain nombre d'autres macros et fonctions que vous pouvez utiliser si nécessaire :

key

Cette macro est utilisée pour signaler des saisies clavier, telle C-x C-s. Les macros spécifiques kbd-gen, kbd-text, kbd-math, kbd-symb, kbd-big, kbd-large, kbd-ia, kbd-exec et kbd-table sont utilisées pour les saisies clavier correspondant à un type spécifique d'action ou de mode. Par exemple, la macro kbd-math correspond aux raccourcis clavier pour les opérations mathématiques, tel A-f, qui débute une fraction.

menu

Cette fonction, composée d'un nombre arbitraire d'arguments, fait référence à un menu, tel Fichier ou Document→Langue. Les articles de menu sont automatiquement traduits par cette fonction.

markup

Cette macro est utilisée pour signaler une macro ou une fonction, telle section.

tmstyle

Cette macro indique le nom d'un fichier de style TeXmacs ou un module, tel article.

tmpackage

Cette macro indique le nom d'un package, tel std-markup.

tmdtd

Cette macro indique le nom d'un d.t.d. TeXmacs, tel number-env.

Attention, aucune des marques ci-dessus ne doit être traduite. En effet, les marques de menus sont automatiquement traduites, de façon à assurer la synchronisation de leur traduction avec la traduction actuelle des menus de TeXmacs. En ce qui concerne les marques, styles, packages et d.t.d.s, il faut absolument garder le nom original, car il correspond souvent au nom d'un fichier.

Les macros et fonctions suivantes sont utilisées pour les liens et les index ; elles seront améliorées plus tard :

simple-link

Cette macro a pour argument x une URL et génère un hyperlien de nom et destination x.

hyper-link

Cette macro correspond à un hyperlien.

concept-link

Cette macro a pour argument un concept. Plus tard, un hyperlien pourra être créé automatiquement à partir du concept et du reste de la documentation.

only-index

Indexe une chaîne de caractères.

def-index

Définit un nouveau concept ; le texte est imprimé en italique et indexé.

re-index

Réutilise un concept déjà défini ; le texte est imprimé en roman et mis dans l'index.

Les marques suivantes sont aussi assez fréquemment utilisées :

icon

Lien vers une icône située dans un répertoire central, tel $TEXMACS_PATH/doc/images/pixmaps.

screenshot

Lien vers une capture d'écran. Les captures d'écran sont stockées dans une répertoire central, tel $TEXMACS_PATH/doc/images/screenshots.

scheme

Le language Scheme.

framed-fragment

Pour afficher un fragment de code dans un cadre approprié.

scheme-fragment

Pour du code Scheme sur plusieurs paragraphes.

tm-fragment

Pour marquer du code TeXmacs en format Scheme.

descriptive-table

Pour les tables de description ; on peut utiliser ces tables pour documenter des listes de raccourcis clavier, différents types de marquage, etc...

The style tmdoc hérite du style generic. Vous devez utiliser les macros em, verbatim, itemize, etc. contenues dans ce style quand le cas se présente.