[Openvas-commits] r8728 - trunk/doc/website

[scm-commit@wald.intevation.org]

Author: jan
Date: 2010-08-09 08:18:40 +0200 (Mon, 09 Aug 2010)
New Revision: 8728

Modified:
   trunk/doc/website/openvas-cr-48.htm4
Log:
Change Request #48: Editorial Changes.
Move technical design aspects from section "rationale" to
"design and implementation".


Modified: trunk/doc/website/openvas-cr-48.htm4
===================================================================
--- trunk/doc/website/openvas-cr-48.htm4	2010-08-08 19:55:21 UTC (rev 8727)
+++ trunk/doc/website/openvas-cr-48.htm4	2010-08-09 06:18:40 UTC (rev 8728)
@@ -35,8 +35,8 @@
 <h3>Purpose</h3>
 
 <ul>
-<li>allow API developers to implement OMP and OAP clients or
-    client-APIs much more easy</li>
+<li>support API developers to implement OMP and OAP clients or
+    client-APIs </li>
 <li>help to make and keep the protocols consistent</li>
 <li>enable test suites to be written for both client and server side
     of OMP and OAP </li>
@@ -63,18 +63,22 @@
 </p>
 
 <ul>
-<li>allow API developers to implement OMP and OAP client-APIs much
-more easy</li>
+<li>support API developers to implement OMP and OAP client-APIs</li>
 <li>help finding redundancies, contradictions and other
-inconsistencies in the OMP and OAP specification</li>
+inconsistencies in the OMP and OAP specification and during further
+development of these protocols</li>
 <li>enable test suites to be written for both client and server side
 of OMP and OAP</li>
 </ul>
 
+
+
+<h3>Design and Implementation</h3>
+
 <p>
 For the schema syntax, <a
 href="http://relaxng.org/compact-20021121.html">Relax NG compact
-syntax</a> (RNC) has been chosen. While there are many other schema
+syntax</a> (RNC) is proposed. While there are many other schema
 definition syntaxes (DTD, Relax NG normal syntax, XML Schema
 Definition, etc.) RNC has the benefits of being compact and easy to
 read. RNC uses some kind of <a
@@ -88,8 +92,7 @@
 others). XML documents can be validated against Relax NG using e.g. <a
 href="http://www.xmlsoft.org/">libxml2</a> or emacs' nXML-mode.
 Syntax-highlighting can be done with e.g. <a
-href="http://www.andre-simon.de/zip/download.html">Syntax-higlight</a>
-(which is <em>not</em> GNU source-highlight).
+href="http://www.andre-simon.de/zip/download.html">Syntax-higlight</a>.
 </p>
 
 <p>Here is a simple RelaxNG example for the <span class="pre">create_agent</span> OMP command:
@@ -132,8 +135,24 @@
     <span class="hl sym">}</span>
 </pre>
 
+<ol>
+<li>
+A draft version of <span class="pre">omp-1.0.rnc</span> exists, written by Hartmut
+Goebel (see attachment to <a
+href="http://lists.wald.intevation.org/pipermail/openvas-devel/2010-March/002139.html">this
+message on openvas-devel</a>). As of this initial writing, this draft
+is known to be incomplete and erroneous. Developers of openvas-manager
+are requested to complete and correct this draft.
+</li>
+<li>
+A draft version of <span class="pre">oap-1.0.rnc</span> exists, written by Hartmut
+Goebel. This draft is quite complete yet. Nevertheless developers of
+openvas-administrator are requested to complete and correct this
+draft.
+</li>
+</ol>
 
-<h3>Suggested Changes</h3>
+<h4>Suggested Changes</h4>
 
 <ol>
 <li>
@@ -152,7 +171,7 @@
 </li>
 </ol>
 
-<h3>Future directions</h3>
+<h4>Future directions</h4>
 
 <p>
 Matthew Mundell <a
@@ -170,29 +189,12 @@
 </p>
 
 
-<h3>Design and Implementation</h3>
-
-<ol>
-<li>
-A draft version of <span class="pre">omp-1.0.rnc</span> exists, written by Hartmut
-Goebel (see attachment to <a
-href="http://lists.wald.intevation.org/pipermail/openvas-devel/2010-March/002139.html">this
-message on openvas-devel</a>). As of this initial writing, this draft
-is known to be incomplete and erroneous. Developers of openvas-manager
-are requested to complete and correct this draft.
-</li>
-<li>
-A draft version of <span class="pre">oap-1.0.rnc</span> exists, written by Hartmut
-Goebel. This draft is quite complete yet. Nevertheless developers of
-openvas-administrator are requested to complete and correct this
-draft.
-</li>
-</ol>
-
-
 <h3>History</h3>
 
 <ul>
+<li> 2010-08-09 Jan-Oliver Wagner &lt;jan-oliver.wagner at greenbone.net&gt;:<br/>
+     Editorial Changes. Move technical design aspects from section "rationale" to
+     "design and implementation".</li>
 <li> 2010-05-17 Hartmut Goebel &lt;h.goebel at goebel-consult.de&gt;:<br/>
      Editorial Changes. Added "Future directions".</li>
 <li> 2010-05-06 Hartmut Goebel &lt;h.goebel at goebel-consult.de&gt;:<br/>