[tracker] Document the documentation

[Ivan Frade <ifrade src gnome org>]

commit 88a14e7601bb61d53cfb0f201cbc5c4000029fcc
Author: Ivan Frade <ivan frade nokia com>
Date:   Thu Nov 19 21:31:46 2009 +0200

    Document the documentation

 docs/ontologies/README.ontologiesdoc      |   30 +++++++++++++++++++++++-----
 docs/ontologies/explanation.html.template |    7 ++++++
 2 files changed, 31 insertions(+), 6 deletions(-)
---
diff --git a/docs/ontologies/README.ontologiesdoc b/docs/ontologies/README.ontologiesdoc
index 08228f0..e19fc8f 100644
--- a/docs/ontologies/README.ontologiesdoc
+++ b/docs/ontologies/README.ontologiesdoc
@@ -18,13 +18,31 @@ Expected documents/format
 Explanation.html
 ================
 
-This must be a file in HTML format with <h2> as "biggest" elements (i.e. sections).
+ It must be a file in HTML format with <h2> as "biggest" elements (i.e. sections).
 It will be copied as-it-is into the ontology HTML page, so it shouldn't include all 
 HTML headers (i.e. it is NOT a valid HTML document).
 
-The classes inside the ontology can be linked using <a
-href="#ClassName">. Dia diagrams (x.dia) in the directory, should be
-linked using the png extension (<a href="x.png">). They will be
-converted automatically in doc generation time.
 
-The file "explanation.html.template" can be used as starting point.
+ The classes/properties inside the ontology can be linked using 
+
+   <a href="#ClassName">
+
+ and classes/properties in other ontologies with
+
+   <a href="../ontology-prefix/index.html#ClassName">
+
+
+ Dia diagrams (x.dia) in the directory will be converted automatically
+ in png, and should be linked using the png extension:
+
+    <a href="x.png"> 
+
+ 
+ To include verbatim examples in SparQL or turtle format, use the
+<pre> HTML tag, and all "<" and ">" inside it must be written as
+"&lt;" and "%gt;".
+
+ The file "explanation.html.template" can be used as starting point.
+
+ 
+ 
diff --git a/docs/ontologies/explanation.html.template b/docs/ontologies/explanation.html.template
index 8814262..cb86364 100644
--- a/docs/ontologies/explanation.html.template
+++ b/docs/ontologies/explanation.html.template
@@ -5,3 +5,10 @@
 <h2>Related information</h2>
 
 <h2>Graphical overview</h2>
+
+<p>Example of raw sparQL<p>
+<pre>
+  INSERT {
+    &lt;test://1&gt; a nco:PersonContact .
+  }
+</pre>