The hypermanual presently has just one homepage, which serves equally for authors and for clients (to the extent that there are any). It is located as
html://www.ida.liu.se/labs/rkllab/people/erisa/hymalac/index.htmlLocally (in IDA's SUN system for research) the access path is
/info/www/labs/rkllab/people/erisa/hymalac/index.htmlThe directory containing that index file will be called the home directory of the hypermanual.
The Hymalac homepage contains a table of contents which is divided into chapters. Some of the chapters are divided into several parts called divisions; others are undivided from the point of view of the table of contents in the homepage. An undivided chapter is at the same time a division.
Each division (that is, part of a chapter or whole chapter) has a unique mnemonic name. For example, the present text is a division whose mnemonic name is [dirsit]. (The square brackets are not part of the name, but are often used to distinguish a mnemonic name from surrounding text). It is intended that parts of the hypermanual shall primarily be referred to by the mnemonic name of a division.
Implementationwise, each division is realized either as an HTML file or as a postscript file generated from Latex. In the former case it is called the main page of the division, in the latter case it is called the main text of the division. Each division has its own directory in the file system. Within that directory, the default name for a main page is index.html, and the default name for a main text is main.ps. If there is an associated reference page, it is called main.html.
The division directory may be located at any of the participating sites for the Hypermanual. More about this in the next section below.
For each division, there is also a key page containing administrative information about the division, such as who is responsible for its contents, what is the site of the division's directory, and so on. The key page for a division with the name [div] is always located in Hymalac's home directory at IDA, with the file name div.html. Key pages are always in HTML format.
Main pages will in turn usually contain references to substructures which it owns. These substructures may be both .html files and .ps files; in some cases also other files. In any case they shall be stored in the division's own directory, unless there are very specific reasons for the contrary.
The following sites are presently supporting the Hypermanual. For each cite we specify the general name, the URL, and the local access path for the site's main directory (explained below).
Linkoping html://www.ida.liu.se/labs/rkllab/people/erisa/hymalac/ /info/www/labs/rkllab/people/erisa/hymalac/(more to be added...)
Each participating site has a main directory for Hymalac purposes. When a division resides at a certain site, then it is stored as a subdirectory immediately below the main Hymalac directory of that site. In the case of IDA, the home directory (indicated above) is at the same time IDA's main directory.
In some cases it is desirable to attribute a separate mnemonic name to a subdivision, that is, to a part of a division. Subdivisions are then named in the obvious hierarchical fashion, using the equality sign as the separator. For example, if the present division called [dirsit] were to have two subdivisions, there names might have been [dirsit=struc] and [dirsit=sites]. A sub-sub-division might have been called [dirsit=sites=auxiliary].
Notice that the division/subdivision structure is in principle independent of the physical directory structure in the computer systems. Divisions/subdivisions are only used for referring to the contents of the Hypermanual on the reader's level, for example, if reference is made in the text of another article. It is intended that divisions/subdivisions shall persist over time, although they may be moved between sites, and although also it is likely that more divisions are added and existing ones have their contents modified. It is therefore quite possible to keep the materials for a subdivision in the same directory as its superior main division; it is also possible to create a separate directory for the subdivision.
As explained in [orghyp], one of the basic principles of the Hypermanual organization is that it should be possible to follow the text and the structure on paper printouts as well as on the screen. It is therefore strongly recommended that cross-references between parts of the text are made in such a way that the presented text (screen and paper) shows the mnemonic name for a division (with possible subdivision components), and at the same time it contains a web link to that very division or subdivision. Clicking on the reference brings you there when browsing; the presentation of the division name makes it possible to follow the structure in the paper printouts.
The reference at the beginning of the previous paragraph is an example of this principle. In browsing mode it is possible to click on [orghyp] and be switched to the division in question; in paper reading mode one looks up the pages of paper labelled with the division name [orghyp].