PAL CARD CATALOG ENTRY

SHORT DESCRIPTION

Portable Text Formatter with contents and index


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

ASSET PROFILE

UNIT NAME
PTF
VERSION
1.2
REVIEW CODE
CS (IBM PC/IntegrAda; IBM PC/Meridian; Sun/Verdix Ada; VAX/DEC Ada); ES; C1 1.0 B
DDN ADDRESS
conn@wuarchive.wustl.edu
AUTHOR
Richard Conn
RIGHTS
PUBLIC DOMAIN
COPYRIGHT
None
DATE CREATED
24 August 1989
DATE RELEASED
14 May 1990
DATE LAST UPDATED
7 May 1990
LOCATION
ASR
PAL
ENVIRONMENT
IBM PC Clone (Janus/IntegrAda, Meridian Ada)
Sun workstation (Verdix Ada)
VAX (DEC Ada)
LIMITATIONS
Not documented in PAL database
CERTIFICATION
Ada System Certifier_1 1.0
Date/Time of Processing: Monday    30 May       1994 04:48:23Pm
Overall Assessment of System: OK
Classification of System: B
Basis of Classification --
Syntax Errors                               PASS
Completeness                                PASS
Independence from External Libraries        PASS
Independence from a Specific Ada Compiler   FAIL

Explanations for failures --
System contains compiler-specific pragmas or uses Machine_Code

Number of ...
Files              15
Library Units     144
Lines           42790
Statements      11655
Comments        16689

FILE LISTING

Directory Display


languages/ada/doctools/ptf:
  File Name                 Size
  ---------                 ----
  ptf.vdd                 33,684
  ptf12.zip              178,593
  ptfdiag.zip             44,041
  ptfprint.zip             3,526

languages/ada/swcomps/csparts:
  File Name                 Size
  ---------                 ----
  csp_pc.zip             171,405
  csp_rdr.zip            110,328
  csparts.rpt              1,756
  csparts.sda              7,624
  csparts.sdf            115,442
  csparts.zip            215,195


Totals
  ==============  ==============
   10 Files              881,594

ABSTRACT

   The Portable Text Formatter (PTF) is a document formatting program,
written in Ada, which can execute on a variety of hardware platforms. 
PTF was designed to be as portable as possible, so it should run on any
platform supported by a validated Ada compiler.

   PTF reads one or more source text files which contain both commands
to PTF and text lines, and PTF generates a formatted output file and
(optionally) a file containing index entries. Commands to PTF are
placed on lines whose first character is a dot (this may be changed if
desired), and text lines are those lines whose first character is not a
dot. Commands to PTF instruct it to perform certain operations on the
formatted output file, such as set left margin, underline the following
words, place an entry into the table of contents, place an entry into
the index, and define a macro.

   PTF was designed to meet several objectives:

1. Generate DoD-STD-2167A documents.  PTF was designed specifically to
support the generation of DoD-STD-2167A documents, as detailed in the
DoD-STD-2167A Data Item Descriptors (DIDs). To this end, PTF supports
multiple page heading lines, multiple page footer lines, page numbers
in a variety of formats (including Arabic and Roman numeral),
generation of up to six distinct tables of contents (so that separate
tables for figures and diagrams may be created), and generation of an
index.

2. Support Ada software development.  PTF was written to provide a
mechanism to support other Ada software development tools, such as Ada
PDL (Program Design Language) processors. Output from these tools would
be text files containing PTF commands. Specifically, support of such
tools to process PDL as defined in MIL-HDBK-1804 is anticipated.

3. Support team development of a document.  PTF also supports team
development of a document, where individuals can be given a common set
of macros and instructions on their use, and PTF can assemble a
document in a common format from many different source files which were
independently created.

4. Provide a documentation standard for the Ada Software Repository. 
Many of the reusable documents in the Ada Software Repository will be
revised so they may be processed by PTF, and many new documents will be
released in a form that may be processed by PTF.

5. Port without modification to computer systems for which validated
Ada compilers exist.  PTF is written in Ada and has been tested on a
VAX, Sun, and PC platform in an attempt to insure portability.

   The PTF System consists of two programs: PTF and PTFIDX.  PTF is
the main word processor.  PTFIDX is a companion program to PTF which
processes its index pages.

   The file PTF.VDD contains a listing of the distribution of PTF, an
installation manual, and other instructions which detail how to bring
PTF up on a particular target system.  CS Parts is needed to compile
PTF and PTFIDX.


REVISION HISTORY

DATE         VERSION	AUTHOR                  HISTORY
24 August 89   1.0   Richard Conn            Initial Release
February 1990  1.1   Richard Conn            Internal Update
7 May 1990     1.2   Richard Conn            Update
17 June 1993   1.2   Richard Conn            Initial Release to PAL


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.
	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.