Browse Prior Art Database

CHECKREF: Method for Effectively Identifying IBM Bookmaster Document Markup Language Coding Errors

IP.com Disclosure Number: IPCOM000111151D
Original Publication Date: 1994-Feb-01
Included in the Prior Art Database: 2005-Mar-26

Publishing Venue

IBM

Related People

Huai-Teh Tai, W: AUTHOR

Abstract

Writers who use IBM BookMaster document markup language often use symbols and cross-references in their documents to improve usability, maintainability, and information retrievability. However, using symbols and cross-references can introduce errors that are not easily detected until much later.

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

CHECKREF: Method for Effectively Identifying IBM Bookmaster Document
Markup Language Coding Errors

      Writers who use IBM BookMaster document markup language often
use symbols and cross-references in their documents to improve
usability, maintainability, and information retrievability.  However,
using symbols and cross-references can introduce errors that are not
easily detected until much later.

      This disclosure presents a new method for quickly and
effectively identifying undefined and miscoded symbols and
cross-references within documents.  This method is used in a set of
VM/CMS-based tools and data files called CHECKREF.  The following
diagram shows how CHECKREF is used:

      CHECKREF can be used by writers to examine BookMaster source
files for certain coding errors.  CHECKREF can be used to:

      o   Verify changes made to the source files of a book.  Changes
          made by other writers occasionally introduce errors that go
          unnoticed by the writer printing the book.  Thus, a writer
          can correct any coding errors before formatting and
          printing the book, resulting in a significant savings of
          time and resources that are wasted when a book containing
          errors is printed.

      o   Verify that all source files are being properly embedded;
          the "File imbed trace"  section of the analysis report file
          indicates whether a file is included during the formatting
          process.  For example, should a writer rename the book
          source files, the book would not require reformatting to
          determine if all source files have been renamed and if all
          file imbed macros (.IM, .SETUP) in the parent file have
          been updated.

      o   Identify known symbols which do not resolve on a specific
          type of device, such as a PostScript printer or display
          terminal.

            The overall advantage in using CHECKREF is a significant
      savings in time and resources while virtually eliminating
      symbol and cross-referencing coding errors in the final
      document.  As a result, more of the writer's focus shifts away
      from such minor coding errors to more important issues such as
      technical content and usability.

            Writers use symbols and tags in BookMaster source files
      to create special characters, aliases (or synonyms), and
      cross-references in the final processed document.  However, the
      definition of a symbol is not enforced during the creation and
      editing of the document source file.  A document composed of
      several files would likely have a symbol or tag definition in
      one file and a reference to the symbol or tag in...