← Back to branch summary

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

« back to all changes in this revision

Viewing changes to TeXmacs/doc/main/styles/std-dtds/std-markup-dtd.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/main/styles/std-dtds/std-markup-dtd.en.tm
 
1
<TeXmacs|1.0.0.17>
 
2
 
 
3
<style|tmdoc>
 
4
 
 
5
<\body>
 
6
  <expand|tmdoc-title|Standard markup>
 
7
 
 
8
  Various standard markup is defined in <tmdtd|std-markup>. The following
 
9
  textual content tags all take one argument. Most can be found in the
 
10
  <apply|menu|Text|Content tag> menu.
 
11
 
 
12
  <\description>
 
13
    <expand|item*|<markup|strong>>Indicates an <strong|important> region of
 
14
    text. You can enter this tag via <apply|menu|Text|Content tag|Strong>.
 
15
 
 
16
    <expand|item*|<markup|em>>Emphasizes a region of text like in ``the
 
17
    <em|real> thing''. This tag corresponds to the menu entry
 
18
    \ <apply|menu|Text|Content tag|Emphasize>.
 
19
 
 
20
    <expand|item*|<markup|dfn>>For definitions like ``a <dfn|gnu> is a horny
 
21
    beast''. This tag corresponds to <apply|menu|Text|Content
 
22
    tag|Definition>.
 
23
 
 
24
    <expand|item*|<markup|samp>>A sequence of literal characters like the
 
25
    <samp|ae> ligature �. You can get this tag via <apply|menu|Text|Content
 
26
    tag|Sample>.
 
27
 
 
28
    <expand|item*|<markup|name>>The name of a particular thing or concept
 
29
    like the <name|Linux> system. This tag is obtained using
 
30
    <apply|menu|Text|Content tag|Name>.
 
31
 
 
32
    <expand|item*|<markup|person>>The name of a person like <name|Joris>.
 
33
    This tag corresponds to <apply|menu|Text|Content tag|Person>.
 
34
 
 
35
    <expand|item*|<markup|cite*>>A bibliographic citation like a book or
 
36
    magazine. Example: Melville's <expand|cite*|Moby Dick>. This tag, which
 
37
    is obtained using <apply|menu|Text|Content tag|Cite>, should not be
 
38
    confused with <markup|cite>. The latter tag is also used for citations,
 
39
    but where the argument refers to an entry in a database with
 
40
    bibliographic references.
 
41
 
 
42
    <expand|item*|<markup|abbr>>An abbreviation. Example: I work at the
 
43
    <abbr|C.N.R.S.> An abbreviation is created using <apply|menu|Text|Content
 
44
    tag|Abbreviation> or the <expand|kbd-text|a> keyboard shortcut.
 
45
 
 
46
    <expand|item*|<markup|acronym>>An acronym is an abbreviation formed from
 
47
    the first letter of each word in a name or a phrase, such as
 
48
    <acronym|HTML> or <acronym|IBM>. In particular, the letters are not
 
49
    separated by dots. You may enter an acronym using
 
50
    <apply|menu|Text|Content tag|Acronym>.
 
51
 
 
52
    <expand|item*|<markup|verbatim>>Verbatim text like output from a computer
 
53
    program. Example: the program said <verbatim|hello>. You may enter
 
54
    verbatim text via <apply|menu|Text|Content tag|Verbatim>. The tag may
 
55
    also be used as an environment for multi-paragraph text.
 
56
 
 
57
    <expand|item*|<markup|kbd>>Text which should be entered on a keyboard.
 
58
    Example: please type <kbd|return>. This tag corresponds to the menu entry
 
59
    <apply|menu|Text|Content tag|Keyboard>.
 
60
 
 
61
    <expand|item*|<markup|code*>>Code of a computer program like in
 
62
    ``<expand|code*|cout \<less\>\<less\> 1+1;> yields <verbatim|2>''. This
 
63
    is entered using <apply|menu|Text|Content tag|Code>. For longer pieces of
 
64
    code, you should use the <markup|code> environment.
 
65
 
 
66
    <expand|item*|<markup|var>>Variables in a computer program like in
 
67
    <verbatim|cp <var|src-file> <var|dest-file>>. This tag corresponds to the
 
68
    menu entry <apply|menu|Text|Content tag|Variable>.
 
69
 
 
70
    <expand|item*|<markup|math>>This is a tag which will be used in the
 
71
    future for mathematics inside regular text. Example: the formula
 
72
    <math|sin<rsup|2> x+cos<rsup|2> x=1> is well-known.
 
73
 
 
74
    <expand|item*|<markup|op>>This is a tag which can be used inside
 
75
    mathematics for specifying that an operator should be considered on
 
76
    itself, without any arguments. Example: the operation <math|<op|+>> is a
 
77
    function from <with|mode|math|\<bbb-R\><rsup|2>> to
 
78
    <with|mode|math|\<bbb-R\>>. This tag may become depreciated.
 
79
 
 
80
    <expand|item*|<markup|tt>>This is a physical tag for typewriter phase. It
 
81
    is used for compatability with <name|HTML>, but we do not recommend its
 
82
    use.
 
83
  </description>
 
84
 
 
85
  The following are standard environments:
 
86
 
 
87
  <\description>
 
88
    <expand|item*|<markup|verbatim>>Described above.
 
89
 
 
90
    <expand|item*|<markup|code>>Similar to <markup|code*>, but for pieces of
 
91
    code of several lines.
 
92
 
 
93
    <expand|item*|<markup|quote>>Environment for short (one paragraph)
 
94
    quotations.
 
95
 
 
96
    <expand|item*|<markup|quotation>>Environment for long (multi-paragraph)
 
97
    quotations.
 
98
 
 
99
    <expand|item*|<markup|verse>>Environment for poetry.
 
100
 
 
101
    <expand|item*|<markup|center>>This is a physical tag for centering one or
 
102
    several lines of text. It is used for compatability with <name|HTML>, but
 
103
    we do not recommend its use.
 
104
  </description>
 
105
 
 
106
  Some standard tabular environments are
 
107
 
 
108
  <\description>
 
109
    <expand|item*|<markup|tabular*>>Centered tables.
 
110
 
 
111
    <expand|item*|<markup|block>>Left aligned tables with a border of
 
112
    standard <verbatim|1ln> width.
 
113
 
 
114
    <expand|item*|<markup|block*>>Centered tables with a border of standard
 
115
    <verbatim|1ln> width.
 
116
  </description>
 
117
 
 
118
  The following miscellaneous tags don't take arguments:
 
119
 
 
120
  <\description>
 
121
    <expand|item*|<markup|TeXmacs>>The <TeXmacs> logo.
 
122
 
 
123
    <expand|item*|<markup|TeX>>The <TeX> logo.
 
124
 
 
125
    <expand|item*|<markup|LaTeX>>The <LaTeX> logo.
 
126
 
 
127
    <expand|item*|<markup|hflush>>Used by developers for flushing to the
 
128
    right in the definition of environments.
 
129
 
 
130
    <expand|item*|<markup|hrule>>A horizontal rule like the one you see
 
131
    below:
 
132
 
 
133
    <value|hrule>
 
134
  </description>
 
135
 
 
136
  The following miscellaneous tags all take one or more arguments:
 
137
 
 
138
  <\description>
 
139
    <expand|item*|<markup|overline>>For <overline|overlined text>, which can
 
140
    be wrapped across several lines.
 
141
 
 
142
    <expand|item*|<markup|underline>>For <underline|underlined text>, which
 
143
    can be wrapped across several lines.
 
144
 
 
145
    <expand|item*|<markup|fold>>Macro with two arguments. The first argument
 
146
    is displayed and the second one ignored: the macro corresponds to the
 
147
    folded presentation of a piece of content associated to a short title or
 
148
    abstract. The second argument can be made visible using
 
149
    <apply|menu|Insert|Switch|Unfold>.
 
150
 
 
151
    <expand|item*|<markup|unfold>>Macro with two arguments <var|x> and
 
152
    <var|y>, which yields the unfolded presentation of a piece of content
 
153
    <var|y> associated to a short title or abstract <var|x>. The second
 
154
    argument can be made invisible using <apply|menu|Insert|Switch|Fold>.
 
155
 
 
156
    <expand|item*|<markup|switch>>Macro with two arguments <var|x> and
 
157
    <var|y>, where <var|y> is a set of possible representations of the switch
 
158
    and <var|x> the current representation. The function keys <key|F9>,
 
159
    <key|F10>, <key|F11> and <key|F12> can be used to switch between
 
160
    different representations.
 
161
 
 
162
    <expand|item*|<markup|phantom>>Function with one argument <var|x>. This
 
163
    tag takes as much space as the typesetted argument <var|x> would take,
 
164
    but <var|x> is not displayed. For instance, the text ``phantom'' as an
 
165
    argument of <markup|phantom> yields ``<apply|phantom|phantom>''.
 
166
 
 
167
    <expand|item*|<markup|set-header>>Function with one argument for
 
168
    permanently changing the header. Notice that certain tags in the style
 
169
    file, like sectional tags, may override such manual changes.
 
170
 
 
171
    <expand|item*|<markup|set-footer>>Function with one argument for
 
172
    permanently changing the footer.
 
173
  </description>
 
174
 
 
175
  <apply|tmdoc-copyright|1998--2002|Joris van der Hoeven>
 
176
 
 
177
  <expand|tmdoc-license|Permission is granted to copy, distribute and/or
 
178
  modify this document under the terms of the GNU Free Documentation License,
 
179
  Version 1.1 or any later version published by the Free Software Foundation;
 
180
  with no Invariant Sections, with no Front-Cover Texts, and with no
 
181
  Back-Cover Texts. A copy of the license is included in the section entitled
 
182
  "GNU Free Documentation License".>
 
183
</body>
 
184
 
 
185
<\initial>
 
186
  <\collection>
 
187
    <associate|paragraph width|150mm>
 
188
    <associate|odd page margin|30mm>
 
189
    <associate|shrinking factor|4>
 
190
    <associate|page right margin|30mm>
 
191
    <associate|page top margin|30mm>
 
192
    <associate|reduction page right margin|25mm>
 
193
    <associate|page type|a4>
 
194
    <associate|reduction page bottom margin|15mm>
 
195
    <associate|even page margin|30mm>
 
196
    <associate|reduction page left margin|25mm>
 
197
    <associate|page bottom margin|30mm>
 
198
    <associate|reduction page top margin|15mm>
 
199
    <associate|language|english>
 
200
  </collection>
 
201
</initial>