Navsquare Guide

Gilles Lamiral

$Id: navsquare-guide.en.sgml,v 1.2 2001/01/29 06:32:25 gilles Exp $
A guide document for navsquare.

Documentation index

You can find the latest release of this document, written by Gilles Lamiral, located at:

This document, written in SGML, may be available in several formats: ASCII TeX SGML PostScript HTML HTM PDF Info LyX man

1. Licence

This software is under the GPL, the GNU Public License Version 2, in order to avoid to be oust from it but I really doubt a commercial enterprise can be interested one day. See the gpl document.

Navsquare can use wwwtable which is not under the GPL license. See the file wwwtable.txt in the wwwtable distribution.

Navsquare use freetable, by default, which is under the GPL license. Thanks to Tomasz Węgrzanowski

2. What's new ?

Read the CHANGELOG file.

3. What is it ?

NavSquare is just a web tool to generate navigation squares. A navigation square is like a navigation bar except it displays information in two dimensions instead of one.

Informations are :

    - where you are.
    - where you're from.
    - where you can go.

Navquare allows to consctuct a hierachical web site and maintain a coherent navigation tool on each page.

4. What do you need ?

5. Bugs

No known bug. Any unknown bug may be corrected when found and sent to the author.

6. To Do:

See the TODO file.

7. How to use it ?

navquare recursively goes down through the directory where you run it. it searches for files named ".myname". Those files contain an alternative name of the directory where they are. If the ".myname" file does not exist then the directory will not be shown in the square.

So before running, you have to create the ".myname" files in each directory you want to see the navigation square.

The script does this job for you. Just run it from the top directory you want to add recursive navsqares.

The following commands are safe since they deal whit STDOUT:

     $ navsquare --help
     $ navsquare
     $ navsquare --nohtml

Be carefull when you use --ouput=index.html because it will change the index.html files, if they are already present.

See an example in the test/ directory