[Gzz-commits] fenfire ./README-loom ./TODO-loom ./build.xml o...

[Benja Fallenstein]

CVSROOT:        /cvsroot/fenfire
Module name:    fenfire
Changes by:     Benja Fallenstein <address@hidden>      03/03/13 15:34:34

Modified files:
        .              : README-loom TODO-loom build.xml 
        org/fenfire/loom: Loom.java 

Log message:
        Readme update, work towards release target

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/fenfire/fenfire/README-loom.diff?tr1=1.4&tr2=1.5&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/fenfire/fenfire/TODO-loom.diff?tr1=1.42&tr2=1.43&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/fenfire/fenfire/build.xml.diff?tr1=1.11&tr2=1.12&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/fenfire/fenfire/org/fenfire/loom/Loom.java.diff?tr1=1.34&tr2=1.35&r1=text&r2=text

Patches:
Index: fenfire/README-loom
diff -u fenfire/README-loom:1.4 fenfire/README-loom:1.5
--- fenfire/README-loom:1.4     Mon Mar 10 14:44:01 2003
+++ fenfire/README-loom Thu Mar 13 15:34:16 2003
@@ -14,6 +14,13 @@
 when the first release is complete, we will move it into
 an independent project at Savannah.nongnu.org.
 
+Please send comments about this software to::
+
+    address@hidden
+
+If you would like to subscribe to that mailing list, 
+please go to <http://mail.nongnu.org/mailman/listinfo/gzz-dev>.
+
 Currently Loom is only a browser, but we're working on
 making it a full RDF editor.
 
@@ -22,96 +29,166 @@
 =======
 
 Fenfire Loom is released under the GNU Lesser General
-Public License (LGPL). For details, see file LICENSE.
+Public License (LGPL). For details, see file ``LICENSE``.
 
 
-How to install
-==============
+How to run
+==========
 
-To compile Loom, you will need a Java VM and Apache Ant
-<http://ant.apache.org/> installed. You will need to check out
-both the ``fenfire`` and the ``fenfire-depends`` CVS module
-in the same directory::
+Launching Loom
+--------------
 
-  cvs -d:pserver:address@hidden:/cvsroot/fenfire login
-  cvs -z3 -d:pserver:address@hidden:/cvsroot/fenfire co fenfire
-  cvs -z3 -d:pserver:address@hidden:/cvsroot/fenfire co fenfire-depends
+If you have downloaded and unzipped the precompiled version,
+you can run Loom by typing::
 
-To compile and run the test suite, just cd into the ``fenfire/``
-directory and type ``ant``. To compile only, use ``ant compile``;
-to only run the tests, use ``ant test``.
+    java -jar loom.jar
 
+You can also pass an RDF file on the command line::
 
-How to run
-==========
+    java -jar loom.jar data.rdf
 
-To start the browser, type::
+Alternatively, some systems may launch Loom automatically
+if you click on the jar.
 
-    ant run
+Two windows should appear, one entitled "Fenfire Loom"
+(this is the main window) and one entitled "Properties"
+(this contains a list of all properties in the graph).
 
-Then open an RDF file with ``File/Open...`` and hit some
-key or click somewhere. (Open bug: the screen isn't refreshed
-after an RDF file has been read...)
 
-Alternatively, you can pass an RDF file on the command line::
+Getting started
+---------------
 
-    ant run -Dfile=foo.rdf
+To open an RDF file, just choose "File/Open...".
 
 When you've opened a file, you'll be taken to a random node
 in the RDF graph. The nodes connected to it will be shown
 left and right from it. Above each connected node, the
 property through which the nodes are connected is shown.
 
-You may have to resize your window, the nodes are
-quite large at the moment.
-
+If you know the URI of a node you want to start browsing at,
+choose "View/Go to URI..." or hit ``Ctrl-G``.
+You will be prompted to enter the URI.
+
+The node in the center of the screen is called the
+'focus.' The nodes directly left and right of the
+focus are called the 'selected nodes.' The focus
+and the selected nodes are shown with a blue border.
 
-Moving around
--------------
-
-You can choose between the connected nodes using
-the Up/Down cursor keys and move to a connected node
-using the Left/Right keys. You cannot move onto literals
-(shown as rectangles).
-
-With the mouse, left clicking on a resource will
-move on it and left clicking on a literal will
+Left clicking on a resource will move on it 
+and left clicking on a literal will
 select it (so that it's directly right of the focus).
 Right clicking on either a literal or a resource
 will select it (this is useful when you have
 a large number of connected nodes and need to scroll).
 
+Changing the selected nodes is called "rotating" because
+it rotates the other nodes around the focus.
 
-The wheel view
---------------
 
-There are two views, the 'simple' and the 'wheel' view,
-which you can switch between using the PgUp/PgDown keys.
+View options
+------------
+
+The view you have seen so far is called the *wheel view*
+because it places nodes on a circle around the focus,
+giving the impression of a wheel. There is a second view
+called the *simple view*, which you can access from the
+View menu. It simply shows the nodes as a long vertical list.
+
+You have already noticed the Properties window. An
+RDF property is only shown in the main window if it is
+selected in the Properties window. By switching properties
+on and off you can create different views of an RDF graph.
+
+The 'View' menu has a submenu entitled 'Show Graph.'
+In this menu, there is another submenu for every class
+in the RDF graph (a resource is considered a class
+if it is the object of an ``rdf:type`` statement).
+
+If you click on a class, another submenu with a list
+of properties appears. In this menu, you can choose
+a property connecting an instance of a class to the
+name of that instance; for example, you could choose
+``rss:title`` for a RDF Site Summary ``rss:item``,
+or ``vcard:FN`` (full name) for a ``vcard:internet``
+virtual business card. RSS item nodes will then
+be shown as contain their title instead of their URI,
+and ``vcard:internet`` instances will be shown
+containing their owner's full name.
+
+All these view options are inconvenient to set up
+each time you open an RDF graph. In a future release,
+you will be able to save your view options as RDF,
+either within an RDF graph or externally in another file.
+
+
+Using the keyboard
+------------------
+
+You can also navigate an RDF graph using the keyboard.
+Use ``j`` and ``l`` to move to the selected node 
+left or right of the focus, respectively. Use
+``u`` and ``n`` to select the nodes above and below
+the left selected node, respectively; use ``o`` and ``.``
+to select the nodes above and below the right
+selected node, respectively.
+
+Using the keyboard is faster than using the mouse,
+but may require a bit of getting used to.
+
+
+How to compile
+==============
+
+To compile Loom, you will need a Java VM and Apache Ant
+<http://ant.apache.org/> installed. You can either
+download the source distribution of Fenfire Loom,
+or you can get the newest bleeding-edge version
+from CVS (see below).
+
+In either case, you will have two directories
+called ``fenfire/`` and ``fenfire-depends/``.
+To compile, cd into ``fenfire/`` and just type::
+
+    ant
+
+This will compile the code and run the test suite.
+You can also only compile (``ant compile``) or
+only run the tests (``ant run``).
+
+After compilation, you can run Loom by typing::
+
+    ant run
+
+You can also pass an RDF file like this::
+
+    ant run -Dfile=data.rdf
+
+
+Getting the bleeding-edge version from CVS
+------------------------------------------
+
+You will need to check out both the ``fenfire`` 
+and the ``fenfire-depends`` CVS module
+from the same directory::
+
+  cvs -d:pserver:address@hidden:/cvsroot/fenfire login
+  cvs -z3 -d:pserver:address@hidden:/cvsroot/fenfire co fenfire
+  cvs -z3 -d:pserver:address@hidden:/cvsroot/fenfire co fenfire-depends
 
-In the wheel view, using Up/Down can be confusing
-when moving to the left, since Up seems to move down
-and Down seems to move up (try it; it's because when
-the nodes right of the cursor go up, the nodes
-left of the cursor go down on the wheel).
-Therefore, we provide a second set of 'cursor' keys
-which work equally well in both views:
-
-- ``j`` moves left.
-- ``l`` moves right.
-- ``u`` goes up left from the cursor.
-- ``n`` or ``m`` goes down left from the cursor.
-- ``o`` goes up right from the cursor.
-- ``.`` goes down right from the cursor.
+To update your checked out copy, run the following command
+both in your ``fenfire/`` and ``fenfire-depends/`` directories::
 
-These may seem strange at first, but seem to work
-really well. (We'll continue to experiment, though.)
+  cvs up -dP
 
 
 Directory structure
-===================
+-------------------
 
 - ``org.fenfire.loom`` contains all Loom classes and tests.
 - ``org.fenfire.test`` contains the test framework (Jython-based).
+- ``lib/libvob.jar`` is a dependency on another Fenfire-related
+  project, libvob, which is currently being prepared for its first
+  public release. See <http://savannah.nongnu.org/projects/libvob>.
 
 
 Homepage and mailing lists
Index: fenfire/TODO-loom
diff -u fenfire/TODO-loom:1.42 fenfire/TODO-loom:1.43
--- fenfire/TODO-loom:1.42      Thu Mar 13 14:03:46 2003
+++ fenfire/TODO-loom   Thu Mar 13 15:34:23 2003
@@ -15,9 +15,6 @@
     - sane sizes for the windows (main, Properties,
       Go to URL) at startup
 
-    - README update to explain property selection
-      and the View menu
-
 later (or now if somebody wants to):
 
     - clip instead of truncate text
Index: fenfire/build.xml
diff -u fenfire/build.xml:1.11 fenfire/build.xml:1.12
--- fenfire/build.xml:1.11      Wed Mar 12 14:22:31 2003
+++ fenfire/build.xml   Thu Mar 13 15:34:23 2003
@@ -5,6 +5,7 @@
     <property name="src" location="${basedir}"/>
     <property name="build" location="build"/>
     <property name="dep" location="../fenfire-depends"/>
+    <property name="releasetag" value="snapshot"/>
 
     <!-- A filename can be passed to Loom at startup by
          overriding this property -->
@@ -51,7 +52,9 @@
     <target name="jar" depends="clean,fenfire,jar-only"/>
 
     <target name="jar-only">
-        <jar destfile="loom.jar">
+        <jar destfile="loom-${releasetag}.jar">
+           <fileset file="README-loom"/>
+            <fileset file="LICENSE"/>
            <fileset dir="${build}"/>
            <zipfileset src="lib/libvob.jar"/>
            <zipgroupfileset dir="${dep}" includes="*.jar"/>
@@ -61,6 +64,37 @@
            </manifest>
        </jar>
     </target>
+
+    <target name="tar">
+        <property name="reldir" value="loom-${releasetag}-src"/>
+
+        <mkdir dir="${reldir}"/>
+       <mkdir dir="${reldir}/fenfire"/>
+       <mkdir dir="${reldir}/fenfire-depends"/>
+
+       <copy file="README-loom" todir="${reldir}"/>
+       <copy file="LICENSE" todir="${reldir}"/>
+       <copy todir="${reldir}/fenfire">
+           <fileset dir=".">
+               <include name="build.xml"/>
+               <include name="org/**/*.java"/>
+               <include name="org/**/*.py"/>
+               <include name="org/**/*.test"/>
+               <include name="lib/libvob.jar"/>
+               <exclude name="org/fenfire/modules/**"/>
+           </fileset>
+       </copy>
+       <copy todir="${reldir}/fenfire-depends">
+           <fileset dir="${dep}" defaultexcludes="yes"/>
+       </copy>
+
+       <tar destfile="loom-${releasetag}-src.tar.gz" basedir="."
+            includes="${reldir}/**" compression="gzip"/>
+
+       <delete dir="${reldir}"/>
+    </target>
+
+    <target name="release" depends="jar,tar"/>
 
     <target name="clean">
         <delete dir="${build}"/>
Index: fenfire/org/fenfire/loom/Loom.java
diff -u fenfire/org/fenfire/loom/Loom.java:1.34 
fenfire/org/fenfire/loom/Loom.java:1.35
--- fenfire/org/fenfire/loom/Loom.java:1.34     Thu Mar 13 13:58:36 2003
+++ fenfire/org/fenfire/loom/Loom.java  Thu Mar 13 15:34:27 2003
@@ -204,9 +204,9 @@
        Menu mView = new Menu("View"); mBar.add(mView);
        MenuItem mGoTo = new MenuItem("Go to URI... (Ctrl-G)"); 
        mView.add(mGoTo); mView.add(new MenuItem("-"));
-       MenuItem mSimple = new /*Checkbox*/MenuItem("Simple View"); 
        MenuItem mWheel = new /*Checkbox*/MenuItem("Wheel View");
-       mView.add(mSimple); mView.add(mWheel);
+       MenuItem mSimple = new /*Checkbox*/MenuItem("Simple View"); 
+       mView.add(mWheel); mView.add(mSimple);
        mView.add(new MenuItem("-"));
        mView.add(showClassMenu);
 
@@ -236,14 +236,14 @@
                }
            });
 
-       mSimple.addActionListener(new ActionListener() {
+       mWheel.addActionListener(new ActionListener() {
                public void actionPerformed(ActionEvent _) {
                    viewcur = 0;
                    AbstractUpdateManager.chg();
                }
            });
 
-       mWheel.addActionListener(new ActionListener() {
+       mSimple.addActionListener(new ActionListener() {
                public void actionPerformed(ActionEvent _) {
                    viewcur = 1;
                    AbstractUpdateManager.chg();
@@ -353,8 +353,8 @@
                    }
                }
            };
-       views = new View[] { new SimpleView(nodeView), 
-                            new WheelView(nodeView) };
+       views = new View[] { new WheelView(nodeView), 
+                            new SimpleView(nodeView) };
        final Shower s = new Shower() {
                Screen screen;
                public void setScreen(Screen s) {
@@ -401,14 +401,16 @@
                    if(model == null) return;
 
                    if(viewcur == 0) {
-                       if(s.equals("u") || s.equals("o"))
+                       if(s.equals("i") || s.equals("Up") ||
+                          s.equals(",") || s.equals("Down")) return;
+                       if(s.equals("m") || s.equals("n") || s.equals("o"))
                            s = "Up";
-                       else if(s.equals("m") || s.equals("n") || s.equals("."))
+                       else if(s.equals("u") || s.equals("."))
                            s = "Down";
                    } else {
-                       if(s.equals("m") || s.equals("n") || s.equals("o"))
+                       if(s.equals("u") || s.equals("o"))
                            s = "Up";
-                       else if(s.equals("u") || s.equals("."))
+                       else if(s.equals("m") || s.equals("n") || s.equals("."))
                            s = "Down";
                    }