GNOME.org
 

[tracker] Add notation to the main page. Updated doc-doc

commit 1205b86f5e818b11aeca8df843e0d70f67467e5b
Author: Ivan Frade <ivan frade nokia com>
Date:   Mon Nov 23 15:14:34 2009 +0200

    Add notation to the main page. Updated doc-doc

 docs/ontologies/explanation.html.template |   11 +++--
 docs/ontologies/index.html                |    8 +++-
 docs/ontologies/nie/explanation.html      |   67 ++++++++++++++++++++--------
 docs/ontologies/notation.dia              |  Bin 0 -> 2140 bytes
 utils/services/gen-doc.sh                 |    3 +-
 5 files changed, 64 insertions(+), 25 deletions(-)
---
diff --git a/docs/ontologies/explanation.html.template b/docs/ontologies/explanation.html.template
index cb86364..0d4366e 100644
--- a/docs/ontologies/explanation.html.template
+++ b/docs/ontologies/explanation.html.template
@@ -2,13 +2,16 @@
 
 <h2>Special remarks</h2>
 
-<h2>Related information</h2>
-
-<h2>Graphical overview</h2>
-
 <p>Example of raw sparQL<p>
 <pre>
   INSERT {
     &lt;test://1&gt; a nco:PersonContact .
   }
 </pre>
+
+<h2>Related information</h2>
+
+<h2>Graphical overview</h2>
+<!-- <img src="xxxx.png"/><br/> -->
+<small>Notation defined <a href="../index.html#Notation">in this page</a></small>
+
diff --git a/docs/ontologies/index.html b/docs/ontologies/index.html
index 04a60ff..8a635ed 100644
--- a/docs/ontologies/index.html
+++ b/docs/ontologies/index.html
@@ -35,7 +35,7 @@
  <li><a href="./nfo/index.html">NFO</a>: Nepomuk File Ontology. Basic file description. Extended by tracker to improve playlists support.</li>
  <li><a href="./nao/index.html">NAO</a>: Nepomuk Annotation Ontology. Tag support everywhere in the ontologies.</li>
  <li><a href="./mto/index.html">MTO</a>: Maemo Transfers Ontology, to represent uploads/downloads.</li>
- <li><a href="./nmm/index.html">NMM</a>: Nepomuk Multimedia Ontology (Maemo proposal to replace/complement NID3)</li>
+ <li><a href="./nmm/index.html">NMM</a>: Nepomuk Multimedia Ontology (Maemo proposal to replace/complement NID3/NEXIF). Includes music, images, video and radio.</li>
  <li><a href="./mfo/index.html">MFO</a>: Maemo Feeds Ontology, for feeds and podcasts</li>
  <li><a href="./mlo/index.html">MLO</a>: Maemo Location Ontology: Very Early Draft of a location ontology.</li>
  <li><a href="./tracker/index.html">Tracker</a>/<a href="./maemo/index.html">maemo</a>: Specific tracker/maemo internal properties</li>
@@ -47,5 +47,11 @@
  <li><a href="./scal/index.html">SCAL</a>: Simplified Calendar Ontology. Custom made ontology for calendar. Compatible with ical (maybe some rough edges to fix), easier to handle, and probably more efficient in some scenarios.</li>
 </ul>
 
+<a name="Notation">
+<h2>Notation</h2>
+<p>Brief description of the notation used in the diagrams</p>
+<img src="./notation.png">
+
+
 
 </html>
diff --git a/docs/ontologies/nie/explanation.html b/docs/ontologies/nie/explanation.html
index 5c0a6c9..69bd6d4 100644
--- a/docs/ontologies/nie/explanation.html
+++ b/docs/ontologies/nie/explanation.html
@@ -9,22 +9,22 @@
 </p>
 
 <p>
- <a href="#DataObject">DataObject</a> class represents a bunch of
+ <a href="#DataObject">nie:DataObject</a> class represents a bunch of
  bytes somwhere (local or remote), the physical entity that contain
  data. The <emph>meaning</emph> (intepretation) of that entity, the
  information for the user contained in those bytes (e.g. a music file,
  a picture) is represented on the  
-<a href="#InformationElement">InformationElement</a> side of the
+<a href="#InformationElement">nie:InformationElement</a> side of the
 ontology. 
 </p>
 
 <p>
 Both sides are linked using the
-property <a href="#interpretedAs">interpretedAs</a> (and its reverse
-<a href="#isStoredAs">isStoredAs</a>), indicating the correspondence
+property <a href="#interpretedAs">nie:interpretedAs</a> (and its reverse
+<a href="#isStoredAs">nie:isStoredAs</a>), indicating the correspondence
 between the physical element and its interpretation. There is also a
 property to
-link <a href="#InformationElement">InformationElement</a>s,
+link <a href="#InformationElement">nie:InformationElement</a>s,
 representing the logical containment between them (like a picture and
 its album). 
 </p>
@@ -37,17 +37,17 @@ properties defined here will be inherited for a lot of classes. It is
 worth to comment few of them with special relevance:
 </p>
 <dl>
-  <dt><a href="#title">title</a><dt>
+  <dt><a href="#title">nie:title</a><dt>
   <dd>Title or name or short text describing the item</dd>
-  <dt><a href="#description">description</a><dt>
+  <dt><a href="#description">nie:description</a><dt>
   <dd>More verbose comment about the element</dd>
-  <dt><a href="#language">language</a><dt>
+  <dt><a href="#language">nie:language</a><dt>
   <dd>To specify the language of the item.</dd>
-  <dt><a href="#plainTextContent">plainTextContent</a><dt>
+  <dt><a href="#plainTextContent">nie:plainTextContent</a><dt>
   <dd>Just the raw content of the file, if it makes sense as text.</dd>
-  <dt><a href="#generator">generator</a><dt>
+  <dt><a href="#generator">nie:generator</a><dt>
   <dd>Software/Agent that set/produced the information.</dd>
-  <dt><a href="#usageCounter">usageCounter</a><dt>
+  <dt><a href="#usageCounter">nie:usageCounter</a><dt>
   <dd>Count number of accesses to the information. It can be an
   indicator of relevance for advanced searches</dd>
 </dl>
@@ -56,18 +56,50 @@ worth to comment few of them with special relevance:
 <h3>Dates and timestamps representations</h3>
 FIXME Explain the mess with dates
 <dl>
-  <dt><a href="#contentLastModified">contentLastModified</a><dt>
+  <dt><a href="#contentLastModified">nie:contentLastModified</a><dt>
   <dd>.</dd>
-  <dt><a href="#informationElementDate">informationElementDate</a><dt>
+  <dt><a href="#informationElementDate">nie:informationElementDate</a><dt>
   <dd>.</dd>
-  <dt><a href="#contentCreated">contentCreated</a><dt>
+  <dt><a href="#contentCreated">nie:contentCreated</a><dt>
   <dd>.</dd>
-  <dt><a href="#contentAccessed">contentAccessed</a><dt>
+  <dt><a href="#contentAccessed">nie:contentAccessed</a><dt>
   <dd>.</dd>
-  <dt><a href="#lastRefreshed">lastRefreshed</a><dt>
+  <dt><a href="#lastRefreshed">nie:lastRefreshed</a><dt>
   <dd>.</dd>
 </dl>
 
+<h2>URIs and full representation of a file</h2>
+<p>One of the most common resources in a desktop is a file. Given the split between Data Objects and Information Elements, some times it is not clear how a real file is represented into Nepomuk. Here are some indications:</p>
+<ol>
+ <li>Every file (local or remote) should generate one DataObject instance and an InformationElement instance.</li>
+ <li>Even when Data Objects and Information Elements are completely different things, for efficency reasons in Tracker we use the URI for both of them.</li>
+ <li>The URI will be an autogenerated ID, and the real location of the 
+ <li>To link both things together, every InformationElement must have the property <a href="#isStoredAs">nie:isStoredAs</a>, that points to the location of the resource, and should be used by any program that wants to access it.</li>
+</ol>
+
+ Here comes an example, for the image file /home/user/a.jpeg:</p>
+
+<pre>
+&lt;file:///home/ivan/test/CC-test-big.png&gt;  a nfo:FileDataObject ;
+         # Properties as FileDataObject (physicalities)
+         nfo:fileSize 12341234 .
+
+&lt;urn:uuid:10293801928301293&gt; a nmm:Photo ;
+         # Properties as nmm:Photo 
+	 nfo:width 49 ;
+	 nfo:height 36 ;
+         nmm:flash &lt;nmm:flash-off&gt;;
+         nmm:whiteBalance &lt;nmm:white-balance-automatic&gt; ;
+         nmm:camera "Tracknon N900" ;
+
+         # Mandatory from InformationElement
+         nie:isStoredAs &lt;file:///home/ivan/test/CC-test-big.png&gt; .
+
+</pre>
+
+<h2>Graphical overview</h2>
+
+<img src="./overview.png"/>
 
 <h2>Related information</h2>
 
@@ -75,6 +107,3 @@ This explanation is just a brief extract from the
 original <a href="http://www.semanticdesktop.org/ontologies/nie";>
 Nepomuk NIE Ontology</a> web page.
 
-<h2>Graphical overview</h2>
-
-<img src="./overview.png">
diff --git a/docs/ontologies/notation.dia b/docs/ontologies/notation.dia
new file mode 100644
index 0000000..7efc01a
Binary files /dev/null and b/docs/ontologies/notation.dia differ
diff --git a/utils/services/gen-doc.sh b/utils/services/gen-doc.sh
index b168505..23b992b 100755
--- a/utils/services/gen-doc.sh
+++ b/utils/services/gen-doc.sh
@@ -49,4 +49,5 @@ done
 
 echo "Copying resources"
 cp -R resources/ $BUILD_DIR
-cp ../../docs/ontologies/index.html $BUILD_DIR
\ No newline at end of file
+cp ../../docs/ontologies/index.html $BUILD_DIR
+cp ../../docs/ontologies/notation.png $BUILD_DIR
\ No newline at end of file
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]