EDIS Internal Naming and Structuring Conventions

Directories

• All EDIS material resides in one directory tree `edis/'.
• Each system document resides in its own subdirectory, together with related files. The name of the subdirectory equals or resembles the system name.
• All system subdirectories reside in the subdirectory tree `edis/sys/'.
• EDIS meta-material resides in `edis/'. Examples are: intro.html, guide.html, bibl.html, index.html.
• Some other EDIS material is collected in separate subdirectories under `edis' (to be elaborated).
• All released directories are world searchable and readable.

Files

General

• All HTML documents adhere, as much as possible, to the HTML 2.0 Standard. This allows for consistent browsing, even with text-only browsers.
• All internal links in EDIS, that is, from EDIS documents to other EDIS documents, are explicit and relative. That is, they never refer to index.html with HREF=".../" (but always with HREF=".../index.html") and they never refer to file.html with HREF="http://.../file.html" or HREF="/.../file.html".
  This makes EDIS an independent subweb, which is convenient when EDIS is accessed locally (through `file:', rather than `http:'), e.g. if you have a copy of EDIS on your own machine, possibly without Internet access.
• All xfig figures are available in three formats: *.fig, *.gif and *.x2.gif, where *.x2.gif is a 200% enlarged version of *.gif (for zooming). All *.gif have a transparent background color. All *.gif included in documents are accompanied by links to *.x2.gif (zoom) and *.fig (xfig).
• All released files are world readable.
• There is a distributed cross reference generated by SWAN. For each HTML document file.html there is cross reference in .file.html (that is, with a prefixed dot). The cross reference enables one to traverse the internal hyperlinks towards the original document in reverse direction. Currently, there is no direct link from a document to its cross reference. The cross reference is primarily intented as an aid for maintaining EDIS.

System documents

• Each system document is called `index.html' (sitting in its own subdirectory).
• It has the following sections (HTML anchor names appear in parentheses; useful in case you want to link directly to such a section):
  • Specifications (spec)
  • Properties (prop)
  • Implementations (impl)
  • Generalizations (gen)
  • Miscellaneous (misc)
  • References (ref)
• The connection diagram resides in files `cd.*'.
• The state graph resides in files `sg.*'.
• The connection diagrams of (relevant) implementations reside in files `impl-n.*'. The number n corresponds to the item number in the implementation list of `index.html'.
• At the bottom of the document is a trailer with links to general EDIS pages (introduction, guide, search, bibliography, index, feedback).

Last modified at Mon Oct 26 16:02:45 1998