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
|
<!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: default 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="fdatestr.html">Previous Topic</A> | <A HREF="fdefine.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.11. default Filter</H1>
<HR>
<H2><A NAME="Interface">Interface</A></H2>
<P>The general syntax is:</P>
<PRE>
!block <STRONG>default</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>
family
</TD>
<TD>
string
</TD>
<TD>
<\w+>
</TD>
</TR>
<TR>
<TD>
export
</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>
Name
</TD>
<TD>
key
</TD>
<TD>
<\w+>
</TD>
</TR>
<TR>
<TD>
Value
</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>default</EM> filter is a convenient way of calling the <A HREF="../ref/mdefault.html">default</A> macro for several variables.</P>
<P>The <EM>family</EM> parameter is often used to specify a common prefix.</P>
<P>The <EM>export</EM> parameter can be used to export the variables to the target document system. See the <A HREF="../ref/mexport.html">export</A> macro for further details on variable exporting.</P>
<HR>
<H2><A NAME="Examples">Examples</A></H2>
<PRE>
<B>!block</B> default
Name Value
COMPANY_NAME ACME Mining
COMPANY_PHONE 1234 5678
<B>!endblock</B>
</PRE>
<P>A simpler version is:</P>
<PRE>
<B>!block</B> default; family=<TT>"COMPANY"</TT>
Name Value
NAME ACME Mining
PHONE 1234 5678
<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="fdatestr.html">Previous Topic</A> | <A HREF="fdefine.html">Next Topic</A> <BR><A HREF="../index.html">Home</A> | <A HREF="../catalog.html">Catalog</A></P>
</DIV>
</DIV>
</BODY>
</HTML>
|
