Pliant talk forum

Pliant talk forum

Discussion: Navigation

Navigation within a site is a major issue.
Navigation within a documentation site is a fundamental issue.
Message posted by maybe pom on 2002/05/07 08:12:05
After some time of reflexion (say 3 years), I eventually reached some
(I think) nice and general architecture for site navigation.

The naviagtion scheme I propose is based on a database coding, but database
information declarations will be fully embedded in dynamic pages.

It is based on a "Topic Map"-like princip: we document some topics, and topics
are related by somme relations (associations). Each relation has some incoming
topics and some outgoing ones.

A declaration could have the follwing syntax:

topic "pointer" "Pointers"
   from "/keyword/addressof" key "addressof:syntax"
   from "/subjects/language/base" "Basics" key "3"
   to "/subjects/language/objects" "Manipulating objects" key "2b"

Which means that the current page belongs to three relations. The title attributed
to these relations will be "addressof" (end of path, because no specific title
given), "Basics" and "Manipulating objects".
Navigation presentation will split the relations into two kinds: incoming out
outgoing ones.
For each incoming relation, the topics which are going to the relation will be
gathered in a sub part "Up" in key order, those coming from the relation will
be gathered in a sub part "Related".

For each outgoing relation, the topics which are coming from the relation will be
gathered in a sub part "Down" in key order, those going to the relation will
be gathered in a sub part "Related".

So, the previous example would lead to a presentation like:

addressof                     Manipulating Objects
  Up ...                         Down ...
     ...                              ...
  Related ...                    Related ...
    ....                              ....

  Up ...
  Related ...

It could also be possible to embed links to relations themselves; for instance,
clicking on "addressof" could lead to a page like


Up ...

Down ...
  Pointers (syntax)

the (syntax) part being obtained by the part of the key after ":"


In such a context, links between pages are obtained from indications within
the two pages: no more direct "link" exist, only "half-links"...
Message posted by maybe Marcus on 2002/05/07 14:49:59
Gumptious Patrice.

In case you have already implemented this scheme, I wonder if you could
prepare a sample, i.e., a couple of tiny .page files which uses this navigation
scheme, for us to better understand your idea.
Message posted by maybe pom on 2002/05/07 17:35:55
It is not yet implementing, but will probably be quite soon.
The main idea is to consider the documentation has a set of
"cards" linked togather with some associations.
The navigation would then be a way to go from one card to another through