Index

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Special Characters

! (exclamation mark), used in shorthand markup

% (percent symbol), used in shorthand markup[1] [2]

& (ampersand)
        entity reference [1] [2]
        used as text character

&copy

&empty

* (asterisk), used in list

+ (plus), used in shorthand markup [1] [2]

.htg file         [.htg file]

(semicolon) [1] [2]

< (angle bracket)
        used as text character
        used as comment

\ (backslash)
        used as text character
        end tag syntax
        used in multiline head

_abstract ID

_copyright ID [1] [2]

_glossary ID

_hometopic ID

_title ID

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

A

<abbrev>

abbreviating long titles

<abstract> [1] [2]

abstract for help volume

_abstract ID

actions, help

alias, used in execution links

ampersand (&)
        entity reference
        used as text character

angle bracket (<)

<<annotation text>>

apostrophe

AppDefined parameter

appearance, determining font scheme

API, list of functions

application entry points, verifying

application help

application package

application program interface, list of functions

application programmer, collaborating with

application registration

application-configured, button enabling

application-defaults file, for dthelpview

application-defined
        hyperlink
        link, creating

asterisk (*) , used in list

audience
        knowing
        writing for international

author
        collaboration with application programmer
        responsibilities
        workflow

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z


B

backslash (\)
        
used as text character
        to create a multiline head
        used in end tag

bitmap

blank leader

bold font

<book> [1] [2]

book title, creating [1] [2]

break, forcing line

browser help volume
        adding your help to
        creating
        defined
        displaying

bullet
        used in list
        parameter in list

bulleted list

button, application-configured

buttons, navigation

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

C

callback
        
adding close callback
        close callback example
        adding help callback
        hyperlink, providing

caption
        figure

<caution>

caution statement, adding

CDE Help System, introduction to

CDE HelpTag markup reference

<chapter> [1] [2] [3]

chapter
        creating
        in topic hierarchy

character set
        defined
        names of supported sets

character, inserting special [1] [2]

checklist
        application programmer's
        author's
        internationalized help
        product integrator's
        product preparation

class, dialog widgets

clean parameter

CloseHelpCB()

column heading in labeled list

command variable, marking

command, Using Help menu

command
        dthelpgen
        summary of help commands
        dthelpview
        gencat

comment, inserting

components, in help volume

<computer> [1] [2]

computer, displaying input/output

computer, displaying input/output

continue parameter

copying Help4Help source files

<copyright> [1] [2]

copyright
        predefined help ID
        notice [1] [2]
        used in meta information

_copyright ID[1] [2]

correcting errors

creating
        index
        application-defined link
        cross reference
        definition link
        figure
        file entity
        general help dialog box
        glossary
        help dialog boxes
        help family
        home topic
        hyperlink
        language formatting table
        man page link
        message catalog
        meta information topic
        quick help dialog box
        run-time help files [1] [2]
        structure within topic
        text entity
        topic hierarchy

cross-reference
        creating with <xref>
        examples
        using link element
        using xref element
        ID value
        to list items
        using location ID

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

D

danger, warning of

data types, help

definition hyperlink

definition link
        creating
        for term

definition
        entering in glossary
        of term

delivery, preparing for product

destination
        cross-reference
        hyperlink

dialog box
        creating quick help

dialog boxes
        creating and managing
        creating general help
        general help
        quick help

dialog
        detecting when dismissed
        handling event in

display, font scheme for

displaying
        computer input/output examples
        computer literal
        graphics
        help on help
        help topic
        help volume
        inline graphic
        man page
        text file
        text string
        variable

displays, testing graphics on various

document title

Document Type Definition (DTD)

dotted leader

draft comment or question

DtCreateHelpQuickDialog()

DtHelp.cat

DtHelp.msg, message catalog source

DtHelpDialogCallbackStruct

DtHelpExecAlias, keyword in execution link

dthelpgen, command line options

DtHelpReturnSelectedWidgetId()

dthelptag command
        command line options
        run from command line

dthelpview command
        command line options
        run from the command line

DtHelp_TYPE_DYNAMIC_STRING

DtHELP_TYPE_FILE

DtHELP_TYPE_MAN_PAGE

DtHELP_TYPE_STRING

DtNhelpType

DtNhelpVolume

DtNlocationId

DtNmanPage

DTTAGOPT environment variable

dump, X Window

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

E

editor, structured

element tag [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20] [21] [22] [23] [24] [25] [26] [27] [28] [29] [30] [31] [32] [33] [34] [35] [36] [37] [38] [39] [40] [41] [42] [43] [44]
                definition link
                man page
                application-defined
                examples
                meta information [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20] [21] [22] [23]
                adding topics [1] [2]
                examples
                topic hierarchy [1] [2]
         [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15]

element
        entering inline
        hierarchical structure
        parameters
        start and end tags
        within topic, adding ID to

<emph>

emphasis
        using a note
        using bold font
        using italic font

end tag

entities
        multiple source files
        special character
        uses for

entity parameter [1] [2]

entity reference

entity reference, for special characters

<!entity>

entity
        examples of
        creating file entity
        creating text entity
        declaration [1] [2]
        LanguageElementDefaultCharset
        LanguageElementDefaultLocale

entry points in application, verifying

environment variable
        DTTAGOPT, for parser options
        LANG
        system help search path
        user help search path

errors, correcting

<esc>

escape text

event
        hyperlink, responding to
        in help dialog, handling

<ex>[1] [2]

example
        text entity declarations
        using markup in
        complete standalone help volume
        displayed verbatim
        graphic file entity declarations
        using

exclamation mark (!)
        used in shorthand markup [1] [2]

execution alias
        creating
        used in hyperlinks

execution hyperlink

execution link
        control policy
        default behavior

external file, referencing

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

F

F1 (help key)

family file
        creating

family
        definition of
        finding

<figure> [1] [2] [3]

figure
        caption
        creating
        entity
        ID
        including
        number

file entity, creating

FILE parameter [1] [2]

file
        .htg [file
                htg]
        displaying text
        DtHelp.cat
        DtHelp.msg
        helpchar.ent
        helptag.dtd
        helptag.opt
        helptag.opt
        inserting contents of

files, run-time help
        creating [1] [2]

finding help files

font resources, specifying

font
        changing to bold
        for computer literal
        italic [1] [2]
        scheme, determining actual appearance
        scheme, for display

foreign language, creating help volume

formal markup
        Document Type Defintion
        entity declarations
        caveats
        defined
        processing of
        SGML compliance

formal parameter

formatting table

front matter
        uncategorized

function
        DtHelpReturnSelectedWidgetId()
        HelpRequestCB()
        ProcessOnItemHelp()
        XtAddCallback() [1] [2]

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

G

gencat command

general help dialog box
        dialog buttons
        features
        creating

general markup guidelines

gentity parameter [1] [2]

getting help

ghyperlink parameter [1] [2]

glinktype parameter [1] [2]

gloss parameter

<glossary> [1] [2]

glossary
        component of help volume
        element tag
        creating
        defining term in
        term, marking
        term, newly introduced

_glossary ID

goals for online help

gposition parameter

<graphic> [1] [2] [3]

graphic
        used as a hyperlink
        displaying
        displaying inline
        element within text
        formats
        including
        wrapping text around

graphics, testing on various displays

group of related volumes, family as

guidelines, markup

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

H

<head>

heading line, continuing

heading
        section
        starting new line

help browser

help dialog
        detecting when dismissed
        handling events in

help entry points, required

help family
        creating
        defined

help files, finding

help key

help menu, providing

help on help
        accessing
        application resource
        in quick help dialog box
        displaying
        quick help dialog box
        writing volume

help topic
        adding an ID
        assigning ID names
        defined

help volume, processing

help volume
        components
        creating
        defined
        displaying
        dthelpview command
        overview
        sample markup

help, how users get

<helpvolume>

Help4Help
        location of Help4Help volume
        required entry points
        accessing from application
        copying source files
        helpOnHelpVolume resource

help
        actions
        data types
        topic organization
        types of access

help browser

help topic
        adding an ID
        defined

help volume
        dthelpview command

helpchar.ent file

helplang.ent file

helpOnHelpVolume resource, setting

HelpRequestCB()

helptag software

helptag.dtd file

helptag.opt file
        memo option
        sample of
        search option

hierarchy
        adding nonhierarchical topic
        adding topic to
        organizing elements
        topic, creating

history, help ID for History dialog box

home topic
        defined
        in topic tree list
        menu command
        predefined help ID
        creating

hyperlink parameter

<hometopic> [1] [2]

_hometopic ID

hyperlink
        attribute in link element
        display formats
        application-defined link
        callback
        callback, providing
        creating
        definition link
        destination
        event, responding to
        execution link
        jump type
        man page link
        types
        validating hyperlinks

HyperlinkCB()

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

I

ID parameter
        
in element
        in [1] [2] [3] [4] [5] [6] [7]
        in        ...

ID
        adding to element within topic
        adding to topic
        figure
        in list
        naming rules
        predefined names
        used in

<idx> [1] [2]

<image> [1] [2]

indent parameter
        for paragraph element
        for image element

index
        help ID for Index Search dialog box
        help ID for Search Volume Selection Dialog box
        Index search dialog index
        providing index-search ID
        creating
        marking entry
        sort order

information model, help

information, meta

inline elements, entering

inline elements
        entering

inline graphic, displaying

input files, multiple

inserting
        contents of another file
        comment
        special character
        writer's memo

installation package

international audiences, writing for

introduction to Help System

italic font [1] [2]

<item>

item help
        adding support for
        invoking

item in list

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

J

job of author

jump type hyperlink

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

K

key, enabling help (F1)

<keycap>

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

L

labeled list

<labheads> [1] [2]

LANG environment variable

<lablist> [1] [2]

language
        foreign
        formatting table
        multibyte

leader
        blank
        dotted

line break
        forcing
        within head
        within title

line breaks, preserving

line endings, preserving

line
        continuing heading
        definition spanning more than one
        starting new heading
        wrapping

<link> [1] [2]

link
        creating execution alias
        to meta information
        creating application-defined
        creating definition
        creating man page
        hypertext

<list> [1] [2]

list
        bulleted
        cross reference to item
        entering
        item in
        labeled
        labeled, heading
        leader
        numbered
        plain
         [1] [2] [3] [4] [5]

literal, displaying computer

locale
        creating entity for
        specifying for help volume

localization

<location> [1] [2]

location IDs, predefined

loose parameter [1] [2]

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

M

man page
        
creating link
        displaying
        hyperlink

Man parameter

managing help dialog boxes

manual title

markup language
        formal markup, SGML-compliant [1] [2]
        shorthand markup

markup reference

markup
        formal (SGML)
        shorthand [1] [2]
        guidelines
        sample help volume

<memo> [1] [2]

memo option

memo, inserting writer's

menu
        Edit
        File
        Help
        Navigate
        providing help menu
        Search

message catalog
        creating
        DtHelp.msg file
        translating

<metainfo> [1] [2]

meta information
        defined
        topic, creating
        topic, linking to
        volume title

mode, item help

model, help information

MoreHelpCB()

Motif

multibyte language support

multiple lines, definition spanning

multiple occurrences of same string of text

multiple source files

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

N

native language support
        
creating online help
        checklist for authors and translators

navigation, help buttons

<newline>

new line
        forcing start of
        within title

new paragraph, starting

nogloss parameter [1] [2]

nonhierarchical topic, adding

nonumber parameter [1] [2]

<note>

note, adding

number parameter

number, figure

numbered list

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

O

online help
        
objectives

online presentation format

option, memo

order parameter [1] [2]

order, keyword index sort

OSF/Motif

<otherfront> [1] [2]

<otherhead> [1] [2]

overview
        Help graphical user interface
        help volume

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

P

<p>
[1] [2]

paragraph
        indenting
        starting

parameter
        alias_name
        AppDefined
        bullet [1] [2]
        clean
        continue
        default_command
        entity [1] [2]
        FILE [1] [2]
        format
        gentity [1] [2]
        ghyperlink [1] [2]
        glinktype [1] [2]
        gloss
        gposition
        hyperlink
        ID in [1] [2] [3] [4] [5] [6] [7] [8]
        ID in        ...
        indent [1] [2]
        loose [1] [2]
        Man
        nogloss [1] [2]
        nonumber [1] [2]
        number
        order [1] [2]
        plain [1] [2]
        search
        shortnames
        smaller
        smallest
        tight [1] [2]
        verbose

parameters in element

parser

parser errors

percent symbol (%), used in shorthand markup

perspective, seeing help from user's

pixmap

plain list

plain parameter [1] [2]

plus (+) , used in shorthand markup [1] [2]

points, entry, verifying in application

predefined entities

predefined ID
        _abstract
        _copyright
        _glossary
        _hometopic
        _title

printing
        dialog box
        help ID for Print dialog box
        help information
        help topics

<procedure> [1] [2]

ProcessOnItemHelp()

product family
        creating
        finding

product preparation checklist

programmer, application
        collaborating with
        responsibility

prompt, user response to computer

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Q

quick help dialog box
        
creating
        buttons
        creating

quotation mark
        element for directional quotes
        entity name for straight quotes
        used in shorthand markup [1] [2]

quotation marks, printing text within

<quote>

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

R

reference
        
entity reference
        section
        subsection
        to entity

referencing external file

registration
        help family
        help volume

related volumes, family as group of

requests, responding to help

reserved IDs

resource
        DtNexecutionPolicy
        DtNhelpType
        DtNhelpVolume
        DtNlocationId
        DtNmanPage
        helpOnHelpVolume

resources
        help dialog boxes
        specifying fonts

responding to
        help requests
        hyperlink event

responsibility
        author
        programmer

reviewing
        errors
        help as user will see it

<rsect>

<rsub>

run-time files
        creating [1] [2]

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

S

<s1 ... s9>
[1] [2] [3]

sample application, integrated help

sample help volume markup

sample standalone help volume
        steps to create

Search menu

SDL (Semantic Delivery Language) [1] [2]

section
        describing procedure
        heading
        heading within topic
        reference
        subsection within reference
        topic

Semantic Delivery Language (SDL) [1] [2]

semicolon ( [1] [2]

SGML, compliance

shorthand markup [1] [2]

shortnames parameter

smaller parameter

smallest parameter

<sort> [1] [2]

sort order, index

source files, multiple

spacing, preserving

special characters, inserting

special characters
        list of

standalone help

standalone help volume
        sample

Standard Generalized Markup Language (SGML)

start tag

starting new line within title

starting paragraph [1] [2]

string of text
        displaying
        multiple occurrences of same

structure within topic, creating

structure
        DtHelpDialogCallbackStruct

structured editor

<sub>

subheading, within topic [1] [2]

subsection within reference section

subtopics
        creating
        definition

summary
        Help System commands
        CDE HelpTag markup

supporting item help mode

<super>

symbol
        inserting
        list of symbols
        plus (+)

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

T

tag

Tagged Image File Format (TIFF)

tags, element

<term> [1] [2]

term
        defining in glossary
        definition
        glossary, marking
        newly introduced

testing
        graphics on various displays
        help

text
        preserving line endings
        entity, creating
        file, displaying
        string, displaying
        untranslated
        wrapping around graphic

TIFF (Tagged Image File Format)

tight parameter [1] [2]

<title> [1] [2]

title
        abbreviating
        book
        entering book title
        help volume
        line break within
        list
        note
        section

_title ID

topic [1] [2]

topic tree
        selecting topic
        in general help dialog

topic
        accessing
        structure of elements
        accessing
        adding ID to
        adding ID to element within
        adding nonhierarchical
        adding to hierarchy
        creating hierarchy
        creating structure within
        defined
        displaying
        home
        home, creating
        linking to meta information
        providing subheadings within
        starting new
        subheading within
        subordinate
        title
        volume as collection of
        writing
        

typographical symbols

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

U

unformatted text

untranslated text

<user>

user's perspective, seeing help from

Using Help command, providing

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

V

validating hyperlinks

<var> [1] [2]

variable
        displaying
        marking in command

verbatim example

verbose parameter

verifying application entry points

vertical bar, used in shorthand markup

<vex> [1] [2]

viewing help volume

volume
        abstract
        as collection of topics
        components
        defined
        desktop browser volume
        displaying
        family of volumes
        finding
        overview
        registering
        sample standalone help volume
        standalone help
        title
        viewing
        

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

W

<warning>

warning statement, adding

warning, of danger

widget classes

widget resources

window dump

wrapping text around graphic

writer's memo, inserting

writing
        for international audiences
        help on help volume
        topic

Click letter for quick access:
[Special Characters] A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

X

X Window Dump

<xref>

XtAddCallback

XtAddCallback()

xwd graphic format