OS/2 Shareware BBS: 10 Tools/10-Tools.zip/bookm2.zip/bookmakr.hlp

OS/2 Help File | 1994-11-10 | 18KB | 295 lines

ΓòÉΓòÉΓòÉ 1. Overview ΓòÉΓòÉΓòÉ

BookMaker assists the user in creating IPF files and compiling them with the
IPF (Information Presentation Facility) compiler.

To create a simple INF file select File/New and type a title into the dialog
which appears.  Then select Heading and in the heading dialog type the title of
your first heading.  Finally select paragraph and insert your text into the
file.  Conitinue alternating between paragraph and heading for each additional
topic in your file. For more information about creating IPF files see the
following files below.

IPFC20.INF   - Help compiler information
BASIC.INF   - Basic examples and information
LINKING.INF  - Information on linking
WINDOWS.INF - Information on ipf windows
README.INF - BookMaker readme file


ΓòÉΓòÉΓòÉ 2. File/New ΓòÉΓòÉΓòÉ

File/New is used to create a new IPF file.  When you click this option you will
be asked to save any unsaved information in your currently opened file and you
are presented with a dialog asking you for a title for your new document. (40
characters max.) There is also a spin button which defaults to 3.  This means
your TOC level will be 123.  If you change this to 4, for example, your TOC
would read 1234.


ΓòÉΓòÉΓòÉ 3. File/Open ΓòÉΓòÉΓòÉ

This option is used to open an IPF file which you are currently working on.


ΓòÉΓòÉΓòÉ 4. File/Save ΓòÉΓòÉΓòÉ

Saves the current file to disk.  If you are using the AutoSave feature, your
project is saved automatically after each dialog.


ΓòÉΓòÉΓòÉ 5. File/Save As ΓòÉΓòÉΓòÉ

This option allows you to save a file to disk under an alternate filename or to
overwrite one file with another.


ΓòÉΓòÉΓòÉ 6. File/Exit ΓòÉΓòÉΓòÉ

Shuts down BookMaker.  You are promped to save any unsaved work.


ΓòÉΓòÉΓòÉ 7. Edit/Undo ΓòÉΓòÉΓòÉ

Undoes the last edit made to the file.  If you insert something into the main
window and then Preview the file, you can undo the last addition to the file
using this feature.


ΓòÉΓòÉΓòÉ 8. Edit/Cut ΓòÉΓòÉΓòÉ

Cuts selected text to clipboard.


ΓòÉΓòÉΓòÉ 9. Copy ΓòÉΓòÉΓòÉ

Copies selected text to clipboard.


ΓòÉΓòÉΓòÉ 10. Edit/Paste ΓòÉΓòÉΓòÉ

Pastes clipboard text into main window.


ΓòÉΓòÉΓòÉ 11. Heading ΓòÉΓòÉΓòÉ

Brings up a dialog allowing you to select the features of the next window to be
inserted into your file.  The formatting options allow you to easily change
window attributes.

see heading tag in the IPFC20.INF file for information about options


ΓòÉΓòÉΓòÉ 12. Paragraph ΓòÉΓòÉΓòÉ

The paragraph selection presents a dialog which allows you to insert text into
your document.  Keep in mind that the lines you type into the dialog box should
remain under about 70 characters.  The way to do this is to hit return at the
end of every line you type.


ΓòÉΓòÉΓòÉ 13. Lines ΓòÉΓòÉΓòÉ

In the lines dialog, hit return after each line that you type. By selecting the
alignment option, you can left align. right aligh and center text.


ΓòÉΓòÉΓòÉ 14. List ΓòÉΓòÉΓòÉ

The list dialog allows you to add an optional title and items to a list. In
addition you are given the option of selecting the type of list and whether or
not you wish to compact the list.


ΓòÉΓòÉΓòÉ 15. Link ΓòÉΓòÉΓòÉ

The link option allows you to link selected text with a window by either a
resource ID or a keyword.  The you should select the word or phrase you wish to
link before you select this option.

Options:

Res No. - The resource ID of the window to which you wish to link

ID - The ID (can contain letters and numbers) of the window to which you wish
to link.


ΓòÉΓòÉΓòÉ 16. Comment ΓòÉΓòÉΓòÉ

This option allows you to insert a comment into your file.  If words are
selected when this option is called they become part of the comment. This
option is open to a single line of text only.  Selecting multiple lines will
generate an error when compiling.


ΓòÉΓòÉΓòÉ 17. Footnote ΓòÉΓòÉΓòÉ

This option is used to present a small note to the user regarding the selected
term.  Selecting more than one word will generate an error message on compile.


ΓòÉΓòÉΓòÉ 18. Message ΓòÉΓòÉΓòÉ

Message is used to present a formatted message to the user.  Selected text can
be turned into a message.


ΓòÉΓòÉΓòÉ 19. Table ΓòÉΓòÉΓòÉ

A table presents information to the user in a tabular format. You can select
from one to for colums using BookMaker.  Add text to each listbox you wish to
use and set the width for each column. You can alse select the rules which you
wish to present with your information.

Options:

Use - if not selected a column is not created

Width - In each column box is a spin button which allows you to select the
width if eacn columen individually

rule lines - allow you to select the rule lines for the table


ΓòÉΓòÉΓòÉ 20. Colors ΓòÉΓòÉΓòÉ

Applies selected color attributes to new or selected text.  It's best to create
text with the another selection first and then select the text to which you
wish to apply the new colors.  In the background and forground options, the
white box represents default.

Options:

 1. Forecolor - sets the forecolor for the text

 2. Backcolor - sets the backcolor for the text


ΓòÉΓòÉΓòÉ 21. Font ΓòÉΓòÉΓòÉ

The font selection applies font attributes to selected text, or it inserts the
selected attribute if no text is selected.  Note that the default font can not
be changed in size, but the other options can.


ΓòÉΓòÉΓòÉ 22. Highlight ΓòÉΓòÉΓòÉ

The highlight option allows you to add a highligting tag to selected text. The
options available represent the look of the text format.


ΓòÉΓòÉΓòÉ 23. Character Graphics ΓòÉΓòÉΓòÉ

The character graphics function allows you to insert frames and text built with
an ansii editor.  If you use a different editor you can simply paste your
graphics into the Character Graphics edit window and hit insert.

As mentioned in the Readme.inf, this feature is still in development. Please
send information to Katt Development regarding how this feature is working for
you.


ΓòÉΓòÉΓòÉ 24. Example ΓòÉΓòÉΓòÉ

Example is used to insert files which need to remain in their normal format.
This mostly applies to code sample although it could also apply to any ascii
documents you wish to add to the file.  Lines over 70 characters long are
clipped by IPFC.


ΓòÉΓòÉΓòÉ 25. Artwork ΓòÉΓòÉΓòÉ

Artwork allows for the insertion of Bitmaps and Metafiles into your file.  Also
available are options for linking the graphic to another window and specifying
how the graphic is to be presented within your document.

Options:

inline - places the bitmap in the same line as the text

Fit to page - bitmap or metafile becomes backgroung for the window

Link to - links the bitmap to a window by res number.


ΓòÉΓòÉΓòÉ 26. Autolink ΓòÉΓòÉΓòÉ

Autolink allows you to specify a window to open when the window which holds the
autolink tag is opened.  All windows formatting can be handled from within the
link.

see autolink in the IPFC20.INF file for information about options


ΓòÉΓòÉΓòÉ 27. Options/Autosave ΓòÉΓòÉΓòÉ

If Autosave is checked (default), then the file is saved after every new option
is inserted.  If the file is untitled, the user is prompted for a filename to
which the file will be saved.


ΓòÉΓòÉΓòÉ 28. Res Max ΓòÉΓòÉΓòÉ

This option allows the user to select the potential number of Resource Id's in
the file.  The higher the number selected, the longer it takes to load certain
dialogs.  (Default is 300)


ΓòÉΓòÉΓòÉ 29. Preview ΓòÉΓòÉΓòÉ

Preview saves the currently open file as testtemp.ipf and then compiles and
runs the file.  No changes are made to the currently open file or the
previously compiled files.


ΓòÉΓòÉΓòÉ 30. Compile ΓòÉΓòÉΓòÉ

Opens the Compile Options Window.


ΓòÉΓòÉΓòÉ 31. Compile Options ΓòÉΓòÉΓòÉ

Compile options allows you to compile a file as either an INF or a HLP file.
In addition IPFC options are available.  If output from the compile window is
sent to a file, the compile window is closed automatically otherwise you must
close the window yourself.


ΓòÉΓòÉΓòÉ 32. View ΓòÉΓòÉΓòÉ

View opens the previously compiled INF file.

This option doesn't work for HLP files.


ΓòÉΓòÉΓòÉ 33. Index ΓòÉΓòÉΓòÉ

This option allows you to create index pointers for your file. These can be
either Headings or subheadings and can be placed anywhere within your IPF file.


ΓòÉΓòÉΓòÉ 34. Index Synonym ΓòÉΓòÉΓòÉ

This feature allows you to create a list of synonyms for topics within your
document.


ΓòÉΓòÉΓòÉ 35. Symbol/Colan(:) ΓòÉΓòÉΓòÉ

This will insert a colon tag into your document.


ΓòÉΓòÉΓòÉ 36. Symbol/Ampersand(&) ΓòÉΓòÉΓòÉ

 This will insert an ampersand tag into your document.


ΓòÉΓòÉΓòÉ 37. Symbol Table ΓòÉΓòÉΓòÉ

The symbol table allows you to choose special characters which you might want
to insert into your document.

The two most common symbols you might wish to add, the ampersand and the colon,
are included as a menu option.