PAL CARD CATALOG ENTRY

SHORT DESCRIPTION

PTF templates for creating DoD-STD-2167A DID documents


MOVEMENT WITHIN THE PAL CARD CATALOG
Move to top-level taxonomy
Move to keyword list

ASSET PROFILE

UNIT NAME
DID2167A
VERSION
2
REVIEW CODE
CS(PTF); ES
INET ADDRESS
rconn @ wsmr-simtel20.army.mil
AUTHOR
Richard Conn
Ada Software Repository
RIGHTS
PUBLIC DOMAIN
COPYRIGHT
Not documented in PAL database
DATE CREATED
14 Sep 89
DATE RELEASED
15 May 90
DATE LAST UPDATED
15 May 90
LOCATION
ASR
PAL
ENVIRONMENT
N/A (requires PTF)
LIMITATIONS
Not documented in PAL database

FILE LISTING

Directory Display


languages/ada/asr/std2167a/did:
  File Name                 Size
  ---------                 ----
  did.zip                 59,134


Totals
  ==============  ==============
    1 Files               59,134

ABSTRACT

    This  system  is  a collection of templates for all the
Data  Item  Descriptors  (DIDs) documented in DoD-STD-2167A.
These  templates  are  to be edited and tailored by the user
for  his specific project.  They contain instructions to the
user,  telling  him  what  items of information to insert at
various  points  in  the  template.  The user replaces these
instructions  with  the information itself, transforming the
template  into the document.  Once the tailoring is complete
and all items required by the DID are filled in by the user,
the  user may then execute the Portable Text Formatter (PTF)
to   process   the   edited   template  into  the  formatted
deliverable  document.  The required section numbering, page
numbering, headers, table of contents, list of figures, list
of  tables, and index will be generated automatically by PTF
in the format required by the DID.

     This  system  consists  of  two  sets of files: (1) the
common  files,  which are filled in once by the user and are
then  read  by the templates during their processing by PTF,
and   (2)   the   DID   templates   themselves,  where  each
DoD-STD-2167A  DID  maps  to  one of the DID templates.  The
common  files  provide  information, such as the name of the
system,  an  overview of the system, and a list of acronyms,
which  are  needed by all or most of the DID templates.  The
common  files eliminate duplication of effort on the part of
the user by putting information needed by one or more DID in
a common location that can be read by the template.  The DID
templates  contain  all the PTF commands and instructions to
the  user  for  their use.  The user instructions are always
enclosed  in  square  brackets  ([]), and, as the user works
with  a  template,  he  can read the instructions, input the
required  information, and then delete everything within the
square  brackets as he goes.  The instructions in the square
brackets  are, in effect, replaced by the information of the
DID   itself.    In   some  cases,  the  DID  templates  are
stand-alone;  the  user  does  not  need  to  refer  to  the
DoD-STD-2167A DID to fill out the template.  In other cases,
the  DID  template  refers to the DoD-STD-2167A DID for more
information.

     The  documentation  provided  with  this  system  is  a
Software  User's  Manual  (DID DI-MCCR-80019A) and a Version
Description    Document    (DID    DI-MCCR-80013A).     This
documentation  was  prepared  as  outlined  above  from  the
respective  DID  templates  and provides a living example of
this  system  in  action.   Other examples of this system in
action  can be found in the Ada Software Repository (ASR) in
the    Proposed   MIL-HDBK-1804   documents   and   in   the
documentation for the Portable Text Formatter (PTF).

     This   system   represents  an  interpretation  of  the
DoD-STD-2167A  document  and its DIDs, and, while great care
was  taken  to  be correct, errors may have been introduced.
Please  report  any such errors to the Manager, Ada Software
Repository.   This  system  is a project of the Ada Software
Repository  activity  at  White Sands and is not necessarily
endorsed  by  the  United States Department of Defense as an
official representation of DoD-STD-2167A.


REVISION HISTORY

DATE         VERSION	AUTHOR                  HISTORY
14 Sep 89       1    Richard Conn            Initial Release
15 May 90       2    Richard Conn            Added PCR


RELEASE NOTICE

This prologue must be included in all copies of this software.

This software is released to the Ada community.
This software is released to the Public Domain (note:
  software released to the Public Domain is not subject
  to copyright protection).
Restrictions on use or distribution:  NONE


DISCLAIMER

This software and its documentation are provided "AS IS" and
without any expressed or implied warranties whatsoever.
No warranties as to performance, merchantability, or fitness
for a particular purpose exist.

Because of the diversity of conditions and hardware under
which this software may be used, no warranty of fitness for
a particular purpose is offered.  The user is advised to
test the software thoroughly before relying on it.  The user
must assume the entire risk and liability of using this
software.

In no event shall any person or organization of people be
held responsible for any direct, indirect, consequential
or inconsequential damages or lost profits.