Browse Prior Art Database

Tool to Generate OS/2 IPF Help Linkage Cross-Reference Information

IP.com Disclosure Number: IPCOM000118810D
Original Publication Date: 1997-Jul-01
Included in the Prior Art Database: 2005-Apr-01
Document File: 4 page(s) / 132K

Publishing Venue

IBM

Related People

Walters, DA: AUTHOR

Abstract

Disclosed is an OS/2* program which will extract help text linkage information from IPF files and provide sorted cross-reference information in a variety of formats. To ensure that the writer uses consistent and accurate terminology throughout the document, it is important to know where related topics are defined and how the end user may see the flow of information. Using this method, the writer can verify that all of the hypertext link phrases (defined with the IPF :LINK tag) which point to a common help section use the same terminology.

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

Tool to Generate OS/2 IPF Help Linkage Cross-Reference Information

      Disclosed is an OS/2* program which will extract help text
linkage information from IPF files and provide sorted cross-reference
information in a variety of formats.  To ensure that the writer uses
consistent and accurate terminology throughout the document, it is
important to know where related topics are defined and how the end
user may see the flow of information.  Using this method, the writer
can verify that all of the hypertext link phrases (defined with the
IPF :LINK  tag) which point to a common help section use the same
terminology.

The program can generate several types of reports:
  Heading       This format includes only information defined
                 by the IPF heading tags (:H1-:H6).  No linkage
                 information is included.  When this report is
                 sorted based on the heading title text, this
                 format is useful during testing to identify the
                 IPF source file name which contains specific
                 help text, using the product's help title text
                 as an index into the report.
                For example, this report is sorted using the
                 help's title text:

                            (Image Omitted)

                  In the above example, if the tester found an
                 error in the help section titled "Messages",
                 the tester would simply look through the report
                 to find the "Messages" title.  The tester would
                 then know the source for the help section was
                 at line 853 in the IPF source file INSTALL.IPF
  Link          This format includes all of the information from
                 the "Heading" report and also includes for each
                 heading or footnote section, the hypertext links
                 to that section.  This format is useful during
                 development to ensure that all linkage terminology
                 is consistent with the help text that it links
                 to.  It is also useful during testing to identify
                 where all of the links are defined which link to
                 a specific help or footnote section.
                For example, this report is sorted using the
                 help's title text and then the link phrases:
                

                            (Image Omitted)

IPF File
                  In the...