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
|
<!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: about 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="in_filt.html">Previous Topic</A> | <A HREF="fabstrac.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.2. about Filter</H1>
<HR>
<H2><A NAME="Interface">Interface</A></H2>
<P>The general syntax is:</P>
<PRE>
!block <STRONG>about</STRONG>
...
!endblock
</PRE>
<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>about</EM> filter is used when including a topic as an "about" section within a document. Typically, this implies:</P>
<UL>
<LI>the headings are converted to plain headings and slid down one level
<LI>the headings (except those initially at level 1) are removed from the table of contents.</UL>
<HR>
<H2><A NAME="Examples">Examples</A></H2>
<P>A typical book might look like this:</P>
<PRE>
<B>!init</B> OPT_STYLE=<TT>"manual"</TT>
<B>!define</B> DOC_NAME <TT>"A Sample Book"</TT>
<B>!build_title</B>
<B>!include</B> <TT>"myabout.sdf"</TT>; about
<B>!include</B> <TT>"chapter1.sdf"</TT>
<B>!include</B> <TT>"chapter2.sdf"</TT>
<B>!include</B> <TT>"chapter3.sdf"</TT>
<B>!include</B> <TT>"appendx1.sdf"</TT>; appendix
</PRE>
<P>A typical about topic looks like this:</P>
<PRE>
H1: About this manual
H2: Purpose
This manual provides information on ...
H2: Scope
This manual contains information on ...
</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="in_filt.html">Previous Topic</A> | <A HREF="fabstrac.html">Next Topic</A> <BR><A HREF="../index.html">Home</A> | <A HREF="../catalog.html">Catalog</A></P>
</DIV>
</DIV>
</BODY>
</HTML>
|
