/[fenfire]/fenfire/README-loom
ViewVC logotype

Diff of /fenfire/README-loom

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.4 by benja, Mon Mar 10 19:44:01 2003 UTC revision 1.5 by benja, Thu Mar 13 20:34:16 2003 UTC
# Line 14  to anything else. However, Loom can also Line 14  to anything else. However, Loom can also
14  when the first release is complete, we will move it into  when the first release is complete, we will move it into
15  an independent project at Savannah.nongnu.org.  an independent project at Savannah.nongnu.org.
16    
17    Please send comments about this software to::
18    
19        gzz-dev@nongnu.org
20    
21    If you would like to subscribe to that mailing list,
22    please go to <http://mail.nongnu.org/mailman/listinfo/gzz-dev>.
23    
24  Currently Loom is only a browser, but we're working on  Currently Loom is only a browser, but we're working on
25  making it a full RDF editor.  making it a full RDF editor.
26    
# Line 22  License Line 29  License
29  =======  =======
30    
31  Fenfire Loom is released under the GNU Lesser General  Fenfire Loom is released under the GNU Lesser General
32  Public License (LGPL). For details, see file LICENSE.  Public License (LGPL). For details, see file ``LICENSE``.
33    
34    
35  How to install  How to run
36  ==============  ==========
37    
38  To compile Loom, you will need a Java VM and Apache Ant  Launching Loom
39  <http://ant.apache.org/> installed. You will need to check out  --------------
 both the ``fenfire`` and the ``fenfire-depends`` CVS module  
 in the same directory::  
40    
41    cvs -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/fenfire login  If you have downloaded and unzipped the precompiled version,
42    cvs -z3 -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/fenfire co fenfire  you can run Loom by typing::
   cvs -z3 -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/fenfire co fenfire-depends  
43    
44  To compile and run the test suite, just cd into the ``fenfire/``      java -jar loom.jar
 directory and type ``ant``. To compile only, use ``ant compile``;  
 to only run the tests, use ``ant test``.  
45    
46    You can also pass an RDF file on the command line::
47    
48  How to run      java -jar loom.jar data.rdf
 ==========  
49    
50  To start the browser, type::  Alternatively, some systems may launch Loom automatically
51    if you click on the jar.
52    
53      ant run  Two windows should appear, one entitled "Fenfire Loom"
54    (this is the main window) and one entitled "Properties"
55    (this contains a list of all properties in the graph).
56    
 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...)  
57    
58  Alternatively, you can pass an RDF file on the command line::  Getting started
59    ---------------
60    
61      ant run -Dfile=foo.rdf  To open an RDF file, just choose "File/Open...".
62    
63  When you've opened a file, you'll be taken to a random node  When you've opened a file, you'll be taken to a random node
64  in the RDF graph. The nodes connected to it will be shown  in the RDF graph. The nodes connected to it will be shown
65  left and right from it. Above each connected node, the  left and right from it. Above each connected node, the
66  property through which the nodes are connected is shown.  property through which the nodes are connected is shown.
67    
68  You may have to resize your window, the nodes are  If you know the URI of a node you want to start browsing at,
69  quite large at the moment.  choose "View/Go to URI..." or hit ``Ctrl-G``.
70    You will be prompted to enter the URI.
71    
72    The node in the center of the screen is called the
73    'focus.' The nodes directly left and right of the
74    focus are called the 'selected nodes.' The focus
75    and the selected nodes are shown with a blue border.
76    
77  Moving around  Left clicking on a resource will move on it
78  -------------  and left clicking on a literal will
   
 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  
79  select it (so that it's directly right of the focus).  select it (so that it's directly right of the focus).
80  Right clicking on either a literal or a resource  Right clicking on either a literal or a resource
81  will select it (this is useful when you have  will select it (this is useful when you have
82  a large number of connected nodes and need to scroll).  a large number of connected nodes and need to scroll).
83    
84    Changing the selected nodes is called "rotating" because
85    it rotates the other nodes around the focus.
86    
 The wheel view  
 --------------  
87    
88  There are two views, the 'simple' and the 'wheel' view,  View options
89  which you can switch between using the PgUp/PgDown keys.  ------------
90    
91    The view you have seen so far is called the *wheel view*
92    because it places nodes on a circle around the focus,
93    giving the impression of a wheel. There is a second view
94    called the *simple view*, which you can access from the
95    View menu. It simply shows the nodes as a long vertical list.
96    
97    You have already noticed the Properties window. An
98    RDF property is only shown in the main window if it is
99    selected in the Properties window. By switching properties
100    on and off you can create different views of an RDF graph.
101    
102    The 'View' menu has a submenu entitled 'Show Graph.'
103    In this menu, there is another submenu for every class
104    in the RDF graph (a resource is considered a class
105    if it is the object of an ``rdf:type`` statement).
106    
107    If you click on a class, another submenu with a list
108    of properties appears. In this menu, you can choose
109    a property connecting an instance of a class to the
110    name of that instance; for example, you could choose
111    ``rss:title`` for a RDF Site Summary ``rss:item``,
112    or ``vcard:FN`` (full name) for a ``vcard:internet``
113    virtual business card. RSS item nodes will then
114    be shown as contain their title instead of their URI,
115    and ``vcard:internet`` instances will be shown
116    containing their owner's full name.
117    
118    All these view options are inconvenient to set up
119    each time you open an RDF graph. In a future release,
120    you will be able to save your view options as RDF,
121    either within an RDF graph or externally in another file.
122    
123    
124    Using the keyboard
125    ------------------
126    
127    You can also navigate an RDF graph using the keyboard.
128    Use ``j`` and ``l`` to move to the selected node
129    left or right of the focus, respectively. Use
130    ``u`` and ``n`` to select the nodes above and below
131    the left selected node, respectively; use ``o`` and ``.``
132    to select the nodes above and below the right
133    selected node, respectively.
134    
135    Using the keyboard is faster than using the mouse,
136    but may require a bit of getting used to.
137    
138    
139    How to compile
140    ==============
141    
142    To compile Loom, you will need a Java VM and Apache Ant
143    <http://ant.apache.org/> installed. You can either
144    download the source distribution of Fenfire Loom,
145    or you can get the newest bleeding-edge version
146    from CVS (see below).
147    
148    In either case, you will have two directories
149    called ``fenfire/`` and ``fenfire-depends/``.
150    To compile, cd into ``fenfire/`` and just type::
151    
152        ant
153    
154    This will compile the code and run the test suite.
155    You can also only compile (``ant compile``) or
156    only run the tests (``ant run``).
157    
158    After compilation, you can run Loom by typing::
159    
160        ant run
161    
162    You can also pass an RDF file like this::
163    
164        ant run -Dfile=data.rdf
165    
166    
167    Getting the bleeding-edge version from CVS
168    ------------------------------------------
169    
170    You will need to check out both the ``fenfire``
171    and the ``fenfire-depends`` CVS module
172    from the same directory::
173    
174      cvs -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/fenfire login
175      cvs -z3 -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/fenfire co fenfire
176      cvs -z3 -d:pserver:anoncvs@subversions.gnu.org:/cvsroot/fenfire co fenfire-depends
177    
178  In the wheel view, using Up/Down can be confusing  To update your checked out copy, run the following command
179  when moving to the left, since Up seems to move down  both in your ``fenfire/`` and ``fenfire-depends/`` directories::
 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.  
180    
181  These may seem strange at first, but seem to work    cvs up -dP
 really well. (We'll continue to experiment, though.)  
182    
183    
184  Directory structure  Directory structure
185  ===================  -------------------
186    
187  - ``org.fenfire.loom`` contains all Loom classes and tests.  - ``org.fenfire.loom`` contains all Loom classes and tests.
188  - ``org.fenfire.test`` contains the test framework (Jython-based).  - ``org.fenfire.test`` contains the test framework (Jython-based).
189    - ``lib/libvob.jar`` is a dependency on another Fenfire-related
190      project, libvob, which is currently being prepared for its first
191      public release. See <http://savannah.nongnu.org/projects/libvob>.
192    
193    
194  Homepage and mailing lists  Homepage and mailing lists

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.5

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26