2012-02-04 05:39:51 +08:00
|
|
|
<TeXmacs|1.0.7.14>
|
2011-08-28 15:59:50 +08:00
|
|
|
|
|
|
|
|
<style|tmdoc>
|
|
|
|
|
|
|
|
|
|
<\body>
|
2011-09-02 06:57:35 +08:00
|
|
|
<tmdoc-title|Using the tmdoc style>
|
2011-08-28 15:59:50 +08:00
|
|
|
|
2011-09-02 06:57:35 +08:00
|
|
|
Besides the <hlink|copyright information|copyright.en.tm> macros and
|
|
|
|
|
<hlink|traversal macros|traversal.en.tm>, which have been documented
|
|
|
|
|
before, the <tmstyle|tmdoc> style comes with a certain number of other
|
2012-02-04 05:39:51 +08:00
|
|
|
macros and functions, which you should use whenever appropriate.
|
2011-08-28 15:59:50 +08:00
|
|
|
|
2012-02-04 05:39:51 +08:00
|
|
|
Notice that the <tmstyle|tmdoc> style inherits from the <tmstyle|generic>
|
|
|
|
|
style, so you should use macros like <markup|em>, <markup|verbatim>,
|
|
|
|
|
<markup|itemize>, <abbr|etc.> from this style whenever appropriate. In
|
2017-10-13 14:30:48 +08:00
|
|
|
particular, when documenting program code, you should use
|
2012-02-04 05:39:51 +08:00
|
|
|
<menu|Insert|Program|Inline code> and <menu|Insert|Program|Block of code>
|
|
|
|
|
in order to mark such pieces of code.
|
2011-09-02 06:57:35 +08:00
|
|
|
|
2012-02-04 05:39:51 +08:00
|
|
|
<\traverse>
|
|
|
|
|
<branch|Explanations of macros, environment variables, and so
|
|
|
|
|
on|tmdoc-explain.en.tm>
|
2011-09-02 06:57:35 +08:00
|
|
|
|
2012-02-04 05:39:51 +08:00
|
|
|
<branch|Graphical user interface related markup|tmdoc-gui.en.tm>
|
2011-09-02 06:57:35 +08:00
|
|
|
|
2012-02-04 05:39:51 +08:00
|
|
|
<branch|Common annotations|tmdoc-annotate.en.tm>
|
2011-09-02 06:57:35 +08:00
|
|
|
|
2012-02-04 05:39:51 +08:00
|
|
|
<branch|Miscellaneous markup|tmdoc-misc.en.tm>
|
|
|
|
|
</traverse>
|
2011-08-28 15:59:50 +08:00
|
|
|
|
2011-09-02 06:57:35 +08:00
|
|
|
<tmdoc-copyright|1998--2011|Joris van der Hoeven>
|
2011-08-28 15:59:50 +08:00
|
|
|
|
2011-09-02 06:57:35 +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|english>
|
|
|
|
|
</collection>
|
2011-09-02 06:57:35 +08:00
|
|
|
</initial>
|
