Browse Prior Art Database

Algorithm for a Documentation Publishing System Preprocessor

IP.com Disclosure Number: IPCOM000110308D
Original Publication Date: 1992-Nov-01
Included in the Prior Art Database: 2005-Mar-25
Document File: 2 page(s) / 94K

Publishing Venue

IBM

Related People

Amundsen, LC: AUTHOR

Abstract

The algorithm described in this article eliminates the need to create and maintain duplicate source material when producing common documentation using BookMaster* and Information Presentation Facility (IPF) software, thus reducing documentation costs by up to a factor of 2. A BOOKMASTER AND INFORMATION PRESENTATION FACILITY PREPROCESSOR

This text was extracted from an ASCII text file.
This is the abbreviated version, containing approximately 52% of the total text.

Algorithm for a Documentation Publishing System Preprocessor

       The algorithm described in this article eliminates the
need to create and maintain duplicate source material when producing
common documentation using BookMaster* and Information Presentation
Facility (IPF) software, thus reducing documentation costs by up to a
factor of 2.
A BOOKMASTER AND INFORMATION PRESENTATION FACILITY PREPROCESSOR

      Today's requirement of having software and hardware
documentation available in many formats has led to increased
challenges for Information Developers.  Documentation for products
running on multiple platforms, and documentation delivered in both
traditional hardcopy and the newer online form, often requires
multiple versions of the same source material.  This is because
different publishing systems for different platforms often require
drastically different source preparation and format.  This duplicate
source is more costly to develop and maintain than if common source
were used.

      This disclosure describes a preprocessing algorithm that can be
used on source material before using publishing software to build the
final documentation.  Using this algorithm eliminates the need for
duplicate source when generating hardcopy information using
BookMaster and duplicate online information using IPF.
THE ALGORITHM

      The approach used is to accept source material in BookMaster
format and to convert it into IPF format using the following
algorithm for each element in the BookMaster source file:
    CASE TEXT
    Copy text from the input file to the output file unchanged.
    CASE TAG - SIMPLE REPLACEMENT
    When acceptable equivalent tags exist in both BookMaster and IPF,
conversion only involves a simple replacement of the tag.  For
example, when a :xph. tag is encountered in the input file, it is
simply replaced with an IPF equivalent, such as an :hp1. tag. CASE
TAG - DELETE
    When no acceptable equivalent tags exist in both BookMaster and
IPF, and any loss of tag...