File: cterms.html

package info (click to toggle)
sdf 2.001%2B1-8
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 6,288 kB
  • sloc: perl: 18,543; sh: 31; makefile: 29
file content (138 lines) | stat: -rw-r--r-- 2,815 bytes parent folder | download | duplicates (6)
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
<!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: terms Class</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_class.html">Parent Topic</A> | <A HREF="creferen.html">Previous Topic</A> | <A HREF="in_dstyl.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>1.5. terms Class</H1>
<HR>
<H2><A NAME="Interface">Interface</A></H2>
<P>The general syntax is:</P>
<PRE>
  !block <STRONG>terms</STRONG>[; parameters]
  table of objects
  !endblock
</PRE>
<P>The object attributes 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>
Term
</TD>
<TD>
mandatory
</TD>
<TD>
&nbsp;
</TD>
</TR>
<TR>
<TD>
Definition
</TD>
<TD>
optional
</TD>
<TD>
&nbsp;
</TD>
</TR>
<TR>
<TD>
Jump
</TD>
<TD>
optional
</TD>
<TD>
&nbsp;
</TD>
</TR>
</TABLE>

<P>See <A HREF="in_claif.html">Understanding Class Interfaces</A>, if necessary.</P>
<HR>
<H2><A NAME="Description">Description</A></H2>
<P>The <EM>terms</EM> filter is used to declare and/or format objects in the <EM>terms</EM> class. The attributes supported are:</P>
<TABLE CLASS="columns" BORDER>
<TR CLASS="heading">
<TD>
<STRONG>Attribute</STRONG>
</TD>
<TD>
<STRONG>Description</STRONG>
</TD>
</TR>
<TR>
<TD>
Term
</TD>
<TD>
the term name
</TD>
</TR>
<TR>
<TD>
Definition
</TD>
<TD>
the explanation for the term
</TD>
</TR>
</TABLE>

<HR>
<H2><A NAME="Examples">Examples</A></H2>
<P>A configuration file may have the following declaration of terms:</P>
<PRE>
  !block terms; data
  Term     Definition
  SDF      Simple Document Format
  SQL      Structured Query Language
  !endblock
</PRE>
<P>These can then be inserted into a document as follows:</P>
<PRE>
  !block terms
  Term     Definition
  SDF
  SQL
  WWW      World Wide Web
  !endblock
</PRE>
<P>Note that the definition for a term already declared will be inserted if none is provided. Furthermore, new terms (like WWW above) can be inserted and added to the configured ones.</P>
</DIV>
<DIV CLASS="footer">
<DIV CLASS="navigate">
<P ALIGN="Center"><A HREF="re_sdf.html">Contents</A> | <A HREF="in_class.html">Parent Topic</A> | <A HREF="creferen.html">Previous Topic</A> | <A HREF="in_dstyl.html">Next Topic</A> <BR><A HREF="../index.html">Home</A> | <A HREF="../catalog.html">Catalog</A></P>
</DIV>
</DIV>

</BODY>
</HTML>