Rearrange the document to put the web-service description before the …

…introduction
misdoro · Oct 28, 2015 · 8356552 · 8356552
1 parent 21dd34f
commit 8356552
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 25 deletions.
diff --git a/source/_templates/documentTemplate.tex b/source/_templates/documentTemplate.tex
@@ -33,7 +33,7 @@
 \textbf{Distribution:} & public \\ %\hline 
 \textbf{Work package:} & WP6 \\ %\hline 
 \textbf{Version:} & 12.07r2 \\ %\hline 
-\textbf{Date:} & 12/10/2015 \\ %\hline
+\textbf{Date:} & 28/10/2015 \\ %\hline
 \textbf{Document code:} &  \\ %\hline 
 \textbf{Document URL:} & \url{http://www.vamdc.org/documents/software/JavaNodeSwDoc_12.07r2.pdf} \\ %\hline 
 
@@ -60,7 +60,7 @@
 \textbf{Version} & \textbf{Date} & \textbf{Modified By} & \textbf{Description of Change} \\ \hline 
 V0.1 & 31/10/2011 & M.Doronin & first draft \\ \hline 
 V12.07 & 29/08/2012 & M.Doronin & Release documentation for 12.07 Java node software \\ \hline 
-V12.07r2 & 12/10/2015 & M.Doronin & Updates for 12.07r2 release of the Java Node Software \\ \hline
+V12.07r2 & 28/10/2015 & M.Doronin & Updates for 12.07r2 release of the Java Node Software \\ \hline
  &  &  &  \\ \hline 
  &  &  &  \\ \hline 
 \end{tabular}

diff --git a/source/index.rst b/source/index.rst
@@ -11,8 +11,12 @@ Java VAMDC-TAP node software documentation
 .. toctree::
    :maxdepth: 2
 
+   preface
+
+   webservice
+
    intro
-   
+
    plugin-arch
    plugin-test
    plugin-datamodel
@@ -21,6 +25,6 @@ Java VAMDC-TAP node software documentation
    plugin-metrics
 
    deploy
-   webservice
 
-   biblio
+   biblio
+
diff --git a/source/intro.rst b/source/intro.rst
@@ -1,24 +1,4 @@
 
-This document describes the implementation and installation of a VAMDC-TAP node using the Java Node Software. It is organized to follow the node development path.
-Each chapter corresponds to an individual development task.
-
-In the :ref:`intro`, a brief description of the components employed in the java node software implementation is given.
-
-:ref:`plugin` chapter presents the architecture of the Java Node Software and gives the details on the interaction interfaces between the node software parts.
-
-Setting up the development environment with the TAPValidator program is described in the :ref:`plugintest` chapter.
-
-The first development task is to access the data in the database. Apache Cayenne library is used to perform this task. The process is briefly described in the
-chapter :ref:`datamodel`.
-Once the access to the data is established, one may proceed to building the XSAMS elements from the database objects, as described in the chapter :ref:`XSAMSGen`.
-The last development task is to define the mapping between the incoming VSS2 queries and the internal database queries. 
-The chapter :ref:`QueryHandling` describes that mapping in detail.
-
-By this moment, node plugin should be capable of producing the XSAMS documents in response to incoming queries.
-Final development task is to implement special queries used to estimate if the database contains data for a given VSS2 request. 
-It is described in the :ref:`metrics` chapter.
-
-The last chapter and last task is to install the node web service (:ref:`deploy`).
 
 
 

diff --git a/source/preface.rst b/source/preface.rst
@@ -0,0 +1,24 @@
+Preface
+========
+
+
+This document describes the implementation and installation of a VAMDC-TAP node using the Java Node Software. It is organized to follow the node development path.
+Each chapter corresponds to an individual development task.
+
+In the :ref:`intro`, a brief description of the components employed in the java node software implementation is given.
+
+:ref:`plugin` chapter presents the architecture of the Java Node Software and gives the details on the interaction interfaces between the node software parts.
+
+Setting up the development environment with the TAPValidator program is described in the :ref:`plugintest` chapter.
+
+The first development task is to access the data in the database. Apache Cayenne library is used to perform this task. The process is briefly described in the
+chapter :ref:`datamodel`.
+Once the access to the data is established, one may proceed to building the XSAMS elements from the database objects, as described in the chapter :ref:`XSAMSGen`.
+The last development task is to define the mapping between the incoming VSS2 queries and the internal database queries. 
+The chapter :ref:`QueryHandling` describes that mapping in detail.
+
+By this moment, node plugin should be capable of producing the XSAMS documents in response to incoming queries.
+Final development task is to implement special queries used to estimate if the database contains data for a given VSS2 request. 
+It is described in the :ref:`metrics` chapter.
+
+The last chapter and last task is to install the node web service (:ref:`deploy`).
diff --git a/source/webservice.rst b/source/webservice.rst
@@ -1,3 +1,6 @@
+
+
+
 .. _webservice:
 
 Web-service description
Original file line number	Diff line number	Diff line change
		@@ -1,3 +1,6 @@



		.. _webservice:

		Web-service description
Expand Down