next up previous contents
Next: Documentation Isotopes Up: 6.2.3 Documentation Previous: 6.2.3 Documentation

Documentation Atoms

  All hand written documentation is divided into different documentation atoms which are combined by VMake to generate manuals. All known atoms are listed below in alphabetical order:

``about'' About...,
is a max. 30 words long plain text abstract describing the project.

``archi'' Architecture,
internal structure, package structure, components and interactions.

``bugs'' Known Bugs,
description of known bugs and limitations.

``catlist'' Category Listing,
automatically generated listing of functions, macros and variables documented in the source code.

``concept'' Concepts,
abstract concepts, central ideas, generic explanations, analogies.

``diag'' Diagnostic messages,
explanation of messages reported by the error system (see Section A.2).

``dialog'' Dialogue,
documentation of the dialogue-based interaction between user and programs of the project. Dynamical properties of the user interface.

``examples'' Examples,
examples showing the usage of libraries/programs of the project.

``exec'' Execution,
execution aspects, command line description, environment variables.

``exten'' Extension,
how to extend this project, how to add models, modification guideline.

``faq'' FAQ,
collection of frequently asked questions and their answers.

``fileio'' Input Output,
runtime file names, generic formats, file-based data flow.

``files'' Source Files,
what is where in the source code, file descriptions and comments.

``future'' Future Plans,
future plans for this project.

``history'' History,
general historical review/revision history.

``implemen'' Implementation,
implementation details (other than architecture) of the current code.

``indata'' Input Data,
data structures, input data (e.g., PIF) requirements.

``install'' Installation,
installation notes, system requirements and recommendations.

``interact'' Interaction,
interaction between this project and other parts of projects, e.g., dependent ones.

``intro'' Introduction,
a short introductory overview.

``motiv'' Motivation,
motivation of this project/tool and the associated documentation.

``outdata'' Output Data,
data structures, output data (e.g., PIF) peculiarities.

``pi'' PI,
organization of the procedural interface, concept, conventions, argument lists, user-supplied subroutines.

``ref'' Reference Entries,
automatically generated reference manual pages created from source documentation.

``refs'' References,
references, related publications and other project documentation.

``terms'' Terminology,
names, terms, and abbreviations introduced by this project.

``theory'' Theory,
algorithms, models, theory, basic equations, assumptions and simplifications.

``tutorial'' Tutorial,
how to do it, getting started, introductory example.

``ui'' User Interface,
documentation regarding the static properties of the user interface of the project, e.g., panel descriptions and their use.


next up previous contents
Next: Documentation Isotopes Up: 6.2.3 Documentation Previous: 6.2.3 Documentation

IUE WWW server
Fri Jan 3 17:00:13 MET 1997