← Back to branch summary

~ubuntu-branches/ubuntu/hardy/texmacs/hardy

« back to all changes in this revision

Viewing changes to TeXmacs/doc/about/contribute/documentation/tmdoc-style.en.tm

  • Committer: Bazaar Package Importer
  • Author(s): Ralf Treinen
  • Date: 2004-04-19 20:34:00 UTC
  • Revision ID: james.westby@ubuntu.com-20040419203400-g4e34ih0315wcn8v
Tags: upstream-1.0.3-R2
Import upstream version 1.0.3-R2

Show diffs side-by-side

added added

removed removed

Lines of Context:
TeXmacs/doc/about/contribute/documentation/tmdoc-style.en.tm
 
1
<TeXmacs|1.0.1.20>
 
2
 
 
3
<style|tmdoc>
 
4
 
 
5
<\body>
 
6
  <expand|tmdoc-title|Using the tmdoc style>
 
7
 
 
8
  Besides the <apply|hyper-link|copyright information|copyright.en.tm> macros
 
9
  and <apply|hyper-link|traversal macros|traversal.en.tm>, which have been
 
10
  documented before, the <tmstyle|tmdoc> style comes with a certain number of
 
11
  other macros and functions, which you should use whenever appropriate:
 
12
 
 
13
  <\description>
 
14
    <expand|item*|<markup|key>>This macro is used to indicate keyboard input
 
15
    like <key|C-x C-s>. The specialized macros <markup|kbd-gen>,
 
16
    <markup|kbd-text>, <markup|kbd-math>, <markup|kbd-symb>,
 
17
    <markup|kbd-big>, <markup|kbd-large>, <markup|kbd-ia>, <markup|kbd-exec>
 
18
    and <markup|kbd-table> are used for keyboard input corresponding to a
 
19
    specific type of action or mode. For instance, <markup|kbd-math>
 
20
    corresponds to keyboard shortcuts for mathematical operations, such as
 
21
    <expand|kbd-math|f>, which starts a fraction.
 
22
 
 
23
    <expand|item*|<markup|menu>>This function with an arbitrary number of
 
24
    arguments indicates a menu like <apply|menu|File> or
 
25
    <apply|menu|Document|Language>. Menu entries are automatically translated
 
26
    by this function.
 
27
 
 
28
    <expand|item*|<markup|markup>>This macro is used in order to indicate a
 
29
    macro or a function like <markup|section>.
 
30
 
 
31
    <expand|item*|<markup|tmstyle>>This macro indicates the name of a
 
32
    <TeXmacs> style file or package like <tmstyle|article>.
 
33
 
 
34
    <expand|item*|<markup|tmpackage>>This macro indicates the name of a
 
35
    <TeXmacs> package like <tmpackage|std-markup>.
 
36
 
 
37
    <expand|item*|<markup|tmdtd>>This macro indicates the name of a <TeXmacs>
 
38
    <abbr|d.t.d.> like <tmdtd|number-env>.
 
39
  </description>
 
40
 
 
41
  Notice that the contents of none of the above tags should be translated
 
42
  into foreign languages. Indeed, for menu tags, the translations are done
 
43
  automatically, so as to keep the translations synchronized with the
 
44
  translations of the actual <TeXmacs> menus. In the cases of markup, styles,
 
45
  packages and <abbr|d.t.d.>s, it is important to keep the original name,
 
46
  because it often corresponds to a file name.
 
47
 
 
48
  The following macros and functions are used for linking and indexing
 
49
  purposes, although they should be improved in the future:
 
50
 
 
51
  <\description>
 
52
    <expand|item*|<markup|simple-link>>This macro takes an URL
 
53
    <with|mode|math|x> as argument and is a hyperlink with name and
 
54
    destination <with|mode|math|x>.
 
55
 
 
56
    <expand|item*|<markup|hyper-link>>This macro is a usual hyperlink.
 
57
 
 
58
    <expand|item*|<markup|concept-link>>This macro takes a concept as
 
59
    argument. Later on an appropriate hyperlink might be created
 
60
    automatically from this and the other documentation.
 
61
 
 
62
    <expand|item*|<markup|only-index>>Index a simple string.
 
63
 
 
64
    <expand|item*|<markup|def-index>>Definition of a new concept; the text is
 
65
    printed in italic and indexed.
 
66
 
 
67
    <expand|item*|<markup|re-index>>Reappearance of an already defined
 
68
    concept; the text is printed in roman and put in the index.
 
69
  </description>
 
70
 
 
71
  The following tags are also frequently used:
 
72
 
 
73
  <\description>
 
74
    <expand|item*|<markup|icon>>Link to an icon in a central directory like
 
75
    <verbatim|$TEXMACS_PATH/doc/images/pixmaps>.
 
76
 
 
77
    <expand|item*|<markup|screenshot>>Link to a screenshot. The actual
 
78
    screenshots are stored in a central directory like
 
79
    <verbatim|$TEXMACS_PATH/doc/images/screenshots>.
 
80
 
 
81
    <expand|item*|<markup|scheme>>The <value|scheme> language.
 
82
 
 
83
    <expand|item*|<markup|cpp>>The <value|cpp> language.
 
84
 
 
85
    <expand|item*|<markup|framed-fragment>>For displaying a piece of code in
 
86
    a nice frame.
 
87
 
 
88
    <expand|item*|<markup|scheme-fragment>>For multi-paragraph <value|scheme>
 
89
    code.
 
90
 
 
91
    <expand|item*|<markup|cpp-fragment>>For multi-paragraph <value|cpp> code.
 
92
 
 
93
    <expand|item*|<markup|tm-fragment>>For a piece of <TeXmacs> markup code
 
94
    in <value|scheme> format.
 
95
 
 
96
    <expand|item*|<markup|scheme-code>>For a short piece of <value|scheme>
 
97
    code.
 
98
 
 
99
    <expand|item*|<markup|cpp-code>>For a short piece of <value|cpp> code.
 
100
 
 
101
    <expand|item*|<markup|descriptive-table>>For descriptive tables; such
 
102
    tables can be used to document lists of keyboard shortcuts, different
 
103
    types of markup, <abbr|etc.>
 
104
  </description>
 
105
 
 
106
  The <tmstyle|tmdoc> style inherits from the <tmstyle|generic> style and you
 
107
  should use macros like <markup|em>, <markup|verbatim>, <markup|itemize>,
 
108
  <abbr|etc.> from this style whenever appropriate.
 
109
 
 
110
  <apply|tmdoc-copyright|1998--2002|Joris van der Hoeven>
 
111
 
 
112
  <expand|tmdoc-license|Permission is granted to copy, distribute and/or
 
113
  modify this document under the terms of the GNU Free Documentation License,
 
114
  Version 1.1 or any later version published by the Free Software Foundation;
 
115
  with no Invariant Sections, with no Front-Cover Texts, and with no
 
116
  Back-Cover Texts. A copy of the license is included in the section entitled
 
117
  "GNU Free Documentation License".>
 
118
</body>
 
119
 
 
120
<\initial>
 
121
  <\collection>
 
122
    <associate|paragraph width|150mm>
 
123
    <associate|odd page margin|30mm>
 
124
    <associate|shrinking factor|4>
 
125
    <associate|page right margin|30mm>
 
126
    <associate|page top margin|30mm>
 
127
    <associate|reduction page right margin|25mm>
 
128
    <associate|page type|a4>
 
129
    <associate|reduction page bottom margin|15mm>
 
130
    <associate|even page margin|30mm>
 
131
    <associate|reduction page left margin|25mm>
 
132
    <associate|page bottom margin|30mm>
 
133
    <associate|reduction page top margin|15mm>
 
134
    <associate|language|english>
 
135
  </collection>
 
136
</initial>
 
137
 
 
138
<\references>
 
139
  <\collection>
 
140
    <associate|idx-1|<tuple|<uninit>|?>>
 
141
    <associate|idx-2|<tuple|<uninit>|?>>
 
142
    <associate|idx-3|<tuple|<uninit>|?>>
 
143
    <associate|idx-4|<tuple|<uninit>|?>>
 
144
    <associate|idx-5|<tuple|<uninit>|?>>
 
145
    <associate|idx-6|<tuple|<uninit>|?>>
 
146
    <associate|idx-7|<tuple|<uninit>|?>>
 
147
    <associate|idx-8|<tuple|<uninit>|?>>
 
148
    <associate|idx-9|<tuple|<uninit>|?>>
 
149
    <associate|idx-40|<tuple|<uninit>|?>>
 
150
    <associate|idx-10|<tuple|<uninit>|?>>
 
151
    <associate|idx-20|<tuple|<uninit>|?>>
 
152
    <associate|idx-30|<tuple|<uninit>|?>>
 
153
    <associate|idx-41|<tuple|<uninit>|?>>
 
154
    <associate|idx-11|<tuple|<uninit>|?>>
 
155
    <associate|idx-21|<tuple|<uninit>|?>>
 
156
    <associate|idx-31|<tuple|<uninit>|?>>
 
157
    <associate|idx-42|<tuple|<uninit>|?>>
 
158
    <associate|idx-12|<tuple|<uninit>|?>>
 
159
    <associate|idx-22|<tuple|<uninit>|?>>
 
160
    <associate|idx-32|<tuple|<uninit>|?>>
 
161
    <associate|idx-43|<tuple|<uninit>|?>>
 
162
    <associate|idx-33|<tuple|<uninit>|?>>
 
163
    <associate|idx-13|<tuple|<uninit>|?>>
 
164
    <associate|idx-23|<tuple|<uninit>|?>>
 
165
    <associate|idx-44|<tuple|<uninit>|?>>
 
166
    <associate|idx-34|<tuple|<uninit>|?>>
 
167
    <associate|idx-14|<tuple|<uninit>|?>>
 
168
    <associate|idx-24|<tuple|<uninit>|?>>
 
169
    <associate|idx-45|<tuple|<uninit>|?>>
 
170
    <associate|idx-35|<tuple|<uninit>|?>>
 
171
    <associate|idx-15|<tuple|<uninit>|?>>
 
172
    <associate|idx-25|<tuple|<uninit>|?>>
 
173
    <associate|idx-36|<tuple|<uninit>|?>>
 
174
    <associate|idx-16|<tuple|<uninit>|?>>
 
175
    <associate|idx-26|<tuple|<uninit>|?>>
 
176
    <associate|idx-37|<tuple|<uninit>|?>>
 
177
    <associate|idx-17|<tuple|<uninit>|?>>
 
178
    <associate|idx-27|<tuple|<uninit>|?>>
 
179
    <associate|idx-38|<tuple|<uninit>|?>>
 
180
    <associate|idx-18|<tuple|<uninit>|?>>
 
181
    <associate|idx-28|<tuple|<uninit>|?>>
 
182
    <associate|idx-39|<tuple|<uninit>|?>>
 
183
    <associate|idx-19|<tuple|<uninit>|?>>
 
184
    <associate|idx-29|<tuple|<uninit>|?>>
 
185
  </collection>
 
186
</references>
 
187
 
 
188
<\auxiliary>
 
189
  <\collection>
 
190
    <\associate|idx>
 
191
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|brown>|tmdoc>>|<pageref|idx-1>>
 
192
 
 
193
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
194
      green>|key>>|<pageref|idx-2>>
 
195
 
 
196
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
197
      green>|kbd-gen>>|<pageref|idx-3>>
 
198
 
 
199
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
200
      green>|kbd-text>>|<pageref|idx-4>>
 
201
 
 
202
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
203
      green>|kbd-math>>|<pageref|idx-5>>
 
204
 
 
205
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
206
      green>|kbd-symb>>|<pageref|idx-6>>
 
207
 
 
208
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
209
      green>|kbd-big>>|<pageref|idx-7>>
 
210
 
 
211
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
212
      green>|kbd-large>>|<pageref|idx-8>>
 
213
 
 
214
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
215
      green>|kbd-ia>>|<pageref|idx-9>>
 
216
 
 
217
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
218
      green>|kbd-exec>>|<pageref|idx-10>>
 
219
 
 
220
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
221
      green>|kbd-table>>|<pageref|idx-11>>
 
222
 
 
223
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
224
      green>|kbd-math>>|<pageref|idx-12>>
 
225
 
 
226
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
227
      green>|menu>>|<pageref|idx-13>>
 
228
 
 
229
      <tuple|<tuple|<with|font family|<quote|ss>|File>>|<pageref|idx-14>>
 
230
 
 
231
      <tuple|<tuple|<with|font family|<quote|ss>|Document>|<with|font
 
232
      family|<quote|ss>|Language>>|<pageref|idx-15>>
 
233
 
 
234
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
235
      green>|markup>>|<pageref|idx-16>>
 
236
 
 
237
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
238
      green>|section>>|<pageref|idx-17>>
 
239
 
 
240
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
241
      green>|tmstyle>>|<pageref|idx-18>>
 
242
 
 
243
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|brown>|article>>|<pageref|idx-19>>
 
244
 
 
245
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
246
      green>|tmpackage>>|<pageref|idx-20>>
 
247
 
 
248
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|brown>|std-markup>>|<pageref|idx-21>>
 
249
 
 
250
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
251
      green>|tmdtd>>|<pageref|idx-22>>
 
252
 
 
253
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
254
      magenta>|number-env>>|<pageref|idx-23>>
 
255
 
 
256
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
257
      green>|simple-link>>|<pageref|idx-24>>
 
258
 
 
259
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
260
      green>|hyper-link>>|<pageref|idx-25>>
 
261
 
 
262
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
263
      green>|concept-link>>|<pageref|idx-26>>
 
264
 
 
265
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
266
      green>|only-index>>|<pageref|idx-27>>
 
267
 
 
268
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
269
      green>|def-index>>|<pageref|idx-28>>
 
270
 
 
271
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
272
      green>|re-index>>|<pageref|idx-29>>
 
273
 
 
274
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
275
      green>|icon>>|<pageref|idx-30>>
 
276
 
 
277
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
278
      green>|screenshot>>|<pageref|idx-31>>
 
279
 
 
280
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
281
      green>|scheme>>|<pageref|idx-32>>
 
282
 
 
283
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
284
      green>|framed-fragment>>|<pageref|idx-33>>
 
285
 
 
286
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
287
      green>|scheme-fragment>>|<pageref|idx-34>>
 
288
 
 
289
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
290
      green>|cpp-fragment>>|<pageref|idx-35>>
 
291
 
 
292
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
293
      green>|tm-fragment>>|<pageref|idx-36>>
 
294
 
 
295
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
296
      green>|scheme-code>>|<pageref|idx-37>>
 
297
 
 
298
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
299
      green>|cpp-code>>|<pageref|idx-38>>
 
300
 
 
301
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
302
      green>|descriptive-table>>|<pageref|idx-39>>
 
303
 
 
304
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|brown>|tmdoc>>|<pageref|idx-40>>
 
305
 
 
306
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|brown>|generic>>|<pageref|idx-41>>
 
307
 
 
308
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
309
      green>|em>>|<pageref|idx-42>>
 
310
 
 
311
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
312
      green>|verbatim>>|<pageref|idx-43>>
 
313
 
 
314
      <tuple|<tuple|<with|font family|<quote|tt>|color|<quote|dark
 
315
      green>|itemize>>|<pageref|idx-44>>
 
316
    </associate>
 
317
  </collection>
 
318
</auxiliary>