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
|
<!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 Reference: topics Filter</TITLE>
</HEAD>
<BODY BGCOLOR="ffffff">
<DIV CLASS="header">
<P><IMG SRC="../sdflogo.gif" ALIGN="Right"></P>
<DIV CLASS="navigate">
<P ALIGN="Center"><A HREF="re_sdf.html">Contents</A> | <A HREF="in_filt.html">Parent Topic</A> | <A HREF="ftitle.html">Previous Topic</A> | <A HREF="fverbati.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>5.33. topics Filter</H1>
<HR>
<H2><A NAME="Interface">Interface</A></H2>
<P>The general syntax is:</P>
<PRE>
!block <STRONG>topics</STRONG>[; parameters]
<EM>table</EM>
!endblock
</PRE>
<P>The parameters are:</P>
<TABLE CLASS="columns" BORDER>
<TR CLASS="heading">
<TD>
<STRONG>Name</STRONG>
</TD>
<TD>
<STRONG>Type</STRONG>
</TD>
<TD>
<STRONG>Rule</STRONG>
</TD>
</TR>
<TR>
<TD>
intro
</TD>
<TD>
string
</TD>
<TD>
</TD>
</TR>
<TR>
<TD>
noslide
</TD>
<TD>
boolean
</TD>
<TD>
</TD>
</TR>
<TR>
<TD>
data
</TD>
<TD>
boolean
</TD>
<TD>
</TD>
</TR>
</TABLE>
<P>The table fields are:</P>
<TABLE CLASS="columns" BORDER>
<TR CLASS="heading">
<TD>
<STRONG>Field</STRONG>
</TD>
<TD>
<STRONG>Category</STRONG>
</TD>
<TD>
<STRONG>Rule</STRONG>
</TD>
</TR>
<TR>
<TD>
Topic
</TD>
<TD>
mandatory
</TD>
<TD>
</TD>
</TR>
<TR>
<TD>
Label
</TD>
<TD>
optional
</TD>
<TD>
</TD>
</TR>
<TR>
<TD>
Level
</TD>
<TD>
optional
</TD>
<TD>
</TD>
</TR>
<TR>
<TD>
Next
</TD>
<TD>
optional
</TD>
<TD>
</TD>
</TR>
<TR>
<TD>
Prev
</TD>
<TD>
optional
</TD>
<TD>
</TD>
</TR>
<TR>
<TD>
Up
</TD>
<TD>
optional
</TD>
<TD>
</TD>
</TR>
</TABLE>
<P>See <A HREF="in_filif.html">Understanding Filter Interfaces</A>, if necessary.</P>
<HR>
<H2><A NAME="Description">Description</A></H2>
<P>The <EM>topics</EM> filter is used to include a set of sub-topics into a document. For <A HREF="http://www.adobe.com">PostScript</A>, this implies that the heading levels on topics included as sub-topics are adjusted accordingly. For <A HREF="http://www.w3.org/hypertext/WWW/MarkUp/">HTML</A> and Windows help files, this implies that hypertext jumps are inserted to the topics.</P>
<P>This filter expects a table of data in <A HREF="../ref/fmt_tbl.html">TBL</A> format. The only field typically provided is <EM>Topic</EM> - the name of the file containing the topic, excluding the <EM>.sdf</EM> extension. The other fields are used by SDF internally during the generation of HTML topics.</P>
<P>The <EM>intro</EM> parameter can be used to specify SDF text to be output before the hypertext jumps. This text is not output for formats where the topics are simply included, e.g. PostScript.</P>
<P>The <EM>noslide</EM> parameter stops the heading levels of the topics being slid down.</P>
<P>The <EM>data</EM> parameter is used to specify that the table is topics data and no output should be generated. This parameter is used by SDF internally during the generation of HTML topics.</P>
<HR>
<H2><A NAME="Examples">Examples</A></H2>
<PRE>
The subroutines are documented below.
<B>!block</B> topics; intro=<TT>'H2: Subroutines'</TT>
Topic
mysub1
mysub2
<B>!endblock</B>
</PRE>
</DIV>
<DIV CLASS="footer">
<DIV CLASS="navigate">
<P ALIGN="Center"><A HREF="re_sdf.html">Contents</A> | <A HREF="in_filt.html">Parent Topic</A> | <A HREF="ftitle.html">Previous Topic</A> | <A HREF="fverbati.html">Next Topic</A> <BR><A HREF="../index.html">Home</A> | <A HREF="../catalog.html">Catalog</A></P>
</DIV>
</DIV>
</BODY>
</HTML>
|
