[tracker] Very first example of textual documenation



commit 646eccd770fe9cb40ba1d8e5f8bf9bd2d6023498
Author: Ivan Frade <ivan frade nokia com>
Date:   Sun Nov 15 18:44:20 2009 +0200

    Very first example of textual documenation

 docs/ontologies/README.ontologiesdoc      |   22 ++++++++++++++++++++++
 docs/ontologies/explanation.html.template |    7 +++++++
 docs/ontologies/nie/explanation.html      |    7 +++++++
 3 files changed, 36 insertions(+), 0 deletions(-)
---
diff --git a/docs/ontologies/README.ontologiesdoc b/docs/ontologies/README.ontologiesdoc
new file mode 100644
index 0000000..43ad8d9
--- /dev/null
+++ b/docs/ontologies/README.ontologiesdoc
@@ -0,0 +1,22 @@
+Documentation for ontologies
+============================
+
+This directory contains verbose documentation explaining each ontology.
+
+Expected documents/format
+=========================
+
+1) There should be one directory per ontology prefix. 
+2) In that directory, there must be a file called 'explanation.html'
+   This file will be copied as-it-is into the ontology webpage
+3) That file can link to any other files in the same directory
+   All files in the directory will be copied together in the final web directory
+
+Explanation.html
+================
+
+This 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 file "explanation.html.template" can be used as starting point.
diff --git a/docs/ontologies/explanation.html.template b/docs/ontologies/explanation.html.template
new file mode 100644
index 0000000..8814262
--- /dev/null
+++ b/docs/ontologies/explanation.html.template
@@ -0,0 +1,7 @@
+<h2>Overview</h2>
+
+<h2>Special remarks</h2>
+
+<h2>Related information</h2>
+
+<h2>Graphical overview</h2>
diff --git a/docs/ontologies/nie/explanation.html b/docs/ontologies/nie/explanation.html
new file mode 100644
index 0000000..8814262
--- /dev/null
+++ b/docs/ontologies/nie/explanation.html
@@ -0,0 +1,7 @@
+<h2>Overview</h2>
+
+<h2>Special remarks</h2>
+
+<h2>Related information</h2>
+
+<h2>Graphical overview</h2>



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