# "@(#) $Id: UserManual.txt,v 1.38 2004/01/13 08:55:01 vltsccm Exp $"

Each module containing one or more ESO dictionaries must contain:
  * a config directory, containing one or more dictionaries
  * a src directory, with the Makefile. The Makefile merely
    contains an "install" target, which installs the dictionary under
    $INTROOT/config or $VLTROOT/config, depending on whether or not
    the environment variable INTROOT is defined. It also establishes
    a symbolic link from $INS_ROOT to this dictionary, if the
    environment variable INS_ROOT exists.
  * a Changelog file, which contains a description (added manually)
    of the changes.

The Makefile will install this module's dictionary/-ies (which are
located under ../config) into $INTROOT/config or $VLTROOT/config. It 
will automatically append the version-number of the dictionary to the
filename, and also establish a symbolic link from the filename-without-
version to the filename-with-version. The version number is taken from
the configuration control software.
If the variable INS_ROOT is defined, it will also create a symbolic
link from $(INS_ROOT)/SYSTEM/Dictionary/<dictionary> to 
$(VLTROOT)/config/<dictionary-with-version>
for each <dictionary> located under ../config. The Makefile must be
run on a system with the VLT Common SW installed, as it relies on
the VLT Standards (see Makefile(5) for more).
 
Example:
  Consider the PAF dictionary ESO-VLT-DIC.PAF, module name dicPAF,
  version 1.2
      $ setenv INTROOT myINTROOT
      $ cd dicPAF/src
      $ make clean install INS_ROOT=myInsRoot
  will install the dictionary as $myINTROOT/config/ESO-VLT-DIC.PAF-1.2,
  create under $myINTROOT/config a symbolic link from ESO-VLT-DIC.PAF 
  to ESO-VLT-DIC.PAF-1.2, and also establish a symbolic link from 
  $myInsRoot/SYSTEM/Dictionary/ESO-VLT-DIC.PAF
  to myINTROOT/config/ESO-VLT-DIC.PAF-1.2

Remark that in the top-part of the dictionary, there is some
manual edition required for "Revision" (format XX.YY) and "Date"
(ISO format: YYYY-MM-DD), at least if we stick with these formats
(versus the $Revision: 1.38 $ and $Date: 2004/01/13 08:55:01 $ RCS-keywords which get
updated automatically). At this stage we do not yet consider some
script to take care of that (or a target in the Makefile).

Remark also that simply changing the "Status" of the dictionary 
from "submitted" to "released" means of course an increase in
version number.