|
|
The Documentation Directory StructureDOC-GEN-3$Revision: 1.8 $ |
Purpose of this document
This document defines the directory structure for the http served web pages. The purpose of this document is to define a suitable directory structure to allow automatic updating of web pages on release and installation of new software.
The Documentation Manager is responsible for defining the Document ID and ensuring that the required directory structures exist. During document installation the Manager will update the document catalogue (if required).
The Document ID has the following format <name1>-<name2>-<idnumber>.
name1 consists of a 3 character string using the ASCII character set a-z.
name2 consists of a character string using the ASCII character set a-z.
idnumber is an character string composed of an integer number in the range of 1-9999.
The total Document ID text string length will not exceed the maximum length of a file name under the following operating systems:
All filenames and directories will be in lower-case ASCII as an aid to portability of web-pages.
The directory structure for the docs directory follows from the Document ID for example this
document DOC-GEN-3 resides in the directory :-
~docs/doc/gen/doc-gen-3/
and the file has the document name doc-gen-3.html
All associated files attached to the html document are in the same directory. This will allow relative links to be made in a consistent manner. ie to link to the document DOC-STY-3 the relative directory is defined as ../../sty/doc-sty-3/doc-sty-3.html from this document as both documents are in the ~docs/doc directory.
The absolute location of the file at ING is http://www.ing.iac.es/~docs/doc/sty/doc-sty-3/doc-sty-3.html
Where multiple versions of a document are required to be served online then the directory structure will include the version number. For example the document INS-DAS-29 Version 3.1 the relative path is defined as ../../../ins/das/ins-das-29-3-1 from this document and the file retains the name ins-das-29.html and resides in that directory.
The absolute path definition for the file is http://www.ing.iac.es/~docs/ins/das/ins-das-29-3-1/ins-das-29.html
A symbolic link will be created to link the latest version directory to the standard version directory. To access the latest version of this document then http://www.ing.iac.es/~docs/ins/das/ins-das-29/ins-das-29.html is specified and no changes required to other existing documentation which have hyper-links to the INS-DAS-29 document.
This directory structure allows for a simple script to be used during software installation to install a new web-page and update the document catalogue.