| 1 |
sashby |
1.1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
| 2 |
|
|
|
| 3 |
|
|
<!--Converted with jLaTeX2HTML 2002 (1.62) JA patch-1.4
|
| 4 |
|
|
patched version by: Kenshi Muto, Debian Project.
|
| 5 |
|
|
LaTeX2HTML 2002 (1.62),
|
| 6 |
|
|
original version by: Nikos Drakos, CBLU, University of Leeds
|
| 7 |
|
|
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
|
| 8 |
|
|
* with significant contributions from:
|
| 9 |
|
|
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
|
| 10 |
|
|
<HTML>
|
| 11 |
|
|
<HEAD>
|
| 12 |
|
|
<TITLE>3.1 SCRAM Configuration Documents</TITLE>
|
| 13 |
|
|
<META NAME="description" CONTENT="3.1 SCRAM Configuration Documents">
|
| 14 |
|
|
<META NAME="keywords" CONTENT="SCRAM">
|
| 15 |
|
|
<META NAME="resource-type" CONTENT="document">
|
| 16 |
|
|
<META NAME="distribution" CONTENT="global">
|
| 17 |
|
|
|
| 18 |
|
|
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
|
| 19 |
|
|
<META NAME="Generator" CONTENT="jLaTeX2HTML v2002 JA patch-1.4">
|
| 20 |
|
|
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
|
| 21 |
|
|
|
| 22 |
|
|
<LINK REL="STYLESHEET" HREF="SCRAM.css">
|
| 23 |
|
|
|
| 24 |
|
|
<LINK REL="next" HREF="node25.html">
|
| 25 |
|
|
<LINK REL="previous" HREF="node17.html">
|
| 26 |
|
|
<LINK REL="up" HREF="node17.html">
|
| 27 |
|
|
<LINK REL="next" HREF="node19.html">
|
| 28 |
|
|
</HEAD>
|
| 29 |
|
|
|
| 30 |
|
|
<BODY bgcolor="beige" >
|
| 31 |
|
|
<!--Navigation Panel-->
|
| 32 |
|
|
<A NAME="tex2html590"
|
| 33 |
|
|
HREF="node19.html">
|
| 34 |
|
|
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
|
| 35 |
|
|
SRC="file:/usr/share/latex2html/icons/next.png"></A>
|
| 36 |
|
|
<A NAME="tex2html584"
|
| 37 |
|
|
HREF="node17.html">
|
| 38 |
|
|
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
|
| 39 |
|
|
SRC="file:/usr/share/latex2html/icons/up.png"></A>
|
| 40 |
|
|
<A NAME="tex2html578"
|
| 41 |
|
|
HREF="node17.html">
|
| 42 |
|
|
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
|
| 43 |
|
|
SRC="file:/usr/share/latex2html/icons/prev.png"></A>
|
| 44 |
|
|
<A NAME="tex2html586"
|
| 45 |
|
|
HREF="node2.html">
|
| 46 |
|
|
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents"
|
| 47 |
|
|
SRC="file:/usr/share/latex2html/icons/contents.png"></A>
|
| 48 |
|
|
<A NAME="tex2html588"
|
| 49 |
|
|
HREF="node85.html">
|
| 50 |
|
|
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index"
|
| 51 |
|
|
SRC="file:/usr/share/latex2html/icons/index.png"></A>
|
| 52 |
|
|
<BR>
|
| 53 |
|
|
<B> Next:</B> <A NAME="tex2html591"
|
| 54 |
|
|
HREF="node19.html">3.1.1 The BootStrapProject Class</A>
|
| 55 |
|
|
<B> Up:</B> <A NAME="tex2html585"
|
| 56 |
|
|
HREF="node17.html">3. Creating and Maintaining</A>
|
| 57 |
|
|
<B> Previous:</B> <A NAME="tex2html579"
|
| 58 |
|
|
HREF="node17.html">3. Creating and Maintaining</A>
|
| 59 |
|
|
  <B> <A NAME="tex2html587"
|
| 60 |
|
|
HREF="node2.html">Contents</A></B>
|
| 61 |
|
|
  <B> <A NAME="tex2html589"
|
| 62 |
|
|
HREF="node85.html">Index</A></B>
|
| 63 |
|
|
<BR>
|
| 64 |
|
|
<BR>
|
| 65 |
|
|
<!--End of Navigation Panel-->
|
| 66 |
|
|
|
| 67 |
|
|
<H1><A NAME="SECTION00410000000000000000"></A><A NAME="sec:scramconfigdocs"></A><A NAME="441"></A>
|
| 68 |
|
|
<BR>
|
| 69 |
|
|
3.1 SCRAM Configuration Documents
|
| 70 |
|
|
</H1>
|
| 71 |
|
|
|
| 72 |
|
|
<P>
|
| 73 |
|
|
Instructions to <SMALL>SCRAM</SMALL> are passed using documents called
|
| 74 |
|
|
<TT>ActiveDocs</TT> which are written in a syntax that closely<A NAME="1828"></A>
|
| 75 |
|
|
resembles XML. <A NAME="tex2html34"
|
| 76 |
|
|
HREF="#foot444"><SUP>3.1</SUP></A> These are
|
| 77 |
|
|
web-enabled mark-up documents, each being associated with a download
|
| 78 |
|
|
and cacheing mechanism that is accessed using a <TT>URL</TT>. This
|
| 79 |
|
|
<TT>URL</TT> can behave like a normal WWW URL or can be a file or a
|
| 80 |
|
|
path to a CVS server. A number of <TT>ActiveDoc</TT> markup tags are
|
| 81 |
|
|
defined, some of which are common to all types of document; some tags
|
| 82 |
|
|
are specific for their application and only used in a particular class
|
| 83 |
|
|
of document. An <TT>ActiveDoc</TT> document must begin with a special
|
| 84 |
|
|
statement that informs <SMALL>SCRAM</SMALL> what sort of document it is and how it
|
| 85 |
|
|
should be parsed; each type of statement is specific to a class of
|
| 86 |
|
|
functionality. The tag
|
| 87 |
|
|
|
| 88 |
|
|
<UL>
|
| 89 |
|
|
<<TT>doc</TT> type=<I>type</I> version=<I>version</I>>
|
| 90 |
|
|
</LI>
|
| 91 |
|
|
</UL>is always the first line of the document. The type entry is set
|
| 92 |
|
|
according to the <SMALL>SCRAM</SMALL> parsing class.
|
| 93 |
|
|
|
| 94 |
|
|
<P>
|
| 95 |
|
|
There are three main different classes of <TT>ActiveDoc</TT> document
|
| 96 |
|
|
that are needed to configure a project: <TT>BootStrapProject</TT>,
|
| 97 |
|
|
<TT>RequirementsDoc</TT> and <TT>ToolDoc</TT>. These classes are
|
| 98 |
|
|
described in the following sections.
|
| 99 |
|
|
|
| 100 |
|
|
<P>
|
| 101 |
|
|
<BR><HR><H4>Footnotes</H4>
|
| 102 |
|
|
<DL>
|
| 103 |
|
|
<DT><A NAME="foot444">... XML.</A><A
|
| 104 |
|
|
HREF="node18.html#tex2html34"><SUP>3.1</SUP></A></DT>
|
| 105 |
|
|
<DD>The <SMALL>SCRAM</SMALL> document parsing mechanism was
|
| 106 |
|
|
written before XML parsers became widely available. Future
|
| 107 |
|
|
development includes introducing proper XML parsing.
|
| 108 |
|
|
|
| 109 |
|
|
</DD>
|
| 110 |
|
|
</DL>
|
| 111 |
|
|
<BR><HR>
|
| 112 |
|
|
<!--Table of Child-Links-->
|
| 113 |
|
|
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
|
| 114 |
|
|
|
| 115 |
|
|
<UL>
|
| 116 |
|
|
<LI><A NAME="tex2html592"
|
| 117 |
|
|
HREF="node19.html">3.1.1 The BootStrapProject Class</A>
|
| 118 |
|
|
<UL>
|
| 119 |
|
|
<LI><A NAME="tex2html593"
|
| 120 |
|
|
HREF="node20.html">3.1.1.0.1 <I>Example</I>:</A>
|
| 121 |
|
|
</UL>
|
| 122 |
|
|
<BR>
|
| 123 |
|
|
<LI><A NAME="tex2html594"
|
| 124 |
|
|
HREF="node21.html">3.1.2 The RequirementsDoc Class</A>
|
| 125 |
|
|
<UL>
|
| 126 |
|
|
<LI><A NAME="tex2html595"
|
| 127 |
|
|
HREF="node22.html">3.1.2.0.1 <I>Example</I>:</A>
|
| 128 |
|
|
</UL>
|
| 129 |
|
|
<BR>
|
| 130 |
|
|
<LI><A NAME="tex2html596"
|
| 131 |
|
|
HREF="node23.html">3.1.3 The ToolDoc Class</A>
|
| 132 |
|
|
<UL>
|
| 133 |
|
|
<LI><A NAME="tex2html597"
|
| 134 |
|
|
HREF="node24.html">3.1.3.0.1 <I>Example</I>:</A>
|
| 135 |
|
|
</UL></UL>
|
| 136 |
|
|
<!--End of Table of Child-Links-->
|
| 137 |
|
|
<HR>
|
| 138 |
|
|
<!--Navigation Panel-->
|
| 139 |
|
|
<A NAME="tex2html590"
|
| 140 |
|
|
HREF="node19.html">
|
| 141 |
|
|
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
|
| 142 |
|
|
SRC="file:/usr/share/latex2html/icons/next.png"></A>
|
| 143 |
|
|
<A NAME="tex2html584"
|
| 144 |
|
|
HREF="node17.html">
|
| 145 |
|
|
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
|
| 146 |
|
|
SRC="file:/usr/share/latex2html/icons/up.png"></A>
|
| 147 |
|
|
<A NAME="tex2html578"
|
| 148 |
|
|
HREF="node17.html">
|
| 149 |
|
|
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
|
| 150 |
|
|
SRC="file:/usr/share/latex2html/icons/prev.png"></A>
|
| 151 |
|
|
<A NAME="tex2html586"
|
| 152 |
|
|
HREF="node2.html">
|
| 153 |
|
|
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents"
|
| 154 |
|
|
SRC="file:/usr/share/latex2html/icons/contents.png"></A>
|
| 155 |
|
|
<A NAME="tex2html588"
|
| 156 |
|
|
HREF="node85.html">
|
| 157 |
|
|
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index"
|
| 158 |
|
|
SRC="file:/usr/share/latex2html/icons/index.png"></A>
|
| 159 |
|
|
<BR>
|
| 160 |
|
|
<B> Next:</B> <A NAME="tex2html591"
|
| 161 |
|
|
HREF="node19.html">3.1.1 The BootStrapProject Class</A>
|
| 162 |
|
|
<B> Up:</B> <A NAME="tex2html585"
|
| 163 |
|
|
HREF="node17.html">3. Creating and Maintaining</A>
|
| 164 |
|
|
<B> Previous:</B> <A NAME="tex2html579"
|
| 165 |
|
|
HREF="node17.html">3. Creating and Maintaining</A>
|
| 166 |
|
|
  <B> <A NAME="tex2html587"
|
| 167 |
|
|
HREF="node2.html">Contents</A></B>
|
| 168 |
|
|
  <B> <A NAME="tex2html589"
|
| 169 |
|
|
HREF="node85.html">Index</A></B>
|
| 170 |
|
|
<!--End of Navigation Panel-->
|
| 171 |
|
|
<ADDRESS>
|
| 172 |
|
|
scram-developers@cern.ch
|
| 173 |
|
|
</ADDRESS>
|
| 174 |
|
|
</BODY>
|
| 175 |
|
|
</HTML>
|
