1
0
Fork 0
doc/about/contribute/documentation/tmdoc-style.fr.tm

138 lines
4.8 KiB
Plaintext
Raw Permalink Normal View History

<TeXmacs|1.0.7.20>
2011-08-28 15:59:50 +08:00
<style|tmdoc>
<\body>
<tmdoc-title|Utilisation du style tmdoc>
En plus des macros <hlink|droits d'auteur|copyright.fr.tm> et
<hlink|navigation|traversal.fr.tm>, qui ont d<>j<EFBFBD> <20>t<EFBFBD> expliqu<71>es, le style
<tmstyle|tmdoc> contient un certain nombre d'autres macros et fonctions que
vous pouvez utiliser si n<>cessaire :
<\explain|<markup|key>>
Cette macro est utilis<69>e pour signaler des saisies clavier, telle
<shortcut|(save-buffer)>. Les macros sp<73>cifiques <markup|kbd-gen>,
<markup|kbd-text>, <markup|kbd-math>, <markup|kbd-symb>,
<markup|kbd-big>, <markup|kbd-large>, <markup|kbd-ia>, <markup|kbd-exec>
\ et <markup|kbd-table> sont utilis<69>es pour les saisies clavier
correspondant <20> un type sp<73>cifique d'action ou de mode. Par exemple, la
macro <markup|kbd-math> correspond aux raccourcis clavier pour les
op<6F>rations math<74>matiques, tel <key|math f>, qui d<>bute une fraction.
</explain>
<\explain|<markup|menu>>
Cette fonction, compos<6F>e d'un nombre arbitraire d'arguments, fait
r<>f<EFBFBD>rence <20> un menu, tel <menu|File> ou <menu|Document|Language>. Les
articles de menu sont automatiquement traduits par cette fonction.
</explain>
<\explain|<markup|markup>>
Cette macro est utilis<69>e pour signaler une macro ou une fonction, telle
<markup|section>.
</explain>
<\explain|<markup|tmstyle>>
Cette macro indique le nom d'un fichier de style <TeXmacs> ou un module,
tel <tmstyle|article>.
</explain>
<\explain|<markup|tmpackage>>
Cette macro indique le nom d'un package, tel <tmstyle|std-markup>.
</explain>
<\explain|<markup|tmdtd>>
Cette macro indique le nom d'un d.t.d. <TeXmacs>, tel <tmdtd|number-env>.
</explain>
2011-08-28 15:59:50 +08:00
Attention, aucune des marques ci-dessus ne doit <20>tre traduite. En effet,
les marques de menus sont automatiquement traduites, de fa<66>on <20> assurer la
synchronisation de leur traduction avec la traduction actuelle des menus de
<TeXmacs>. En ce qui concerne les marques, styles, packages et
<abbr|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<69>es pour les liens et les
index ; elles seront am<61>lior<6F>es plus tard :
<\explain|<markup|simple-link>>
Cette macro a pour argument <math|x> une URL et g<>n<EFBFBD>re un hyperlien de
nom et destination <math|x>.
</explain>
2011-08-28 15:59:50 +08:00
<\explain|<markup|hyper-link>>
Cette macro correspond <20> un hyperlien.
</explain>
2011-08-28 15:59:50 +08:00
<\explain|<markup|concept-link>>
Cette macro a pour argument un concept. Plus tard, un hyperlien pourra
<20>tre cr<63><72> automatiquement <20> partir du concept et du reste de la
documentation.
</explain>
2011-08-28 15:59:50 +08:00
<\explain|<markup|only-index>>
Indexe une cha<68>ne de caract<63>res.
</explain>
2011-08-28 15:59:50 +08:00
<\explain|<markup|def-index>>
D<>finit un nouveau concept ; le texte est imprim<69> en italique et index<65>.
</explain>
2011-08-28 15:59:50 +08:00
<\explain|<markup|re-index>>
R<>utilise un concept d<>j<EFBFBD> d<>fini ; le texte est imprim<69> en roman et mis
dans l'index.
</explain>
2011-08-28 15:59:50 +08:00
Les marques suivantes sont aussi assez fr<66>quemment utilis<69>es :
<\explain|<markup|icon>>
Lien vers une ic<69>ne situ<74>e dans un r<>pertoire central, tel
\ <verbatim|$TEXMACS_PATH/doc/images/pixmaps>.
</explain>
2011-08-28 15:59:50 +08:00
<\explain|<markup|screenshot>>
Lien vers une capture d'<27>cran. Les captures d'<27>cran sont stock<63>es dans
une r<>pertoire central, tel <verbatim|$TEXMACS_PATH/doc/images/screenshots>.
</explain>
2011-08-28 15:59:50 +08:00
<\explain|<markup|scheme>>
Le language <scheme>.
</explain>
2011-08-28 15:59:50 +08:00
<\explain|<markup|framed-fragment>>
Pour afficher un fragment de code dans un cadre appropri<72>.
</explain>
2011-08-28 15:59:50 +08:00
<\explain|<markup|scheme-fragment>>
Pour du code <scheme> sur plusieurs paragraphes.
</explain>
2011-08-28 15:59:50 +08:00
<\explain|<markup|tm-fragment>>
Pour marquer du code <TeXmacs> en format <scheme>.
</explain>
2011-08-28 15:59:50 +08:00
<\explain|<markup|descriptive-table>>
Pour les tables de description ; on peut utiliser ces tables pour
documenter des listes de raccourcis clavier, diff<66>rents types de
marquage, etc...
</explain>
2011-08-28 15:59:50 +08:00
The style <tmstyle|tmdoc> h<>rite du style <tmstyle|generic>. Vous devez
utiliser les macros <markup|em>, <markup|verbatim>, <markup|itemize>,
<abbr|etc.> contenues dans ce style quand le cas se pr<70>sente.
<tmdoc-copyright|1998--2003|Joris van der Hoeven|Mich<63>le Garoche>
2011-08-28 15:59:50 +08:00
<tmdoc-license|Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License, Version 1.1
or any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled "GNU Free
Documentation License".>
2011-08-28 15:59:50 +08:00
</body>
<\initial>
<\collection>
<associate|language|french>
</collection>
</initial>