OS/2 Shareware BBS: 10 Tools/10-Tools.zip/ipfe10.zip/IPFEDIT.HLP

OS/2 Help File | 1993-08-17 | 105KB | 3,006 lines

ΓòÉΓòÉΓòÉ 1. Compiler Setup Information ΓòÉΓòÉΓòÉ

You can use this to control your IPF Compiler.  This will send the proper
commands to correctly build your online document.


ΓòÉΓòÉΓòÉ 1.1. Base Project File ΓòÉΓòÉΓòÉ

This is the name of the base project file to use when compiling projects.  It
will also be the name of the file to compile if you are not using a project
when you choose compile.  Generally, this will be automatically filled in
either with the current document file or the project base file by the IPF
Editor.  This will also be the name of the output file with the extension of
either .HLP for online help files or .INF for online document files.


ΓòÉΓòÉΓòÉ 1.2. Output View (INF) File Type ΓòÉΓòÉΓòÉ

This will cause the compiler to generate a VIEW.EXE compatible INF file.


ΓòÉΓòÉΓòÉ 1.3. Output Help (HLP) File Type ΓòÉΓòÉΓòÉ

This will cause the compiler to generate a help file that can be used with
applications that you write.


ΓòÉΓòÉΓòÉ 1.4. Display Compiler Results ΓòÉΓòÉΓòÉ

This will enable the compiler results window during the compile.


ΓòÉΓòÉΓòÉ 1.5. Generate Cross Reference ΓòÉΓòÉΓòÉ

This will cause the compiler to generate a cross-reference list of all tags
used in your document.


ΓòÉΓòÉΓòÉ 1.6. IPFC Environment ΓòÉΓòÉΓòÉ

This is the IPFC environment variable value that is required by the IPFC
Compiler.  It points to the IPFC directory in the OS/2 2.x Toolkit.  This is
filled in automatically by the IPF Editor if you have the IPFC environment
variable defined in your CONFIG.SYS.  If you don't have it predefined you will
need to fill this value with the <DRIVE>:\TOOLKT2x\IPFC directory.


ΓòÉΓòÉΓòÉ 1.7. Compiler ΓòÉΓòÉΓòÉ

Pressing this will let you locate your IPFC compiler on your disk.  If the IPFC
compiler is in your path, just press Select.  Otherwise, you will need to use
the file dialog to locate your IPFC compiler.


ΓòÉΓòÉΓòÉ 1.8. Warning Level 1 ΓòÉΓòÉΓòÉ

This will set the compiler warning level to 1.  This will return level 1 only
messages.  Level 1 messages are the most severe.  For a complete list of error
messages see the IPF Compiler Online Help "Compiler Error Messages" section.


ΓòÉΓòÉΓòÉ 1.9. Warning Level 2 ΓòÉΓòÉΓòÉ

This will set the compiler warning level to 2.  This will return level 1 and
level 2 messages.


ΓòÉΓòÉΓòÉ 1.10. Warning Level 3 ΓòÉΓòÉΓòÉ

This will set the compiler warning level to 3.  This will return all levels of
warning messages.  Level three messages are the least severe (informational).


ΓòÉΓòÉΓòÉ 2. Compiler Results Window ΓòÉΓòÉΓòÉ

This window shows you the results of your last IPF Compiler compile.  You may
scroll through the list of messages shown here.  If you see an error message (a
message that starts with "<filename:n> nnn") you may double click on it and you
will be taken directly to the error in that file and its best guess as to the
location in that file.  Be sure to save the current  file you are working on,
however, before exercising this option as the current file is not saved before
switching to the new file.

The following shows how to read an error message:

    <IPFEHHLP.IPF:1> 101: Invalid Document Body.

The file and the line number containing the error is shown in the opening
brackets.  The next number (in the example 101) shows both the severity
(indicated by the one-hundred level number) and the error message index (the 01
portion).  If you look up error 101 you will see that it is an "Invalid
Document Body" message.


ΓòÉΓòÉΓòÉ 3. File Open Information ΓòÉΓòÉΓòÉ

This shows a list of the last twenty files that you have edited.  If you are
working on a project it will contain the files that are associated with the
project to make it easier to keep track of them and access them.

If you are using the project mode you will also see file icons at the bottom of
the IPF Editor display.  You can select any file in your project by clicking
once on the file icon.  If there are more files in your project than will fit
in the display the scroll bar at the bottom of the IPF Editor will let you
scroll through the list of file icons.


ΓòÉΓòÉΓòÉ 3.1. Previously Edited Files ΓòÉΓòÉΓòÉ

This shows files that you have previously edited or that are in the current
project.  To use this just click once on the desired file and then select the
Open pushbutton or double click on the file name.


ΓòÉΓòÉΓòÉ 3.2. File List Information ΓòÉΓòÉΓòÉ

This will cause the standard OS/2 File Open dialog box to appear.  From that
you may select any IPF file that you wish to open.


ΓòÉΓòÉΓòÉ 4. Panel Headers for HyperLinking Dialog ΓòÉΓòÉΓòÉ

The Panel Headers for Hyperlinking contains a list of all of the panel headers
that have been created in the current file or project and may be hyperlinked
to.

Use this to select panel headers to hyperlink text or graphics to.  This is
only brought up when you choose the "Hypertext/Graphics link" command.  You may
hyperlink to the same panel from multiple text locations (i.e. from you may
mark different sections of text and link them to the same panel header).

Note:  You will probably want to use the "Application Generate
       Auto-hypertext/graphics links" menu item to generate all hypertext links.


ΓòÉΓòÉΓòÉ 4.1. Panel Headers for HyperLinking List ΓòÉΓòÉΓòÉ

The Panel Headers for HyperLinking list contains a list of all of the panel
headers scanned in from your document.  This list is only shown as a result of
selecting the hypertext/graphics link command.  You may double click the left
mouse button on a panel header or click once on the desired item and then click
on the "Select" push button.


ΓòÉΓòÉΓòÉ 5. Panel Header List Information ΓòÉΓòÉΓòÉ

This shows a list of panel definitions that may be used to define panel header
names and res codes. These panel definitions are generated from the C include
files you load in using the "Application Load definition include file."  If you
have not loaded an include file this list will be empty.


ΓòÉΓòÉΓòÉ 5.1. Panel Header Name List Usage ΓòÉΓòÉΓòÉ

Select the definition you want to use for a panel header name. You may click
once on the panel header name and then select the "Select" push button or you
may double-click on the desired panel header name.  If a definition has an IPF
file name before the definition name, as shown below, the definition has
already been used for a  panel header and should not be used again.

    <<FILE1.IPF>> IDD_SAMPLE_DIALOG


ΓòÉΓòÉΓòÉ 5.2. Panel Header Name Select ΓòÉΓòÉΓòÉ

Use this to select the panel header definition currently highlighted.  You can
also double click on the panel header definition name directly.


ΓòÉΓòÉΓòÉ 5.3. Panel Header Name Cancel ΓòÉΓòÉΓòÉ

Use this to cancel the panel heading creation.


ΓòÉΓòÉΓòÉ 5.4. Panel Header Name Create ΓòÉΓòÉΓòÉ

Selecting this will let you enter in a new panel heading definition for panels
that you wish to create that don't have pre-defined definitions.  Generally
this would be used if you are creating on-line documentation where there is no
C program's source code containing these definitions.  You might also use this
if you are creating on-line help for your application and you wish to include a
footnote or other entry that isn't directly tied to your application.


ΓòÉΓòÉΓòÉ 6. Application Menu Information ΓòÉΓòÉΓòÉ

This menu allows you to automatically create the resource, include, and C
Source code file required to add help to your application.  It also let's you
select an existing include file to use as definitions for header statements.


ΓòÉΓòÉΓòÉ 6.1. Create Help Resource Tables Information ΓòÉΓòÉΓòÉ

This will create all of the files you need to add Help support to your C
program.  You must also have a 32 bit C Compiler such IBM's C Set/2 and the
resource compiler included with the IBM OS/2 2.0 Toolkit.

When you select this option the following steps will occur:

The IPF Editor will ask you for the name of an include file to use as the basis
for generating panel definitions (typically this is the include file containing
your C #define statements used when you defined your menus).  It will then scan
this file and extract from it your menu, dialog, and dialog control
definitions.  You can only select groups of files located in the same
directory.

Next you will be asked for the name of the resource file to be generated to
hold the help resource statements required to add help to your application.
This file should NOT be the same as your primary resource file containing menu
and/or dialog statements.

The IPF Editor will now attempt to scan the main resource files for your
application.  It will read the menu, dialog, and dialog control statements and
extract the definition labels for each control.  If you are building help for a
large project it is desirable to create a separate directory and copy all of
the resource files from each module into it.  It may also ask you for the
application resource ID value (the value assigned to the applications menu,
acceltable, or icon statements in the resource file) if it is unable to find a
MENU table to extract it from in the first resource file scanned.  Just select
the appropriate ID value from the list displayed and that  value will be used.

The IPF Editor will ask you for the name of the include file to create for use
in your application and in your resource file.  This will contain all of your
panel definitions for your help files.

The IPF Editor next will ask you for the name of the C Source Code file to
generate.  This file will contain several functions that you may call from your
C application.  You may either compile and link this file  into your
application or create a Dynamic Link Library and link it in that way.  Note:
No prototypes are generated for these functions.  It is up to you to create the
prototypes required and use them in your source code.

The following functions are available:

   - HelpInit

     Call this after you have created your main window for your application.
     This will activate the help system with your applications help files.

   - HelpDestroyInstance

     This will remove the help system and should be called before you exit your
     program.  If you do not call this before exiting OS/2 will automatically
     deassociate the help instance from your application (since your
     application no longer exists).

   - HelpProcessMessages

     Call this from your main window function for the following messages:

      o WM_ACTIVATE

      o WM_INITMENU

      o WM_COMMAND

      o HM_ERROR

      o HM_GENERAL_HELP_UNDEFINED

      o HM_HELPSUBITEM_NOT_FOUND

The following table shows the functions generated, their arguments, and their
purpose:

ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéFunction            ΓöéDescription              ΓöéArguments                Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéHelpInit            ΓöéThis intiializes the helpΓöéHWND hwndFrame - Owner ofΓöé
Γöé                    Γöésystem and sets the help Γöéhelp instance.           Γöé
Γöé                    Γöéinstance to your         Γöé                         Γöé
Γöé                    Γöéapplication help         Γöé                         Γöé
Γöé                    Γöédocument.                Γöé                         Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéHelpDestroyInstance ΓöéThis removes the help    ΓöéNo Arguments.            Γöé
Γöé                    Γöéinstance.  This will     Γöé                         Γöé
Γöé                    Γöéallow you to set a new   Γöé                         Γöé
Γöé                    Γöéhelp instance or you may Γöé                         Γöé
Γöé                    Γöécall this before  your   Γöé                         Γöé
Γöé                    Γöéprogram exits.           Γöé                         Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéProcessHelpMessages ΓöéThis will process        ΓöéHWND hwnd, USHORT msg,   Γöé
Γöé                    ΓöéWM_ACTIVATE, WM_INITMENU,ΓöéMPARAM mp1, MPARAM mp2 - Γöé
Γöé                    Γöéand WM_COMMAND messages  ΓöéStandard window procedureΓöé
Γöé                    Γöéand process help related Γöéarguments.               Γöé
Γöé                    Γöéportions of these        Γöé                         Γöé
Γöé                    Γöémessages.                Γöé                         Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ

The following limitations exist (per project) when creating application help
resource files:

o 1 Primary Menu

  The first MENU statement found is the one used.  Any following MENU
  statements are ignored. Generally, applications have a menu used in the menu
  bar, and some may have a pop-up menu containing a sub-set of the regular
  menu.  The IPF Editor will generate help resource files that will provide
  help for both menus automatically.

o 256 Menu Item

o 4096 Panel Definition Names from Include Files

  Include files contain base ID code and definition and are automatically
  converted to PANEL_xxxx statements as required by your tagged document(s).

o 128 Dialog boxes

o 32 Controls per dialog box

o 32 Include Files (containing definitions for dialog and menu items)

General Rules for easily creating help for your applications:

o Always create all dialog boxes using individual resource ID values.

  Don't create two or more dialog boxes that have controls with the same ID's
  in them.  Also avoid creating controls or dialogs with resource ID's the same
  as Menu ID's.

o Adding Headers

  If you wish to add headers to a project that has already been loaded always
  save the file, then reload the project before using the Application Generate
  Resource Option.  This allows the IPF Editor to accurately scan all files
  that have been modified before building the help related files.

o Scanning Include Files

  Be sure to scan the include files before trying to add headers as it will
  automatically create header panel ID's for you.  If you try to generate a
  header and no panel ID's are are available,  you have not yet scanned an
  include file.

o Help Menu Items

  The following help menu items are automatically generated in the C source
  file:

   - IDM_HELP_USING

   - IDM_HELP_INDEX

   - IDM_HELP_CONTENTS

   - IDM_HELP_GENERAL

  To take advantage of the code generated to process these messages you must
  define them in an include file.  You must also create the appropriate menu
  item statements in your applications menu resource statement.  If you do not
  want to handle these in your application comment them out of the C source
  file generated.

Warning: You must define one panel as PANEL_MAIN so that the application can
correctly initialize the help manager.  The PANEL_MAIN is the general help
displayed when the user presses F1 with no menu or dialog selected.


ΓòÉΓòÉΓòÉ 6.2. Load Definition File ΓòÉΓòÉΓòÉ

This will scan a C include file and extract all of the definition labels
defined in it.  These may then be used for header references when creating
online help documents.  You may select more than one include file to scan as
long as they all reside in the same directory.


ΓòÉΓòÉΓòÉ 6.3. Generate Auto-Hypertext Links ΓòÉΓòÉΓòÉ

This will scan the current file for any words that match previously defined
headings in any file in the current project.  It will then insert the
appropriate hypertext link command.  Matches are based on the heading name
matching exactly (not counting case) text in the file.  If the text being
linked ends with an 'S' (as in a plural version of the word) the 'S' will be
included in the hypertext link.  No marking is required for this function to
work.


ΓòÉΓòÉΓòÉ 6.4. Application Generation Control Panel ΓòÉΓòÉΓòÉ

This control panel lets you select which file names you wish to change when
generating help resource files for use with your C program.  You can select any
of the check-boxes shown to mark which file names you wish to reselect during
the generation process.  If you select Start Generation without selecting any
check-boxes the IPF Editor will automatically generate all files without any
further input from you (If you have filled in these values from a previous
generation).


ΓòÉΓòÉΓòÉ 6.4.1. C Include Files ΓòÉΓòÉΓòÉ

This lets you select the C include (.h) file to scan for definition statements
used as headers in your help file document.  This is the same as the
Application Load definition include file function but must be filled in
correctly for the auto table generation to work.  You should select any include
file that contains "#define" statements that are used in menu or dialog
definitions.


ΓòÉΓòÉΓòÉ 6.4.2. C Include Files List ΓòÉΓòÉΓòÉ

This contains a list of C Include files that will be scanned for definition
statements that may be used in your help document.  These files are used to
correctly generate the help tables.  All include files must reside in the same
directory.


ΓòÉΓòÉΓòÉ 6.4.3. C Resource Files ΓòÉΓòÉΓòÉ

Mark this to let you select your resource files containing menu and dialog
definition statements.


ΓòÉΓòÉΓòÉ 6.4.4. C Resource File List ΓòÉΓòÉΓòÉ

This contains the resource (RC)  file(s) that will be scanned for MENU, DIALOG,
and other related resource file statements.  The help panel definitions are
built from these files.


ΓòÉΓòÉΓòÉ 6.4.5. C Panel IncludeFile ΓòÉΓòÉΓòÉ

Selecting this lets you specify the C Include (.H) file to generate containing
panel definitions for use with the help resource file.


ΓòÉΓòÉΓòÉ 6.4.6. C Panel Include File Selected ΓòÉΓòÉΓòÉ

This shows the currently selected C Include file that will be generated and
contain the panel definitions for use with the help resource table being
generated.


ΓòÉΓòÉΓòÉ 6.4.7. Help Resource File ΓòÉΓòÉΓòÉ

Selecting this lets you set the name of the RC (resource) file to generate
containing the help resource tables.


ΓòÉΓòÉΓòÉ 6.4.8. Help Resource File Name ΓòÉΓòÉΓòÉ

This contains the name of the RC (resource) file to generate.  This resource
file contains the HELP table statements that will be used in your resource
file.


ΓòÉΓòÉΓòÉ 6.4.9. C Source File ΓòÉΓòÉΓòÉ

Selecting this option lets you choose the name of the C language source code
file you want to generate.


ΓòÉΓòÉΓòÉ 6.4.10. C Source File Selected ΓòÉΓòÉΓòÉ

This shows the currently selected name for the C Source code file to generate.


ΓòÉΓòÉΓòÉ 6.4.11. Start Generation ΓòÉΓòÉΓòÉ

This will being the generation of the help resource files.


ΓòÉΓòÉΓòÉ 6.4.12. Generate Panels From RC File ΓòÉΓòÉΓòÉ

Using this will let you select a resource (.RC) file to generate panel headers
from.  It will automatically scan the RC file and determine what headers are
needed to generate complete help for your application.

All header resources will be generated in separate files, and added to the
current project file.  You may find this function easier to use using the File
Create Project menu item.


ΓòÉΓòÉΓòÉ 7. Compiler Menu Information ΓòÉΓòÉΓòÉ

This menu provides you with the ability to compile your IPF Documentation
files.  You must have the IBM OS/2 2.0 Toolkit IPF Compiler (IPFC.EXE) to
actually compile and the IPF Editor will ask you to locate the IPFE.EXE program
on your drive (typically in the \TOOLKT2x\OS2BIN directory).


ΓòÉΓòÉΓòÉ 7.1. Compile Document File ΓòÉΓòÉΓòÉ

Use this to compile the current file you are editing.  This is useful for
testing whether or not the current file has any problems.  If this file is part
of a project. you can compile it for debugging  by adding :userdoc. and
:euserdoc. statements surrounding the document.  Generally, however, you will
want to use the Compile Project command to build the project documentation
completely.


ΓòÉΓòÉΓòÉ 7.2. Compile Project ΓòÉΓòÉΓòÉ

This will compile all files in a project and generate the file (either .HLP or
.INF) that will you can use with either your application (if developing a .HLP
file) or the VIEW.EXE program supplied with OS/2 2.0.


ΓòÉΓòÉΓòÉ 7.3. Test Document ΓòÉΓòÉΓòÉ

This will let you test your online documentation file.  It will attempt to run
VIEW.EXE and have it display your document.  This will not work with
Application Help documents.


ΓòÉΓòÉΓòÉ 7.4. Show Compiler Results ΓòÉΓòÉΓòÉ

This will toggle displaying compiler results in the compiler results window.
Compiler results will be displayed when you enable this menu option.

The compiler results are taken directly from the IPFC compiler.  For
explanations of the results displayed see the IPF Compiler documentation.

When looking at the compiler results you may see errors.  You may double click
on the error and you will be taken immediately to the file containing the
problem and at the appropriate line number.


ΓòÉΓòÉΓòÉ 8. Edit Menu Information ΓòÉΓòÉΓòÉ

These menu options allow you to undo mistakes,  cut, copy, and paste marked
text.


ΓòÉΓòÉΓòÉ 8.1. Edit Undo Information ΓòÉΓòÉΓòÉ

This will let you restore the last change you made to the document if you
change your mind.


ΓòÉΓòÉΓòÉ 8.2. Edit Cut Information ΓòÉΓòÉΓòÉ

Use this to cut marked text out of the current document and place them in the
OS/2 system clipboard.  You can also use the Shift Del key to cut text out and
place it in the clipboard.  Text cut this way and placed in the clipboard may
be pasted back into any application that supports the clipboard paste command.


ΓòÉΓòÉΓòÉ 8.3. Edit Copy Information ΓòÉΓòÉΓòÉ

Use this to copy marked text from the current document and place it in the OS/2
system clipboard.  You can also use the Ctrl-Ins key combination to copy marked
text into the clipboard buffer.  Text copied this way and placed in the
clipboard may be pasted back into any application that supports the clipboard
paste command.


ΓòÉΓòÉΓòÉ 8.4. Edit Paste Information ΓòÉΓòÉΓòÉ

Use this option to paste the contents of the clipboard into the current
document at the current cursor location.  You can also use the Shift-Ins
keyboard combination.


ΓòÉΓòÉΓòÉ 9. File Menu ΓòÉΓòÉΓòÉ

The file menu option contains commands that allow you to create new IPF files,
edit existing IPF files, merge IPF files together, and create projects.  It
also lets you print IPF files and import text files so that they are compatible
with the IPF file format.


ΓòÉΓòÉΓòÉ 9.1. File New ΓòÉΓòÉΓòÉ

The File New command allows you to create new IPF files for editing.  The
current file (if any) is erased from the editing window and the cursor is reset
to the top of the list.

If you are not in project mode you will be asked if you want to use the
standard online document template.  If you say yes, the IPF Editor will
automatically provide you a template for creating a single file online
document, complete with the initial panel header required by all online
documents.

If you are in project mode you will be asked whether you want to add the new
file you are creating to the current project.  If you say no a new file will
not be created.  If you say yes an empty file will be added to the current
project (it will have the title "Untitled.ipf").  You must use the "File Save
As" menu option to save the file to the project permanently.

If you wish to quit working on the current project and create a new document
use the "File Reset (clear) project" menu option.


ΓòÉΓòÉΓòÉ 9.2. File Open ΓòÉΓòÉΓòÉ

The File Open command allows you to edit existing IPF files.  You may either
select a file from the list of previously opened files or from the standard
OS/2 File Dialog box.  To create a new file select the File New command.

If you are using a project the list of files will contain those currently part
of the project.  Alternatively, you may wish to use the file icons below the
editing window to select project files.


ΓòÉΓòÉΓòÉ 9.3. File Merge ΓòÉΓòÉΓòÉ

The File Merge command allows you to merge an IPF file into the current file
beginning at the current cursor location.  Any text following the current
cursor location is pushed back to immediately following the merged text.

Note:  You should only merge IPF files.  Do not merge text files as they may
       not be compatible with the IPF editor.


ΓòÉΓòÉΓòÉ 9.4. File Select Project ΓòÉΓòÉΓòÉ

The Select Project menu option allows you to select an existing project to work
on.  This will replace the current project if one is already selected.
Projects may be created using the File Create Project menu option.  Only one
project may be opened at one time.  Each project contains a list of active
files, base file,


ΓòÉΓòÉΓòÉ 9.5. File Create Project ΓòÉΓòÉΓòÉ

The  Create Project option allows you to select IPF files to group together
into a single project to produce either a .INF or .HLP file.


ΓòÉΓòÉΓòÉ 9.6. File Create Base File ΓòÉΓòÉΓòÉ

This option allows you to create a base file that all chapters/sections of your
documentation will be merged into when you compile your document.  This file
has the same extension as other help source files (.IPF).

Note:  You  do not need to use this option if you are using a project since the
base file creation is automatic.


ΓòÉΓòÉΓòÉ 9.7. File Reset Project ΓòÉΓòÉΓòÉ

This removes the current project from memory.  It will not be removed from the
disk.  The IPF Editor will no longer be in project editing mode (therefore
project related functions such as Compiler Compile Project, Create Base File,
etc. will be disabled).


ΓòÉΓòÉΓòÉ 9.8. File Import Word Processing/text File ΓòÉΓòÉΓòÉ

Use this to read in an ASCII text or WordPerfect file and convert all colons to
&colon. and make other required adjustments to ease the conversion.  Future
revisions of the IPF Editor may directly read other word processing files.


ΓòÉΓòÉΓòÉ 9.9. File Save ΓòÉΓòÉΓòÉ

This lets you save the file you are editing.  If this option isn't available
you haven't made any changes to the file.  Information will be saved to the
current file name supplied. If the current file is "Untitled.ipf" you will not
be able to use this option.

Note:  To save it to a different file name use the File Save As menu option.


ΓòÉΓòÉΓòÉ 9.10. File Save As ΓòÉΓòÉΓòÉ

This option prompts you to select the directory and file name to save the
current file. If the selected file already exists the file will be overwritten.
If the current file hasn't been altered this option will not be available.


ΓòÉΓòÉΓòÉ 9.11. File Print ΓòÉΓòÉΓòÉ

This option will let you print the current file to your printer.


ΓòÉΓòÉΓòÉ 9.12. File Quit ΓòÉΓòÉΓòÉ

This allows you to exit the IPF Editor.  If you have made changes to your
document but haven't saved them you will be warned that you should save the
changes before quitting.

You will also be asked whether you want to save the current IPF Editor
settings. These include the position of the IPF Editor window, various options
(such as requiring tag names, autosave features, etc.), and the last 30 files
you have edited list.  See Options Save Options Preferences for more details.


ΓòÉΓòÉΓòÉ 9.13. Project Definitions ΓòÉΓòÉΓòÉ

Projects are groups of files that are all part of the same help or online
document. Typically projects consist of IPF files set up so that there is one
IPF help file per chapter or section of the application.  This help file was
setup to have each sub-menu in a separate IPF file.

Projects require a base file that will be generated automatically by the IPF
Editor.  Each base file contains .im statements that imbed (or include) each
IPF file.


ΓòÉΓòÉΓòÉ 9.14. IPF File Format ΓòÉΓòÉΓòÉ

The IPF file format requires that the text file contain straight ASCII
characters (extended characters are OK).


ΓòÉΓòÉΓòÉ 9.15. Import File Type Selection ΓòÉΓòÉΓòÉ

This dialog allows you to select the type of file you are about to import.
Currently, ASCII text and WordPerfect 4.2, 5.0, and 5.1 are supported.  Use the
5.0 option to import WP 4.2 options.


ΓòÉΓòÉΓòÉ 9.16. Importing WordPerfect 5.0 ΓòÉΓòÉΓòÉ

This will read a WordPerfect 5.0 for DOS or OS/2 file and import it into the
IPF Editor.  Many of the WordPerfect text markings will be converted to IPF
tags.  If your WordPerfect document has a table of contents each TOC entry will
create a new panel in the IPF file(s) created.

Note:  If the file is larger than 60,000 bytes it will be split into several
different files automatically.


ΓòÉΓòÉΓòÉ 9.17. Importing WordPerfect 5.1 ΓòÉΓòÉΓòÉ

This will read a WordPerfect 5.1 for DOS or Windows file and import it into the
IPF Editor.  Many of the WordPerfect text markings will be converted to IPF
tags.  If your WordPerfect document has a table of contents each TOC entry will
create a new panel in the IPF file(s) created.

Note:  If the file is larger than 60,000 bytes it will be split into several
different files automatically.


ΓòÉΓòÉΓòÉ 9.18. Importing ASCII ΓòÉΓòÉΓòÉ

This sets the current import file type to ASCII.  ASCII files have the colons
replaced with &colon.. No other changes to the file are made.

Note:  If the file is larger than 60,000 bytes it will be split into several
different files automatically.


ΓòÉΓòÉΓòÉ 9.19. Import Start ΓòÉΓòÉΓòÉ

This starts the import file operation.  From here you will be taken to the file
selection dialog where you can select the actual file to import.


ΓòÉΓòÉΓòÉ 9.20. Import Cancel ΓòÉΓòÉΓòÉ

This allows you to cancel the current import file operation.


ΓòÉΓòÉΓòÉ 9.21. File Create Project Dialog Help ΓòÉΓòÉΓòÉ

Use this dialog to create new projects.  It will allow you to quickly and
easily create projects for either online help or online documents.

Note:  Remember, the base file name is also the name of the output file with
the extension of either .HLP for online help files or .INF for online document
files.


ΓòÉΓòÉΓòÉ 9.21.1. Selected Files List ΓòÉΓòÉΓòÉ

This list contains the files that are currently included in the project.  You
can add IPF files to the project using the "Select Existing IPF Files" or
"Generate IPF from RC" push buttons.


ΓòÉΓòÉΓòÉ 9.21.2. Select Existing IPF Files ΓòÉΓòÉΓòÉ

Use this to bring up a standard file dialog box to select existing IPF files to
add to your project.


ΓòÉΓòÉΓòÉ 9.21.3. Generate IPF from RC ΓòÉΓòÉΓòÉ

Use this to scan application resource (.RC) files to generate IPF files
including Panel Headers.  This is the fastest way to create new online help
projects.  The created files will be placed in the Selected Files list.


ΓòÉΓòÉΓòÉ 9.21.4. Project Base File ΓòÉΓòÉΓòÉ

This contains the name of the project base file.  This file is used to hold the
basic IPF Tag commands required for IPF documents/online help files.  It also
includes all of the IPF imbed statements linking your IPF files to the current
project.

Note:  This will also be the name of the output file with the extension of
either .HLP for online help files or .INF for online document files.


ΓòÉΓòÉΓòÉ 9.21.5. Select Base File Name ΓòÉΓòÉΓòÉ

Use this to select an existing base file for use with your project.  If you
want to create a new base file name it is easier to just enter the new name in
the Project Base File entry field.  This will also be the name of the output
file with the extension of either .HLP for online help files or .INF for online
document files.


ΓòÉΓòÉΓòÉ 9.21.6. Project Type Online Help ΓòÉΓòÉΓòÉ

Select this radio button to generate online help for your applications.


ΓòÉΓòÉΓòÉ 9.21.7. Project Type Online Documentation ΓòÉΓòÉΓòÉ

Select this radio button to generate online documentation.


ΓòÉΓòÉΓòÉ 9.21.8. Project Title ΓòÉΓòÉΓòÉ

Enter a description of your project here.  If you are creating an online
documentation project this will also appear as the title of the document when
examined with the VIEW.EXE program.


ΓòÉΓòÉΓòÉ 9.21.9. Project Creation Save ΓòÉΓòÉΓòÉ

Select this to create your project.


ΓòÉΓòÉΓòÉ 9.21.10. Project Creation Cancel ΓòÉΓòÉΓòÉ

Select this to cancel project creation.


ΓòÉΓòÉΓòÉ 9.22. Print Setup Help ΓòÉΓòÉΓòÉ

Use this dialog to set up your printer for printing the current file.


ΓòÉΓòÉΓòÉ 9.22.1. Select Print Queue List ΓòÉΓòÉΓòÉ

Select the print queue to print to.


ΓòÉΓòÉΓòÉ 9.22.2. Copies Entry Field ΓòÉΓòÉΓòÉ

Enter the number of copies to print in this field.  The default is one copy.


ΓòÉΓòÉΓòÉ 9.22.3. Print All Files ΓòÉΓòÉΓòÉ

Select this radio button to print all of the file.


ΓòÉΓòÉΓòÉ 9.22.4. Print Marked ΓòÉΓòÉΓòÉ

Select this radio button to print the marked text (marked with the mouse).


ΓòÉΓòÉΓòÉ 9.22.5. Raw Output ΓòÉΓòÉΓòÉ

Select this radio button to print the IPF tags as well as the text.


ΓòÉΓòÉΓòÉ 9.22.6. Print Setup Print ΓòÉΓòÉΓòÉ

Select this to print the file


ΓòÉΓòÉΓòÉ 9.22.7. Print Cancel ΓòÉΓòÉΓòÉ

Select this to cancel the print operation


ΓòÉΓòÉΓòÉ 9.22.8. Print Preview ΓòÉΓòÉΓòÉ

Select this to preview your print before actually printing.


ΓòÉΓòÉΓòÉ 10. IPF Editor General Help ΓòÉΓòÉΓòÉ

Overview

The IPF Editor provides an easy to use method for creating both online
documentation and online help files for your applications or as stand-alone
files to use with the VIEW.EXE program provided with IBM OS/2 2.x.  For more
detailed information on using the IPF Help Editor see the tutorial and sample
projects included with this package as well as the  IBM Information
Presentation Facility Guide  (Version 2.x) and the IPF Editor Reference.

Currently there are two versions of the IPF Editor available.  The first is a
25-usage trial version with some options disabled.  The second is a registered
version that must be purchased from PCS and includes many more features,
customer support, updates to new versions, a complete tutorial, optional
printed documentation, samples, and more!

The IPF Editor IPF Commands menu provides you with a large variety of IPF tags
to choose from.  Some commands require you to mark text (high-light it) before
selecting the command.  If an IPF command is not available it is because it
requires marked text to operate correctly.  Use your mouse to mark the desired
text, then select the tagging command you want to apply to the marked text.

The following general information is available:

o Using the IPF Editor to create an Online Document (.INF) File
o Using the IPF Editor to create a Help (.HLP) File
o Project File Selection and Creation
o Graphical Tool Menu
o Registration
o Source File Size Limitations
o C Functions Created for Online Help Support
o Final Caveats


ΓòÉΓòÉΓòÉ 10.1. Using the IPF Editor to create an Online Document ΓòÉΓòÉΓòÉ

To create on online document perform the following steps:

o Enter all text that you wish to include in your document, or import text from
  a word processor.

o Mark the document using the standard IPF commands available in the IPF Editor
  or enter them manually if they are available in the IPF Guide but not
  directly supported by the IPF Editor.

o Create a project by selecting the files to include in your document using the
  Create Project.  All files must be in the same directory.

o Use the Compiler Compile Project option to generate your online document.

o Test your online document using the Compiler Test Document option.


ΓòÉΓòÉΓòÉ 10.2. Using the IPF Editor to create an Online Help File ΓòÉΓòÉΓòÉ

The IPF Editor makes creating online help for your C and C++ applications easy.
To create an online help file you must tag all panel headers, compile the IPF
files (creating a .HLP file), and add resource statements and C function calls
to your application.

To generate the resource, C source, and include files to successfully add
online help to your C application you will need to use the "Application Create
Help Resource Tables" option.  It will ask you to select several files (the
source resource files and include files), decide on names for the output files
(the resource help table file name, include file name, and C source file name),
and then it will generate those files for you.

Note:  You must also have a 32 bit C Compiler such IBM's C Set/2, C Set ++ and
the resource compiler included with the IBM OS/2 2.x Toolkit.  Use the
following list for the steps to successfully add context sensitive help to your
applications:

     Create Panels

     Each panel (a panel is one section of a online help file when - you are
     currently looking at a single panel)  in an online help file must have a
     panel header.  The panel header is created using the panel header menu
     command.  There are six level's of panel headers, but only the top four
     (1-4) are supported by the hypertext/graphics linking commands.

     Each panel header in an online help file requires a tag res number.  You
     must enable the "Options Require Tag Res" menu option to turn this res
     number generation on.  You may also wish to generate tag names for each
     panel to make it easier to keep track of panel names when creating
     hypertext/graphics links and other operations performed on panel headers.

     Each panel's tag resource number must match the resource identifier for
     the menu item, dialog item, etc. in your application.

     You can make panel definition much easier by scanning the include files
     for your application using the "Application Load definition include file"
     option.  Once you've read in those files every time you create a panel
     header (the title of the panel) the tag res number will be set to the
     resource ID number from the #define definition you select from a list of
     include file definitions.  If you've turned on the tag name option the
     #define label will automatically be used to create a "PANEL_<label>" tag
     name for the panel header.

     Then insert the ":p." (paragraph, with <ALT>-<P>) command on the line
     immediately following the panel header line and begin typing the
     description of the applications menu, menu item, dialog, or dialog item.

 Note:  General Help Creation You must define a main panel header and text to
        enable the general help (just pressing F1 with no menu's or dialog
        items selected).  Use the predefined PANEL_MAIN for the general
        information panel of your online help.

 Note:  You may also wish to see the "C Functions Created for Online Help
        Support" for an overview of what C functions are provided for your application.


ΓòÉΓòÉΓòÉ 10.2.1. C Functions Created for Online Help Support ΓòÉΓòÉΓòÉ

If you are building application help the program will automatically create the
functions you need to link into your application for initializing the help
system and for activating it when your program's window gets the focus.  For
detailed information see the Application Create Help Resource Files section.
The C Source file generated should compile with no warnings or errors.  You
must create prototypes for each function if you wish to call them from other
modules.  Briefly, the following functions are available:

 o HelpInit

   Call this after you have created your main window for your application.
   This will activate the help system with your applications help files.

 o HelpDestroyInstance

   This will remove the help system and should be called before you exit your
   program.  If you do not call this before exiting OS/2 will automatically
   disassociate the help instance from your application (since your application
   no longer exists).

 o HelpProcessMessages

   Call this from your main window function.

 Note:  This online help was created using the IPF Editor.


ΓòÉΓòÉΓòÉ 10.3. Creating Panels ΓòÉΓòÉΓòÉ

Creating panels can be done in several different ways.  You can create panels
that have tag resource identifiers, tag names, and/or tag ID's.  Which method
you use often is based on what type of document you are creating and what
information you have when you are creating the panel.

When you are creating panels you do not need to include a tag res, name, or ID
value unless you wish to hyperlink some text to the panel.

If you want to allow hyperlinking to the panel you are creating you will need
to supply a tag res code. You can force the requirement of tag res codes by
setting the "Option Require Tag Res" menu option on.

Follow these steps to create a panel (including it's panel header):

 o Enter a title for the panel (A maximum of 32 characters is allowed).

 o On the following line use the :p. (paragraph) tag by pressing <ALT>-<P>.
   Then enter the text you want to place in this panel.  You can place as many
   paragraphs, tables, pictures, or other tags as you want into the panel.

 o Now mark (highlight) the panel's title and select the panel header level you
   wish to create.  Panel headers 1 through 4 are "hyperlinkable" from
   hypertext/graphics tags.

 o Enter a tag res code (if you have that option enabled).  You can use the
   default value supplied (which will automatically be incremented each time
   you create a panel definition).


ΓòÉΓòÉΓòÉ 10.4. Project File Selection ΓòÉΓòÉΓòÉ

If you select a project file you will see file icons below the main editing
window.  You can select any file in the project by clicking on the desired file
icon.  If there are more files in your project than can be shown in the current
space available in the window, use the scroll bar at the bottom of the IPF
Editor window to scroll the file icons left or right.

You can create a project file using the "File Create Project" menu option.
Using projects greatly facilitates generation of online documents and
applicaton help.


ΓòÉΓòÉΓòÉ 10.5. Graphical Tool Menu ΓòÉΓòÉΓòÉ

The graphical tool menu at the right side of the IPF Editor window provides you
with several tools to quickly edit documents.  If the entire graphical menu
doesn't fit in your current window, you can use the scroll bar at the right
side of the IPF Editor window to view the rest of the graphical menu. The
following options are available in the graphical menu:

 The  lets you define heading level one tags (just as if you had used the IPF
 commands, Panel Headers Level 1 menu option).

 The  lets you define heading level two tags (just as if you had used the IPF
 commands, Panel Headers Level  2 menu option).

 The  lets you define heading level three tags (just as if you had used the IPF
 commands, Panel Headers Level  3 menu option).

 The  lets you insert a paragraph marker at the current location.  This is the
 same as pressing the right mouse button and releasing it while the "Paragraph"
 menu option is highlighted on the pop-up menu, or using the IPF commands,
 paragraph option.

 The  lets you mark a section of text as a table.

 The  lets you insert artwork (OS/2 bitmaps or OS/2 metafiles)  into your
 document.

 The  lets you insert a note into your document.

 The  lets you define a footnote link in your document.

 The  lets you mark an area of text as a simple list.

 The  lets you mark an area of text as an ordered list

 The  lets you mark an area of text as an unordered list

 The  lets you create an index entry.

 The  lets you mark a selection of text as a "CAUTION:" statement.

 The  lets you mark a selection of text as a "WARNING:" statement.

 The  lets you insert a special symbol into your document at the current
 location.

 The  lets you mark selected text as being aligned with the left or right side
 of a panel.

 The  lets you setup the push button controls located at the bottom of the help
 or VIEW window.

 The  lets you generate hyperlinks to other portions of your document.

 The  allows you to save the current file to disk.

 The  lets you save a new file to disk (it lets you give it a new name).

 The  lets you select a project file to work on.

 The  lets you compile the current file or project.

 The  lets you locate text in your document or project.

 To make full use of the IPF Editor you will need to have either the IBM OS/2
 2.0 or 2.1 Toolkit (which contains the IPF Compiler) or a compatible product.


ΓòÉΓòÉΓòÉ 10.6. Registration ΓòÉΓòÉΓòÉ

The IPF Editor is both a shareware and commercial product.  The shareware
version is distributed via bulletin boards and Compuserve, and gives you a
twenty-five usage trial period to test out the product. If you find it of value
you can register it and receive the full package.

You may register it by  filling out the registration/order form and sending
$95.00 U.S. to Perez Computing Services at the address written below.
Washington state residents add 7.8% sales tax.  Please use the provided form in
the file "IPFEDIT.REG" when ordering.  Sorry, no VISA or MASTERCARD orders,
please.  COD orders are available for a $5.00 charge.

     Compuserve: 70410, 2416
     Prodigy: GFKM03A

     Perez Computing Services
     4725 Monte Vista Pl.
     Mount Vernon, WA 98273

The IPF Editor has been thoroughly  tested.  If you find a problem, or have a
suggestion for a new feature, please contact PCS, attention Bill Perez,  either
through Compuserve, Prodigy, or the U.S. mail.


ΓòÉΓòÉΓòÉ 10.7. Source File Size Limitations ΓòÉΓòÉΓòÉ

There is a 60,000 byte limit to each source file that may be edited in the IPF
Editor.  You can create larger documents by using the project option and
creating multiple source files (usually one per chapter/section).  The IPF
Editor limits you to 60,000 bytes so that you will never exceed the 64K limit
on a source file imposed by the IBM IPF Compiler.


ΓòÉΓòÉΓòÉ 10.8. Final Caveats ΓòÉΓòÉΓòÉ

Special thanks for testing and debugging, and putting up with the work involved
in this, to:

 o Mario Perez III ("Gee, does it work right now?", "It sure would be nice if
   it would...", and "This isn't right, is it?")

 o Mario Perez Jr. ("That works pretty well except for..." and "Where's the
   multi-tasking?  Add a thread here...")

 o D.M.B. ("Are you done working on that program yet...")

 o D.A.B. ("I want to push the button!")

 o Brent Anderson ("Biking in mud's a lot more fun than programming...Let's
   go!")


ΓòÉΓòÉΓòÉ 10.9. Help Menu Information ΓòÉΓòÉΓòÉ

The Help Submenu provides help access as well as access to on-line references.


ΓòÉΓòÉΓòÉ 10.10. Product Information Help ΓòÉΓòÉΓòÉ

This will display product information such as version number, registration
number, how to register your IPF Editor, etc.  Remember, if you haven't
registered, your free usage of this program will expire after twenty-five trial
usages.  For your registration you will receive the latest version of the IPF
Editor as well as the information about receiving future revisions as they
become available.  You'll also get the complete application menu support
including auto-generation of hyper-text links, resource and C files creation,
etc.!


ΓòÉΓòÉΓòÉ 10.11. Help Index Information ΓòÉΓòÉΓòÉ

This will display the help index for the IPF Editor's online help.


ΓòÉΓòÉΓòÉ 10.12. General Help Information ΓòÉΓòÉΓòÉ

This will display the general help page for the IPF Editor's online help.
Selecting this is the same as pressing F1 with the focus in the editing window.


ΓòÉΓòÉΓòÉ 10.13. Using Help Information ΓòÉΓòÉΓòÉ

This will display the using help information page.  It will give you brief
instructions on how to use the help system.


ΓòÉΓòÉΓòÉ 10.14. Help Contents Information ΓòÉΓòÉΓòÉ

This will display the online help table of contents.


ΓòÉΓòÉΓòÉ 10.15. View IPF Editor Reference ΓòÉΓòÉΓòÉ

This will display the IPF Editor Reference manual using the OS/2 VIEW.EXE
program.


ΓòÉΓòÉΓòÉ 10.16. View IPFC 2.0 Reference ΓòÉΓòÉΓòÉ

This will start the VIEW.EXE program and show you the IPF 2.x Reference manual
if you have the OS/2 2.x Toolkit.  If you don't,  this option will not work.
The IPF 2.x Reference is highly recommended for answering detailed IPF
questions if you are developing online documentation. Using the IPF Editor, you
will find you do  not need to rely on it nearly as much as you would if you
were just using a standard text editor.


ΓòÉΓòÉΓòÉ 10.17. View IPFC 2.x Example ΓòÉΓòÉΓòÉ

This will start the VIEW.EXE program and show you the IPF 2.x Example
documentation if you have the OS/2 2.x Toolkit.  If you don't this option will
not work.


ΓòÉΓòÉΓòÉ 11. IPF Commands Menu Information ΓòÉΓòÉΓòÉ

This menu lets you select different tags to add to your documentation.  You can
access most of these menu options from the pop-up menu by pressing the right
mouse button while the pointer is over the document editing window or using the
graphical menu bar at the right side of the IPF Editor window.

The IPF Editor provides a majority of the IPF tag commands you will require in
everyday use.  You may, of course, use any other standard IPF tag described in
the IPF documentation even if it isn't supported directly by the IPF Editor.
Just type the commands in directly.


ΓòÉΓòÉΓòÉ 11.1. Special IPF Commands Menu ΓòÉΓòÉΓòÉ

This menu lets you access tags that are less commonly used.  You can mark the
document title, body of the document, hypertext/graphics links, etc.  Most of
the commands you would commonly use in this menu can be accessed via the pop-up
menu or the graphical menu but are here to support whichever method you find
the most convenient.


ΓòÉΓòÉΓòÉ 11.2. Title Tag Information ΓòÉΓòÉΓòÉ

This tag lets you specify the title of the document you are editing. This tag
is only valid for online documents and shouldn't be used for online help
windows.  The maximum length the title can be is 47 characters, including
spaces and blanks.

Tagging Information

 Insert this tag on a blank line following the :userdoc. tag.  The following
shows the proper usage of the :title. tag:

    :userdoc.
    :title.Using the Title Tag
    :h1 res=100.A Panel Heading
    :p.This is an example.
    :euserdoc.

If you were to compile this example it would generate an online document and
place "Using the Title Tag" in the title line of the main window.

Note:  If you are using the project option, and creating an automatic base
       file, you will never need to use this tag as it is automatically placed
       in the base IPF file.

  when you create the project.


ΓòÉΓòÉΓòÉ 11.3. User Documentation Tags Information ΓòÉΓòÉΓòÉ

These tags (:userdoc. and :euserdoc.) are placed at the beginning and ending of
your document.  These allow the IPFC compiler to correctly determine the
complete contents of your document.  The following shows a very brief sample
document that uses the user document tags:

    :userdoc.
    :body.

    ┬╖* This is a comment in an empty documentation file.

    :euserdoc.

Tagging Information

 Place the :userdoc. before any other statements in your document file and the
:euserdoc. after all the statements in your document file.  Both statements
must reside in the same file and you must not use these statements more than
once in the same document.

Note:  If you are using the project option, and creating an automatic base
       file, you won't need to use this tag as it is automatically placed in
       the base IPF file.


ΓòÉΓòÉΓòÉ 11.4. Body Tag Information ΓòÉΓòÉΓòÉ

This (:body.) marks the beginning of the text body for your IPF documentation
file.  This must be placed after the :userdoc.  tag and normally also after the
:title. tag. This must be placed before any heading tags or commands to imbed
other IPF files into your document.

Tagging Information

 Place this after the :userdoc. and :title. statements but before any heading
or imbed statements.

    :userdoc.
    :body.


    :euserdoc.

Note:  If you are using the project option, and creating an automatic base
       file, you don't need to use this tag as it is automatically placed in
       the base IPF file.


ΓòÉΓòÉΓòÉ 11.5. Comment Tag Information ΓòÉΓòÉΓòÉ

This tag (┬╖*) marks the current line as a comment (i.e. the line is ignored by
the IPFC compiler).  You can use this tag to help keep track of revisions to
the documentation and to add comments describing links to other documents, etc.

Tagging Information

 Place the cursor in the first column of any line in your document and then
select the comment tag menu item.  The tag will be inserted at that location
and line will be considered a comment and not show up in your generated
document.

    ┬╖* This is a comment.
    ┬╖* This is a second comment.

Note:  The comment tag must be placed in the first column of the line being
marked as a comment.


ΓòÉΓòÉΓòÉ 11.6. Imbed File Tag Information ΓòÉΓòÉΓòÉ

The imbed file tag (┬╖im  filename) lets you imbed (include or merge when the
document is compiled) a specific IPF document file into the current document.
Usually this command is used in a base file to include different chapters (each
located in a different file) into a single online document.

This online help was split up into separate files, one for each submenu and one
for each dialog box to make maintenance easier.

Tagging Information

 To use this option place the cursor on a blank line in your document, select
this option, then select the IPF document file to imbed.  The imbed command
looks like the following:

    :userdoc.
    :body.
    ┬╖im chapter1.ipf
    ┬╖im chapter2.ipf
    ┬╖im chapter3.ipf
    :euserdoc.

Note:  If you are using the project option, and creating an automatic base
       file, you won't need to use this tag as it is automatically placed in
       the base IPF file. If you wish to add a new file to the project use the
       "File New" command to create a new file, then either paste the new text
       into it or type it in.


ΓòÉΓòÉΓòÉ 11.7. Setup Button Controls ΓòÉΓòÉΓòÉ

This option lets you define what buttons are displayed below your help
page/online document in either the Help Window or View program.  You can select
to show the Previous, Search, Next, Index, etc. buttons in your document.

The default buttons shown (if you don't specify this command) are:

 o Online Documents

    - Previous

    - Search

    - Print

    - Index

    - Contents

    - Back

    - Forward

    - Tutorial (but only if a tutorial is available).

 o Help windows

    - Previous

    - Search

    - Print

    - Index

    - Tutorial (but only if a tutorial is available).


ΓòÉΓòÉΓòÉ 11.7.1. Push-Button Control Selection ΓòÉΓòÉΓòÉ

This dialog allows you to select which push-buttons you want activated in your
help document.


ΓòÉΓòÉΓòÉ 11.7.2. Search ΓòÉΓòÉΓòÉ

Selecting this will cause the "Search" push button to be displayed at the
bottom of the document window.


ΓòÉΓòÉΓòÉ 11.7.3. Print ΓòÉΓòÉΓòÉ

Selecting this will cause the "Print" push button to be displayed at the bottom
of the document window.


ΓòÉΓòÉΓòÉ 11.7.4. Index ΓòÉΓòÉΓòÉ

Selecting this will cause the "Index" push button to be displayed at the bottom
of the document window.


ΓòÉΓòÉΓòÉ 11.7.5. Contents ΓòÉΓòÉΓòÉ

Selecting this will cause the "Contents" push button to be displayed at the
bottom of the document window.


ΓòÉΓòÉΓòÉ 11.7.6. Esc ΓòÉΓòÉΓòÉ

Selecting this will cause the "Esc" push button to be displayed at the bottom
of the document window.


ΓòÉΓòÉΓòÉ 11.7.7. Back ΓòÉΓòÉΓòÉ

Selecting this will cause the "Back" push button to be displayed at the bottom
of the document window.


ΓòÉΓòÉΓòÉ 11.7.8. Forward ΓòÉΓòÉΓòÉ

Selecting this will cause the "Forward" push button to be displayed at the
bottom of the document window.


ΓòÉΓòÉΓòÉ 11.7.9. Page ΓòÉΓòÉΓòÉ

This will assign the control settings to the current panel heading only.


ΓòÉΓòÉΓòÉ 11.7.10. Coverpage ΓòÉΓòÉΓòÉ

This will assign the control settings to the main window (unless over-ridden by
another control button setup for a specific page (panel heading)).


ΓòÉΓòÉΓòÉ 11.7.11. Res Code Identifier ΓòÉΓòÉΓòÉ

Selecting this will let you define a res. code for push button control.


ΓòÉΓòÉΓòÉ 11.7.12. Name Identifier ΓòÉΓòÉΓòÉ

Selecting this will let you define a name identifier for the push button
control.


ΓòÉΓòÉΓòÉ 11.8. Paragraph Tag Information ΓòÉΓòÉΓòÉ

The paragraph tag (:p.) is one of the most common tags to use.  It marks the
start of a paragraph. The paragraph continues until another tag, marking either
a new paragraph or some other sectional tag (such as lists, sub-sections, or a
new panel header), is placed.  You can also use the  graphical menu item.

Tagging Information

 The paragraph tag can most easily be placed by positioning the cursor at the
beginning of a paragraph, pressing the right button, and selecting the
currently highlighted paragraph menu option.  (To speed tagging, you may wish
to just place the cursor anywhere on the first word in the paragraph, double
click with the left button, then press the right button to insert the tag).

The following shows the typical use of the paragraph tag:

    :h1 res=100.File Open Help
    :p.This menu option allows you to open files.

Note:  You may also generate the paragraph tag by pressing ALT-P.


ΓòÉΓòÉΓòÉ 11.9. Panel Header Tag Information ΓòÉΓòÉΓòÉ

The panel header tags provide you with the ability to create separate panels
for different parts of your documentation.  Each heading in your online
documentation has a panel header tag.  Panel header tags are also used to allow
hyper-text and hyper-graphic links to be made to different portions of the
document.  The IPF Editor currently supports up to 32,000 panel header tags in
a single project.

There are six levels of panel headers available.  Each panel header level
represents a different level in the table of contents.  Level one panel headers
always are displayed in the table of contents, while level two panel header are
not shown unless the the top-level panel headers are expanded.  In this online
help document, the sub-menus are all level one headers, while the menu items
themselves are level two panel headers.  Some reference panels headers are
level three or deeper headers.  It is important to remember that only panel
header levels 1 through 3 may be linked to using hypertext/graphics links.

You may have chosen to require either panel header res codes, panel header tag
names, or header tag ID's.  If you choose panel header tag names, and have
loaded a C Language Include file (using the "Load definitions include file"
menu option), you will see a list of possible definitions to use for your res
codes and name codes.

You may also use the auto-increment feature and enter your own res codes to
build a document without an external definition list.   If you are using the
pre-defined definitions the auto-increment feature is not used on the
pre-defined res number.

Panel header name codes are usually generated from the C Language Include file
when generating online help  files.  Otherwise, you may type in a name of your
choosing for the panel header being generated.  The panel name should be 32
characters or less, and have some relevance to the panel being created.

Tagging Information

 To create a panel header mark the text you want to use for the panel header
title using your mouse to select the desired text.  Then select the panel
header-level you desire from the menu (either the graphical, popup, or standard
menu).  Then choose the pre-defined definition or enter in the res number,
panel name, and tag ID as required.

Some headers may not require res, name, or tag values if they are merely part
of a document and won't be hyper-linked to.  Panels that will not be
hyperlinked to do not requires res codes.  Panel names and ID's are always
optional but you will find that panel names help you organize you documents.

The following shows a typical panel header level 1 definition:

    :h1 res=100.Panel Name
    :p.This is a panel with a panel header at level 1.


ΓòÉΓòÉΓòÉ 11.9.1. Panel Header 1 Information ΓòÉΓòÉΓòÉ

This generates a first level panel header that will show up in the documents
table of contents.

Note:  This panel header is a linkable panel header (this means that
       hypertext/graphics links may be made to this panel header).


ΓòÉΓòÉΓòÉ 11.9.2. Panel Header 2 Information ΓòÉΓòÉΓòÉ

This generates a second level panel header that will show up in the documents
table of contents.

Note:  This panel header is a linkable panel header (this means that
       hypertext/graphics links may be made to this panel header).


ΓòÉΓòÉΓòÉ 11.9.3. Panel Header 3 Information ΓòÉΓòÉΓòÉ

This generates a third level header that will show up in the documents table of
contents.

Note:  This panel header is a linkable panel header (this means that
       hypertext/graphics links may be made to this panel header).


ΓòÉΓòÉΓòÉ 11.9.4. Panel Header 4 Information ΓòÉΓòÉΓòÉ

This generates a fourth level panel header that will show up in the documents
table of contents.

Note:  This level panel header may not be linked via hypertext/graphics links.


ΓòÉΓòÉΓòÉ 11.9.5. Panel Header 5 Information ΓòÉΓòÉΓòÉ

This generates a fifth level panel header that will show up in the documents
table of contents.

Note:  This level panel header may not be linked via hypertext/graphics links.


ΓòÉΓòÉΓòÉ 11.9.6. Panel Header 6 Information ΓòÉΓòÉΓòÉ

This generates a sixth level panel header that will show up in the documents
table of contents.

Note:  This level panel header may not be linked via hypertext/graphics links.


ΓòÉΓòÉΓòÉ 11.10. Highlighting Text Tag Information ΓòÉΓòÉΓòÉ

Use these options to select different appearances for selected text.  You can
choose any of the following text formats:

 o This is an example of :hp1.
 o This is an example of :hp2.
 o This is an example of :hp3.
 o This is an example of :hp4.
 o This is an example of :hp5.
 o This is an example of :hp6.
 o This is an example of :hp7.
 o This is an example of :hp8.
 o This is an example of :hp9.

 Tagging Information

  Place the cursor at the beginning of the text to be marked and select it.
 Then choose the desired highlighting method.  A :hp1. and :eh1. (or whatever
 method you chose from 1 to 9) will be inserted into the text.


ΓòÉΓòÉΓòÉ 11.10.1. Highlighting Italics Information ΓòÉΓòÉΓòÉ

This is an example of :hp1. Italics text.

See Highlighting Tag Information for usage details.


ΓòÉΓòÉΓòÉ 11.10.2. Highlighting Bold Information ΓòÉΓòÉΓòÉ

This is an example of :hp2. bold text.

See Highlighting Tag Information for usage details.


ΓòÉΓòÉΓòÉ 11.10.3. Highlighting Bold Italics Information ΓòÉΓòÉΓòÉ

This is an example of :hp3. bold italics.

See Highlighting Tag Information for usage details.


ΓòÉΓòÉΓòÉ 11.10.4. Highlighting Blue Information ΓòÉΓòÉΓòÉ

This is an example of :hp4. blue text.

See Highlighting Tag Information for usage details.


ΓòÉΓòÉΓòÉ 11.10.5. Highlighting Underlined Information ΓòÉΓòÉΓòÉ

This is an example of :hp5. underlined text.

See Highlighting Tag Information for usage details.


ΓòÉΓòÉΓòÉ 11.10.6. Highlighting Underlined Italics Information ΓòÉΓòÉΓòÉ

This is an example of :hp6. underlined italics text.

See Highlighting Tag Information for usage details.


ΓòÉΓòÉΓòÉ 11.10.7. Highlighting Underlined Blue Information ΓòÉΓòÉΓòÉ

This is an example of :hp7. underlined blue text.

See Highlighting Tag Information for usage details.


ΓòÉΓòÉΓòÉ 11.10.8. Highlighting Red Information ΓòÉΓòÉΓòÉ

This is an example of :hp8. red text.

See Highlighting Tag Information for usage details.


ΓòÉΓòÉΓòÉ 11.10.9. Highlighting Magenta Information ΓòÉΓòÉΓòÉ

This is an example of :hp9. magenta text.

See Highlighting Tag Information for usage details.


ΓòÉΓòÉΓòÉ 11.11. Figures/Artwork Tag Information ΓòÉΓòÉΓòÉ

This menu provides you with the ability to add both figures (and captions),
bitmap graphics, and character graphics to your document.


ΓòÉΓòÉΓòÉ 11.11.1. Figure Tag Information ΓòÉΓòÉΓòÉ

The figure tags allow you to mark text as a figure that will be displayed in a
format exactly as entered.  The tags that surround figures are :fig. and :efig.

Tagging Information

 Mark the selected text to be identified as a figure using your mouse then
select the Figure Tag menu item.

The following shows the markings for a text figure:

:fig.
         A            B               C         D        E
     1  $100.00       $ -45.00        This spreadsheet shows
     2  $200.00       $ 131.15        text captured from my spreadsheet
     3  $150.00       $  22.20        program.
     4  @SUM(A1..A3)  @SUM(B1..B3)
     5
:efig.

This will look like the following in your document:


     A       B        C     D     E
   1  $100.00    $ -45.00     This spreadsheet shows
   2  $200.00    $ 131.15     text captured from my spreadsheet
   3  $150.00    $  22.20     program.
   4  @SUM(A1..A3)  @SUM(B1..B3)
   5


ΓòÉΓòÉΓòÉ 11.11.2. Figure Caption Tag Information ΓòÉΓòÉΓòÉ

This (:figcap.) allows you to add a title/caption to figures.

Tagging Information

 The pointer is placed between the :fig. and :efig. statements and then select
this option.


ΓòÉΓòÉΓòÉ 11.11.3. Character Graphics Tag Information ΓòÉΓòÉΓòÉ

These tags (:cgraphic. and :ecgraphic.) identify marked text as a character
graphic that will be displayed in the monospace system font.  A blank line is
inserted before and after the graphic.

Tagging Information

 Mark the graphic text and then select the the Character Graphics menu item.

Note:  This can be used to display the character graphics symbols that consist
of the upper 128 bytes in the ASCII table.


ΓòÉΓòÉΓòÉ 11.11.4. Artwork Tag Information ΓòÉΓòÉΓòÉ

This tag (:artwork filename.) allows you to include bitmaps and metafiles into
your document.

Tagging Information

 Place the pointer where you wish to insert the bitmap and then select the
Artwork menu item or select the  graphics menu item.  Select the bitmap to
insert from the file list, then determine alignment for the bitmap (either
left, center, right, in-line, or no alignment).

The following shows a typical bitmap displayed:

The above bitmap was loaded using the following tag:

    :artwork name='IPFEDIT.BMP' align=left.

You may wish to edit the path to the bitmap so that it doesn't include the
drive label if you plan on working on the document on several different
computers (unless each computer has the same drive/directory structure).


ΓòÉΓòÉΓòÉ 11.11.4.1. Artwork Setup ΓòÉΓòÉΓòÉ

The Artwork setup page allows you to select artwork (either bitmaps or
metafiles) for inclusion in your online document.


ΓòÉΓòÉΓòÉ 11.11.4.2. Bitmap/Metafile Name ΓòÉΓòÉΓòÉ

This field contains the name of the bitmap or metafile to include in your
document.  Normally this field is filled in when you press the Select Graphic
button but you may manually enter any bitmap or metafile name here, instead.


ΓòÉΓòÉΓòÉ 11.11.4.3. Select Graphic ΓòÉΓòÉΓòÉ

This will bring up a file dialog that will allow you to select a bitmap or
metafile for inclusion into your document.


ΓòÉΓòÉΓòÉ 11.11.4.4. Preview ΓòÉΓòÉΓòÉ

This will display the selected bitmap in a window so that you may verify you
have chosen the correct art.


ΓòÉΓòÉΓòÉ 11.11.4.5. Link Artwork ΓòÉΓòÉΓòÉ

This option is not currently supported, sorry.  Future versions will support
this option.  Please use the hypertext/graphics link to link artwork.


ΓòÉΓòÉΓòÉ 11.11.4.6. Alignment Left ΓòÉΓòÉΓòÉ

This will align the artwork at the left portion of the display.


ΓòÉΓòÉΓòÉ 11.11.4.7. Alignment Center ΓòÉΓòÉΓòÉ

This will align the artwork in the center part of the display.


ΓòÉΓòÉΓòÉ 11.11.4.8. Alignment Right ΓòÉΓòÉΓòÉ

This will align the artwork at the right portion of the display.


ΓòÉΓòÉΓòÉ 11.11.4.9. Alignment In-Line ΓòÉΓòÉΓòÉ

This will place the artwork in the middle of the line, as shown below:

The symbol, , is in the middle of this line.


ΓòÉΓòÉΓòÉ 11.11.4.10. Alignment Fit ΓòÉΓòÉΓòÉ

This will fit the artwork into the current display page (compressing or
exanding it as necessary).


ΓòÉΓòÉΓòÉ 11.11.4.11. Alignment None ΓòÉΓòÉΓòÉ

This will place the artwork at the current location and not adjust its size or
position at all.


ΓòÉΓòÉΓòÉ 11.11.4.12. Artwork Setup Save ΓòÉΓòÉΓòÉ

This will save your select artwork and insert it into your document.


ΓòÉΓòÉΓòÉ 11.12. Foreground Color Tag ΓòÉΓòÉΓòÉ

These tags (:fc=color.) lets you change the documents output color.  The color
remains set to this until the next panel header is encountered or until a new
:fc=color. command is encountered.

Tagging Information

 Place the pointer at the location where you wish to start changing the color
and then select the foreground color command from the color list.

If you wish to only change only the selected text to the specified foreground
color mark the text then select the foreground color.  The default foreground
color will be restored after the marked text.


ΓòÉΓòÉΓòÉ 11.12.1. fc=default ΓòÉΓòÉΓòÉ

This sets the current foreground text color to the default (Whatever the user
has selected for the default help information text color in the OS/2 System
Setup).  The color stays in effect until a new color is selected or until the
panel description ends.


ΓòÉΓòÉΓòÉ 11.12.2. fc=blue Information ΓòÉΓòÉΓòÉ

This sets the current foreground text color to blue.  The color stays in effect
until a new color is selected or until the panel description ends.


ΓòÉΓòÉΓòÉ 11.12.3. fc=cyan Information ΓòÉΓòÉΓòÉ

This sets the current foreground text color to cyan.  The color stays in effect
until a new color is selected or until the panel description ends.


ΓòÉΓòÉΓòÉ 11.12.4. fc=green Information ΓòÉΓòÉΓòÉ

This sets the current foreground text color to green.  The color stays in
effect until a new color is selected or until the panel description ends.


ΓòÉΓòÉΓòÉ 11.12.5. fc=neutral Information ΓòÉΓòÉΓòÉ

This sets the current foreground text color to neutral (this is the same as the
help manager background color).  The color stays in effect until a new color is
selected or until the panel description ends.


ΓòÉΓòÉΓòÉ 11.12.6. fc=yellow Information ΓòÉΓòÉΓòÉ

This sets the current foreground text color to yellow.  The color stays in
effect until a new color is selected or until the panel description ends.


ΓòÉΓòÉΓòÉ 11.13. Background Color Tag Information ΓòÉΓòÉΓòÉ

These tags (:bc=color.) lets you change the documents output background color.
The color remains set to this until the next panel is encountered or until a
new :bc=color. command is encountered.

Tagging Information

 Place the pointer at the location where you wish to start changing the text
background color and then select the background color command from the color
list.

If you wish to only change only the selected text to the specified background
color mark the text then select the background color.  The default background
color will be restored after the marked text.


ΓòÉΓòÉΓòÉ 11.13.1. bc=default Information ΓòÉΓòÉΓòÉ

This sets the current background text color to the default (Whatever the user
has selected for the default help information text color).  The color stays in
effect until a new color is selected or until the panel description ends.


ΓòÉΓòÉΓòÉ 11.13.2. bc=blue Information ΓòÉΓòÉΓòÉ

This sets the current background text color to blue.  The color stays in effect
until a new color is selected or until the panel description ends.


ΓòÉΓòÉΓòÉ 11.13.3. bc=cyan Information ΓòÉΓòÉΓòÉ

This sets the current background text color to cyan.  The color stays in effect
until a new color is selected or until the panel description ends.


ΓòÉΓòÉΓòÉ 11.13.4. bc=green Information ΓòÉΓòÉΓòÉ

This sets the current background text color to green.  The color stays in
effect until a new color is selected or until the panel description ends.


ΓòÉΓòÉΓòÉ 11.13.5. bc=neutral Information ΓòÉΓòÉΓòÉ

This sets the current background text color to neutral (this is the same as the
help manager background color).  The color stays in effect until a new color is
selected or until the panel description ends.


ΓòÉΓòÉΓòÉ 11.13.6. bc=yellow Information ΓòÉΓòÉΓòÉ

This sets the current foreground text color to yellow.  The color stays in
effect until a new color is selected or until the panel description ends.


ΓòÉΓòÉΓòÉ 11.14. Sub-Sections Menu Information ΓòÉΓòÉΓòÉ

These IPF commands allow you to mark text as notes, note paragraphs, examples,
footnotes, warnings, and tables.


ΓòÉΓòÉΓòÉ 11.14.1. Caution Information ΓòÉΓòÉΓòÉ

The Caution tag allows you to mark a section of text using the caution
attribute.

Tagging Information

 Place the pointer before the text to display as a cautionary statement, then
select the caution tag.

The following shows an example of the Caution tag:  :caution.This is an example
of the caution tag.:ecaution.

which appears as the following in your document:

CAUTION:
This is an example of the caution tag.

Note:  You  can insert a blank line after the "CAUTION:" text by starting to
       tag on a blank line above the text you wish to include in your caution tag.


ΓòÉΓòÉΓòÉ 11.14.2. Note Information ΓòÉΓòÉΓòÉ

The Note tag allows you to add a Note: line into your document.  Notes are
single lines of text preceded by the word "Note:."

Tagging Information

 Place the pointer at the beginning of the line to tag as a single line note.
Then select the note tag.

The following shows an example of the Note tag: :note.This is a note example.

which displays as shown below:

Note:  This is a note example.


ΓòÉΓòÉΓòÉ 11.14.3. Note Paragraph Information ΓòÉΓòÉΓòÉ

The Note Paragraph tag lets you create a paragraph note to your document.  This
is different from the note tag in that this allows you to mark several lines as
a note.

Below is an example of a paragraph note tag that contains several lines of
text:

    :nt.The text will wrap around and allow you to place multiple lines of text as needed to complete your note.
    :ent.

which displays as shown below:

Note:  The text will wrap around and allow you to place multiple lines of text
       as needed to complete your note.

 Note:  If you only need a single line note try the Note tag.


ΓòÉΓòÉΓòÉ 11.14.4. Footnote Information ΓòÉΓòÉΓòÉ

Use this tag to add footnotes to your document.  Footnotes cause a pop-up
window to appear with the text you place in the footnote when the user selects
a hyperlink to it.  The tag requires that you enter a tag name so that you may
use a hyperlink to the footnote.

Tagging Information

 Mark the desired text for the footnote, then select the footnote command or
use the  menu item.

The following is a sample footnote:

    :fn id=Footnote_sample.
    This is a footnote.
    :efn.

Select Footnote Sample to display the example footnote.

Note:  The footnote command itself will not do anything without a hypertext
link to activate it.


ΓòÉΓòÉΓòÉ 11.14.5. Warning Information ΓòÉΓòÉΓòÉ

This will add the Warning statement to your text.

Tagging Information

Mark the desired text then select the warning tag.

The following shows a sample tagging:

:warning.This is a warning example.:ewarning.

which looks like the following:

Warning: This is a warning example.


ΓòÉΓòÉΓòÉ 11.14.6. Example Information ΓòÉΓòÉΓòÉ

This allows you to mark text as an example.

The following shows an example of example tagging:

    :xmp.
    This is an example, showing monospaced text and indentation.
         Indented just like I typed it.
    :exmp.

which displays as follows:

    This is an example, showing monospaced text and indentation.
         Indented just like I typed it.

Note:  The text is changed to monospaced for examples automatically.


ΓòÉΓòÉΓòÉ 11.14.7. Table Information ΓòÉΓòÉΓòÉ

This lets you create tables, organized by rows and columns.  When you are asked
to specify the column size you must enter one width for each column separated
by spaces.

The table below was created using the following tags:

    :table cols='20 15'.
    :row.
    :c┬╖Column # 1, Row #1
    :c┬╖Column # 2, Row #1
    :row.
    :c┬╖Column #1, Row # 2
    :c┬╖Column #2, Row # 2
    :etable.

The following shows what the above tagging generates:

ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
ΓöéColumn # 1, Row #1  ΓöéColumn # 2, RowΓöé
Γöé                    Γöé#1             Γöé
Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
ΓöéColumn #1, Row # 2  ΓöéColumn #2, Row Γöé
Γöé                    Γöé# 2            Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö┤ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ

The entire contents of the table was selected then marked using the Sub-Section
Table command with the column sizes entered as "20 15" (signifying that the
first column is 20 characters wide and the second 15).  Then each column and
row were marked individually using the Table Row and Table Column commands.


ΓòÉΓòÉΓòÉ 11.14.7.1. Table Row Information ΓòÉΓòÉΓòÉ

This lets you mark text as the start of a new row in a table.


ΓòÉΓòÉΓòÉ 11.14.7.2. Table Column Information ΓòÉΓòÉΓòÉ

This lets you mark text as the start of a new column in a table.


ΓòÉΓòÉΓòÉ 11.15. List Menu Information ΓòÉΓòÉΓòÉ

The list sub-menu allows you to mark a variety of lists in your document.
Simple, ordered, unordered, and definition lists may be marked.  Each list may
also be marked as compact or normal depending on how you wish the list to be
displayed.

The following lists are supported:

 o Parameter Lists
 o Definition Lists
 o Ordered Lists
 o Unordered Lists
 o Simple Lists

 Tagging Information

 Mark the text to include in the list using the mouse then select the type of
 list to create.

 Note:  If you separate each item in your list with a blank line each item will
        automatically be tagged with a list item for you (:li.).


ΓòÉΓòÉΓòÉ 11.15.1. Compact Lists Information ΓòÉΓòÉΓòÉ

This attribute allows you to cause a list to be compacted (removes blank lines
between list items).  The following is a standard unordered list:

 o 101 Dalmations

 o Dumbo

 o Beauty and the Beast

 o Little Mermaid

 This is the same list, compacted:

 o 101 Dalmations
 o Dumbo
 o Beauty and the Beast
 o Little Mermaid

 Note:  You must select the compact option before marking a list since this is
 a modifier to the standard list commands.


ΓòÉΓòÉΓòÉ 11.15.2. Definition Lists Information ΓòÉΓòÉΓòÉ

This submenu lets you create definition lists.


ΓòÉΓòÉΓòÉ 11.15.2.1. Definition List Information ΓòÉΓòÉΓòÉ

The definition list tag allows you to tag selected text as a definition list.
A definition list is a list of terms and their meanings.

To make use of this you must have text tagged with the term-heading tag and
description heading tag, as well as text tagged with the term and description
tags.

The following shows the tagging for a simple definition table:

    :dl tsize=20.
    :dthd.Function Name
    :ddhd.Purpose
    :dt.ScreenErase()
    :dd.Erase the display screen
    :dt.ScreenWrite()
    :dd.Write data to screen
    :edl.

which will be displayed as:

 Function Name       Purpose

 ScreenErase()       Erase the display screen

 ScreenWrite()       Write data to screen


ΓòÉΓòÉΓòÉ 11.15.2.2. Definition Term Heading ΓòÉΓòÉΓòÉ

Use this to mark the heading describing the definition term column.


ΓòÉΓòÉΓòÉ 11.15.2.3. Definition Description Heading ΓòÉΓòÉΓòÉ

Use this to mark the heading describing the definition description column.


ΓòÉΓòÉΓòÉ 11.15.2.4. Definition Term ΓòÉΓòÉΓòÉ

This is used to mark the definition term being defined.


ΓòÉΓòÉΓòÉ 11.15.2.5. Definition Description ΓòÉΓòÉΓòÉ

This is used to mark the definition description associated with the preceding
definition term.


ΓòÉΓòÉΓòÉ 11.15.3. Parameter List Menu Information ΓòÉΓòÉΓòÉ

This submenu provides you with the options to create parameter lists.


ΓòÉΓòÉΓòÉ 11.15.3.1. Parameter List Definition ΓòÉΓòÉΓòÉ

This lets you create a parameter list.  The following shows a simple parameter
list tagging:

    :parml  tsize=20.
    :pt.Parm1
    :pd.Description of Parm1
    :pt.Parm2
    :pd.Description of Parm2
    :eparml.

which is displayed as follows:

 Parm1
                     Description of Parm1

 Parm2
                     Description of Parm2

 This was created by placing the parameter term (Parm1 and Parm2) on separate
 lines with the parameter descriptions on the lines immediately following them.
 The entire section was then marked as a parameter list.  Terms are marked
 using the Parameter List Term tag  and the definitions with the Parameter List
 Description tag.


ΓòÉΓòÉΓòÉ 11.15.3.2. Parameter List Term ΓòÉΓòÉΓòÉ

This marks the term that will be defined in the parameter list.


ΓòÉΓòÉΓòÉ 11.15.3.3. Parameter List Definition ΓòÉΓòÉΓòÉ

This defines the definition of a parameter in a parameter list.


ΓòÉΓòÉΓòÉ 11.15.4. Ordered Lists Information ΓòÉΓòÉΓòÉ

This creates an ordered list from selected text.  The following shows the
tagging for an ordered list using the following names:

    :ol.
    :li.Zoe

    :li.Delaine

    :li.Danika

    :li.Brent

    :li.Bill

    :eol.

which displays as follows:

  1. Zoe

  2. Delaine

  3. Danika

  4. Brent

  5. Bill

 Tagging Information

 If you separate each item in your list with a blank line each item will
 automatically be tagged with a list item (:li.).

 Note:  Ordered lists are similar to unordered lists but have a numbered item
 for each element in the list.


ΓòÉΓòÉΓòÉ 11.15.5. Unordered Lists Information ΓòÉΓòÉΓòÉ

This creates an unordered list.  The following shows an unordered list as it is
tagged:

    :ul.

    :li.One

    :li.Three

    :li.Two

    :eul.

which will look like the following:

 o One

 o Three

 o Two

 Tagging Information

 If you separate each item in your list with a blank line each item will
 automatically be tagged with a list item (:li.).


ΓòÉΓòÉΓòÉ 11.15.6. Simple Lists Information ΓòÉΓòÉΓòÉ

This causes selected text to be tagged as a simple list.  The following tags
create a simple list:

    :sl.

    :li.Dog

    :li.Cat

    :li.Rabbit

    :esl.

which generates:

 Dog

 Cat

 Rabbit

 Tagging Information

 If you separate each item in your list with a blank line each item will
 automatically be tagged with a list item (:li.).


ΓòÉΓòÉΓòÉ 11.15.7. List Item Information ΓòÉΓòÉΓòÉ

This is used to tag an item in a list.  This tag works with any of the standard
lists.  The following list of names has each named tagged with :li.:

    :ul.

    :li.Mario

    :li.Mom

    :li.Dad

    :eul.

which generates the following:

 o Mario

 o Mom

 o Dad

 The :li. were entered using list item command.  The :ul. and :eul. were
 generated using the unordered list command.

 Note:  You can press ALT-L to quickly insert the :li. symbol.

 Note:  If you separate each list item with a blank line before marking the
        list the IPF Editor will automatically generate the list items for you.


ΓòÉΓòÉΓòÉ 11.15.8. List Paragraph Information ΓòÉΓòÉΓòÉ

This allows you to insert the list paragraph tag into a list of items.  With
this tag you can easily create a list of paragraphs that are automatically
formatted.  The following shows an unordered list with list paragraphs:

    :ul.

    :li.This is a list item.
    :lp.This is the first paragraph in the list and can be as many lines are you like.
    :lp.This is the second paragraph in the list associated with the first list item.

    :li.This is another list item (:li.).

    :eul.

which generates the following list:

 o This is a list item.

   This is the first paragraph in the list and can be as many lines are you
   like.

   This is the second paragraph in the list associated with the first list
   item.

 o This is another list item (:li.).


ΓòÉΓòÉΓòÉ 11.16. Lines Information ΓòÉΓòÉΓòÉ

The Lines option lets you show text in the help manager exactly as you type it
in the editor.  The following text shows how to use this command:

    :lines align=center.
    The
         dog
               ran
                   by.
    :elines.

which generates the following:

                                       The
                                        dog
                                          ran
                                           by.


ΓòÉΓòÉΓòÉ 11.17. Font Information ΓòÉΓòÉΓòÉ

This menu option provides a method for changing the displayed font type and
size in your document. To adjust the attributes of text, see the Highlighting
options.

The following shows setting a list of names in monospaced text:

    :font facename='System Monospaced' size=20x10.
    :ul.

    :li.Bill

    :li.Delaine

    :li.Danika

    :eul.
    :font facename='default'.

which displays as the following:

 o Bill

 o Delaine

 o Danika

 The text is restored to the system default font after the marked text is set
 to the desired font.


ΓòÉΓòÉΓòÉ 11.18. Margin Information ΓòÉΓòÉΓòÉ

The Margin submenu allows you to set the left and right margins for you
document.


ΓòÉΓòÉΓòÉ 11.18.1. Left Margin Information ΓòÉΓòÉΓòÉ

This allows you to specify the left margin for your document.  The following
shows normal paragraphs with the left margin set to 15

    :lm margin=15.
    :p.This has a left margin of 15
    :lm margin=1.

which generates:

               This has a left margin of 15

 The left margin is restored to 1 when we are finished with it so all further
 text will be normal.


ΓòÉΓòÉΓòÉ 11.18.2. Right Margin Information ΓòÉΓòÉΓòÉ

This allows you to specify the right margin for your document.  The following
sets the right margin to 20.

    :lm margin=1.
    :rm margin=20.
    :p.This has a right margin of 20

which will output:

 This has a right margin of 20 and a left margin of 1.


ΓòÉΓòÉΓòÉ 11.19. HyperText/Graphics Link Information ΓòÉΓòÉΓòÉ

The Hypertext/Graphics link menu option lets you create hypertext/graphics
links from one part of your document to another. Hypertext/graphics links can
only be made to items tagged using the Header command or the footnotes command
and having either res numbers and/or tag names.

Generally, you will not need to manually mark text and link it using this
command if you use the "Generate Auto-hypertext/graphics links" menu option in
the Application menu (it will automatically generate all links to headers and
footnotes as they are encountered in your project).

Tagging Information

 Mark the selected text then select the hypertext/graphics menu item or  menu
item.

Note:  Hyper-links can only be made to panel headings levels 1 through 3.


ΓòÉΓòÉΓòÉ 11.20. Index Information ΓòÉΓòÉΓòÉ

Use this to add primary or secondary level indices to your document.

When you generate a primary index entry you will specify the "root words."
"Root words" are the key words used by index synonyms, which are created
automatically when you create an index entry.

You must also supply the description entry to place into the index. This is a
short text description which is what you will see in the index.

Indices also require an ID, which is a brief text label used to link secondary
and primary indices.  The default ID is the first three characters of the
description entry.


ΓòÉΓòÉΓòÉ 11.20.1. Index Creation ΓòÉΓòÉΓòÉ

This page allows you to create indices in your document or index synonyms.
This index entry will appear when the user selects the Help index from the help
menu (or the from the options menu if in the VIEW.EXE program).


ΓòÉΓòÉΓòÉ 11.20.1.1. Index Description ΓòÉΓòÉΓòÉ

Place the index description in this field.  If you leave this field blank a
synonym tag only will be created, but no new index entry.


ΓòÉΓòÉΓòÉ 11.20.1.2. Index Level 1 ΓòÉΓòÉΓòÉ

Selecting this will generate a primary index.


ΓòÉΓòÉΓòÉ 11.20.1.3. Index Level 2 ΓòÉΓòÉΓòÉ

Selecting this will generate a secondary index.


ΓòÉΓòÉΓòÉ 11.20.1.4. Index Root(s) ΓòÉΓòÉΓòÉ

This field contains the roots for primary index entries or the root for a
secondary index entry.

Root words (roots) are index entries to specified topics.  These root words are
associated with words defined with the index-synonyms. Root words can contain
alphabetic and numeric characters, and can be upper or lower case.  When
entering more than one root word place a space between each word.

A root word in a synonym only creation is used to link to the primary index or
secondary index entry.


ΓòÉΓòÉΓòÉ 11.20.1.5. Index ID or Ref ID ΓòÉΓòÉΓòÉ

This field contains the identifier for the primary index, or the reference
indentifier for secondary index entries.  ID and reference ID's are used to
link primary and secondary index entries.


ΓòÉΓòÉΓòÉ 11.20.1.6. Index Synonym Text ΓòÉΓòÉΓòÉ

Enter the text for synonyms for this index.


ΓòÉΓòÉΓòÉ 11.21. Symbols Information ΓòÉΓòÉΓòÉ

This allows you to select from a list of commonly used symbols for use in your
document. Some of the many symbols available are as show below:

 : - Colon
 ┬░ - Degree symbol
 с - Beta symbol
 ╨╝ - 1/4th symbol

 These symbols can be quickly placed into your text using the ALT-S command.


ΓòÉΓòÉΓòÉ 11.21.1. Symbol List ΓòÉΓòÉΓòÉ

This list provides you with the most common symbols supported by the IPF
system. You may double click on an item or single click and then press
"Select."


ΓòÉΓòÉΓòÉ 11.21.2. Symbol List Select ΓòÉΓòÉΓòÉ

Pressing this button, once you have selected a symbol from the symbol list,
will cause the symbol to be placed directly into your IPF document.


ΓòÉΓòÉΓòÉ 11.22. Group Panel Headings ΓòÉΓòÉΓòÉ

This option will allow you to group selected headings together to display them
on the save visible page.  This means that whatever panels headings you have
selected will share the displayed View or Help Manager window.  Normally when a
panel is displayed it replaces any previous panels shown.  With this option you
can provide multiple panels, each with related information, quickly and easily.
The IPF system refers to this as the Viewport.  Of course you can still
manually tag groups of headers together but using the predefined types of
header groupings can save a tremendous amount of time.


ΓòÉΓòÉΓòÉ 11.22.1. Panel Heading Group Type ΓòÉΓòÉΓòÉ

Select the type of panel header grouping you wish to include in your document
for the marked headers.  If you try to select a grouping that requires more
panel headers than you have marked you will receive an warning message and not
be allowed to select it.

The following panel header groupings are supported:

 o The  selection will create a single panel that will be overlaid (not
   replaced) by the second panel selected.  This will allow you to have two
   panels active that both fill the entire display area.

 o The  selection will create two panels that will share the display
   equally.The second window will not be shown until the user selects the
   hyperlink to it.

 o The  selection will group three panels side by side, each using 1/3rd of the
   display.  The second window will not be shown until the user selects the
   hyperlink to it.

 o The  selection group four panels side by side, each using a quarter of the
   display.  The second window will not be shown until the user selects the
   hyperlink to it.

 o The  will place two headers in the display area, one on top of the other.
   The second window will not be shown until the user selects the hyperlink to
   it.

 o The  will provide a parent panel along with multiple child windows, with
   each successive child window replacing the previous child window on the
   right side.  The second window(s) will not be shown until the user selects
   the hyperlink to it.

 o The  will generate two panels, side by side, that both appear immediately
   when the first is selected.

 o The  will generate three panels, each using 1/3rd of the display, that will
   appear when the parent window is selected.

 o The  will generate four panels, each using 1/4th of the display, that will
   appear when the parent window is selected.

 o The  will generate two panels, with the parent on top and the child below
   it, with both of them appearing when the parent is displayed.


ΓòÉΓòÉΓòÉ 11.22.2. Hide Child Panels ΓòÉΓòÉΓòÉ

Selecting this will cause any child panels (any panel except the first panel
marked is considered to be a child panel) to be hidden until the hyperlink to
it is activated.


ΓòÉΓòÉΓòÉ 11.22.3. Select Group Headers Type ΓòÉΓòÉΓòÉ

Pushing this will insert the commands into your document to generate the
desired grouping.


ΓòÉΓòÉΓòÉ 12. Options Menu Information ΓòÉΓòÉΓòÉ

The Options menu lets you set the Auto-save, Auto-Increment, tagging required
elements, set the IPF Editor display font, and the type of document being
worked on.   It  also allows you to save the current options for use the next
time the editor is run.


ΓòÉΓòÉΓòÉ 12.1. Options Display Font ΓòÉΓòÉΓòÉ

This allows you to select which font to use when displaying text in the IPF
Editor text editing window.


ΓòÉΓòÉΓòÉ 12.1.1. Font Selection ΓòÉΓòÉΓòÉ

Use this dialog to select the font to use in the IPF Editor.  Any font
installed in your system may be used.


ΓòÉΓòÉΓòÉ 12.2. Display Color ΓòÉΓòÉΓòÉ

This option lets you set the foreground and background text colors.


ΓòÉΓòÉΓòÉ 12.2.1. Selecting Display Text Color ΓòÉΓòÉΓòÉ

You may select any combination of foreground and background text colors that
you wish to.  Click on the desired colors, then click on the select push
button.


ΓòÉΓòÉΓòÉ 12.2.2. Foreground Display Color Selection ΓòÉΓòÉΓòÉ

Select the color you want to use for the foreground (text) color.  Be careful
not to select the same foreground and background colors or you won't be able to
see your text.


ΓòÉΓòÉΓòÉ 12.2.3. Background Display Color Selection ΓòÉΓòÉΓòÉ

Select the color you want to use for the background color (the color that the
foreground text will be displayed with).  Be careful not to select the same
foreground and background colors or you won't be able to see your text.


ΓòÉΓòÉΓòÉ 12.2.4. Display Color Select ΓòÉΓòÉΓòÉ

Click on this to enable your color selections.


ΓòÉΓòÉΓòÉ 12.3. Enable Word Wrapping ΓòÉΓòÉΓòÉ

This option enables word wrapping when displaying you document in the IPF
Editor editing window.  It will not, however, insert carriage returns into your
document.  If you wish to enter carriage returns you must manually insert them
into the document by pressing enter at the desired point.  The purpose of
word-wrapping is to make it easier for you to edit documents when you have
redefined the size of the IPF Editor window to a size smaller than the width of
your text.


ΓòÉΓòÉΓòÉ 12.4. Auto convert : to &colon. ΓòÉΓòÉΓòÉ

This option will generate a "&colon." whenever you press the colon key.  It
will be placed into the current document at the current location.  This is
especially handy when you are creating new help or online document files and
don't want to worry about accidentally placing raw colons into your document.

Note:  Colons are used by IPF tags and inserting a straight colon (':') will
       generate an error when you attempt to compile the document.


ΓòÉΓòÉΓòÉ 12.5. Options Document Settings ΓòÉΓòÉΓòÉ

These options allow you to set the type of document you are editing.  The only
two types of documents supported are the information (.INF) file format for use
with the VIEW.EXE program and the application help (.HLP) file format for use
with applications.


ΓòÉΓòÉΓòÉ 12.5.1. Options Document Settings Help Document ΓòÉΓòÉΓòÉ

This sets the document type to a help document.  Normally you would select the
project type when you create the project file but this is in there in case you
change your mind or if you are building a document without using the project
system.


ΓòÉΓòÉΓòÉ 12.5.2. Options Document Settings INF Document ΓòÉΓòÉΓòÉ

This sets the document type to a VIEW.EXE compatible INF file. Normally this is
set when you create a project file but you can use this if you are not using
the project system.


ΓòÉΓòÉΓòÉ 12.6. Options Auto-Save ΓòÉΓòÉΓòÉ

This lets you set how often the IPF Editor automatically saves your document to
disk.  The file is saved to either the directory pointed to in your temporary
directory (pointed to by the TMP= environment variable) or it uses the root
directory of the current drive.

Files with the extension .C2T are temporary files used by the IPF Editor.
These may be safely deleted if you are not currently running any copies of the
IPF Editor.  Normally the IPF Editor removes these on exit but may not if your
system shuts down abnormally.

You may disable this option by setting the auto-save frequency to zero.


ΓòÉΓòÉΓòÉ 12.7. Options Set Auto Increment Amount ΓòÉΓòÉΓòÉ

This lets you set the amount that res codes are incremented automatically when
you are creating new res codes during panel header creation (res codes
generated by selecting from pre-defined definitions and/or header codes are not
auto-incremented ever).

Note:  Setting this value to five provides you with enough flexibility to go
       back and add new res codes in the list while still maintaining some
       numerical ordering to your document.


ΓòÉΓòÉΓòÉ 12.8. Options Require Tag Names ΓòÉΓòÉΓòÉ

Enabling this option forces the IPF Editor to ask you for a panel name whenever
you are adding a new heading.


ΓòÉΓòÉΓòÉ 12.9. Options Require Tag Res ΓòÉΓòÉΓòÉ

Enabling this option forces the IPF Editor to ask you for a res code for use
with the panel being created when adding a new heading.  Panel headers used for
application help or linked to by hypertext/graphics linking require a res code.


ΓòÉΓòÉΓòÉ 12.10. Options Require Tag ID ΓòÉΓòÉΓòÉ

Use this option to cause the IPF Editor to ask you for a Tag ID when you are
defining a new header.


ΓòÉΓòÉΓòÉ 12.11. Options Save Options Preferences ΓòÉΓòÉΓòÉ

Use this to save your preferences for the option's settings.


ΓòÉΓòÉΓòÉ 12.12. Show Graphical Menu ΓòÉΓòÉΓòÉ

This option toggles on and off the graphical menu located at the right side of
the IPF Editor.


ΓòÉΓòÉΓòÉ 13. Search Menu ΓòÉΓòÉΓòÉ

The Search menu lets search for text, change text globally, jump to a specific
line number, and adjust the case of marked text.


ΓòÉΓòÉΓòÉ 13.1. Search Search ΓòÉΓòÉΓòÉ

The Search menu option lets you locate the first occurrence of a line of text
in the current document you are editing.  It also allows you to change either
the first or all occurrences of the specified text.


ΓòÉΓòÉΓòÉ 13.1.1. Search Dialog Search Text ΓòÉΓòÉΓòÉ

Enter the text you would like to locate and/or replace.


ΓòÉΓòÉΓòÉ 13.1.2. Search Dialog Replace Text ΓòÉΓòÉΓòÉ

Enter the text you would like to use to replace the "search" text with.  Leave
this blank if you don't want to do any text replacement.


ΓòÉΓòÉΓòÉ 13.1.3. Search Dialog Ignore Case ΓòÉΓòÉΓòÉ

Select this to have the search ignore the case of the text being searched and
the "search" text specified.


ΓòÉΓòÉΓòÉ 13.1.4. Search Dialog Change All Occurrences ΓòÉΓòÉΓòÉ

This will change all occurrences of the specified search text with the
specified replacement text.  If no replacement text has been supplied this
value is ignored.


ΓòÉΓòÉΓòÉ 13.1.5. Search Dialog Search Project ΓòÉΓòÉΓòÉ

Select this to search your entire project for the specified text (or to search
and replace text in your entire project).  Each file in the project is searched
and, when complete, the last file in the project will be displayed.  You will
need to select either "Search Find Next" or "Search Change Next" to find or
replace the next occurrence of the search text unless you have selected the
"Change All Occurrences" checkbox.


ΓòÉΓòÉΓòÉ 13.2. Search Find Next ΓòÉΓòÉΓòÉ

The Search Find Next option lets you find the next occurrence of text in the
current document.  This must be used after the Search Search option has been
used.


ΓòÉΓòÉΓòÉ 13.3. Search Change Next ΓòÉΓòÉΓòÉ

This locates the next occurrence of the text specified with the Search Search
menu option and replaces it with the text entered at that time.


ΓòÉΓòÉΓòÉ 13.4. Goto Line Number ΓòÉΓòÉΓòÉ

This lets you jump to a specific line number in the file.


ΓòÉΓòÉΓòÉ 13.5. Adjust Case ΓòÉΓòÉΓòÉ

This lets you adjust the case of marked text.  It will change text from all
capitals to mixed capitals and lower case.

Example:  To convert the following text from all capitals to just capitalizing
the first letter of each word as in the following:

    THIS IS HARD TO READ AS ALL CAPITALS.

    This Is Hard To Read As All Capitals.


ΓòÉΓòÉΓòÉ 13.6. Goto Panel Header ΓòÉΓòÉΓòÉ

Selecting this menu option will bring up a list of defined panel headers in
your document or project.  You can then select any panel header and the IPF
Editor will go to it.


ΓòÉΓòÉΓòÉ 13.6.1. Goto Panel Header General Information ΓòÉΓòÉΓòÉ

This dialog will allow you to locate a panel header anywhere in your document
or project.


ΓòÉΓòÉΓòÉ 13.6.2. Goto Panel Heading List ΓòÉΓòÉΓòÉ

This shows a list of currently defined panel headings you may go to.  You can
either select one then use the Goto push button or double click on the desired
panel.


ΓòÉΓòÉΓòÉ 13.6.3. Goto Push Button ΓòÉΓòÉΓòÉ

Use this to go to the selected panel heading once you have selected the panel
in the list box above the push button.


ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ

Perez Computing Services (PCS) is a software development company  founded by
Mario Perez Jr. and Bill Perez.  PCS specializes in software programming tools
for DOS, Windows, and OS/2.  We provide custom programming as well as having
several retail OS/2 and DOS software packages available.

If you wish to contact us you may via U.S. mail or Compuserve, Prodigy, or
IBMLINK's OS/2 BBS.  Please make all contacts "attention Bill Perez."


ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ

The Information Presentation Facility Guide is available from IBM either as
part of the OS/2 2.x Technical Library or separately.  You can contact IBM at
1-800-3-IBM-OS2 to order it.


ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ

IBM and OS/2 are registered trademarks of International Business Machines
Corporation.


ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ

Marked text is text you have selected by placing the cursor at the beginning of
it and highlighting it by pressing the left mouse button and dragging the
pointer over the text.


ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ

This is a footnote.