home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
OS/2 Shareware BBS: 8 Other
/
08-Other.zip
/
HELPDEMO.ZIP
/
HELPDEMO.INF
(
.txt
)
Wrap
OS/2 Help File
|
1990-02-23
|
361KB
|
3,448 lines
ΓòÉΓòÉΓòÉ 1. Introduction ΓòÉΓòÉΓòÉ
This is a demonstration of the 1.2 Information Presentation Facility. It will
attempt to make you familiar with the different things that IPF supports.
Select Word or Graphic
Throughout the demo you will be asked to select words or grahpics. Select
means to press the Tab key until the word or graphic is highlighted then press
the Enter key. If you are a mouse user, click on the word or graphic.
Return to Previous Panel
To return to a previous panel from a hypertext link, press the Esc key. If you
are a mouse user, select "Options" in the Action Bar, then select "Previous".
Exit IPF Demo
To exit the Information Presentation Facility, press the F3 key. If you are a
mouse user, select "Services" in the Action Bar, then select "Exit".
ΓòÉΓòÉΓòÉ <hidden> Information Presentation Facility Demo ΓòÉΓòÉΓòÉ
ΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇΓûÇΓûÇ
ΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇ
ΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇ
ΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇ
ΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇ
ΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇ
ΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇΓûÇ
ΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇΓûÇ ΓûÇΓûÇΓûÇΓûÇ ΓûÇ ΓûÇΓûÇΓûÇΓûÇ
ΓòöΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòù
Γòæ IBM Information Presentation Facility Γòæ
Γòæ Demonstration 1.0 Γòæ
ΓòÜΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓò¥
(C) Copyright IBM Corporation 1989
ΓòÉΓòÉΓòÉ 2. Hypertext ΓòÉΓòÉΓòÉ
Select the highlighted word to see a hypertext link.
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Hypertext Link Syntax ΓòÉΓòÉΓòÉ
The hypertext link requires the placing of two tag strings. The first tag
string is placed within the text of the panel and surrounds the hypertexted
word or phrase.
ΓöÇΓöÇ :link res=a reftype=hd ΓöÇΓöÇ . ΓöÇΓöÇ HYPERTEXT PHRASE ΓöÇΓöÇ :elink. ΓöÇΓöÇΓöñ
The second tag string is placed outside the text of the panel. This tag string
creates a new panel that will contain the hypertexted information. If the panel
you want to link to already exists, then omit this step.
Note: Be sure that the res=a of the hypertext link matches the res=a of the
panel being linked.
ΓöÇΓöÇ :hn ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ . ΓöÇΓöÇ TITLE ΓöÇΓöÇΓöñ
Γö£ id=a ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ Γöö hide Γöÿ
Γö£ res=b ΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γö£ name=c ΓöÇΓöÇΓöÇΓöÇΓöñ
Γöö tutorial=d Γöÿ
A heading:
o Creates a new panel and places the title in the title area of the panel.
Note: Headings listed in the docprof toc= tag are used to create new panels.
The default setting is docprof toc=123.
o Creates a heading within a panel.
Note: Headings not listed in the docprof toc= tag are used to create
headings within a panel.
o Can have a title with up to 70 characters including blank spaces.
Note: If no title is specified, an error will occur during the compile, and
the panel will not be created.
If the panel title exceeds the width of the window, the title is clipped
until the window is sized large enough to display it.
o Places the title of the panel in the Table of Contents window.
Note: The hide attribute keeps the title hidden from the Table of Contents.
o Can be referenced by another panel using the res=, name=, or id= attribute.
Note: The res= attribute is the preferred one.
o Can associate a tutorial with a panel and add the word Tutorial to the Main
Window Help pull-down.
o Requires that the heading levels be used in order and no heading level is
skipped. For example, a :h1. heading must precede a :h2. heading. Likewise,
a :h4. heading cannot be used until a :h1, :h2, :h3 heading has been used.
ΓòÉΓòÉΓòÉ <hidden> Hypertext Link Markup ΓòÉΓòÉΓòÉ
:h1 res=20.Hypertext
:i1.hypertext link
:p.Select the highlighted word to see a :link reftype=hd res=21.hypertext
link:elink.. :p.
:link reftype=hd res=22.Tag Syntax:elink. :link reftype=hd
res=23.Markup:elink.
:h1 res=21 hide.Hypertext Link Window
:p.This is the window linked to by the hypertext link. To return to the
previous window press the Esc key.
ΓòÉΓòÉΓòÉ <hidden> Hypertext Link Window ΓòÉΓòÉΓòÉ
This is the window linked to by the hypertext link. To return to the previous
window press the Esc key.
ΓòÉΓòÉΓòÉ 3. Footnote ΓòÉΓòÉΓòÉ
At times you may want to keep the original panel up and display additional
information in a small window. The small window is called a footnote.
Select the word Footnote to see a footnote.
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Footnote Syntax ΓòÉΓòÉΓòÉ
The footnote link requires the placing of two tag strings. The first tag
string is placed within the text of the panel and surrounds the hypertexted
word or phrase.
ΓöÇΓöÇ :link refid=a reftype=fn. ΓöÇΓöÇ HYPERTEXT WORD ΓöÇΓöÇ :elink. ΓöÇΓöÇΓöñ
The second tag string can be placed either inside or outside the text of the
panel. This tag string creates the footnote panel that will contain the
hypertexted information. If the footnote you want to link to already exists,
then omit this step.
Note: Be sure that the refid=name of the hypertext link matches the id=name of
the footnote being linked.
ΓöÇΓöÇ :fn id=a. ΓöÇΓöÇΓöÇΓöÇ FOOTNOTE TEXT ΓöÇΓöÇΓöÇΓöÇ :efn ΓöÇΓöÇΓöñ
A footnote:
o Displays the information in a small pop-up window.
o Requires that one footnote ends before another begins.
o Cannot contain index entries.
o Requires that the the id= of a the footnote tag match the refid= of the link
tag .
Note: A single footnote can be linked to many hypertext links by referencing
the same footnote id= attribute.
ΓòÉΓòÉΓòÉ <hidden> Footnote Markup ΓòÉΓòÉΓòÉ
:h1 res=30.Footnote
:i1.footnote
:p.At times you may want to keep the original panel up and display additional
information in a small window. The small window is called a footnote.
:p.Select the word :link reftype=fn refid=footnote.Footnote:elink. to see a
footnote.
:fn id=footnote.This is the footnote window linked to the word Footnote.:efn.
:p.
:link reftype=hd res=31.Tag Syntax:elink. :link reftype=hd
res=32.Markup:elink.
ΓòÉΓòÉΓòÉ 4. Figure ΓòÉΓòÉΓòÉ
This is an example of a figure with a caption.
W* * * * * *N***********************************
W** * * * **W
W* * * * * *N***********************************
W** * * * **W
W* * * * * *N***********************************
W** * * * **W
W* * * * * *N***********************************
W** * * * **W
W* * * * * *N***********************************
***************************************************i
***************************************************i
Flag of the United States of America
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Figure Syntax ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :fig. ΓöÇΓöÇΓöÇΓöÇ FIGURE ΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ :efig. ΓöÇΓöÇΓöÇΓöÇΓöñ
Γöö :figcap.Text Γöÿ
A figure:
o Places a blank line before and after the figure.
o Displays the information in the figure in proportional font.
Note: This may cause words and numbers not to line up. You may have to
insert or delete spaces to line up the information.
o Clips information that exceeds the panel area of the window.
o Allows the placing of a caption at the top or bottom of the figure.
Note: The caption cannot contain tags or semi-colons.
ΓòÉΓòÉΓòÉ <hidden> Figure Markup ΓòÉΓòÉΓòÉ
:h1 res=40.Figure
:i1.figures
:p.This is an example of a figure with a caption.
:fig.
:color fc=blue bc=blue.W:color fc=yellow bc=blue.* * * * * *:color fc=blue bc=blue.N:color fc=red bc=red.***********************************
:color fc=blue bc=blue.W*:color fc=yellow.* * * * *:color fc=blue bc=blue.*W:color fc=default bc=default.
:color fc=blue bc=blue.W:color fc=yellow bc=blue.* * * * * *:color fc=blue bc=blue.N:color fc=red bc=red.***********************************
:color fc=blue bc=blue.W*:color fc=yellow.* * * * *:color fc=blue bc=blue.*W:color fc=default bc=default.
:color fc=blue bc=blue.W:color fc=yellow bc=blue.* * * * * *:color fc=blue bc=blue.N:color fc=red bc=red.***********************************
:color fc=blue bc=blue.W*:color fc=yellow.* * * * *:color fc=blue bc=blue.*W:color fc=default bc=default.
:color fc=blue bc=blue.W:color fc=yellow bc=blue.* * * * * *:color fc=blue bc=blue.N:color fc=red bc=red.***********************************
:color fc=blue bc=blue.W*:color fc=yellow.* * * * *:color fc=blue bc=blue.*W:color fc=default bc=default.
:color fc=blue bc=blue.W:color fc=yellow bc=blue.* * * * * *:color fc=blue bc=blue.N:color fc=red bc=red.***********************************
:p.
:color fc=red bc=red.***************************************************i
:p.
:color fc=red bc=red.***************************************************i
:color fc=default bc=default.
:figcap.Flag of the United States of America
:efig.
:p.
:link reftype=hd res=41.Tag Syntax:elink. :link reftype=hd
res=42.Markup:elink.
ΓòÉΓòÉΓòÉ 5. Character Graphics ΓòÉΓòÉΓòÉ
This is an example of character graphics.
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
Γöé ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ Information Γöé
Γöé Γöé SGML Γöé Presentation Γöé
Γöé Γöé PE Γö£ΓöÇΓöÇΓöÇΓöÉ Compiler Facility Γöé
Γöé Γöé FILE Γöé Γöé Output File Γöé
Γöé ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ Γöé ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ Γöé
Γöé Γöé ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ Γöé Γöé ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ Γöé
Γöé Γöé Γöé IPFC Γöé Γöé Γöé Γöé IPF Γöé Γöé Γöé Γöé
Γöé Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇ>Γöé Γö£ΓöÇΓöÇΓöÇ>Γöé .HLP Γö£ΓöÇΓöÇΓöÇΓöÇ>Γöé Γö£ΓöÇΓöÇΓöÇ>Γöé Display Γöé Γöé
Γöé Γöé Γöé EXE Γöé Γöé Γöé Γöé EXE Γöé Γöé Γöé Γöé
Γöé ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ Γöé Γöé Γöé ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ Γöé Γöé ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ Γöé
Γöé Γöé Γöé Γöé ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ Γöé
Γöé Γöé IPFL Γöé Γöé Γöé
Γöé Γöé PE Γö£ΓöÇΓöÇΓöÇΓöÿ Γöé
Γöé Γöé FILE Γöé Γöé
Γöé Γöé Γöé Γöé
Γöé ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Character Graphic Syntax ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :cgraphic. ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇ GRAPHIC ΓöÇΓöÇΓöÇΓöÇΓöÇ :ecgraphic. ΓöÇΓöÇΓöñ
A character graphic:
o Displays the data in a monospace font.
o Instructs the compiler to use special characters to create the drawings.
o Places a blank line before and after the drawing.
ΓòÉΓòÉΓòÉ <hidden> Character Graphic Markup ΓòÉΓòÉΓòÉ
:h1 res=50.Character Graphics
:i1.character graphics
:p.This is an example of character graphics. :cgraphic.
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
Γöé ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ Information Γöé
Γöé Γöé SGML Γöé Presentation Γöé
Γöé Γöé PE Γö£ΓöÇΓöÇΓöÇΓöÉ Compiler Facility Γöé
Γöé Γöé FILE Γöé Γöé Output File Γöé
Γöé ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ Γöé ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ Γöé
Γöé Γöé ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ Γöé Γöé ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ Γöé
Γöé Γöé Γöé IPFC Γöé Γöé Γöé Γöé IPF Γöé Γöé Γöé Γöé
Γöé Γö£ΓöÇΓöÇΓöÇΓöÇΓöÇ>Γöé Γö£ΓöÇΓöÇΓöÇ>Γöé .HLP Γö£ΓöÇΓöÇΓöÇΓöÇ>Γöé Γö£ΓöÇΓöÇΓöÇ>Γöé Display Γöé Γöé
Γöé Γöé Γöé EXE Γöé Γöé Γöé Γöé EXE Γöé Γöé Γöé Γöé
Γöé ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ Γöé Γöé Γöé ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ Γöé Γöé ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ Γöé
Γöé Γöé Γöé Γöé ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ Γöé
Γöé Γöé IPFL Γöé Γöé Γöé
Γöé Γöé PE Γö£ΓöÇΓöÇΓöÇΓöÿ Γöé
Γöé Γöé FILE Γöé Γöé
Γöé Γöé Γöé Γöé
Γöé ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ Γöé
ΓööΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
:ecgraphic. :p.
:link reftype=hd res=51.Tag Syntax:elink. :link reftype=hd
res=52.Markup:elink.
ΓòÉΓòÉΓòÉ 6. Examples ΓòÉΓòÉΓòÉ
This is an example of an example.
6(5 + 3) + 7 = 55
This is an example of an example using color.
Employee Name Serial Number Salary
J. R. Greer 031654 27,234
N. A. Cook 279561 25,997
C. P. Sullivan 652134 28,001
C. Williams 007481 26,454
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Example Syntax ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :xmp. ΓöÇΓöÇΓöÇ EXAMPLE ΓöÇΓöÇΓöÇ :exmp. ΓöÇΓöÇΓöñ
An example:
o Displays the information in monospace font.
Note: An example tag cannot be placed within another example tag.
o Clips information that exceeds the panel area of the window.
o Indents the example two spaces from the left margin setting.
ΓòÉΓòÉΓòÉ <hidden> Example Markup ΓòÉΓòÉΓòÉ
:h1 res=60.Examples
:i1.examples
:p.This is an example of an example. :p.
:xmp. 6(5 + 3) + 7 = 55 :exmp.
:p.This is an example of an example using color. :color fc=red.
:xmp.
:hp2.Employee Name Serial Number Salary:ehp2.
J. R. Greer 031654 27,234
N. A. Cook 279561 25,997
C. P. Sullivan 652134 28,001
C. Williams 007481 26,454
:exmp. :color fc=default. :p.
:link reftype=hd res=61.Tag Syntax:elink. :link reftype=hd
res=62.Markup:elink.
ΓòÉΓòÉΓòÉ 7. Highlighting ΓòÉΓòÉΓòÉ
These are examples of the nine different highlighting phrases.
This is an example of highlighting phrase 1.
This is an example of highlighting phrase 2.
This is an example of highlighting phrase 3.
This is an example of highlighting phrase 4.
This is an example of highlighting phrase 5.
This is an example of highlighting phrase 6.
This is an example of highlighting phrase 7.
This is an example of highlighting phrase 8.
This is an example of highlighting phrase 9.
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Highlighting Syntax ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :hpn. ΓöÇΓöÇ TEXT ΓöÇΓöÇ :ehpn. ΓöÇΓöÇΓöñ
The highlighting tag:
o Changes the font and/or color of the text, or underlines it.
Note: The color of the text is dependent upon the type of display you have.
o Cannot be nested within another highlighting tag.
ΓòÉΓòÉΓòÉ <hidden> Highlighting Markup ΓòÉΓòÉΓòÉ
:h1 res=70.Highlighting
:i1.highlighting
:p.These are examples of the nine different highlighting phrases.
:p.
:hp1.This is an example of highlighting phrase 1.:ehp1.
:p.
:hp2.This is an example of highlighting phrase 2.:ehp2.
:p.
:hp3.This is an example of highlighting phrase 3.:ehp3.
:p.
:hp4.This is an example of highlighting phrase 4.:ehp4.
:p.
:hp5.This is an example of highlighting phrase 5.:ehp5.
:p.
:hp6.This is an example of highlighting phrase 6.:ehp6.
:p.
:hp7.This is an example of highlighting phrase 7.:ehp7.
:p.
:hp8.This is an example of highlighting phrase 8.:ehp8.
:p.
:hp9.This is an example of highlighting phrase 9.:ehp9.
:p.
:link reftype=hd res=71.Tag Syntax:elink. :link reftype=hd
res=72.Markup:elink.
ΓòÉΓòÉΓòÉ 8. Colors ΓòÉΓòÉΓòÉ
This is an example of the different foreground and background color
combinations.
Default on Blue Blue on Default
Default on Cyan Cyan on Default
Default on Green Green on Default
Default on Neutral Neutral on Default
Default on Red Red on Default
Default on Yellow Yellow on Default
Blue on Cyan Cyan on Blue
Blue on Green Green on Blue
Blue on Neutral Neutral on Blue
Blue on Red Red on Blue
Blue on Yellow Yellow on Blue
Cyan on Green Green on Cyan
Cyan on Neutral Neutral on Cyan
Cyan on Red Red on Cyan
Cyan on Yellow Yellow on Cyan
Green on Neutral Neutral on Green
Green on Red Red on Green
Green on Yellow Yellow on Green
Neutral on Red Red on Neutral
Neutral on Yellow Yellow on Neutral
Red on Yellow Yellow on Red
Default on Default
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Color Syntax ΓòÉΓòÉΓòÉ
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
Γöé
ΓöÇΓöÇ :color ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓö┤ΓöÇ . ΓöÇΓöÇΓöñ
Γö£ fc=color Γöñ
Γöö bc=color Γöÿ
The color tag:
o Changes the color of the background beneath the text.
o Changes the color of the text.
o Remains in effect until it is changed.
Note: To return to the system colors, use fc=default and bc=default.
ΓòÉΓòÉΓòÉ <hidden> Color Markup ΓòÉΓòÉΓòÉ
:h1 res=80.Colors
:i1.colors
:p.This is an example of the different foreground and background color
combinations.
:p.:color fc=default bc=blue.Default on Blue :color fc=blue bc=default.Blue on Default
:p.:color fc=default bc=cyan.Default on Cyan :color fc=cyan bc=default.Cyan on Default
:p.:color fc=default bc=green.Default on Green :color fc=green bc=default.Green on Default
:p.:color fc=default bc=neutral.Default on Neutral :color fc=neutral bc=default.Neutral on Default
:p.:color fc=default bc=red.Default on Red :color fc=red bc=default.Red on Default
:p.:color fc=default bc=yellow.Default on Yellow :color fc=yellow bc=default.Yellow on Default
:p.:color fc=blue bc=cyan.Blue on Cyan :color fc=cyan bc=blue.Cyan on Blue
:p.:color fc=blue bc=green.Blue on Green :color fc=green bc=blue.Green on Blue
:p.:color fc=blue bc=neutral.Blue on Neutral :color fc=neutral bc=blue.Neutral on Blue
:p.:color fc=blue bc=red.Blue on Red :color fc=red bc=blue.Red on Blue
:p.:color fc=blue bc=yellow.Blue on Yellow :color fc=yellow bc=blue.Yellow on Blue
:p.:color fc=cyan bc=green.Cyan on Green :color fc=green bc=cyan.Green on Cyan
:p.:color fc=cyan bc=neutral.Cyan on Neutral :color fc=neutral bc=cyan.Neutral on Cyan
:p.:color fc=cyan bc=red.Cyan on Red :color fc=red bc=cyan.Red on Cyan
:p.:color fc=cyan bc=yellow.Cyan on Yellow :color fc=yellow bc=cyan.Yellow on Cyan
:p.:color fc=green bc=neutral.Green on Neutral :color fc=neutral bc=green.Neutral on Green
:p.:color fc=green bc=red.Green on Red :color fc=red bc=green.Red on Green
:p.:color fc=green bc=yellow.Green on Yellow :color fc=yellow bc=green.Yellow on Green
:p.:color fc=neutral bc=red.Neutral on Red :color fc=red bc=neutral.Red on Neutral
:p.:color fc=neutral bc=yellow.Neutral on Yellow :color fc=yellow bc=neutral.Yellow on Neutral
:p.:color fc=red bc=yellow.Red on Yellow :color fc=yellow bc=red.Yellow on Red
:p.:color fc=default bc=default.Default on Default
:p.
:link reftype=hd res=81.Tag Syntax:elink. :link reftype=hd
res=82.Markup:elink.
ΓòÉΓòÉΓòÉ 9. Lists ΓòÉΓòÉΓòÉ
The Information Presentation Facility supports 5 different types of lists.
Simple Lists
Unordered Lists
Ordered Lists
Parameter Lists
Definition Lists
Nested Lists
ΓòÉΓòÉΓòÉ 9.1. Simple Lists ΓòÉΓòÉΓòÉ
This is an example of a compact simple list.
Oceans
Atlantic
Pacific
Indian
Artic
Antarctic
This is an example of a simple list.
Continents
Africa
Antarctica
Asia
Australia
Europe
North America
South America
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Simple List Syntax ΓòÉΓòÉΓòÉ
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ Γöé
Γöé
ΓöÇΓöÇ :sl ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ . ΓöÇΓöÇ :li. ΓöÇΓöÇ ITEM ΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓö┤ΓöÇΓöÇ :esl. ΓöÇΓöÇΓöñ
Γöö compact Γöÿ Γöö :lp.PARAGRAPH Γöÿ
A simple list:
o Has no bullets, hyphens, dashes, letters, or numbers preceding the items in
the list.
o Places a blank line between each item.
Note: The compact attribute causes the list to be displayed without a blank
line between each item.
o Can have paragraphs within the list.
o Can have any other type of list nested within it.
o Can be nested within any other type of list.
Note: A simple list is indented four spaces when nested within another list.
ΓòÉΓòÉΓòÉ <hidden> Simple List Markup ΓòÉΓòÉΓòÉ
:h2 res=91.Simple Lists
:i1.simple lists
:p.This is an example of a compact simple list.
:p.Oceans
:sl compact.
:li.Atlantic
:li.Pacific
:li.Indian
:li.Artic
:li.Antarctic
:esl.
:p.This is an example of a simple list.
:p.Continents
:sl.
:li.Africa
:li.Antarctica
:li.Asia
:li.Australia
:li.Europe
:li.North America
:li.South America
:esl.
:p. :link reftype=hd res=911.Tag Syntax:elink. :link reftype=hd
res=912.Markup:elink.
ΓòÉΓòÉΓòÉ 9.2. Unordered lists ΓòÉΓòÉΓòÉ
This is an example of a compact unordered list.
Vegetables
o Cabbage
o Corn
o Onions
o Parsnips
o Sweet Potatoes
This is an example of an unordered list.
Fruits
o Apples
o Grapes
o Oranges
o Pears
o Strawberries
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Unordered List Syntax ΓòÉΓòÉΓòÉ
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ Γöé
Γöé
ΓöÇΓöÇ :ul ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ . ΓöÇΓöÇ :li. ΓöÇΓöÇ ITEM ΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓö┤ΓöÇΓöÇ :eul. ΓöÇΓöÇΓöñ
Γöö compact Γöÿ Γöö :lp.PARAGRAPH Γöÿ
An unordered list:
o Has a bullet preceding each item in the list.
Note: This is true of levels 1, 3, 5, 7, etc. Levels 2, 4, 6, etc. are
preceded by a hyphen. The bullets and hyphens alternate with each nested
level.
o Places a blank line between each item in the list.
Note: The compact attribute causes the list to be displayed without a blank
line between each item.
o Can have paragraphs within the list.
o Can have any other type of list nested within it.
o Can be nested within any other type of list.
Note: An unordered list nested within a list is indented four spaces.
ΓòÉΓòÉΓòÉ <hidden> Unordered List Markup ΓòÉΓòÉΓòÉ
:h2 res=92.Unordered lists
:i1.unordered lists
:p.This is an example of a compact unordered list.
:p.Vegetables
:ul compact.
:li.Cabbage
:li.Corn
:li.Onions
:li.Parsnips
:li.Sweet Potatoes
:eul.
:p.This is an example of an unordered list.
:p.Fruits
:ul.
:li.Apples
:li.Grapes
:li.Oranges
:li.Pears
:li.Strawberries
:eul.
:p. :link reftype=hd res=921.Tag Syntax:elink. :link reftype=hd
res=922.Markup:elink.
ΓòÉΓòÉΓòÉ 9.3. Ordered lists ΓòÉΓòÉΓòÉ
This is an example of a compact ordered list.
Feeding a cat
1. Select can of cat food
2. Open can
3. Place contents of can in dish
4. Say "Here Kitty Kitty"
5. Place dish on floor.
This is an example of an ordered list.
Mailing a letter
1. Write letter
2. Address envelope
3. Place letter in envelope
4. Affix stamp
5. Place letter in mailbox
6. Raise mailbox flag.
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Ordered List Syntax ΓòÉΓòÉΓòÉ
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ Γöé
Γöé
ΓöÇΓöÇ :ol ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ . ΓöÇΓöÇ :li. ΓöÇΓöÇ ITEM ΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓö┤ΓöÇΓöÇ :eol. ΓöÇΓöÇΓöñ
Γöö compact Γöÿ Γöö :lp.PARAGRAPH Γöÿ
An ordered list:
o Has a number preceding each item in the list.
Note: This is true of levels 1, 3, 5, 7, etc. Levels 2, 4, 6, etc. are
preceded by letters. The numbers and letters alternate with each nested
level.
o Places a blank line between each item in the list.
Note: The compact attribute causes the list to be displayed without a blank
line between each item.
o Can have paragraphs within the list.
o Can have any other type of list nested within it.
o Can be nested within any other type of list.
Note: An ordered list nested within a list is indented two spaces.
ΓòÉΓòÉΓòÉ <hidden> Ordered List Markup ΓòÉΓòÉΓòÉ
:h2 res=93.Ordered lists
:i1.ordered lists
:p.This is an example of a compact ordered list.
:p.Feeding a cat
:ol compact.
:li.Select can of cat food
:li.Open can
:li.Place contents of can in dish
:li.Say "Here Kitty Kitty"
:li.Place dish on floor.
:eol.
:p.This is an example of an ordered list.
:p.Mailing a letter
:ol.
:li.Write letter
:li.Address envelope
:li.Place letter in envelope
:li.Affix stamp
:li.Place letter in mailbox
:li.Raise mailbox flag.
:eol.
:p. :link reftype=hd res=931.Tag Syntax:elink. :link reftype=hd
res=932.Markup:elink.
ΓòÉΓòÉΓòÉ 9.4. Parameter lists ΓòÉΓòÉΓòÉ
This is an example of a compact parameter list.
Time Parameters
Parameter Description
hours Specifies hours from 0 through 23.
minutes Specifies minutes from 0 through 59.
seconds Specifies seconds from 0 through 59.
100ths seconds Specifies hundredths of a second from 0 through 99.
This is an example of a parameter list.
Atomic Symbols
Symbol Element
O Oxygen
Rn Radon
Pu Plutonium
He Helium
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Parameter List Syntax ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :parml ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ . ΓöÇΓöÇ
Γöö compact Γöÿ Γöö tsize=n Γöÿ Γöö break=noneΓöéfitΓöéall Γöÿ
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
Γöé
ΓöÇΓöÇΓöÇ :pt.ΓöÇΓöÇ TERM ΓöÇΓöÇ :pd.ΓöÇΓöÇ DEFINITION ΓöÇΓö┤ΓöÇ :eparml. ΓöÇΓöÇΓöñ
A parameter list:
o Displays the list in two columns. The term is displayed in the left column
and the definition in the right column.
Note: If either the term or definition tag is missing, the compiler will
issue a warning error. You can ignore the error if you do not want to
specify either a term or definition for the item.
o Places a blank line between the items in the list.
Note: The compact attribute causes the list to be displayed without a blank
line between each item.
o Allows as the default, 10 character spaces for the term column.
Note: This can be changed using the tsize= attribute.
o Places the definition text on the same line as the term text.
Note: This can be changed using the break=none|fit|all attribute.
ΓòÉΓòÉΓòÉ <hidden> Parameter List Markup ΓòÉΓòÉΓòÉ
:h2 res=94.Parameter lists
:i1.parameter lists
:p.This is an example of a compact parameter list.
:p.Time Parameters
:parml tsize=23 break=none compact.
:pt.Parameter
:pd.Description
:pt.hours
:pd.Specifies hours from 0 through 23.
:pt.minutes
:pd.Specifies minutes from 0 through 59.
:pt.seconds
:pd.Specifies seconds from 0 through 59.
:pt.100ths seconds
:pd.Specifies hundredths of a second from 0 through 99.
:eparml.
:p.This is an example of a parameter list.
:p.Atomic Symbols
:parml tsize=12 break=none.
:pt.Symbol
:pd.Element
:pt.O
:pd.Oxygen
:pt.Rn
:pd.Radon
:pt.Pu
:pd.Plutonium
:pt.He
:pd.Helium
:eparml.
:p. :link reftype=hd res=941.Tag Syntax:elink. :link reftype=hd
res=942.Markup:elink.
ΓòÉΓòÉΓòÉ 9.5. Definition lists ΓòÉΓòÉΓòÉ
This is an example of a definition list.
Animal Description
Squirrel A tree climbing rodent with gray or reddish-brown fur and a bushy
tail.
Dog A domesticated mammal related to wolves and foxes.
Bat A mouselike flying mammal with membranous wings.
This is an example of a compact definition list.
Gems Description
Sapphire A relatively pure form of corundum, usually blue.
Diamond An extremely hard, colorless or white crystalline form of carbon.
Opal A translucent mineral of hydrated silicon dioxide.
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Definition List Syntax ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :dl ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ . ΓöÇΓöÇ
Γöö compact Γöÿ Γöö tsize=n Γöÿ Γöö break=noneΓöéfitΓöéall Γöÿ
ΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ
Γöö :dthd.TERM HEADING Γöÿ Γöö :ddhd.DEFINITION HEADING Γöÿ
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
Γöé
ΓöÇΓöÇ:dt.ΓöÇΓöÇ TERM ΓöÇΓöÇ :dd. ΓöÇΓöÇ DEFINITION ΓöÇΓöÇΓö┤ΓöÇΓöÇ :edl. ΓöÇΓöÇΓöñ
A definition list:
o Displays the list in two columns. The term is displayed in the left column
and the definition in the right column.
Note: If either the term or definition tag is missing, the compiler will
issue a warning error. You can ignore the error if you do not want to
specify either a term or definition for the item.
o Can include headings for both the term and definition columns.
Note: If a heading is specified for one column but not the other, the
compiler will issue a warning error. You can ignore the error if you only
want one heading.
o Places the headings above the text, in the same column and font as the list
item.
o Places a blank line between the items in the list.
Note: The compact attribute causes the list to be displayed without a blank
line between each item.
o Allows as the default, 10 character spaces for the term column.
Note: This can be changed using the tsize= attribute.
o Places the definition column text on the same line as the term columns text.
Note: This can be changed using the break=none|fit|all attribute.
ΓòÉΓòÉΓòÉ <hidden> Definition List Markup ΓòÉΓòÉΓòÉ
:h2 res=95.Definition lists
:i1.definition lists
:p.This is an example of a definition list.
:dl tsize=12 break=none.
:dthd. Animal
:ddhd.Description
:dt.Squirrel
:dd.A tree climbing rodent with gray or reddish-brown fur and a bushy tail.
:dt.Dog
:dd.A domesticated mammal related to wolves and foxes.
:dt.Bat
:dd.A mouselike flying mammal with membranous wings.
:edl.
:p.This is an example of a compact definition list.
:dl tsize=12 break=none compact.
:dthd.Gems
:ddhd.Description
:dt.Sapphire
:dd.A relatively pure form of corundum, usually blue.
:dt.Diamond
:dd.An extremely hard, colorless or white crystalline form of carbon.
:dt.Opal
:dd.A translucent mineral of hydrated silicon dioxide.
:edl.
:p. :link reftype=hd res=951.Tag Syntax:elink. :link reftype=hd
res=952.Markup:elink.
ΓòÉΓòÉΓòÉ 9.6. Nested Lists ΓòÉΓòÉΓòÉ
This is an example of a simple list nested within a simple list.
Meats
Beef
Pork
Poultry
Chicken
Turkey
Duck
Lamb
This is an example of an unordered list nested within an unordered list.
Colors
o Blue
o Red
- Pink
- Maroon
o Yellow
This is an example of an ordered list nested within an ordered list.
Flying a kite
1. Assemble kite
a. Place the ends of the kites' longest stick into the strings at the top
and bottom of the kite.
b. Place the ends of the kite's shortest stick into the strings on the
left and right side of the kite.
c. Tie tail to bottom of the kite
d. Tie kite string to string located at the cross.
2. Unwind about 10 feet of string.
3. Run until kite catches the wind.
4. Unwind string to allow kite to fly.
This is an example of a parameter list nested within a parameter list.
Money Country
Sol Peru
Shilling Kenya
Shilling Somalia
Shilling Uganda
Yen Japan
Birr Ethiopia
This is an example of a definition list nested within a definition list.
Word Definition
bicycle A vehicle with two wheels tandem, a steering handle, a
saddle seat, and pedals by which it is propelled.
airplane A fixed-wind aircraft heavier than air that is driven by a
screw propeller or by a high velocity jet and supported by
the dynamic reaction of the air against its wings.
train A connected line of railroad cars with or without a
locomotive.
truck A strong horse-drawn or automotvie vehicle for hauling.
truck A small flat-topped car pushed or pulled by hand.
truck A small barrow consisting of a rectangular frame having at
one end a pair of handles and at the other end a pair of
small heavy wheels and a projecting edge to slide under a
load.
bus A large motor-driven passenger vehicle operating usually
according to a schedule along a fixed route.
Markup
ΓòÉΓòÉΓòÉ <hidden> Nested List Syntax ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> Nested List Markup ΓòÉΓòÉΓòÉ
:h2 res=96.Nested Lists
:i1.nested lists
:p.This is an example of a simple list nested within a simple list.
:p.Meats
:sl compact.
:li.Beef
:li.Pork
:li.Poultry
:sl compact.
:li.Chicken
:li.Turkey
:li.Duck
:esl.
:li.Lamb
:esl.
:p.This is an example of an unordered list nested within an unordered list.
:p.Colors
:ul compact.
:li.Blue
:li.Red
:ul compact.
:li.Pink
:li.Maroon
:eul.
:li.Yellow
:eul.
:p.This is an example of an ordered list nested within an ordered list.
:p.Flying a kite
:ol compact.
:li.Assemble kite
:ol compact.
:li.Place the ends of the kites' longest stick into the strings at the top and
bottom of the kite.
:li.Place the ends of the kite's shortest stick into the strings on the left
and right side of the kite.
:li.Tie tail to bottom of the kite
:li.Tie kite string to string located at the cross.
:eol.
:li.Unwind about 10 feet of string.
:li.Run until kite catches the wind.
:li.Unwind string to allow kite to fly.
:eol.
:p.This is an example of a parameter list nested within a parameter list.
:parml tsize=20 break=fit compact.
:pt.Money
:pd.Country
:pt.Sol
:pd.Peru
:pt.Shilling
:pd.Kenya
:parml tsize=17 break=fit compact.
:pt.Shilling
:pd.Somalia
:pt.Shilling
:pd.Uganda
:eparml.
:pt.Yen
:pd.Japan
:pt.Birr
:pd.Ethiopia
:eparml.
:p.This is an example of a definition list nested within a definition list.
:dl tsize=20 compact.
:dthd.Word
:ddhd.Definition
:dt.bicycle
:dd.A vehicle with two wheels tandem, a steering handle, a saddle seat, and
pedals by which it is propelled.
:dt.airplane
:dd.A fixed-wind aircraft heavier than air that is driven by a screw propeller
or by a high velocity jet and supported by the dynamic reaction of the air
against its wings.
:dt.train
:dd.A connected line of railroad cars with or without a locomotive.
:dt.truck
:dd.A strong horse-drawn or automotvie vehicle for hauling.
:dl tsize=17 compact.
:dt.truck
:dd.A small flat-topped car pushed or pulled by hand.
:dt.truck
:dd.A small barrow consisting of a rectangular frame having at one end a pair
of handles and at the other end a pair of small heavy wheels and a projecting
edge to slide under a load.
:edl.
:dt.bus
:dd.A large motor-driven passenger vehicle operating usually according to a
schedule along a fixed route.
:edl.
:p. :link reftype=hd res=962.Markup:elink.
ΓòÉΓòÉΓòÉ 10. Headings ΓòÉΓòÉΓòÉ
This an example of the six different heading levels.
This is a Head 1.
This is a Head 2.
This is a Head 3.
This is a Head 4.
This is a Head 5.
This is a Head 6.
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Heading Syntax ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :hn ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ . ΓöÇΓöÇ TITLE ΓöÇΓöÇΓöñ
Γö£ id=a ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ Γöö hide Γöÿ
Γö£ res=b ΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γö£ name=c ΓöÇΓöÇΓöÇΓöÇΓöñ
Γöö tutorial=d Γöÿ
A heading:
o Creates a new panel and places the title in the title area of the panel.
Note: Headings listed in the docprof toc= tag are used to create new panels.
The default setting is docprof toc=123.
o Creates a heading within a panel.
Note: Headings not listed in the docprof toc= tag are used to create
headings within a panel.
o Can have a title with up to 70 characters including blank spaces.
Note: If the panel title exceeds the width of the window, the title is
clipped until the window is sized large enough to display it.
If no title is specified, an error will occur during the compile, and the
panel will not be created.
o Places the title of the panel in the Table of Contents window.
Note: The hide attribute keeps the title hidden from the Table of Contents.
o Can be referenced by another panel using the res=, name=, or id= attribute.
Note: The res= attribute is the preferred one.
o Can associate a tutorial with a panel and add the word Tutorial to the Main
Window Help pull-down.
o Requires that the heading levels be used in order and no heading level is
skipped. For example, a :h1. heading must precede a :h2. heading. Likewise,
a :h4. heading cannot be used until a :h1, :h2, :h3 heading has been used.
ΓòÉΓòÉΓòÉ <hidden> Heading Markup ΓòÉΓòÉΓòÉ
:h1 res=100.Headings
:i1.headings
:p.This an example of the six different heading levels.
:h1.This is a Head 1.
:h2.This is a Head 2.
:h3.This is a Head 3.
:h4.This is a Head 4.
:h5.This is a Head 5.
:h6.This is a Head 6.
:p. :link reftype=hd res=101.Tag Syntax:elink. :link reftype=hd
res=102.Markup:elink.
ΓòÉΓòÉΓòÉ 11. Margins ΓòÉΓòÉΓòÉ
These are examples of left and right margin settings.
This is an example of the left margin set to 5 and the right margin set to
40. Notice how the text is formatted between the margins.
This is an example of the left
margin set to 45 and the right
margin set to 1.
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Margin Syntax ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :lm ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ . ΓöÇΓöÇΓöñ
Γöö margin=a Γöÿ
ΓöÇΓöÇ :rm ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ . ΓöÇΓöÇΓöñ
Γöö margin=b Γöÿ
The left margin tag:
o Specifies where you want the left margin to begin.
Note: If you start the left margin tag after the boundary indicated by the
lm= value, the margin becomes effective on the following line.
o Remains in effect until another left margin is specified.
Note: The left most margin setting is 1.
The right margin tag:
o Specifies where you want the right margin to begin.
Note: If you start the right margin tag after the boundary indicated by the
rm= value, the margin becomes effective on the following line.
o Remains in effect until another right margin is specified.
Note: The right most margin setting is 1.
ΓòÉΓòÉΓòÉ <hidden> Margin Markup ΓòÉΓòÉΓòÉ
:h1 res=110.Margins
:i1.margins
:p.These are examples of left and right margin settings.
:lm margin=5.
:rm margin=40.
:p.This is an example of the left margin set to 5 and the right margin set to
40. Notice how the text is formatted between the margins.
:lm margin=45.
:rm margin=1.
:p.This is an example of the left margin set to 45 and the right margin set to
1.
:lm margin=1.
:p. :link reftype=hd res=111.Tag Syntax:elink. :link reftype=hd
res=112.Markup:elink.
ΓòÉΓòÉΓòÉ 12. Notices ΓòÉΓòÉΓòÉ
The Information Presentation Facility supports notes, and warning, caution, and
danger statements.
Notes
Warnings
Cautions
Dangers
ΓòÉΓòÉΓòÉ 12.1. Notes ΓòÉΓòÉΓòÉ
Note: This is an example of a single paragraph note.
Attention: This is also an example of a single paragraph note.
Note: This is an example of a multi-paragraph note.
It uses a different tag than the single paragraph note.
Important: This is also an example of a multi-paragraph note.
Notice that the word 'Note' has been changed to 'Important'.
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Note Syntax ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :note ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ . ΓöÇΓöÇ NOTE TEXT ΓöÇΓöÇΓöñ
Γöö text='phrase:' Γöÿ
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
Γöé
ΓöÇΓöÇ :nt ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ . ΓöÇΓöÇ NOTE TEXT ΓöÇΓöÇ :p. ΓöÇΓöÇ NOTE TEXT ΓöÇΓö┤ΓöÇ
Γöö text='phrase:' Γöÿ
ΓöÇΓöÇΓöÇΓöÇ :ent.ΓöÇΓöÇΓöñ
A single paragraph note:
o Places a blank line before the beginning of the note.
o Capitalizes the first letter in the word Note
Note: Displays the text within the text=' ' attribute of the note tag
exactly as it is entered.
o Places a semi-colon at the end of the word Note.
Note: A semi-colon is not automatically added when the text=' ' attribute of
the warning tag is used.
o Emphasizes the word Note: in bold type.
Note: Emphasizes the text within the text=' ' attribute in bold type.
o The body of the note begins on the same line as the Note: and wraps to the
next line even with the left margin if the note exceed one line.
A multi-paragraph note:
o Places a blank line before the beginning of the note.
o Capitalizes the first letter in the word Note:
Note: Displays the text within the text=' ' attribute of the note tag
exactly as it is entered.
o Places a semi-colon at the end of the word Note
Note: A semi-colon is not automatically added when the text=' ' attribute of
the note tag is used.
o Emphasizes the word Note: in bold type.
Note: Emphasizes the text within the text=' ' attribute in bold type.
o The body of the note begins on the same line as Note: with all subsequent
lines and paragraphs indented.
ΓòÉΓòÉΓòÉ <hidden> Note Markup ΓòÉΓòÉΓòÉ
:h2 res=121.Notes
:i1.notes
:p.
:note.This is an example of a single paragraph note.
:p.
:note text='Attention:'.This is also an example of a single paragraph note.
:p.
:nt.This is an example of a multi-paragraph note.
:p.It uses a different tag than the single paragraph note.
:ent.
:p.
:nt text='Important:'.This is also an example of a multi-paragraph note.
:p.Notice that the word 'Note' has been changed to 'Important'.
:ent.
:p. :link reftype=hd res=1211.Tag Syntax:elink. :link reftype=hd
res=1212.Markup:elink.
ΓòÉΓòÉΓòÉ 12.2. Warnings ΓòÉΓòÉΓòÉ
Warning: This is an example of a warning statement.
ROAD CLOSED: This is also an example of a warning statement.
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Warning Syntax ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :warning ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ . ΓöÇΓöÇ :ewarning. ΓöÇΓöÇΓöñ
Γöö text='phrase:' Γöÿ
A warning:
o Capitalizes the first letter in the word Warning:
Note: Displays the text within the text=' ' attribute of the warning tag
exactly as it is entered.
o Places a semi-colon at the end of the word Warning.
Note: A semi-colon is not automatically added when the text=' ' attribute of
the warning tag is used.
o Emphasizes the word Warning: in bold type.
Note: Emphasizes the text within the text=' ' attribute in bold type.
o The body of the warning statement begins on the same line as the Warning:
and wraps to the next line even with the left margin if the warning exceeds
one line.
ΓòÉΓòÉΓòÉ <hidden> Warning Markup ΓòÉΓòÉΓòÉ
:h2 res=122.Warnings
:i1.warnings
:p.
:warning.This is an example of a warning statement.:ewarning.
:p.
:warning text='ROAD CLOSED:'.This is also an example of a warning statement.:ewarning.
:p. :link reftype=hd res=1221.Tag Syntax:elink. :link reftype=hd
res=1222.Markup:elink.
ΓòÉΓòÉΓòÉ 12.3. Cautions ΓòÉΓòÉΓòÉ
CAUTION:
This is an example of a caution statement.
BEWARE:
This is also an example of a caution statement.
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Caution Syntax ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :caution ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ . ΓöÇΓöÇ :ecaution. ΓöÇΓöÇΓöñ
Γöö text='phrase:' Γöÿ
A caution:
o Capitalizes the word CAUTION
Note: Capitalizes the text within the text=' ' attribute of the caution tag.
o Places a semi-colon at the end of the word CAUTION
Note: A semi-colon is not automatically added when the text=' ' attribute of
the caution tag is used.
o Begins the body of the caution statement on a new line even with the left
margin.
ΓòÉΓòÉΓòÉ <hidden> Caution Markup ΓòÉΓòÉΓòÉ
:h2 res=123.Cautions
:i1.cautions
:p.
:caution.This is an example of a caution statement.:ecaution.
:p.
:caution text='BEWARE:'.This is also an example of a caution statement.:ecaution.
:p. :link reftype=hd res=1231.Tag Syntax:elink. :link reftype=hd
res=1232.Markup:elink.
ΓòÉΓòÉΓòÉ 12.4. Dangers ΓòÉΓòÉΓòÉ
Danger: This is an example of a danger statement.
RED ALERT: This is also an example of a danger statement.
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Danger Syntax ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :danger ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ . ΓöÇΓöÇ :edanger. ΓöÇΓöÇΓöñ
Γöö text='phrase:' Γöÿ
A danger:
o Capitalizes the first letter in the word Danger:
Note: Displays the text within the text=' ' attribute of the danger tag
exactly as it is entered.
o Places a semi-colon at the end of the word Danger.
Note: A semi-colon is not automatically added when the text=' ' attribute of
the danger tag is used.
o Emphasizes the word Danger: in bold type.
Note: Emphasizes the text within the text=' ' attribute in bold type.
o The body of the danger statement begins on the same line as the Danger: and
wraps to the next line even with the left margin if the Danger exceeds one
line.
ΓòÉΓòÉΓòÉ <hidden> Danger Markup ΓòÉΓòÉΓòÉ
:h2 res=124.Dangers
:i1.dangers
:p.
:danger.This is an example of a danger statement.:edanger.
:p.
:danger text='RED ALERT:'.This is also an example of a danger
statement.:edanger.
:p. :link reftype=hd res=1241.Tag Syntax:elink. :link reftype=hd
res=1242.Markup:elink.
ΓòÉΓòÉΓòÉ 13. Launch ΓòÉΓòÉΓòÉ
To see an example of a launch, select OS/2 System Editor. The OS/2 System
Editor will be started with the file SAMPLE.TXT loaded.
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Launch Syntax ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :link reftype=launch object='drive\path\filename.ext' ΓöÇΓöÇ
ΓöÇΓöÇ data='drive\path\filename.ext'. ΓöÇΓöÇ HYPERTEXT PHRASE ΓöÇΓöÇ :elink. ΓöÇΓöÇΓöñ
A launch:
o Starts another OS/2 application.
o Requires that the drive/path/filename.ext of the application to be started
be specified in the object=' ' attribute.
o Permits parameters to be passed to the starting program by specifying them
in the data=' ' attribute.
ΓòÉΓòÉΓòÉ <hidden> Launch Markup ΓòÉΓòÉΓòÉ
:h1 res=130.Launch
:i1.launch
:p.To see an example of a launch, select :link reftype=launch
object='C:\OS2\E.EXE' data='C:\OS2\SAMPLE.TXT'. OS/2 System Editor:elink.. The
OS/2 System Editor will be started with the file SAMPLE.TXT loaded.
:p. :link reftype=hd res=131.Tag Syntax:elink. :link reftype=hd
res=132.Markup:elink.
ΓòÉΓòÉΓòÉ 14. Inform ΓòÉΓòÉΓòÉ
To see an example of an inform, select Inform .
Note: This tag requires close cooperation with the application developer
working on the program in which you want to send a message.
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Inform Syntax ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :link res=a reftype=inform. ΓöÇΓöÇΓöÇ HYPERTEXT PHRASE ΓöÇΓöÇ:elink.ΓöÇΓöÇΓöñ
An inform:
o Requires that the link use the reftype=inform attribute.
Note: This option is only available in Help (.HLP) files, Information (.INF)
files cannot use it.
o Sends an HM_INFORM message to the application using the res= attribute as
the message.
Note: This requires close cooperation with an application developer.
ΓòÉΓòÉΓòÉ <hidden> Inform Markup ΓòÉΓòÉΓòÉ
:h1 res=140.Inform
:i1.inform
:p.To see an example of an inform, select :link res=1 reftype=inform.Inform
:elink.. :note.This tag requires close cooperation with the application
developer working on the program in which you want to send a message.
:p. :link reftype=hd res=141.Tag Syntax:elink. :link reftype=hd
res=142.Markup:elink.
ΓòÉΓòÉΓòÉ 15. Hypergraphics ΓòÉΓòÉΓòÉ
This is an example of a hypergraphic. Select the Shuttle graphic and get ready
for a walk on the moon.
ΓòÉΓòÉΓòÉ <hidden> Moonwalk Bitmap ΓòÉΓòÉΓòÉ
To return to Earth, press the Esc key. Happy landing!
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Hypergraphics Syntax ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :artwork ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇ :name='filename.ext'ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇ . ΓöÇΓöÇΓöñ
Γö£ align=leftΓöérightΓöécenter Γöñ
Γö£ linkfile='filename.ext' Γöñ
Γöö runin ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
The artwork tag:
o Places artwork within the document.
Note: The artwork must be in the form of a Presentation Manager bitmap.
o Aligns artwork to the left, right, or center of the current margins.
o Places artwork within a string of text.
o Permits artwork to be used as a hypertext link, called a hypergraphic.
Note: If artwork is to be used as a hypertext link, you must specify the
link coordinates in an artlink file.
o Names the file containing the artlink information.
The artlink file contains the artlink tag and:
o Lists the x, y, cx, and cy link coordinates of the hypergraphic.
Note: If the entire bitmapped artwork is to be used as a single link, then
you do not need to specify coordinates in the artlink file.
o Links the artwork to a heading.
o Links the artwork to a footnote.
o Launches another OS/2 application.
o Sends an inform message to an application.
Note: The inform link requires close cooperation with an application
developer.
ΓòÉΓòÉΓòÉ <hidden> Hypergraphics Markup ΓòÉΓòÉΓòÉ
:h1 res=150.Hypergraphics
:i1.hypergraphics
:p.This is an example of a hypergraphic. Select the Shuttle graphic and get ready for
a walk on the moon.
:artwork name='c:\helpdemo\shuttle.bmp' linkfile='c:\helpdemo\shuttle.dat'.
:h1 res=153 hide.Moonwalk Bitmap
:p.To return to Earth, press the Esc key. Happy landing!
:artwork name='c:\helpdemo\moonwalk.bmp'.
:p. :link reftype=hd res=151.Tag Syntax:elink. :link reftype=hd
res=152.Markup:elink.
ΓòÉΓòÉΓòÉ 16. Segmented Hypergraphics ΓòÉΓòÉΓòÉ
This is an example of a segmented hypergraphic. Select a component in the
graphic to see how it works.
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> CPU ΓòÉΓòÉΓòÉ
This is a PS/2 Model 8580 System Unit.
ΓòÉΓòÉΓòÉ <hidden> Display ΓòÉΓòÉΓòÉ
This is a PS/2 Model 8514 High-resolution Graphics display.
ΓòÉΓòÉΓòÉ <hidden> Keyboard ΓòÉΓòÉΓòÉ
This is a PS/2 keyboard.
ΓòÉΓòÉΓòÉ <hidden> Printer ΓòÉΓòÉΓòÉ
This is a Model 4201 Printer.
ΓòÉΓòÉΓòÉ <hidden> Segmented Hypergraphics Syntax ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :artlink.ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇ :link refid=a reftype=hd. ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇ :eartlink. ΓöÇΓöÇΓöñ
ΓöÇ :artlink.ΓöÇΓöÇ :link reftype=Γöî hd ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼
Γö£ fn ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γö£ inform ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöö launch object='filename.ext' data='filename.ext'Γöÿ
ΓöÇΓöÇ res=b ΓöÇΓöÇ x=c ΓöÇΓöÇ y=d ΓöÇΓöÇ cx=e ΓöÇΓöÇ cy=f. ΓöÇΓöÇ :eartlink. ΓöÇΓöÇΓöñ
The artwork tag:
o Places artwork within the document.
Note: The artwork must be in the form of a Presentation Manager bitmap.
o Aligns artwork to the left, right, or center of the current margins.
o Places artwork within a string of text.
o Permits artwork to be used as a hypertext link, called a hypergraphic.
Note: If artwork is to be used as a hypertext link, you must specify the
link coordinates in an artlink file.
o Names the file containing the artlink information.
The artlink file contains the artlink tag and:
o Lists the x, y, cx, and cy link coordinates of the hypergraphic.
Note: If the entire bitmapped artwork is to be used as a single link, then
you do not need to specify coordinates in the artlink file.
o Links the artwork to a heading.
o Links the artwork to a footnote.
o Launches another OS/2 application.
o Sends an inform message to an application.
Note: The inform link requires close cooperation with an application
developer.
ΓòÉΓòÉΓòÉ <hidden> Segmented Hypergraphics Markup ΓòÉΓòÉΓòÉ
:h1 res=160.Segmented Hypergraphics
:i1.segmented hypergraphics
:p.This is an example of a segmented hypergraphic. Select a component in
the graphic to see how it works.
:artwork name='c:\helpdemo\computr.bmp'
linkfile='c:\helpdemo\computr.lnx' align=center.
:p.
:link reftype=hd res=161.Tag Syntax:elink. :link reftype=hd
res=162.Markup:elink.
:p.
:h1 res=163 hide.CPU
:p.This is a PS/2 Model 8580 System Unit.
:artwork name='c:\helpdemo\cpu.bmp'.
:h1 res=164 hide.Display
:p.This is a PS/2 Model 8514 High-resolution Graphics display.
:artwork name='c:\helpdemo\display.bmp' align=center.
:h1 res=165 hide.Keyboard
:p.This is a PS/2 keyboard.
:artwork name='c:\helpdemo\keybrd.bmp' align=center.
:h1 res=166 hide.Printer
:p.This is a Model 4201 Printer.
:artwork name='c:\helpdemo\printer.bmp' align=center.
ΓòÉΓòÉΓòÉ 17. Index ΓòÉΓòÉΓòÉ
This is an example of an index. To see the actual index for this demo, select
Index from the Options pull-down.
cake, chocolate
cookies
fruit
banana
pineapple
pie
apple
cherry
strawberry rhubarb
pudding, tapioca
Tag Syntax Markup
ΓòÉΓòÉΓòÉ <hidden> Tag Syntax ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :i1 ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ . ΓöÇΓöÇ TEXT ΓöÇΓöÇΓöñ
Γöö id=a Γöÿ Γöö roots='root word' Γöÿ
ΓöÇΓöÇ :i2 ΓöÇΓöÇ refid=a. ΓöÇΓöÇ TEXT ΓöÇΓöÇΓöñ
ΓöÇΓöÇ :isyn root=WORD ΓöÇΓöÇ SYNONYMS ΓöÇΓöÇΓöñ
The index tag:
o Places primary (:i1.) and secondary (:i2.) entries in the index.
Note: An index entry cannot be placed in a footnote.
o Requires that the text of the entry be placed on the same line as the index
tag.
Note: The text of the index entry cannot contain any tags.
o Requires that the text for each primary index entry for a panel be unique.
Note: The index entry text can be duplicated in other panels.
o Requires that the secondary index entries refid= reference an id= specified
in a primary index entry.
Note: The primary index entry must appear before the secondary index entry
in the document.
o Can contain a list of root words contained in the index entry. This list is
then used to create a list of synonym words for the isyn tag.
Note: The root words do not appear in the index. They are enclosed within
apostrophes and can contain only numeric and alphabetic characters in upper
or lowercase.
The synonym tag:
o Permits the use of synonyms during an index search.
Note: The synonyms do not appear in the index listing, they are used only in
a search of the index.
o Lists the valid synonyms for an index entry.
Note: The synonyms are enclosed within apostrophes and can contain only
alphabetic and numeric characters in upper or lowercase. Each synonym is
separated by a blank space.
o The isyn root= must match an index roots= entry.
Note: Any word listed in the isyn root= should also be listed as a synonym.
ΓòÉΓòÉΓòÉ <hidden> Index Markup ΓòÉΓòÉΓòÉ
:h1 res=170.Index
:i1.index
:p.This is an example of an index. To see the actual index for this demo,
select Index from the Options pull-down.
:p.
:i1.cake, chocolate
:il.cookies
:il.id=fruit.fruit
:i2 refid=fruit.banana
:i2 refid=fruit.pineapple
:i1.id=pie.pie
:i2 refid=pie.apple
:i2 refid=pie.cherry
:i2 refid=pie.strawberry rhubarb
:i1.pudding, tapioca
:p. :link reftype=hd res=171.Tag Syntax:elink. :link reftype=hd
res=172.Markup:elink.
ΓòÉΓòÉΓòÉ 18. Lines ΓòÉΓòÉΓòÉ
This is an example of placing text where you want it using lines.
This
was
done
using
the
lines
tag.
So was this.....
this
and this.
Syntax Diagram Markup
ΓòÉΓòÉΓòÉ <hidden> Syntax Diagram ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :lines ΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ . ΓöÇΓöÇΓöÇ :elines. ΓöÇΓöÇΓöñ
Γöö align=leftΓöérightΓöécenter Γöÿ
The lines tag:
o Displays the information in proportional font.
Note: This may cause words and numbers not to appear as they did when
entered. You may have to insert or delete spaces to line up the information.
o Clips information that exceeds the panel area of the window.
o Aligns the text to the left, right, or center of the current margins.
o Requires that the :elines. tag be on a line by itself.
ΓòÉΓòÉΓòÉ <hidden> Markup ΓòÉΓòÉΓòÉ
:h1 res=180.Lines
:i1.lines
:p.This is an example of placing text where you want it using lines.
:lines.
:p.This
was
done
using
the
lines
tag. :elines.
:lines align=left.
So was this.....
:elines.
:lines align=center.
this
:elines.
:lines align=right.
and this.
:elines.
:p.
:link reftype=hd res=181.Syntax Diagram:elink. :link reftype=hd
res=182.Markup:elink.
ΓòÉΓòÉΓòÉ 19. Hide ΓòÉΓòÉΓòÉ
The hide feature is illustrated here. There is additional information on this
panel, but only those people that know the passwords will ever be able to read
it.
This is the information protected by the Ex1 password.
The hide feature can be used to protect information that you do not want
everyone to be able to read. For example: Information about Unannounced
Products, Personnel Records, Bank Account Information, Confidential
Information, Payroll Data, Customer lists, Memos, etc..
This is the information protected by the Ex2 password.
The hide feature can also be used to reduce the amount of information a user
has to read. For example: Suppose you were writing an online Service Manual
that contained information about a variety of printers. You could assign a
password to each printer type. Information common to all could have all
passwords assigned to them. When a Customer Engineer needed to fix a printer,
let's say a 5525 printer, he would type in the password (5525) and only the
information pertaining to the 5525 printer would be displayed.
To see the additional information:
1. Exit this demo by pressing the F3 key or selecting Exit from the Services
pull-down.
2. Select the OS/2 Command Prompt from the Desktop Manager's Group-Main.
3. Type Set Keys=Ex1+Ex2
4. Press the Enter key.
5. Type View Helpdemo, then press the Enter key.
6. Return to the Hide topic and the formerly hidden information is displayed.
Syntax Diagram Markup
ΓòÉΓòÉΓòÉ <hidden> Syntax Diagram ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :hide ΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇ . ΓöÇΓöÇΓöÇ :ehide. ΓöÇΓöÇΓöñ
Γöö key=' ' Γöÿ
The hide tag:
o Adds flexibility to a file by allowing you to hide information.
Note: Only users who know the key can access the information. The key is
case sensitive, and must be entered correctly by the user or access to the
information will be denied.
o Permits multiple hide tags within a panel.
Note: Hide tags cannot be nested within hide tags.
o Permits multiple keys for hidden information.
Note: When specifying multiple keys in the hide tag, place a plus sign
between the names and enclose the "keys" within apostrophes.
o Requires that the key be entered before the program is started.
Note: This can be done by entering the SET KEYS= statement at the OS/2
command prompt, or by setting the environment variable SET KEYS= in the
CONFIG.SYS file.
o Requires that you reissue the SET KEYS= command without a key word to
re-hide the information.
ΓòÉΓòÉΓòÉ <hidden> Markup ΓòÉΓòÉΓòÉ
:h1 res=190.Hide
:i1.hide
:p.The hide feature is illustrated here. There is additional information
on this panel, but only those people that know the passwords will ever be
able to read it.
:hide key=Ex1.
:color fc=red.
:p.This is the information protected by the Ex1 password.
:p.The hide feature can be used to protect information that you do
not want everyone to be able to read. For example: Information about
Unannounced Products, Personnel Records, Bank Account Information, Confidential
Information, Payroll Data, Customer lists, Memos, etc..
:ehide.
:hide key=Ex2.
:color fc=blue.
:p.This is the information protected by the Ex2 password.
:p.The hide feature can also be used to reduce the amount of information
a user has to read. For example: Suppose you were writing an online Service
Manual that contained information about a variety of printers. You could
assign a password to each printer type. Information common to all could have
all passwords assigned to them. When a Customer Engineer needed to fix a
printer, let's say a 5525 printer, he would type in the password (5525) and
only the information pertaining to the 5525 printer would be displayed.
:ehide.
:color fc=default.
To see the additional information:
:ol.
:li.Exit this demo by pressing the F3 key or selecting Exit from the Services
pull-down.
:li.Select the OS/2 Command Prompt from the Desktop Manager's Group-Main.
:li.Type Set Keys=Ex1+Ex2
:li.Press the Enter key.
:li.Type View Helpdemo, then press the Enter key.
:li.Return to the Hide topic and the formerly hidden information is displayed.
:eol.
:p. :link reftype=hd res=191.Syntax Diagram:elink. :link reftype=hd
res=192.Markup:elink.
ΓòÉΓòÉΓòÉ 20. Symbols ΓòÉΓòÉΓòÉ
These are examples of the symbols supported.
Symbol Tag
- &mdash.
- &ndash.
&rbl.
! &xclm.
! &xclam.
" &cdq.
" &odq.
# &numsign.
$ &dollar.
% &percent.
& &.
' &apos.
' &csq.
( &lpar.
( &lparen.
) &rpar.
) &rparen.
* &asterisk.
. &period.
+ &plus.
, &comma.
- &dash.
- &emdash.
- &endash.
- &hyphen.
- &minus.
. &per.
/ &slash.
/ &slr.
: &colon.
; &semi.
> >.
> >sym.
= &eq.
= &equals.
= &eqsym.
< <.
< <sym.
@ &atsign.
{ &lbrace.
{ &lbrc.
| &vbar.
| &lor.
} &rbrace.
} &rbrc.
[ &lbracket.
[ &lbrk.
\ &bslash.
\ &bsl.
] &rbracket.
] &rbrk.
^ &caret.
^ &and.
_ &us.
` &osq.
` &grave.
~ &tilde.
~ &similar.
&house.
А &Cc.
Б &ue.
В &ea.
Г &ac.
Е &ag.
Ж &ao.
З &cc.
╨ÿ &ec.
Й &ee.
К &eg.
Л &ie.
М &ic.
Н &ig.
О &Ae.
П &Ao.
П &angstrom.
Р &Ea.
╨í æ.
╨ó Æ.
У &oc.
Ф &oe.
Х &og.
Ц &uc.
Ч &ug.
Ш &ye.
Щ &Oe.
Ъ &Ue.
Ь &Lsterling.
Я &fnof.
╨░ &aa.
╨▒ &ia.
╨▓ &oa.
╨│ &ua.
╨┤ &nt.
╨╡ &Nt.
╨╢ &aus.
╨╖ &ous.
╨╕ &invq.
╨╣ &Inotrev.
╨║ &lnot.
╨║ ¬sym.
╨╗ ½.
╨╝ ¼.
╨╜ &inve.
╨╛ &odqf.
╨┐ &cdqf.
A &Alpha.
с &Beta.
ф &Sigma.
ц &mu.
ё &plusmin.
ё &pm.
╨Ä ÷.
┬░ °ree.
┬░ °.
┬╖ &dot.
┬ñ ².
Γûá &sqbul.
Γûæ &box14.
ΓûÆ &box12.
Γûô &box34.
Γòú &bx2022.
Γòæ &bx2020.
Γòù &bx0022.
Γò¥ &bx2002.
ΓòÜ &bx2200.
Γòö &bx0220.
Γò⌐ &bx2202.
Γòª &bx0222.
Γòá &bx2220.
ΓòÉ &bx0202.
Γò¼ &bx2222.
Γö┤ &bxas.
Γö┤ &bxbj.
Γö╝ &bxcr.
Γö╝ &bxcj.
Γö¼ &bxde.
Γö¼ &bxtj.
ΓöÇ &bxh.
Γöö &bxll.
Γöÿ &bxlr.
Γöñ &bxri.
Γöñ &bxrj.
Γöî &bxul.
ΓöÉ &bxur.
Γöé &bxv.
Γûê &BOX.
Γûä &BOXBOT.
ΓûÇ &BOXTOP.
&darrow.
&uarrow.
&larrow.
&rarrow.
&rahead.
ΓòÉΓòÉΓòÉ 21. Artwork ΓòÉΓòÉΓòÉ
This is an example of placing artwork within your online document.
This is an example of artwork displayed within the text of a sentence.
You can also align the artwork to appear on the
left,
right,
or center of the panel.
Syntax Diagram Markup
ΓòÉΓòÉΓòÉ <hidden> Artwork Syntax ΓòÉΓòÉΓòÉ
ΓöÇΓöÇ :artwork ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇ :name='filename.ext'ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇ . ΓöÇΓöÇΓöñ
Γö£ align=leftΓöérightΓöécenter Γöñ
Γö£ linkfile='filename.ext' Γöñ
Γöö runin ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
The artwork tag:
o Places artwork within the document.
Note: The artwork must be in the form of a Presentation Manager bitmap.
o Aligns artwork to the left, right, or center of the current margins.
o Places artwork within a string of text.
o Permits artwork to be used as a hypertext link, called a hypergraphic.
Note: If artwork is to be used as a hypertext link, you must specify the
link coordinates in an artlink file.
o Names the file containing the artlink information.
ΓòÉΓòÉΓòÉ <hidden> Markup ΓòÉΓòÉΓòÉ
:h1 res=210.Artwork
:i1.artwork
:p.This is an example of placing artwork within your online document.
:p.This is an example of artwork displayed within the :artwork runin name='c:\helpdemo\book.bmp'. text of a sentence.
:p.You can also align the artwork to appear on the
:lines align=left.
left,
:elines.
:artwork align=left name='c:\helpdemo\book.bmp'.
:lines align=right.
right,
:elines.
:artwork align=right name='c:\helpdemo\book.bmp'.
:lines align=center.
or center of the panel.
:elines.
:artwork align=center name='c:\helpdemo\book.bmp'.
:p. :link reftype=hd res=211.Syntax Diagram:elink. :link reftype=hd
res=212.Markup:elink.
ΓòÉΓòÉΓòÉ 22. Base Document Information ΓòÉΓòÉΓòÉ
Information displayed using the Information Presentation Facility (IPF) is
tagged using the IPF language. This tagging language is similar to ISIL,
BookMaster, and SGML. The tags are are explained in this demo.
This is an example of a base file:
:userdoc.
:docprof toc=12.
:title.Information Presentation Facility Demo
.* First entry in Table of Contents
:h1 res=001.Introduction
.* Index entries
:i1 id=intro.introduction
:i2 refid=intro.selecting
:i2 refid=intro.exiting
.* Text of Introduction panel
:p.This is a demonstration of the Information Presentation Facility.....
.* Second entry in Table of Contents
:h1 res=002.Hypertext
.* Imbedding file containing the text of the Hypertext panel
.im SCRIPT.002
.* Imbedding file containing the index for the Hypertext panel
.im INDEX.002
.
.
.
:euserdoc.
ΓòÉΓòÉΓòÉ 23. Compiling ΓòÉΓòÉΓòÉ
After you create your IPF base document, you need to convert the tags within it
so that it can be viewed. This is called compiling the base document.
Syntax Diagram
ΓòÉΓòÉΓòÉ <hidden> Compile Syntax ΓòÉΓòÉΓòÉ
ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
Γöé
ΓöÇΓöÇ IPFC ΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇ filename.ext ΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓö┤ΓöÇΓöÇΓöñ
Γöö drive Γöÿ Γöö path Γöÿ Γö£ΓöÇΓö¼ΓöÇ /gml ΓöÇΓöÇΓöÇΓöÇΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöñ
Γöé ΓööΓöÇ /gml=ipf ΓöÇΓöÿ Γöé
Γö£ /country=nnn ΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γö£ /codepage=nnn ΓöÇΓöÇΓöÇΓöÇΓöñ
Γö£ /l=xxx ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γö£ /w ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
Γöö /x ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÿ
ΓòÉΓòÉΓòÉ <hidden> Country Code and Code Pages ΓòÉΓòÉΓòÉ
Country Country Code Code Pages Supported
Australia 061 437, 850
Belgium 032 437, 850
Canadian English 001 437, 850
Canadian French 002 863, 850
Denmark 045 865, 850
Finland 358 437, 850
France 033 437, 850
Germany 049 437, 850
Italy 039 437, 850
Latin America 003 437, 850
Netherlands 031 437, 850
Norway 047 865, 850
Portugal 351 860, 850
Spain 034 437, 850
Sweden 046 437, 850
Switzerland 041 437, 850
United Kingdom 044 437, 850
United States 001 437, 850
ΓòÉΓòÉΓòÉ <hidden> Language Identifiers ΓòÉΓòÉΓòÉ
ID Language NLS File
DAN Danish IPFDAN.NLS
DEU German IPFDEU.NLS
ENG English UK IPFENG.NLS
ENU English US IPFENU.NLS
ESP Spanish IPFESP.NLS
FIN Finnish IPFFIN.NLS
FRA French IPFFRA.NLS
FRC Canadian-French IPFFRC.NLS
ITA Italian IPFITA.NLS
NLD Dutch IPFNLD.NLS
NOR Norwegian IPFNOR.NLS
PTG Portuguese IPFPTG.NLS
SVE Swedish IPFSVE.NLS
UND User-defined IPFUND.NLS
ΓòÉΓòÉΓòÉ <hidden> Compiler Markup ΓòÉΓòÉΓòÉ
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
:Link is the beginning tag for a hypertext link.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Res=a is used to identify the panel in which you want to link. Where a is an
integer from 1 to 32000. For example, if you wanted to link to the panel
specified by :h1 res=14., you would replace res=a with res=14.
Note: If you are using name= or id= instead of res= then you will use refid=
instead of res= to identify the panel in which you want to link.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Reftype=hd. is used to specify the type of link you want to create. In this
case, we are linking to a Heading (hd).
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Hypertext phrase is replaced by the word or phrase you want to initiate the
link. This word or phrase will be highlighted and when selected will cause the
linked panel to appear.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
:Elink. is the ending tag for a hypertext link.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
:Hn is the beginning tag for a new panel. Where n is a heading level from 1 to
6. Heading levels must be used in sequential order, that is, h1, h2, h3, h4,
h5, and h6. The heading levels used to specify new panels are h1, h2, and h3.
Heading levels h4, h5, and h6 are used to specify headings within a panel. If
you want to use h4, h5, or h6 to specify new panels you can change the default
setting by adding :docprof toc=123456. following the :userdoc. tag in in your
document. Likewise, you can use headings h2, and h3 for headings within a
panel by adding :docprof toc=1. following the :userdoc. in your document.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Period is used to tell the compiler that the end of the tag is reached.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Title is the name that you want to appear at the top of the panel. It can
contain up to 70 characters including spaces. If your panel is too small the
title will be clipped until the window is maximized.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Id=a is the panel identifier. Where a consists of up to 7 letters or numbers.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Res=b is the panel identifier. Where b is an integer from 1 to 32000.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Name=c is the same as the id= attribute. Where c consists of up to 7 letters
or numbers.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Tutorial=d specifies that a tutorial is associated with the panel. Where d is
the name of the tutorial.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Hide prevents the panel title from being displayed in the Table of Contents.
To view the panel you must provide a link to the panel or list it in the index.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
This is the footnote window linked to the word Footnote.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ID of the footnote being referenced.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies that a footnote window will be displayed when this link is selected.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the text that will be highlighted and used to hypertext you to the
linked panel.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning of a footnote.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the information to be displayed in the panel.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ending of a footnote.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning of an area with a figure.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the figure text.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ending of an area with a figure.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the caption you want to add to the figure. This tag can be placed
before or after the figure text, depending upon whether you want the caption at
the top or bottom of the figure. You cannot use tags or semicolons within the
text of a caption.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning of an area using character graphics.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the character graphic.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ending of an area using character graphics.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning of the area containing an example.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the example.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ending of the area containing an example.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning of a highlighted phrase. There are nine highlighting
phrases available.
Phrase Description
:hp1. Italics
:hp2. Bold
:hp3. Bold Italics
:hp4. Blue
:hp5. Underlined
:hp6. Underlined Italics
:hp7. Underlined Bold
:hp8. Red
:hp9. Pink
Note: The colors of :hp4., :hp8., and :hp9. are dependant upon the type of
display being used.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the text to be highlighted.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ending of the highlighted phrase.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the changing of the foreground and/or background color of the text.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the foreground color (color of text). The available colors are:
blue
cyan
green
neutral
red
yellow
default (system color)
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the background color (color behind the text). The available colors
are:
blue
cyan
green
neutral
red
yellow
default (system color)
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning of a simple list.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies an item in the list
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the text of the item in the list.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ending of a simple list.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies that no blank lines will separate the items in the list.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies a paragraph to be imbedded within a list. The paragraph is aligned
with the current level of the list and is not numbered, lettered, or bulleted.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning of an unordered list.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ending of an unordered list.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning of an ordered list
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ending of an ordered list.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning of a parameter list.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the number of character spaces allocated for the term headings and
terms. The default width is 10 character spaces. You can increase or decrease
the tsize= number to suit your needs. If you exceed the number of character
spaces available between the current left and right margins, a warning message
will be issued and the tsize will be set to the maximum space available between
the margins.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the formatting of the terms and descriptions in the list.
Break=none The description is placed on the same line as the term. If the
term exceeds the tsize specified, the description is pushed to
the right and begins one space after the term ends.
Break=fit The definition description is placed on the line below the term if
the term is longer than the tsize.
Break=all
All descriptions are placed on the line below the term.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies a parameter term.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the term.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies a parameter description.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the description.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ending of a parameter list.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning of a definition list.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies a term in the definition list.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies a heading for the terms in a definition list.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies a heading for the definitions in a definition list.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies a definition in the definition list.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ending of a definition list.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the left margin.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the setting for the left margin. The margin begins at 1 on the left
side of the display. To move the margin 15 spaces to the left, specify :lm.
margin=15..
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the right margin.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the setting for the right margin. The margin begins at 1 on the
right side of the display. To move the margin 15 spaces to the right, specify
:rm. margin=15.
Note: If the window is resized smaller than the margin setting, the right
margin changes and the text is reflowed within the window.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning of a one paragraph note. The word Note: appears on a
new line followed by two blank spaces and the text of the note.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the text in the note.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the text with which you want to replace the word Note:, typed exactly
as you want it to appear.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning of a multi-paragraph note. The word Note: appears on a
new line followed by two blank spaces and the first line of text in the note.
All subsequent lines of text are indented and line up with the beginning of the
text in the first line.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning of a new paragraph.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ending of a note with multiple paragraphs.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning of a Warning: statement.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ending of a Warning: statement.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the text with which you want to replace the word Warning:.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning of a CAUTION: statement.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ending of a CAUTION: statement.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the text with which you want to replace the word CAUTION:.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning of a Danger: statement.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ending of a Danger: statement.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the text with which you want to replace the word Danger:.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies that another application will be started when this link is selected.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the drive\path\filename.ext of the application you want to start when
the link is selected.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies any parameter strings you want to pass to the application when the
link is selected.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the text that will be highlighted and used to hypertext you to the
link.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the integer to be sent to the application with the HM_INFORM message.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies that an HM_INFORM message will be sent when this link is selected.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning of the bitmap artwork.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the drive\path\filename.ext of the file containing the bitmapped
artwork.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the alignment of the artwork within the margins.
Align=left Aligns the artwork to be even with the left margin.
Align=right Aligns the artwork to be even with the right margin.
Align=center Aligns the artwork to be centered between the margins.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the drive\path\filename.ext of the file that contains the link
information.
Note: A linkfile is not necessary if the bitmapped artwork will not be used as
a hypergraphic link.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies that the bitmapped artwork will be placed within a line of text.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies ID of the bitmapped artwork being referenced.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning of the information in the linkfile.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the type of reference link.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies a head level link.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies a footnote link.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies an inform link.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies a launch link.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ID of the link being referenced.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the horizontal axis of the bitmap. Value x=0 and y=0 is always
located at the lower left corner of the bitmap.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the vertical axis of the bitmap. Value x=0 and y=0 is always located
at the lower left corner of the bitmap.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the change in the x axis.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the change in the y axis.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ending of the information in the linkfile.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies a primary entry in the index.
Note: An index entry cannot be placed in a footnote.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the text to be placed in the index.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies an ID for the :i1. index entry.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the keywords to be associated with the index entry. These words do
not appear in the index, rather they are used during an index search to find a
panel when a valid synonym is typed in the Search field.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies a secondary entry in the index. An :i2. index entry is indented
under its associated :i1. index entry.
Note: An index entry cannot be placed in a footnote.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ID of the :i1. index entry being referenced.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies that word variations and synonyms are available for the keywords
listed in an index entry.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the synonyms and word variations for the keyword that follows the
root= attribute.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning of the lines tag.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ending of the lines tag.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the alignment of the text within the margins.
Align=left Aligns the text to be even with the left margin.
Align=right Aligns the text to be even with the right margin.
Align=center Aligns the text to be centered between the margins.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the beginning tag for the hide option.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the ending tag for the hide option.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the password needed to access the hidden information.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
The :userdoc. tag is the first tag in the base document file. It tells the
compiler that a file has been tagged using the IPF language.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
The :docprof toc= . tag is used to tell the compiler which heading levels are
to be placed in the Table of Contents. The default setting is heading levels
1, 2, and 3. If you only want heading level 1 to appear in the Table of
Contents, specify :docprof toc=1.. If you want all six heading levels to
appear in the Table of Contents, specify :docprof toc=123456..
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
The :title. tag is used to specify a title for the document being placed
online. The title can be up to 48 characters long.
Note This tag cannot be used when writing help panels.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
The .* tag is used to add comments to a file. This tag must be placed at the
beginning of the line. Any information on the same line as this tag will not
appear in the output file after it has been compiled.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
The :h1. tag is used to add a new panel to the document. There are six heading
levels. The heading tag requires that heading levels be used in order and that
no heading level is skipped. For example, a :h1. heading must precede a :h2.
heading. Likewise, a :h4. heading cannot be used until a :h1, :h2, and :h3
heading has been used.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
The :i1. tag is used to specify a primary index entry. If you plan on having
secondary index entries, you must use the id= attribute of the :i1. tag. The
id= attribute tells the compiler which secondary entry goes with which primary
entry.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
The :i2 refid= . tag is used to specify a secondary index entry. The refid=
attribute tells the compiler which primary index entry (id= ) should be
reference by the secondary index entry.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
The :p. tag is used to specify the beginning of a new paragraph. A paragraph
is an unindented block of text that is preceded by a blank line.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
The .im tag is used to imbed a file into the base document. This tag allows
you to organize your information in separate files and imbed them in the order
you want them to appear in the Table of Contents. This is particularly useful
when you are working with large amounts of information.
Note The .im tag cannot:
o Be placed within a footnote tag
o Be placed before the first :h1. tag in the base document file.
o Be placed within an imbed file.
o Contain the :userdoc. and :euserdoc. tags.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
The :euserdoc. tag is the last tag in the base document file. It tells the
compiler that the end of a file tagged using the IPF language has been reached.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
IPFC is the command needed to start the compiler. If no filename is specified
after IPFC then the compiler syntax is displayed.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the drive that contains the base document file.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the path to the base document file.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the filename and extension of the base document file.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Tells the compiler that the file is tagged with SGML tags rather than IPF tags.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Tells the compiler to convert the SGML base document to an IPF base document.
This converts the SGML tags to IPF tags in the base document.
Note: Some of the tags may be converted incorrectly. If you have a large base
document tagged in SGML you may want to use the Dialog Tag Language Compiler to
convert your file.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the 3-digit country code to be used for the collating sequence.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifes the 3-digit code page.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the 3-letter identifier of the NLS file to be used. The NLS file
determines the language that is displayed for the Warning, Caution, and Note
tags, and the characters that precede ordered and unordered lists.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Specifies the level of error messages you want to recieve. Values you can
specify are /w1, /w2, or /w3. The default value is /w3, recieve all three
levels of error messages.
ΓòÉΓòÉΓòÉ <hidden> ΓòÉΓòÉΓòÉ
Displays a cross-reference list of all links.