1
0
Fork 0
doc/about/contribute/documentation/tmdoc-annotate.en.tm

61 lines
1.7 KiB
Plaintext
Raw Normal View History

<TeXmacs|1.0.7.20>
2012-02-04 05:39:51 +08:00
<style|tmdoc>
<\body>
<tmdoc-title|Common annotations>
The <menu|Manual|Annotate> and <icon|tm_tmdoc_annotate.xpm> menus contain
the following useful macros for common annotations. You should use them
whenever appropriate.
<\explain|<markup|markup>>
This macro is used in order to indicate a macro or a function like
<markup|section>.
</explain>
<\explain|<markup|src-arg>>
This macro should be used in order to indicate macro arguments such as
<src-arg|body>.
</explain>
<\explain|<markup|src-var>>
This macro is used for the indication of environment variables such as
<src-var|font-size>.
</explain>
<\explain|<markup|src-length>>
This macro is used in order to indicate a length such as
<src-length|12em>.
</explain>
<\explain|<markup|tmstyle>>
This macro indicates the name of a <TeXmacs> style file or package like
<tmstyle|article>.
</explain>
<\explain|<markup|tmpackage>>
This macro indicates the name of a <TeXmacs> package like
<tmpackage|std-markup>.
</explain>
<\explain|<markup|tmdtd>>
This macro indicates the name of a <TeXmacs> <abbr|d.t.d.> like
<tmdtd|number-env>.
</explain>
2012-02-04 05:39:51 +08:00
<tmdoc-copyright|1998--2011|Joris van der Hoeven>
<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".>
</body>
<\initial>
<\collection>
<associate|language|english>
</collection>
</initial>