| 1 |
<! Style Sheet Header>
|
| 2 |
<html>
|
| 3 |
<head>
|
| 4 |
<title>urldocs.html</title>
|
| 5 |
<body bgcolor=beige>
|
| 6 |
<! End Style Sheet Header -----------Insert Text Here --------------------->
|
| 7 |
<center>
|
| 8 |
<h2>ActiveDocs - Web Enabled MarkUp Documents</h2>
|
| 9 |
<p>
|
| 10 |
<font color=red>S</font>oftware <font color=red>C</font>onfiguration,
|
| 11 |
<font color=red>R</font>elease <font color=red>A</font>nd
|
| 12 |
<font color=red>M</font>anagement
|
| 13 |
</center>
|
| 14 |
<hr>
|
| 15 |
Within SCRAM is a mechanism for parsing XML like documents called ActiveDocs.
|
| 16 |
ActiveDocs can associate the documents Markup tags with functionality thus
|
| 17 |
making an otherwise
|
| 18 |
passive document actively control what SCRAM will do. This ensures that the
|
| 19 |
real functionality of the system is well documented as it is the document
|
| 20 |
and not a seperate system, which controls that functionality.
|
| 21 |
<p>
|
| 22 |
ActiveDocs are web enabled, each being associated with a URL download and
|
| 23 |
cacheing mechanism which can be called on as required.
|
| 24 |
<p>
|
| 25 |
<h2>Common ActiveDoc Tags</h2>
|
| 26 |
ActiveDocs have a number of common features and a default set of tags to
|
| 27 |
access them. Note that these are the defaults, different activedoc types
|
| 28 |
may or may not allow the use of these tags as appropriate for their application.
|
| 29 |
<br>
|
| 30 |
<h3><doc type=<em>type</em> version=<em>version</em>> </h3>
|
| 31 |
This tag is a requirement of all documents. Its function is to
|
| 32 |
indicate the type and version of the document in order that it can
|
| 33 |
be parsed correctly.
|
| 34 |
<h3><Base url=<em>baseurl</em>> </Base></h3>
|
| 35 |
Used to specify common elements, such as server name, in multiple urls. Any
|
| 36 |
url specified between these base tags will be merged with that specified in
|
| 37 |
the base according to the following merge rules:
|
| 38 |
<ul>
|
| 39 |
<li>A merge will take place only if the type of the base is identical
|
| 40 |
to the url type.
|
| 41 |
<li>The base server name is taken only if not already defined
|
| 42 |
<li>The base url path is pre-pended to any specified
|
| 43 |
<li>Variables provided in the base parameter list are only added if
|
| 44 |
not already defined.
|
| 45 |
</ul>
|
| 46 |
<h2>URL Document PreProcessing</h2>
|
| 47 |
<h3><Include url=<em>docurl</em>></h3>
|
| 48 |
ActiveDocs provide an equivalent of the C pre-processor <em>#include</em>
|
| 49 |
directive that is web aware. In this way you can assemble a document from
|
| 50 |
many components that are maintained at different locations.<p>
|
| 51 |
To inline a document use the
|
| 52 |
<font color=green>
|
| 53 |
<pre>
|
| 54 |
<include url=<em>url</em>>
|
| 55 |
</pre>
|
| 56 |
</font>
|
| 57 |
tag.
|
| 58 |
<!Style Sheet Footer ---------------Do not change anything after this line-- >
|
| 59 |
<hr>
|
| 60 |
<table border=1 width=100%>
|
| 61 |
<td align=left>
|
| 62 |
<a href=mailto:Christopher.Williams@cern.ch
|
| 63 |
>Chris Williams</a>
|
| 64 |
</td>
|
| 65 |
<td align=center>
|
| 66 |
Last Updated Tue Aug 15 11:44:05 2000
|
| 67 |
</td>
|
| 68 |
<td align=right><a href=/cgi-cmc/pagestat>Show Stats</a>
|
| 69 |
</td>
|
| 70 |
</table>
|
| 71 |
</body> </html>
|
| 72 |
<! End Style Sheet Footer>
|
