[Gzz-commits] fenfire/docs SwampTutorial.rst

[Tuomas J. Lukka]

CVSROOT:        /cvsroot/fenfire
Module name:    fenfire
Changes by:     Tuomas J. Lukka <address@hidden>        03/04/28 14:16:45

Modified files:
        docs           : SwampTutorial.rst 

Log message:
        Doit

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/fenfire/fenfire/docs/SwampTutorial.rst.diff?tr1=1.6&tr2=1.7&r1=text&r2=text

Patches:
Index: fenfire/docs/SwampTutorial.rst
diff -u fenfire/docs/SwampTutorial.rst:1.6 fenfire/docs/SwampTutorial.rst:1.7
--- fenfire/docs/SwampTutorial.rst:1.6  Mon Apr 28 12:34:03 2003
+++ fenfire/docs/SwampTutorial.rst      Mon Apr 28 14:16:45 2003
@@ -1,20 +1,39 @@
-===============================================
-``SwampTutorial.rst``: Short tutorial for swamp
-===============================================
+=====================================================
+``SwampTutorial.rst``: Short tutorial / FAQ for swamp
+=====================================================
 
 :Authors:      Matti J. Katila and Tuomas J. Lukka
 :Date:         2003-04-15T15:53:31Z
-:Revision:     $Revision: 1.6 $
-:Last-Modified:        $Date: 2003/04/28 16:34:03 $
-:Last-Id:      $Id: SwampTutorial.rst,v 1.6 2003/04/28 16:34:03 mudyc Exp $   
+:Revision:     $Revision: 1.7 $
+:Last-Modified:        $Date: 2003/04/28 18:16:45 $
+:Last-Id:      $Id: SwampTutorial.rst,v 1.7 2003/04/28 18:16:45 tjl Exp $   
 
-- [mudyc] jvk give issues: 
+.. contents::
 
-    - What is Swamp?
-    - What is Fen?
+What is Swamp?
+==============
+
+Swamp is our RDF API, designed for SPEED, SPEED and SPEED 
+and also some flexibility. It is general and does not depend
+on the rest of Fenfire or the other projects (alph &c) at all.
+(the Obs interface and some such things are used, but they're
+trivial classes, not really dependencies).
+
+See the peg swamp_rdf_api--tjl.
+
+What is Fen?
+============
+
+Fen is the central "model" class in fenfire. In addition to a swamp,
+it contains objects for dealing with nodes' contents and xanalogical
+indexing, for searching nodes with transclusions.
+
+Here, there are dependencies to Alph with the xanalogical media.
+
+A node (with content) is conceptually similar to a zzStructure cell.
+Not all RDF resources are nodes.
 
 
-.. contents::
 
 
 How to set up Fen with swamps?