Index

24-bit color
Adding Image Files to the Makefile

Adobe Illustrator images
Supported Image Formats

.ai files
Image File Naming Conventions

anchored frames. See frames
Supplementary Reading

appendices, tagging
Quick Reference: Rules for Using the Templates

applications, launching from InSight
Writer-Generated Links
Problem: Marker 17

AppNum paragraph tag
Quick Reference: Rules for Using the Templates
Quick Reference: Rules for Using the Templates

audience for this guide
Audience for This Guide

bibliography
Supplementary Reading

.book file
Standard Files in a Local Working Directory

book-building
debugging
Finding and Fixing Online Book Errors
diagram
Book-Building Architecture
help
Building and Testing the Online Help
overview
Building Online Books
troubleshooting
If make Doesn't Work

BOOK_FILES variable
Editing the Makefile

BOOK_ICON variable
Editing the Makefile

booklist.txt file
No Help Available
Problem: Can't Open booklist.txt File

books
building. See book-building
Supplementary Reading
checking
Checking for Display Problems
linking between. See links
Supplementary Reading
titles
Choosing a Book's Title
viewing
Viewing a Built Book

books directory
The books Directory

BOOKSHELF variable
Editing the Makefile

bsnap utility
Screen Captures of Pull-Down Menus
Screen Captures of Windows

build process. See book-building
Supplementary Reading

buttons, help
Help Buttons Versus Help Menus and Context Sensitive Help

.bw files
Image File Naming Conventions

BW variable
Adding Image Files to the Makefile

capture utility
Tools and Where to Get Them

captures, screen. See screen captures
Supplementary Reading

Carberry
Book-Building Architecture

CGM figures
Book-Building Architecture

ChapNum paragraph tag
Quick Reference: Rules for Using the Templates
Quick Reference: Rules for Using the Templates

chapters
linking to
Quick Reference: Rules for Using the Templates
Problem: Illegal Structure
tagging
Quick Reference: Rules for Using the Templates

ChapTitle paragraph tag
Quick Reference: Rules for Using the Templates

character tags
GlossaryItem
Creating Glossary Links
Quick Reference: Rules for Using the Templates
index
Problem: Illegal Tag
using
Don't Use Character Tags on Tabs, Soft Returns, or Hard Returns
Use Character Tags, Not Character Formats
whitespace
Problem: Character Tag Spans Hanging List
Quick Reference: Rules for Using the Templates
words
Quick Reference: Rules for Using the Templates
ZZZ
Supplementary Reading

characters
formatting
Use Character Tags, Not Character Formats
invalid
Problem: Untranslated Function Character
non-alphanumeric, entering
Create Valid Dashes

chunking
“Chunk” the Text

clbatch utility
Book-Building Architecture

code formatting
Don't Put Tabs in Code

color, 24-bit vs. 8-bit
Adding Image Files to the Makefile

commonbookdefs file
Problem: commonbookdefs File Errors

conditional text
OnlineOnly tag
Workaround for Unsupported Image Types
Tagging FrameMaker Files
PrintOnly tag
Workaround for Unsupported Image Types

consistency of terminology
Use Terms Consistently
ZZZ
Supplementary Reading

context sensitive help
Creating Context Sensitive Help
Help Buttons Versus Help Menus and Context Sensitive Help

conventions. See naming conventions
Supplementary Reading

copyright symbol
Create Valid Copyright and Trademark Symbols

creating figures
Quick Reference: Rules for Using the Templates

creating links. See links
Supplementary Reading

cross references. See links
Supplementary Reading

cross-book links. See links
Supplementary Reading

dashes
Create Valid Dashes

deleting files
Arguments to the make Command

directories
books
The books Directory
figures
The Figure Subdirectories
generated by make
Files and Directories Generated by make
help
Standard Files in a Local Working Directory
online
The Figure Subdirectories
Working With Figures
Standard Files in a Local Working Directory
orig
Standard Files in a Local Working Directory
Working With Figures
The Figure Subdirectories
print
Working With Figures
Quick Reference: Rules for Using the Templates
Processing and Importing Image Files
Standard Files in a Local Working Directory
prod
Standard Files in a Local Working Directory
tabs
Standard Files in a Local Working Directory
working
Organizing a Local Working Directory

display problems, checking for
Checking for Display Problems

.doc files
Quick Reference: Rules for Using the Templates
Book-Building Architecture
Standard Files in a Local Working Directory

DTD
Problem: Frame Tag

EBT
Book-Building Architecture

em dashes
Create Valid Dashes

en dashes
Create Valid Dashes

equations, online
Create Equations as Figures

.err files
Error Files

errors
cannot process frame
Problem: Cannot Process Frame
cross references
The Link QA Report
display problems
Checking for Display Problems
example
Example SGML File
figures, missing
Checking for Display Problems
files
Error Files
fixing
Finding and Fixing Errors
formatting
Checking for Display Problems
generating
Debugging Individual Files: filename.err
help unavailable
Telling Users Which Subsystems to Install
hierarchy problem
Problem: Hierarchy Problem
links, broken
Checking for Display Problems
location of
Finding the Errors in FrameMaker Files
make
make book Error Messages
margin figures
Problem: Cannot Process Indirect Frame
messages
About Error Messages
reports
Error Files
Checking the .full File
translation
MIF-to-SGML Translation Errors
types of
Types of Errors
unclosed tags
Problem: Unclosed Tags
unknown
Unknown Errors
untranslated function character
Problem: Untranslated Function Character
ZZZ
Supplementary Reading

extensions, filename
Image File Naming Conventions

figures
composite
Working With Figures
Supported Image Formats
creating
Working With Figures
Quick Reference: Rules for Using the Templates
customized print figures
Custom print Files
directories
The Figure Subdirectories
generating
Arguments to the make Command
guidelines
Things to Remember About Figures
importing
Working With Figures
Quick Reference: Rules for Using the Templates
links, creating
Writer-Generated Links
Makefile editing
Adding Image Files to the Makefile
margin
Problem: Margin Figure
missing
Problem: Cannot Process Frame
Checking for Display Problems
naming
Image File Naming Conventions
placement
Problem: Hierarchy Problem
structure
Problem: Figure Logic Error

files
converting
Book-Building Architecture
error files
Error Files
generated by make
Files and Directories Generated by make
intermediate
Intermediate Files
locked
Problem: File Already Locked
If make Doesn't Work
naming
Image File Naming Conventions
Quick Reference: Rules for Using the Templates
removing
Arguments to the make Command
SGML
About SGML
templates
Copying Template Files to Your Working Directory

fmbatch utility
Book-Building Architecture

Footnote paragraph tag
Problem: Footnote Paragraph Tag

footnotes
creating
Footnotes
index
Problem: Footnote INDEX Targets
links
Problem: Footnote XREF Targets
tables
Problem: Maximum Number of Table Footnotes
Creating Tables

formats
characters
Use Character Tags, Not Character Formats
frontmatter
Checking for Display Problems
images
Quick Reference: Rules for Using the Templates
Supported Image Formats
index
Problem: Index Format Syntax

FrameMaker
character designer
Use Character Tags, Not Character Formats
equations
Create Equations as Figures
files, naming
Quick Reference: Rules for Using the Templates
index markers
Creating Index Entries
line art
Supported Image Formats
link targets
Problem: Possible Unused Target
Smart Spaces
Don't Put Tabs in Code
tables, creating
Creating Tables
Quick Reference: Rules for Using the Templates
tags, using
Tagging FrameMaker Files
Tagging FrameMaker Files
templates
Copying Template Files to Your Working Directory

frames
multiple
Problem: Figure Logic Error
processing
Problem: Cannot Process Frame

frontmatter
formats
Checking for Display Problems
tagging
Quick Reference: Rules for Using the Templates

.full file
Checking the .full File
Error Files

full titles
Choosing a Book's Title

FULL_TITLE variable
Editing the Makefile

.gif files
Image File Naming Conventions

GIF image format
Supported Image Formats

GIF variable
Adding Image Files to the Makefile

glossary
links, creating
Writer-Generated Links
Creating Glossary Links
QA report
Checking the .full File
Glossary QA Report
tagging
Quick Reference: Rules for Using the Templates
Quick Reference: Rules for Using the Templates

GlossaryDef paragraph tag
Problem: Glossary Tag Usage

GlossaryEntry paragraph tag
Problem: Glossary Tag Usage

GlossaryItem character tag
Quick Reference: Rules for Using the Templates

GlossaryTitle paragraph tag
Quick Reference: Rules for Using the Templates

guidelines for figures
Things to Remember About Figures

hanging lists
Problem: Hanglist Not Legal

hard returns, tagging
Don't Use Character Tags on Tabs, Soft Returns, or Hard Returns

headings
cross referencing
A Word on Cross Referencing Headings
guidelines
Write Descriptive, Standalone Headings

help
Creating Online Help
Creating Online Help
buttons
Help Buttons Versus Help Menus and Context Sensitive Help
context sensitive
Creating Context Sensitive Help
Help Buttons Versus Help Menus and Context Sensitive Help
creating
Creating Online Help
helpmap file
The Helpmap File
incorrect
The Wrong Help Topic Appears
installing
Telling Users Which Subsystems to Install
menus
Creating A Rollover Menu
Help Buttons Versus Help Menus and Context Sensitive Help
missing
No Help Available
missing items
Missing Items on the Help Menu
tagging
Tagging FrameMaker Files
testing
Building and Testing the Online Help
troubleshooting
Troubleshooting
Web pages
Using the World Wide Web from Your Help Menu

help directory
Standard Files in a Local Working Directory

HelpSubTopic paragraph tag
Tagging FrameMaker Files
Problem: Illegal Help Subtopic

HelpTopic paragraph tag
Tagging FrameMaker Files

hierarchy problem
Problem: Hierarchy Problem
Problem: Hierarchy Problem

hipass3 utility
Tools and Where to Get Them

.idx file
Intermediate Files

Illustrator images
Supported Image Formats

images
24-bit color
Adding Image Files to the Makefile
capturing. See screen captures
Supplementary Reading
formats
filename extensions
Image File Naming Conventions
supported
Supported Image Formats
importing
Processing and Importing Image Files
original
Working With Figures
The Figure Subdirectories
unsupported
Workaround for Unsupported Image Types
ZZZ
Supplementary Reading

importing figures
Quick Reference: Rules for Using the Templates

indentation
Quick Reference: Rules for Using the Templates
Problem: Hanglist Indent

index
footnotes
Problem: Footnote INDEX Targets
formatting
Problem: Index Format Syntax
links
Creating Index Entries
links, creating
Writer-Generated Links
syntax
Problem: Index Format Syntax
tagging
Problem: Illegal Tag

indexgen utility
Book-Building Architecture

IndyCam
Tools and Where to Get Them

information, repeating
Cross-Reference Repeated Information

inline media
Writer-Generated Links
Problem: No Inline Type

INLINE_MEDIA variable
Editing the Makefile

InSight viewer
checking books
Checking for Display Problems
features
Before You Begin
help. See help
Supplementary Reading
installing
Installing the IRIS InSight Viewer and Help
launching applications
Writer-Generated Links
links
Writer-Generated Links
Table of Contents view
Automatic Links

introductions, tagging
Quick Reference: Rules for Using the Templates

izoom utility
Tools and Where to Get Them

licensing
Problem: Cannot Map libnsl.so Library

line art
Supported Image Formats

links
automatic
Automatic Links
broken
Checking for Display Problems
creating
Quick Reference: Rules for Using the Templates
Creating Online Links
cross-book
creating
Use Cross-Book References Carefully
Creating Cross-Reference Links to Other Books
errors
Problem: Invalid Marker 18
footnotes
Problem: Footnote XREF Targets
glossary
Creating Glossary Links
guidelines
Guidelines for Cross-Referencing in Online Books
headings
Provide a Linked Chapter Summary
A Word on Cross Referencing Headings
A Word on Cross Referencing Headings
index
Creating Index Entries
QA report
The Link QA Report
Checking the .full File
structural
Automatic Links
targets, unused
Problem: Possible Unused Target
to another book
Creating Cross-Reference Links to Other Books
to chapters
Quick Reference: Rules for Using the Templates
Problem: Illegal Structure
within a book
Creating Cross-Reference Links Within a Book

lists, hanging
Problem: Hanglist Not Legal

local working directory
Organizing a Local Working Directory

locked files
If make Doesn't Work

make
Building Online Books
Files and Directories Generated by make
Checking the make Utility
_online
If make Doesn't Work
_print
If make Doesn't Work
arguments
Arguments to the make Command
book
Making a Viewable Book: make book
book.full
Initial make: make book.full
building an entire book
Arguments to the make Command
commands
choosing
Using make Commands
list of
Arguments to the make Command
disk full
If make Doesn't Work
error files
Debugging Individual Files: filename.err
errors
make book Error Messages
failures
If make Doesn't Work
figures
Arguments to the make Command
final
Verifying an Error-Free Book: make book.full
generated files and directories
Files and Directories Generated by make
initial
Initial make: make book.full
installing
Checking the make Utility
prerequisites
Arguments to the make Command
removing files
Arguments to the make Command

Makefile
description
Standard Files in a Local Working Directory
editing
Editing the Makefile
figures
Adding Image Files to the Makefile
image files in
Working With Figures
renaming
If make Doesn't Work
syntax
If make Doesn't Work

margin figures
errors
Problem: Margin Figure
processing
Problem: Cannot Process Indirect Frame

media, inline
Problem: No Inline Type
Writer-Generated Links

menus
capturing
Screen Captures of Pull-Down Menus
help
Help Buttons Versus Help Menus and Context Sensitive Help
rollover
Creating A Rollover Menu

MIF files
Intermediate Files
Book-Building Architecture

mif2sgml
Book-Building Architecture

miftocgm utility
Book-Building Architecture

mksgidoc utility
Book-Building Architecture

Msg* paragraph tags
Problem: Msg* Without Preceding Msg*1st

naming conventions
books
Choosing a Book's Title
figures
Image File Naming Conventions
files
Observing Naming Conventions

non-alphanumeric characters
Create Valid Dashes

notes, multi-paragraph
Quick Reference: Rules for Using the Templates

online
help. See help
Supplementary Reading
images
Working With Figures
wording
Avoid Print-Oriented Wording
writing tips
Guidelines for Organizing an Online Book

online directory
The Figure Subdirectories
Standard Files in a Local Working Directory
Working With Figures
Standard Files in a Local Working Directory

OnlineOnly conditional text tag
Workaround for Unsupported Image Types
Tagging FrameMaker Files

orig directory
The Figure Subdirectories
Standard Files in a Local Working Directory
Working With Figures

paragraph tags
AppNum
Quick Reference: Rules for Using the Templates
Quick Reference: Rules for Using the Templates
ChapNum
Quick Reference: Rules for Using the Templates
Quick Reference: Rules for Using the Templates
ChapTitle
Quick Reference: Rules for Using the Templates
Footnote
Creating Tables
Problem: Footnote Paragraph Tag
GlossaryDef
Problem: Glossary Tag Usage
GlossaryEntry
Problem: Glossary Tag Usage
GlossaryTitle
Quick Reference: Rules for Using the Templates
HelpSubTopic
Problem: Illegal Help Subtopic
Tagging FrameMaker Files
HelpTopic
Tagging FrameMaker Files
indentation
Problem: Hanglist Indent
Msg*
Problem: Msg* Without Preceding Msg*1st
TableFootnote
Problem: Footnote Paragraph Tag
Creating Tables
TextInd*
Quick Reference: Rules for Using the Templates
Title
Quick Reference: Rules for Using the Templates
ZZZ
Supplementary Reading

paragraphs, indentation
Quick Reference: Rules for Using the Templates

PBMPlus utilities
Book-Building Architecture

PostScript
images
Supported Image Formats
variable
Adding Image Files to the Makefile

prefaces, tagging
Quick Reference: Rules for Using the Templates

print directory
Custom print Files
Standard Files in a Local Working Directory
Quick Reference: Rules for Using the Templates
Processing and Importing Image Files
Working With Figures

print-oriented wording
Avoid Print-Oriented Wording

PRINT_BW variable
Adding Image Files to the Makefile

PRINT_COLOR variable
Adding Image Files to the Makefile

PrintOnly conditional text tag
Workaround for Unsupported Image Types

production editor
Audience for This Guide

.ps files
Image File Naming Conventions

pull-down menus, capturing
Screen Captures of Pull-Down Menus

QA reports
The Link QA Report
Checking the .full File

quick reference list
Quick Reference: Rules for Using the Templates

quotation marks, smart
Don't Put Tabs in Code

README file
Standard Files in a Local Working Directory

reference list
Quick Reference: Rules for Using the Templates

reference pages, links to
Writer-Generated Links

references
Supplementary Reading

registered trademark symbol
Create Valid Copyright and Trademark Symbols

removing files
Arguments to the make Command

repeating information
Cross-Reference Repeated Information

requirements, software
Summary of Software/Configuration Requirements

returns, soft, tagging
Don't Use Character Tags on Tabs, Soft Returns, or Hard Returns

.rgb files
Screen Capture File Names
Image File Naming Conventions

RGB image format
Supported Image Formats

RGB variable
Adding Image Files to the Makefile

rollover menus
Creating A Rollover Menu

rules for online
Quick Reference: Rules for Using the Templates

screen captures
Create Equations as Figures
Capturing Images for FrameMaker Documents
backgrounds
Screen Capture Procedure
equations
Create Equations as Figures
formats
Capturing Images for FrameMaker Documents
menus
Screen Captures of Pull-Down Menus
naming
Screen Capture File Names
tools
Tools and Where to Get Them
Capturing Images for FrameMaker Documents
windows
Screen Captures of Windows

screen snaps. See screen captures
Supplementary Reading

scrsave utility
Tools and Where to Get Them

SGI Help. See help
Supplementary Reading

SGIDOC DTD
Problem: Frame Tag

SGML
description
About SGML
files
Intermediate Files
Book-Building Architecture
About SGML
Standard Files in a Local Working Directory
structure
The FrameMaker File
Problem: Frame Tag
Use Valid Tag Sequences
tag structure
SGML Tag Structure
tags
About SGML

short titles
Choosing a Book's Short Title

short_title.full file
Error Files

Smart Quotes
Don't Put Tabs in Code

Smart Spaces
Don't Put Tabs in Code

snaps, screen. See screen captures
Supplementary Reading

snapshot tool
Screen Captures of Portions of Windows
Create Equations as Figures

soft returns, tagging
Don't Use Character Tags on Tabs, Soft Returns, or Hard Returns

software requirements
Summary of Software/Configuration Requirements

spaces in code
Don't Put Tabs in Code

ssnap utility
Tools and Where to Get Them

structural links
Automatic Links

style, online
Guidelines for Organizing an Online Book

supplementary reading
Supplementary Reading

symbols
copyright
Create Valid Copyright and Trademark Symbols
creating
Quick Reference: Rules for Using the Templates
invalid
Problem: Untranslated Function Character
non-alphanumeric, entering
Create Valid Dashes
Create Valid Copyright and Trademark Symbols
trademark
Create Valid Copyright and Trademark Symbols

TableFootnote paragraph tag
Problem: Footnote Paragraph Tag

tables
creating
Quick Reference: Rules for Using the Templates
Creating Tables
footnotes
Problem: Maximum Number of Table Footnotes
Footnotes
links, creating
Writer-Generated Links
tags, unknown
Problem: Unknown Frame Tag

tabs
in code
Don't Put Tabs in Code
tagging
Quick Reference: Rules for Using the Templates

tabs directory
Standard Files in a Local Working Directory

tags
character. See character tags
Supplementary Reading
creating
Use Valid Tag Sequences
guidelines
Quick Reference: Rules for Using the Templates
obsolete
Problem: Tag is Obsolete
paragraph. See paragraph tags
Supplementary Reading
placement
Problem: Hierarchy Problem
sequences, valid
Use Valid Tag Sequences
SGML
SGML Tag Structure
tips
Tagging FrameMaker Files
unclosed
Problem: Unclosed Tags
variables
Problem: Illegal Tag

targets, unused
Problem: Possible Unused Target

templates
annotated
The FrameMaker File
guidelines
Quick Reference: Rules for Using the Templates
obtaining
Copying Template Files to Your Working Directory
structure
Use Valid Tag Sequences
tags, using
Tagging FrameMaker Files

terminology, consistency of
Use Terms Consistently

testing online help
Building and Testing the Online Help

text indentation
Quick Reference: Rules for Using the Templates

TextInd* paragraph tags
Quick Reference: Rules for Using the Templates

tips for online writing
Guidelines for Organizing an Online Book

Title paragraph tag
Quick Reference: Rules for Using the Templates

TITLE variable
Editing the Makefile

titles
Choosing a Book's Title

tools, setting up
Setting Up Tools and Environment

trademark symbol
Create Valid Copyright and Trademark Symbols

translation errors
MIF-to-SGML Translation Errors
The Translation Error and Warning Report

troubleshooting
book-building
Finding and Fixing Online Book Errors
displaying
Checking for Display Problems
glossary links
Creating Glossary Links
help, online
Troubleshooting
make
If make Doesn't Work
templates
Quick Reference: Rules for Using the Templates

unclosed tags
Problem: Unclosed Tags

unknown errors
Unknown Errors

URLs
Using the World Wide Web from Your Help Menu

variables, character tags
Problem: Illegal Tag

VERSION variable
Editing the Makefile

viewing a book
Viewing a Built Book

whitespace
character tags
Problem: Character Tag Spans Hanging List
tagging
Quick Reference: Rules for Using the Templates

widgets
Creating Context Sensitive Help

windows, capturing
Screen Captures of Windows

winsnap utility
Screen Captures of Windows

wording, print-oriented
Avoid Print-Oriented Wording

words, tagging
Quick Reference: Rules for Using the Templates

working directory
Organizing a Local Working Directory

World Wide Web
Using the World Wide Web from Your Help Menu

writing tips for online
Guidelines for Organizing an Online Book

WWW
Using the World Wide Web from Your Help Menu

.xwd files
Image File Naming Conventions

XWD image format
Supported Image Formats

XWD variable
Adding Image Files to the Makefile