[tracker] Replace old HTML template with the new in XML



commit 630b35addd62f67944311b65c7fcae163c8753ba
Author: Ivan Frade <ivan frade nokia com>
Date:   Wed Jan 27 20:40:02 2010 +0200

    Replace old HTML template with the new in XML

 docs/ontologies/README.ontologiesdoc      |   24 ++++++++++++++
 docs/ontologies/explanation.html.template |   17 ----------
 docs/ontologies/explanation.xml.template  |   50 +++++++++++++++++++++++++++++
 3 files changed, 74 insertions(+), 17 deletions(-)
---
diff --git a/docs/ontologies/README.ontologiesdoc b/docs/ontologies/README.ontologiesdoc
index 148159e..bb380d9 100644
--- a/docs/ontologies/README.ontologiesdoc
+++ b/docs/ontologies/README.ontologiesdoc
@@ -49,3 +49,27 @@ refered using just the filename:
 
  The file "explanation.xml.template" contains an example of the usual
 sections in the documentation and the most common docbook elements.
+
+How to build/rebuild the documentation
+======================================
+
+There are two steps:
+
+1) run make in docs/tools.
+   This will generate from the .ontology, .description and
+   explanation.xml files a docbook document. That generated document
+   (and all the images referenced there) will be copied into
+   docs/reference/ontology
+
+   make check the gen-doc.stamp file to decide when it needs to
+   rebuild. Remove that file after modifying any of the inputs to 
+   force a rebuild.
+
+2) run make in docs/reference/ontology
+   This will take all the XML generated in the previous step, and
+   use the gtk-doc magic to build first a docbook XML and then export
+   it as HTML, devhelp and other formats.
+
+   The HTML result is (surprise!) in the html folder.
+
+ 
diff --git a/docs/ontologies/explanation.xml.template b/docs/ontologies/explanation.xml.template
new file mode 100644
index 0000000..1d48f78
--- /dev/null
+++ b/docs/ontologies/explanation.xml.template
@@ -0,0 +1,50 @@
+<!--
+ Usual ids:
+
+    xxx-ontology for the whole ontology
+    xxx-explanation 
+    xxx-classes
+    xxx-properties
+-->
+
+<section id="xxx-explanation">
+ <title>Description</title>
+ <sect2 id="xxx-introduction">
+   <title>Introduction</title>
+
+  <!-- Content -->
+
+ </sect2>
+
+
+
+ <refsect2 id="xxx-special-remarks">
+   <title>Special remarks</title>
+
+   <para>Example of raw sparQL<para>
+   <code>
+  INSERT {
+    &lt;test://1&gt; a nco:PersonContact .
+  }
+   </code>
+ </refsect2>
+
+
+
+ <refsect2 id="xxx-related-information">
+   <title>Related information</title>
+   <para>
+    <ulink url="http://mail.gnome.org/mailman/listinfo/tracker-list";>External link</ulink>
+    <link linkend="xxx-class">Internal link</link>
+   </para>
+ </refsect2>
+
+
+ <refsect2 id="xxxx-graphical-overview">
+  <figure id="nmm-ontology-graph">
+  <title>Graphical Overview</title>
+    <graphic fileref="images-overview.png" format="PNG"></graphic>
+  </figure>
+  <para>Notation defined <link linkend="ontology-notation">in this page</link></para>
+ </refsect2>
+</section>



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]