[tracker] Doc: MFO brief explanation and diagram
- From: Ivan Frade <ifrade src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [tracker] Doc: MFO brief explanation and diagram
- Date: Wed, 25 Nov 2009 11:06:13 +0000 (UTC)
commit dbd99c6debe092995c7dd63e94f071638f07ac89
Author: Ivan Frade <ivan frade nokia com>
Date: Wed Nov 25 13:03:54 2009 +0200
Doc: MFO brief explanation and diagram
docs/ontologies/mfo/explanation.html | 17 +++++++++++++++++
docs/ontologies/mfo/feeds-overview.dia | Bin 0 -> 5068 bytes
2 files changed, 17 insertions(+), 0 deletions(-)
---
diff --git a/docs/ontologies/mfo/explanation.html b/docs/ontologies/mfo/explanation.html
new file mode 100644
index 0000000..224fd70
--- /dev/null
+++ b/docs/ontologies/mfo/explanation.html
@@ -0,0 +1,17 @@
+<h2>Overview</h2>
+
+<p>This ontology is an abstract representation of entries coming from feeds. These feeds can be blogs (any of the common syndication formats can be translated into this representation), podcasts or even some online services (like flickr).</p>
+
+<p>The basic assumption in the ontology is that all these feeds are unidirectional conversations with (from) the author of the content and every post on those channels is a message.</p>
+
+<p>The source of the posts, the feed itself, is an instance of <a href="#FeedChannel">mfo:FeedChannel</a>. Each post in that feed will be an instance of <a href="#FeedMessage">mfo:FeedMessage</a> . The relation between the messages and the channel comes from their superclasses, <a href="../nmo/index.html#communicationChannel">nmo:communicationChannel</a> (taking into account that <a href="#FeedChannel">mfo:FeedChannel</a> is a subclass of <a href="../nmo/index.html#CommunicationChannel">nmo:CommunicationChannel</a> and <a href="#FeedMessage">mfo:FeedMessage</a> a subclass of <a href="../nmo/index.html#Message">nmo:Message</a>).</p>
+
+<p>A post can be plain text but can contain also more things like links, videos or Mp3. We represent those internal pieces in instances of <a href="#Enclosure.">mfo:Enclosure.</a> This class has properties to link with the remote and local representation of the resource (in case the content has been downloaded).</p>
+
+<p>Finally, the three important classes (mfo:FeedChannel, mfo:FeedMessage, mfo:Enclosure) are subclasses of <a href="#FeedElement">mfo:FeedElement</a>, just an abstract class to share the link with mfo:FeedSettings. <a href="#FeedSettings">mfo:FeedSettings</a> contains some common configuration options. Not all of them applies to all, but it is a quite cleaner solution. For instance the <a href="#maxSize">mfo:maxSize</a> property only makes sense per-enclosure, while the <a href="#updateInterval">mfo:updateInterval</a> is useful for the channel.</p>
+
+
+<h2>Graphical overview</h2>
+<img src="feeds-overview.png"/><br/>
+<small>Notation defined <a href="../index.html#Notation">in this page</a></small>
+
diff --git a/docs/ontologies/mfo/feeds-overview.dia b/docs/ontologies/mfo/feeds-overview.dia
new file mode 100644
index 0000000..343303e
Binary files /dev/null and b/docs/ontologies/mfo/feeds-overview.dia differ
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]