generate the documentation

diff --git a/org.glite.jp.ws-interface/Makefile b/org.glite.jp.ws-interface/Makefile
index 4bed4d2..f762daa 100644 (file)
--- a/org.glite.jp.ws-interface/Makefile
+++ b/org.glite.jp.ws-interface/Makefile
@@ -20,7 +20,7 @@ docbookxls:=http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl
 
 WSDL=JobProvenancePS.wsdl JobProvenanceIS.wsdl JobProvenanceTypes.wsdl 
 
-all compile: ${WSDL}
+all compile: ${WSDL} JobProvenance.html
 
 check: 
        @echo No unit test required for interface-only module.
@@ -45,6 +45,7 @@ install:
        -mkdir -p ${PREFIX}/${STAGETO}
        -mkdir -p ${PREFIX}/share/doc/${package}-${version}
        install -m 644 ${top_srcdir}/LICENSE ${PREFIX}/share/doc/${package}-${version}
+       install -m 644 JobProvenance.html ${PREFIX}/share/doc/${package}-${version}
 #      cd ${top_srcdir}/interface && install -m 644 ${WSDL} ${PREFIX}/${STAGETO}
        install -m 644 ${WSDL} ${PREFIX}/${STAGETO}
 
@@ -54,7 +55,7 @@ clean:
 %.wsdl: %.xml
        ${XSLTPROC} ../src/puke-wsdl.xsl $< >$@
 
-JobProvenancePS.html: doc.xml JobProvenancePS.xml JobProvenanceTypes.xml puke-ug.xsl
+JobProvenance.html: doc.xml JobProvenancePS.xml JobProvenanceIS.xml JobProvenanceTypes.xml puke-ug.xsl
        ${XSLTPROC} --novalid ../src/puke-ug.xsl $< >doc-html.xml
        ${XMLLINT} --valid --noout doc-html.xml
        ${XSLTPROC} --stringparam  chapter.autolabel 0 ${docbookxls} doc-html.xml >$@

diff --git a/org.glite.jp.ws-interface/project/glite-jp-ws-interface.spec b/org.glite.jp.ws-interface/project/glite-jp-ws-interface.spec
index 910b8a8..930f7e7 100644 (file)
--- a/org.glite.jp.ws-interface/project/glite-jp-ws-interface.spec
+++ b/org.glite.jp.ws-interface/project/glite-jp-ws-interface.spec
@@ -1,14 +1,14 @@
 Summary:Change me !!!
 Name:glite-jp-ws-interface
-Version:1.0.0
-Release:0_U200510112245
+Version:1.1.0
+Release:0_U200510151557
 Copyright:Open Source EGEE License
 Vendor:EU EGEE project
 Group:System/Application
 Prefix:/opt/glite
 BuildArch:i386
 BuildRoot:%{_builddir}/%{name}-%{version}
-Source:glite-jp-ws-interface-1.0.0_bin.tar.gz
+Source:glite-jp-ws-interface-1.1.0_bin.tar.gz
 
 %define debug_package %{nil}
 
@@ -37,7 +37,8 @@ Change me !!!
 %{prefix}/interface/JobProvenancePS.wsdl
 %{prefix}/interface/JobProvenanceIS.wsdl
 %{prefix}/interface/JobProvenanceTypes.wsdl
-%{prefix}/share/doc/glite-jp-ws-interface-1.0.0/LICENSE
+%{prefix}/share/doc/glite-jp-ws-interface-1.1.0/LICENSE
+%{prefix}/share/doc/glite-jp-ws-interface-1.1.0/JobProvenance.html
 
 %changelog
 

diff --git a/org.glite.jp.ws-interface/src/JobProvenanceIS.xml b/org.glite.jp.ws-interface/src/JobProvenanceIS.xml
index 5f52089..702b127 100644 (file)
--- a/org.glite.jp.ws-interface/src/JobProvenanceIS.xml
+++ b/org.glite.jp.ws-interface/src/JobProvenanceIS.xml
@@ -11,6 +11,23 @@
 
        <import namespace="http://glite.org/wsdl/services/jp" location="JobProvenanceTypes.wsdl"/>
 
+       <doc>
+               <para>
+                       The Job Provenance (JP) Index Server is a volatile counterpart to the
+                       permanent JP Primary Storage.
+                       Index servers are populated with subsets of data from Primary storage(s)
+                       and indexed according to particular user needs.
+               </para>
+               <para>
+                       The interface to Index server contains three logical parts: administraive
+                       (control), system and user.
+                       The administrative part is used by run-time index server configuration
+                       tool, 
+                       the system one allows Primary storage(s) to feed data into the Index server,
+                       and the user one is available to users for queries.
+               </para>
+       </doc>
+
        <fault name="genericFault"/>
 
        <operations>

diff --git a/org.glite.jp.ws-interface/src/puke-ug.xsl b/org.glite.jp.ws-interface/src/puke-ug.xsl
index ff70ccf..3d34891 100644 (file)
--- a/org.glite.jp.ws-interface/src/puke-ug.xsl
+++ b/org.glite.jp.ws-interface/src/puke-ug.xsl
@@ -10,24 +10,38 @@
 
 <xsl:template match="book">
        <chapter>
-               <title><xsl:value-of select="document('JobProvenancePS.xml')/service/@name"/></title>
+               <title>Job Provenance</title>
 
                <sect1>
-                       <title>Overview</title>
+                       <title>Primary Storage -- Overview</title>
                        <xsl:copy-of select="document('JobProvenancePS.xml')/service/doc/*"/>
                </sect1>
 
                <sect1>
-                       <title>Operations</title>
+                       <title>Primary Storage -- Operations</title>
                        <para> <emphasis><xsl:value-of select="document('JobProvenancePS.xml')/service/version"/></emphasis> </para>
                                <!-- xsl:apply-templates select="operations/op" -->
                                <xsl:apply-templates select="document('JobProvenancePS.xml')/service/operations/op">
                                        <xsl:sort select="@name"/>
                                </xsl:apply-templates>
                </sect1>
+
+               <sect1>
+                       <title>Index Server -- Overview</title>
+                       <xsl:copy-of select="document('JobProvenanceIS.xml')/service/doc/*"/>
+               </sect1>
+
+               <sect1>
+                       <title>Index Server -- Operations</title>
+                       <para> <emphasis><xsl:value-of select="document('JobProvenanceIS.xml')/service/version"/></emphasis> </para>
+                               <!-- xsl:apply-templates select="operations/op" -->
+                               <xsl:apply-templates select="document('JobProvenanceIS.xml')/service/operations/op">
+                                       <xsl:sort select="@name"/>
+                               </xsl:apply-templates>
+               </sect1>
        
                <sect1>
-                       <title>Types</title>
+                       <title>JP Common Types</title>
                        <!--xsl:apply-templates select="types"/ -->
                        <para> <emphasis><xsl:value-of select="document('JobProvenanceTypes.xml')/service/version"/></emphasis> </para>
                        <xsl:apply-templates select="document('JobProvenanceTypes.xml')/service/types"/>