% $Id: README_DES,v 1.1.6.1 2002/04/24 03:25:23 erik Exp $================================================================================                                 README_DES================================================================================This file describes how to create a detailed design document using a set of templates.A design document has the parts shown in the table below.  Brackets [] indicate that a part is optional.  In the filenames, "comp" refers to thecomponent or library that the whole design document describes.   Components are often broken up into separate "classes" or modules, which are typically segregated into separate files.  Several classes or modulesmay be included in a single design document.The structure of the design document accommodates the specification ofmultiple language interfaces.  For now, only Fortran templates are actually included.--------------------------------------------------------------------------------Part		Template File      Description--------------------------------------------------------------------------------document	<comp>_desdoc.tex  Document shell, includes review statussynopsis        <comp>_syn.tex	   Brief description of the software                                    function [algorithms]    <comp>_alg.tex	   Description of the continuous and discrete                                   scientific algorithms expressed in the softwarerequirements	<comp>_req.tex	   Scientific and computational requirements[architecture]  <comp>_arch.tex    Description of the computational                                    architecture, including layering strategy                                    and major internal components and classesclass           class_desc.tex     Short summary of class function descriptionclass           class_design.tex   Class design strategy, including class design                             definition and class restrictionsclass           class_def.tex      Description of the class data structure.definitionclass           class_rest.tes     List of class restrictions due to designrestrictions                       or implementation strategiesfortran files   prologue.F         Code headers instrumented for                                   ProTeX; not included in the document but                                    used to create itfparameters     class_fparam.tex   Fortran flags and parameters, if anyfapi            class_fapi.tex     Fortran application program interface;                                   this file should be generated from the                                   prologue.F template using ProTeX[fexamples]     class_fex.tex      Fortran examples[c/c++ files]   prologue.c         Code headers instrumented for                                   ProTeX; not included in the document but                                    used to create it[cparameters]   class_cparam.tex   C/C++ flags and enum types, if any[capi]          class_capi.tex     C/C++ application program interface;                                   this file should be generated using ProTeX[cexamples]     class_cex.tex      C/C++ examples[glossary]      <comp>_glos.tex	   Definitions, acronyms, abbreviations[references]    <comp>_ref.bib     References--------------------------------------------------------------------------------To create a new design document, fill in the template files, duplicating and renaming the class files for each class in your component.  In <comp>_desdoc.tex, be sure to comment out the \input of any files you aren't including and specify the \input filenames of files that you are including.Process prologue files for each class or module using ProTeX:	do_fprotex <class> <prologue.F[90]>		Here <prologue.F[90]> is the name of the Fortran file with the         instrumented headers.        This script will produce a LaTeX file called <class>_fapi.tex.Build a dvi file from LaTeX documents:	do_latex <comp> desProduce an html version of the documentation:	do_l2h <comp> desThe html files are placed in a directory called <comp>_desdoc.The dvipdf tool can be used to produce a pdf:	dvipdf <comp>_desdoc.dvi================================================================================C. DeLuca (cdeluca@ucar.edu)                                      March 13, 2000