1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
|
<!doctype html public "-//W30//DTD W3 HTML 2.0//EN">
<HTML>
<!-- This file was generated using SDF 2.001 by
Ian Clatworthy (ianc@mincom.com). SDF is freely
available from http://www.mincom.com/mtr/sdf. -->
<HEAD>
<TITLE>SDF 2.001: SDF Release Notes: 2.000beta7</TITLE>
</HEAD>
<BODY BGCOLOR="ffffff">
<DIV CLASS="header">
<P><IMG SRC="../sdflogo.gif" ALIGN="Right"></P>
<DIV CLASS="navigate">
<P ALIGN="Center"><A HREF="rn_sdf.html">Contents</A> | <A HREF="rn_sdf.html">Parent Topic</A> | <A HREF="2000b7a.html">Previous Topic</A> | <A HREF="2000b6c.html">Next Topic</A> <BR><A HREF="../index.html">Home</A> | <A HREF="../catalog.html">Catalog</A></P>
</DIV>
<BR CLEAR="Right">
</DIV>
<DIV CLASS="main">
<H1>14. 2.000beta7</H1>
<P ALIGN="Left"><A HREF="#2.000beta7 - Enhancements">Enhancements</A> | <A HREF="#2.000beta7 - Fixes">Fixes</A> | <A HREF="#2.000beta7 - Incompatibilities">Incompatibilities</A></P>
<HR>
<H2><A NAME="2.000beta7 - Enhancements">14.1. Enhancements</A></H2>
<P>There are lots of new things in this version including:</P>
<UL>
<A HREF="2000b7.html#Topics mode for HTML">Topics mode for HTML</A>
<BR>
<A HREF="2000b7.html#HTML headers and footers">HTML headers and footers</A>
<BR>
<A HREF="2000b7.html#HTML control variables">HTML control variables</A>
<BR>
<A HREF="2000b7.html#Macros inside tables">Macros inside tables</A>
<BR>
<A HREF="2000b7.html#Wide tables">Wide tables</A>
<BR>
<A HREF="2000b7.html#Figure enhancements">Figure enhancements</A>
<BR>
<A HREF="2000b7.html#Special characters">Special characters</A>
<BR>
<A HREF="2000b7.html#Cross-references">Cross-references</A>
<BR>
<A HREF="2000b7.html#Other goodies">Other goodies</A></UL>
<P>Details are given below.</P>
<H3><A NAME="Topics mode for HTML">14.1.1. Topics mode for HTML</A></H3>
<P>SDF can now generate a set of HTML topics, rather than a single HTML file. The command is:</P>
<PRE>
sdf -2topics myfile.sdf
</PRE>
<P>If you want to manually control how a document is split into topics, simply include other sdf files which contain headings. These manual topics, if any, can be supplemented with automatically generated topics. By default, level 1 headings are used as topic breaks, in addition to the manual ones. The -n option can be used to change this:</P>
<UL>
<LI>-n0 disables autosplitting
<LI>-n2 uses level 1-2 headings to autosplit
<LI>-n3 uses level 1-3 headings to autosplit
<LI>etc.</UL>
<P>To make it easy to navigate around the topics, SDF generates a default header and footer for a topic which supports jumping to the:</P>
<UL>
<LI>main topic (i.e. the contents)
<LI>parent topic
<LI>previous topic
<LI>next topic.</UL>
<H3><A NAME="HTML headers and footers">14.1.2. HTML headers and footers</A></H3>
<P>These macros give you total control over the headers and footers used:</P>
<UL>
<LI>HTML_HEADER - header on a HTML document (or main topic)
<LI>HTML_FOOTER - footer on a HTML document (or main topic)
<LI>HTML_TOPIC_HEADER - header on a HTML topic
<LI>HTML_TOPIC_FOOTER - footer on a HTML topic.</UL>
<P>The default implementation of these macros is in <TT>html.sdm</TT> in the <TT>kernel</TT> library. The default versions of these macros use the variables below, if they are set. On most occasions, useful headers and footers can be obtained by simply setting these variables:</P>
<UL>
<LI>HTML_URL_HOME - URL of the home page
<LI>HTML_URL_CATALOG - URL of the catalog
<LI>HTML_URL_SEARCH - URL of the search facilities.</UL>
<H3><A NAME="HTML control variables">14.1.3. HTML control variables</A></H3>
<P>To fine tune HTML output, the following variables are useful:</P>
<UL>
<LI>HTML_BG_COLOR - the background colour of the page
<LI>HTML_BG_IMAGE - the background image of the page
<LI>HTML_TEXT_COLOR - the colour of normal text
<LI>HTML_LINK_COLOR - the colour of unvisited links
<LI>HTML_VLINK_COLOR - the colour of visited links.</UL>
<P>To set a colour, use the RGB (red-green-blue) value as used by <A HREF="http://www.w3.org/hypertext/WWW/MarkUp/">HTML</A>. For example:</P>
<PRE>
!define HTML_BG_COLOR "ffffff"
</PRE>
<P>For convenience, a number of variables are defined for common colours:</P>
<UL>
COLOR_WHITE
<BR>
COLOR_BLACK
<BR>
COLOR_RED
<BR>
COLOR_GREEN
<BR>
COLOR_BLUE
<BR>
COLOR_YELLOW
<BR>
COLOR_CYAN
<BR>
COLOR_MAGENTA.</UL>
<P>These are used as follows:</P>
<PRE>
!define HTML_BG_COLOR COLOR_WHITE
</PRE>
<H3><A NAME="Macros inside tables">14.1.4. Macros inside tables</A></H3>
<P>Macros can now be used inside tables. In particular:</P>
<UL>
<LI>rows can now be conditionally included or excluded
<LI>rows can be marked as changed.</UL>
<P>For example:</P>
<PRE>
!block table
Code Description
BTW By the way
!block changed
RTFM Read the (fine) manual
!endblock
!if ALL_TERMS
SOS Save our souls
!endif
!endblock
</PRE>
<H3><A NAME="Wide tables">14.1.5. Wide tables</A></H3>
<P>The <A HREF="../ref/ftable.html">table</A> filter now supports a new attribute called <EM>wide</EM>. When it is used, the table spans the side-head in addition to the text column.</P>
<H3><A NAME="Figure enhancements">14.1.6. Figure enhancements</A></H3>
<P>The <A HREF="../ref/mimport.html">import</A> macro now supports an <EM>align</EM> attribute, which is passed into the generated HTML. This can be used in combination with the <A HREF="../ref/mclear.html">clear</A> macro to control how figures are aligned with text in HTML.</P>
<P>For example:</P>
<PRE>
!import "mylogo"; align="right"
Some text.
!clear
</PRE>
<P>HTML's <EM>alt</EM> attribute is now also supported by the <A HREF="../ref/mimport.html">import</A> macro.</P>
<H3><A NAME="Special characters">14.1.7. Special characters</A></H3>
<P>Special characters can now be entered using {{CHAR:xxx}} where <EM>xxx</EM> is either:</P>
<UL>
<LI>a symbolic name
<LI>a character code (HTML only).</UL>
<P>The symbolic names supported are given below.</P>
<TABLE CLASS="columns" BORDER>
<TR CLASS="heading">
<TD>
<STRONG>Name</STRONG>
</TD>
<TD>
<STRONG>Description</STRONG>
</TD>
</TR>
<TR>
<TD>
bullet
</TD>
<TD>
</TD>
</TR>
<TR>
<TD>
c
</TD>
<TD>
copyright symbol
</TD>
</TR>
<TR>
<TD>
cent
</TD>
<TD>
</TD>
</TR>
<TR>
<TD>
dagger
</TD>
<TD>
</TD>
</TR>
<TR>
<TD>
doubledagger
</TD>
<TD>
</TD>
</TR>
<TR>
<TD>
emdash
</TD>
<TD>
a hyphen which is the width of the point size
</TD>
</TR>
<TR>
<TD>
endash
</TD>
<TD>
a hyphen which is half the width of the point size
</TD>
</TR>
<TR>
<TD>
emspace
</TD>
<TD>
a space which is the width of the point size
</TD>
</TR>
<TR>
<TD>
enspace
</TD>
<TD>
a space which is half the width of the point size
</TD>
</TR>
<TR>
<TD>
nbdash
</TD>
<TD>
a non-breaking hyphen
</TD>
</TR>
<TR>
<TD>
nbspace
</TD>
<TD>
a non-breaking space
</TD>
</TR>
<TR>
<TD>
nl
</TD>
<TD>
newline
</TD>
</TR>
<TR>
<TD>
pound
</TD>
<TD>
</TD>
</TR>
<TR>
<TD>
r
</TD>
<TD>
registered trademark
</TD>
</TR>
<TR>
<TD>
tab
</TD>
<TD>
tab character
</TD>
</TR>
<TR>
<TD>
tm
</TD>
<TD>
trademark
</TD>
</TR>
<TR>
<TD>
yen
</TD>
<TD>
</TD>
</TR>
</TABLE>
<P>For convenience, variables with the same name are predefined. This makes it easy to include a special character. For example:</P>
<PRE>
Copyright [\[c]\] 1996, Us Pty Ltd.
</PRE>
<P><HR WIDTH="80%" ALIGN="Left">
<STRONG>Note: </STRONG>Some target formats do not yet support all of these characters. For example, HTML does not yet support Em or En spaces. In these cases, <A HREF="../ref/sdf.html">sdf</A> will do the best it can (e.g. use a normal space for enpsace and emspace).
<HR WIDTH="80%" ALIGN="Left"></P>
<H3><A NAME="Cross-references">14.1.8. Cross-references</A></H3>
<P>Cross-references are now supported via the <EM>xref</EM> phrase attribute. For example:</P>
<PRE>
Refer to page {{N[xref="pagenum"] Samples}} for more samples.
</PRE>
<P>The value specifies the cross-reference style to use. The phrase text is used to find the target location. The predefined styles are given below.</P>
<TABLE CLASS="columns" BORDER>
<TR CLASS="heading">
<TD>
<STRONG>Name</STRONG>
</TD>
<TD>
<STRONG>Value</STRONG>
</TD>
</TR>
<TR>
<TD>
pagenum
</TD>
<TD>
the page number
</TD>
</TR>
<TR>
<TD>
paratext
</TD>
<TD>
the paragraph text
</TD>
</TR>
<TR>
<TD>
paratag
</TD>
<TD>
the (FrameMaker) paragraph tag
</TD>
</TR>
<TR>
<TD>
paranum
</TD>
<TD>
the paragraph number (e.g. Appendix A)
</TD>
</TR>
<TR>
<TD>
paranumonly
</TD>
<TD>
the paragraph number only (e.g. A)
</TD>
</TR>
<TR>
<TD>
section
</TD>
<TD>
section <EM>paranumonly</EM>, <EM>paratext</EM>, on page <EM>pagenum</EM>
</TD>
</TR>
</TABLE>
<P>New styles can be added by using the <EM>xrefs</EM> configuration filter. See <TT>mif.sdm</TT> in the <TT>kernel</TT> directory for examples.</P>
<P><HR WIDTH="80%" ALIGN="Left">
<STRONG>Note: </STRONG>Other than <A HREF="http://www.adobe.com">PostScript</A>, most targets ignore cross-references.
<HR WIDTH="80%" ALIGN="Left"></P>
<H3><A NAME="Other goodies">14.1.9. Other goodies</A></H3>
<P>New macros include:</P>
<UL>
<LI><A HREF="../ref/moutput.html">output</A> - dynamically change the output file used</UL>
<P>New filters include:</P>
<UL>
<LI><A HREF="../ref/fchanged.html">changed</A> - mark a block as changed (shorthand for <EM>sdf; changed</EM>)
<LI><A HREF="../ref/ftopics.html">topics</A> - include a set of sub-topics
<LI><A HREF="../ref/fsection.html">sections</A> - create section jumps for html and hlp outputs
<LI><A HREF="../ref/fnote.html">note</A> - format a note
<LI><A HREF="../ref/fquote.html">quote</A> - format a quotation
<LI><A HREF="../ref/faddress.html">address</A> - format an address
<LI><A HREF="../ref/fascii_g.html">ascii_graphic</A> - format an ASCII graphic.</UL>
<P>The current directory is now searched first for the configuration library, i.e. if OPT_CONFIG is <EM>abc</EM>, <A HREF="../ref/sdf.html">sdf</A> first looks for <EM>./abc.sdm</EM> before searching for <EM>abc.sdm</EM> in a directory called <EM>abc</EM> on the search path.</P>
<HR>
<H2><A NAME="2.000beta7 - Fixes">14.2. Fixes</A></H2>
<P>The copy number field on the mincom cover page has been fixed.</P>
<P>The <EM>Limitations & Future Directions</EM> heading in <TT>sdfget.sdm</TT> has been changed to <EM>Limitations and future directions</EM>.</P>
<HR>
<H2><A NAME="2.000beta7 - Incompatibilities">14.3. Incompatibilities</A></H2>
<P>The <EM>objects</EM> attribute of the <A HREF="../ref/ftable.html">table</A> filter is now called <EM>tags</EM>.</P>
<P>The <A HREF="../ref/fsection.html">sections</A> filter now generates SECT jumps for each paragraph within the block, provided the output is html or hlp. To include sub-topics (sub-sections), use the new <A HREF="../ref/ftopics.html">topics</A> filter.</P>
<P>When pretty-printing files using <A HREF="../ref/sdf.html">sdf</A>, use the -N option to control line numbering. The -n option is now used to specify the level when autosplitting into <A HREF="http://www.w3.org/hypertext/WWW/MarkUp/">HTML</A> topics.</P>
<P>The <A HREF="../ref/mmessage.html">message</A> macro has been simplified - the message type is now an optional second parameter.</P>
<P>The <EM>obj*</EM> configuration filters have been renamed to <EM>phrase*</EM> to better reflect their purpose. (This shouldn't affect normal documents.)</P>
<P>The <EM>cfg_lang</EM> configuration filter has been renamed to <A HREF="../ref/flangdef.html">langdefs</A>.</P>
</DIV>
<DIV CLASS="footer">
<DIV CLASS="navigate">
<P ALIGN="Center"><A HREF="rn_sdf.html">Contents</A> | <A HREF="rn_sdf.html">Parent Topic</A> | <A HREF="2000b7a.html">Previous Topic</A> | <A HREF="2000b6c.html">Next Topic</A> <BR><A HREF="../index.html">Home</A> | <A HREF="../catalog.html">Catalog</A></P>
</DIV>
</DIV>
</BODY>
</HTML>
|
