README.maintenance, 2005.0124
=============================

Although the FSW mechanized documentation suite attempts to "figure out"
things on its own, some configuration files still need to be edited from
time to time.  Here is a summary:

  .../web/FSW_demos.shtml

    This is edited by Mark Arndt whenever he has new demos to announce.

  .../web/e_etc/ddf.yml

    In general, modifications to the production scripts and configuration
    files will not require changes to this file.  Adding or removing a
    script will force changes, however, as will adding or removing a file
    (set), either globally or for a single script.

    The semantics of ddf.yml and #DDF entries are intertwined in a rather
    complex fashion, far beyond my ability to document here.  Save copies,
    make changes carefully, and then inspect the results.  See the ddf_y2d
    code, if need be, for clues about the meaning of error messages.

  .../web/e_etc/glossary.yml

    This gets updated whenever someone suggests a new term or a correction.

  .../web/e_etc/latdocs.yml

    When bin/latdocs_y2h encounters an unrecognized document in LATDocs,
    produced by an FSW-related author, it generates a prototype entry for
    the document.  This entry can be pasted into e_etc/latdocs.yml, then
    edited.  Two forms of editing are commonly needed:

      *  Acronyms in the title will not have correct capitalization.
      *  A "Category" will need to be added.

  .../web/e_etc/package.yml

    Whenever Tony creates a new Package, various scripts will start putting
    nastygrams in the run log, of the form:

      ? r_pkg->{Package}{FOO}{expansion} undefined

    Add an entry for the Package, in the format used for its neighbors.  It
    may be possible to glean the description of the package from the source
    files, but the resulting entry should be confirmed by Tony.

  .../web/e_etc/personnel.yml

    Whenever someone joins or leaves the group, this file should be updated.
    In practice, this requires bugging the person (or possibly a manager) for
    the needed information.

See also: e_etc/README