doc: Restructure - split it to multiple chapters

diff --git a/doc/Makefile b/doc/Makefile
index 362aeffe7d3ac4392338573b7b61d2fc41f777d9..f4e9ca6c7f99b2474da1e5b863273517c61cca65 100644 (file)
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -36,11 +36,11 @@ XML_ENTITIES = $(shell cat $(XML_ENT_INCS) | \
 
 
 clean:
-       @rm -f  ${XML_BASENAMES:%=%.html}
-       @rm -f  ${XML_BASENAMES:%=%.pdf}
-       @rm -f ./*.log
-       @rm -f ./*.out
-       @rm -f ./*~
+       rm -f  ${XML_BASENAMES:%=%.html}
+       rm -f  ${XML_BASENAMES:%=%.pdf} $(FIGS:%.fig=%.pdf) $(ORTE_DOC_SOURCES)
+       rm -f ./*.log
+       rm -f ./*.out
+       rm -f ./*~
 
 %.pdf: %.fig
        fig2dev -L pdf $^ $@

diff --git a/doc/orte/orte_api.xml b/doc/orte/orte_api.xml
index e6013471cfcc6676ebf6d3980bf6edd264de15fb..d4955dec49b82ad1af309dba34bd30afb78d8e38 100644 (file)
--- a/doc/orte/orte_api.xml
+++ b/doc/orte/orte_api.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<section id="orte-api">
+<chapter id="orte-api">
   <title>ORTE API</title>
   
   <section><!--sect1-->
@@ -17,4 +17,4 @@
     &orte_defines_api;
   </section><!--/sect3-->
 
-</section>
+</chapter>

diff --git a/doc/orte/orte_examples.xml b/doc/orte/orte_examples.xml
index 409687793095be86029c77992b833b249b9f28ad..9564adcc000befa61fe58e058ca68393be847a8c 100644 (file)
--- a/doc/orte/orte_examples.xml
+++ b/doc/orte/orte_examples.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<section id="orte-examples">
+<chapter id="orte-examples">
   <title>ORTE Examples</title>
 
   <para>
@@ -312,4 +312,4 @@ BoxTypeDeserialize(CDR_Codec *cdrCodec, void *instance) {
   </para>
   </section>
 
-</section>
+</chapter>

diff --git a/doc/orte/orte_internals.xml b/doc/orte/orte_internals.xml
index 1605adc650712c0f2a9a5dac4180f52923e7dafb..6eb4dd0b6932410ffe64be1a54e02df6de2bd754 100644 (file)
--- a/doc/orte/orte_internals.xml
+++ b/doc/orte/orte_internals.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<section id="orte-internals">
-  <title>ORTE Implementation Issues</title>
+<chapter id="orte-internals">
+  <title>ORTE Internals</title>
 
   <para>
   ORTE is network middleware for distributed, real-time application development 
@@ -247,4 +247,4 @@
   </mediaobject>
   </figure>
 
-</section>
+</chapter>

diff --git a/doc/orte/orte_intro.xml b/doc/orte/orte_intro.xml
index 22d3d970d7ab2d164458e07ad288375c713cb26f..cacf673c77e79a82d0cb03460a34cd2d58f47456 100644 (file)
--- a/doc/orte/orte_intro.xml
+++ b/doc/orte/orte_intro.xml
@@ -2,10 +2,18 @@
 <section id="orte-intro">
   <title>Introduction</title>
 
+  <para>The Open Real-Time Ethernet (ORTE) is open source implementation of
+  RTPS communication protocol. RTPS is new application layer protocol
+  targeted to real-time communication area, which is build on the top of
+  standard UDP stack. Since there are many TCP/IP stack implementations
+  under many operating systems and RTPS protocol does not have any other
+  special HW/SW requirements, it should be easily ported to many HW/SW
+  target platforms. Because it uses only UDP protocol, it retains control of
+  timing and reliability.</para>
+
+
   <para id="ORTE" xreflabel="ORTE">
-  The Open Real-Time Ethernet (ORTE) is
-  open source implementation of RTPS communication protocol. This protocol
-  is being to submit to IETF as an informational RFC and has been adopted
-  by the IDA group.
+    RTPS protocol is being to submit to IETF as an informational RFC
+    and has been adopted by the IDA group.
   </para>
-</section>
\ No newline at end of file
+</section>

diff --git a/doc/orte/orte_tests.xml b/doc/orte/orte_tests.xml
index 0110ff9c0e582d035ab62ae9f1da7cbaf24fb38e..e5706d4f81aa324f2d381860ead907cde1a55846 100644 (file)
--- a/doc/orte/orte_tests.xml
+++ b/doc/orte/orte_tests.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<section id="orte-tests">
+<chapter id="orte-tests">
   <title>ORTE Tests</title>
 
   <para>
@@ -8,5 +8,4 @@
   protocol. Results of these test indicate that ORTE is fully
   interoperable with implementation provided by another vendor.
   </para>
-</section>
-
+</chapter>

diff --git a/doc/orte/orte_usage.xml b/doc/orte/orte_usage.xml
index 4498e06bcb1f3753058635699d9e38d9cfe379e9..b36b66ff98ab1fa776b8e96a2cce4468eada1314 100644 (file)
--- a/doc/orte/orte_usage.xml
+++ b/doc/orte/orte_usage.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<section id="orte-usage">
+<chapter id="orte-usage">
   <title>ORTE Usage Information</title>
 
   <section id="orte-installation">
@@ -300,4 +300,4 @@ manager 0xc0a80001-0x123402 was deleted
     &orte_ortespy;
 
   </section>
-</section>
+</chapter>

diff --git a/doc/orte_incl.ent b/doc/orte_incl.ent
index 7f54e6eefd83d4c7c185cd5525f43d9c685afe6f..c97943a18345ba2113125b698462f074a94dbc55 100644 (file)
--- a/doc/orte_incl.ent
+++ b/doc/orte_incl.ent
@@ -1,4 +1,3 @@
-<!ENTITY orte SYSTEM "ortedoc.xml">
 <!--<!ENTITY % ortepath "">-->
 
 <!ENTITY orte_summary   SYSTEM "orte/orte_summary.xml">
@@ -29,5 +28,3 @@
 <!ENTITY orte_attributes_img "%ortepath;/img/orte_attributes">
 <!ENTITY orte_internal_architecture_img "%ortepath;/img/orte_internal_architecture">
 <!ENTITY orte_rtps_communication_img "%ortepath;/img/orte_rtps_communication">
-
-

diff --git a/doc/ortedoc.xml b/doc/ortedoc.xml
deleted file mode 100644 (file)
index 1d33620..0000000
--- a/doc/ortedoc.xml
+++ /dev/null
@@ -1,34 +0,0 @@
-<?xml version='1.0'?>
-<chapter>
-  <title>Open Real-Time Ethernet</title>
-
-  <para>The Open Real-Time Ethernet (ORTE) is open source implementation of
-  RTPS communication protocol. RTPS is new application layer protocol
-  targeted to real-time communication area, which is build on the top of
-  standard UDP stack. Since there are many TCP/IP stack implementations
-  under many operating systems and RTPS protocol does not have any other
-  special HW/SW requirements, it should be easily ported to many HW/SW
-  target platforms. Because it uses only UDP protocol, it retains control of
-  timing and reliability.</para>
-
-  <section>
-    <title>ORTE Summary</title>
-    
-    &orte_summary;
-  </section>
-
-  <section id="orte-description">
-    <title>ORTE Description</title>
-    
-    &orte_intro;
-    &orte_ps_model;  
-    &orte_rtps_model;  
-  </section>
-
-  &orte_internals;
-  &orte_examples;
-  &orte_tests;
-  &orte_usage;
-  &orte_api;
-
-</chapter>

diff --git a/doc/orteman.xml b/doc/orteman.xml
index 096195d9e0a292bd0b84e2dcdfbdc9e385b64866..ec1b7c956221a04a405bd01cd28038aca9adfdf8 100644 (file)
--- a/doc/orteman.xml
+++ b/doc/orteman.xml
@@ -81,7 +81,7 @@
 -->
 
 <bookinfo>
-       <title>ORTE - Open Real-Time Ethernet</title>
+       <title>ORTE &ndash; Open Real-Time Ethernet</title>
 <!--   <authorgroup>
        <author>
         <firstname>Petr</firstname>
@@ -105,7 +105,20 @@
        </legalnotice>-->
 </bookinfo>
 
-&orte;
+<chapter id="orte-description">
+    <title>ORTE Description</title>
+    
+    &orte_intro;
+    &orte_ps_model;  
+    &orte_rtps_model;  
+</chapter>
+
+  &orte_internals;
+  &orte_examples;
+  &orte_tests;
+  &orte_usage;
+  &orte_api;
+
 <!-- Add other entries here    -->
 
 </book>