407 lines
17 KiB
Plaintext
407 lines
17 KiB
Plaintext
<!-- $XConsortium: glossary.sg
|
|
/main/1 1996/01/07 20:10:08 vobad
|
|
$ -->
|
|
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
|
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
|
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
|
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
|
<!-- (c) Copyright 1995 Novell, Inc. -->
|
|
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
|
<!-- (c) Copyright 1995 Hitachi. -->
|
|
<glossary id="HRDC.Gloss.div.1">
|
|
<title>Glossary</title>
|
|
<glossentry><glossterm>application help</glossterm>
|
|
<glossdef>
|
|
<para>Online help for a particular application (software).</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>application-defined link</glossterm>
|
|
<glossdef>
|
|
<para>A hyperlink designed especially for invoking some application behavior.
|
|
To invoke the behavior, the help must be displayed in dialogs created by the
|
|
application. (Application-defined hyperlinks are ignored by Helpview.)</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>automatic help</glossterm>
|
|
<glossdef>
|
|
<para>Help presented by the syste as the result of a particular condition
|
|
or error. Sometimes called “syste initiated“ help. For example,
|
|
error dialogs are a for of “automatic help.” See also <emphasis>semi-automatic help</emphasis> and <emphasis>manual help</emphasis>.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>caution</glossterm>
|
|
<glossdef>
|
|
<para>A warning to the user about possible loss of data. See also <emphasis>note</emphasis> and <emphasis>warning</emphasis>.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>close callback</glossterm>
|
|
<glossdef>
|
|
<para>An application function called when a help dialog box is closed.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>context-sensitive help</glossterm>
|
|
<glossdef>
|
|
<para>Online information that is relevant to what the user is doing within
|
|
an application. Sometimes, pressing the F1 key is referred to as “context-sensitive
|
|
help” because the choice of help topic is based on the user's context.
|
|
</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>cross-volume hyperlink</glossterm>
|
|
<glossdef>
|
|
<para>A hyperlink that jumps to a topic in a different help volume. Cross-volume
|
|
hyperlinks are entered using the Link element, where the Linkend attribute
|
|
specifies the ID of the element that is being linked to:</para>
|
|
<programlisting><link lnkend="some-id"></link></programlisting>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>dialog cache</glossterm>
|
|
<glossdef>
|
|
<para>A list of help dialogs that has been created but may not be in use.
|
|
When the application needs a new help dialog, it first searches its dialog
|
|
cache for an unused dialog. If one is found, it is used. Otherwise, all dialogs
|
|
are in use, so a new one is created.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>Document Type Definition</glossterm>
|
|
<glossdef>
|
|
<para>A description of a set of elements used to create a structured (or hierarchical)
|
|
information. The Document Type Definition (DTD) specifies the syntax for
|
|
each element and governs how and where elements can be used in a document.
|
|
</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>element</glossterm>
|
|
<glossdef>
|
|
<para>A logical portion of information, such as a book title, a paragraph,
|
|
a list, or a topic. Normally, the extent of an element is marked by <emphasis>tags</emphasis>, although the tags for some elements are assumed by context.
|
|
</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>emphasis</glossterm>
|
|
<glossdef>
|
|
<para>An element of text that calls attention to the text (usually by being
|
|
formatted as <emphasis>italic</emphasis>).</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>entity</glossterm>
|
|
<glossdef>
|
|
<para>A text string or file with a name. Most entities are named by the author
|
|
(using the <!Entity> element), but some entities are predefined. See also <emphasis>entity declaration</emphasis> and <emphasis>entity reference</emphasis>.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>entity declaration</glossterm>
|
|
<glossdef>
|
|
<para>Markup that establishes an entity name and its value. See also <emphasis>entity</emphasis> and <emphasis>entity reference</emphasis>.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>entity reference</glossterm>
|
|
<glossdef>
|
|
<para>Use of an entity name preceded by an & (ampersand) and followed
|
|
by a; (semicolon) that indicates to DocBook that the entity is to be inserted
|
|
where the entity name appears. See also <emphasis>entity</emphasis> and <emphasis>entity declaration</emphasis>.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>entry point</glossterm>
|
|
<glossdef>
|
|
<para>A point within a help volume that may be displayed directly as the result
|
|
of a request for help. That is, a topic where the user may “enter”
|
|
or begin reading online help. Any topic, or location within a topic, that
|
|
has an ID can become an entry point.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>example listing</glossterm>
|
|
<glossdef>
|
|
<para>A body of text in which line breaks are left as they are and which is
|
|
displayed in a computer font. The text is typically an example of a portion
|
|
of a computer file.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>execution alias</glossterm>
|
|
<glossdef>
|
|
<para>A resource that assigns a name to a command string or script that an
|
|
execution link executes.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>execution link</glossterm>
|
|
<glossdef>
|
|
<para>A hyperlink that executes a shell command or script. In DocBook, the
|
|
OLink element is the mechanism for this.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>execution policy</glossterm>
|
|
<glossdef>
|
|
<para>The Help Syste provides a resource that can be set to control the behavior
|
|
of execution links. This enables a syste administrator or user to establish
|
|
an appropriate level of security for any given application.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>figure</glossterm>
|
|
<glossdef>
|
|
<para>A graphic or illustration that appears in the help information.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>formal markup</glossterm>
|
|
<glossdef>
|
|
<para>A tag set and accompanying usage rules that are specified in the DocBook
|
|
2.2.1 Document Type Defnition (DTD). By following the rules set forth in the
|
|
DTD, an author can produce Standard Generalized Markup Language (SGML) compliant
|
|
help source files.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>general help dialog box</glossterm>
|
|
<glossdef>
|
|
<para>A window in which help information is displayed. General help dialog
|
|
boxes have a menu bar, a topic tree (which provides a list of topics), and
|
|
a help topic display area. See also <emphasis>quick help dialogbox</emphasis>.
|
|
</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>help callback</glossterm>
|
|
<glossdef>
|
|
<para>An application function called when the user presses the F1 key.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>help family</glossterm>
|
|
<glossdef>
|
|
<para>A set of help volumes that are related to one another because the applications
|
|
they refer to are related.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>help key</glossterm>
|
|
<glossdef>
|
|
<para>A designated key, usually the F1 function key, used to request help
|
|
on the current context. Some keyboards have a dedicated Help key that may
|
|
take the place of F1. In Motif applications, the help key is enabled by
|
|
adding a help callback to a widget.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>help on help</glossterm>
|
|
<glossdef>
|
|
<para>Help information about how to use the help dialog boxes. The user gets
|
|
this information by pressing F1 while using a help window, or by choosing
|
|
Using Help fro the Help menu in a general help dialog box.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>help volume</glossterm>
|
|
<glossdef>
|
|
<para>A complete body of information about a subject. Also, this ter can refer
|
|
to either the set of source files that contain the marked-up text or the run-time
|
|
files generated by running DocBook.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>History dialog box</glossterm>
|
|
<glossdef>
|
|
<para>A dialog box that shows a list of the sequence of topics the user has
|
|
visited. The history sequence can be traversed in reverse order to make it
|
|
easy for the user to return to earlier topics.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>hyperlink</glossterm>
|
|
<glossdef>
|
|
<para>A segment of text (word or phrase) or graphic image that has some behavior
|
|
associated with it. The most common type of hyperlink is a “jump”
|
|
link, which connects to a related topic. When the user chooses a jump link,
|
|
the related topic is displayed. Hyperlinks can also be used to invoke other
|
|
kinds of behavior, such as executing a syste command or invoking specific
|
|
application behavior.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>hyperlink callback</glossterm>
|
|
<glossdef>
|
|
<para>An application function that is invoked when a user chooses a hyperlink.
|
|
This function is responsible for handling the types of hyperlinks not handled
|
|
automatically within the help dialog.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>index</glossterm>
|
|
<glossdef>
|
|
<para>A list of important words and phrases that appear throughout a help
|
|
volume. The index is an alphabetical list of the words or phrases that can
|
|
be searched to find help on a subject. The Help Syste displays the index when
|
|
the user chooses the Index button (in a general help dialog box). See also <emphasis>Index Search dialog box.</emphasis></para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>Index Search dialog box</glossterm>
|
|
<glossdef>
|
|
<para>A dialog box that shows a list of index entries for a help volume. An
|
|
index can be displayed for the current volume, selected volumes, or all help
|
|
volumes. A user can search the index for a word or phrase and any corresponding
|
|
topics that contain the search string will be listed.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>index volume</glossterm>
|
|
<glossdef>
|
|
<para>The desktop uses the Helpview progra as a “help browser”
|
|
by displaying a special indexvolume that lists the help installed on the system.
|
|
A utility called <command>dthelpgen</command> creates this volume in the user's
|
|
home directory.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>inline graphic</glossterm>
|
|
<glossdef>
|
|
<para>A small graphic (illustration) that appears within a line of text.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>jump-new-view hyperlink</glossterm>
|
|
<glossdef>
|
|
<para>A hyperlink that, when chosen, displays its information in a new dialog
|
|
box. Jump-new-view links are intended for cross-volume links. The user senses
|
|
a “new context” by a new window being displayed.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>man page link</glossterm>
|
|
<glossdef>
|
|
<para>A hyperlink that, if activated, displays a “man page,” which
|
|
is a brief online explanation of a system command. The information in man
|
|
pages are not supplied through the DocBook system.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>manual help</glossterm>
|
|
<glossdef>
|
|
<para>A style of online help that requires the user to know what help is needed
|
|
and how to get it. For example, most commands in a Help menu are considered
|
|
“manual” help because the user chooses when and what to view.
|
|
See also <emphasis>automatic help</emphasis> and <emphasis>semi-automatic
|
|
help</emphasis>.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>note</glossterm>
|
|
<glossdef>
|
|
<para>A message to the user that draws attention to important information.
|
|
If the information is critically important, a caution or warning is used instead.
|
|
See also <emphasis>caution</emphasis> and <emphasis>warning</emphasis>.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>parser</glossterm>
|
|
<glossdef>
|
|
<para>The portion of the DocBook software that reads the source files (which
|
|
are created by the author) and converts the into run-time help files that
|
|
the Help Syste dialogs can read. If the author uses markup incorrectly (or
|
|
incompletely), the parser detects the problems and indicates that “parser
|
|
errors” have occurred.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>quick help dialog box</glossterm>
|
|
<glossdef>
|
|
<para>A streamlined help dialog box that has a help topic display area and
|
|
one or more push buttons. See also <emphasis>general help dialog box</emphasis>,
|
|
which offers additional capabilities.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>registration</glossterm>
|
|
<glossdef>
|
|
<para>The process of declaring a help volume to be accessible for browsing
|
|
or cross- volume linking.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>run-time help files</glossterm>
|
|
<glossdef>
|
|
<para>The files generated by the <command>dtdocbook</command> command. These
|
|
are the files distributed to users who will use the Help System.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>Search Volume Selection dialog box</glossterm>
|
|
<glossdef>
|
|
<para>A dialog box that lists the help volumes available on a user's system.
|
|
When a user chooses Selected fro the Index Search dialog box, this dialog
|
|
box lists help volumes that the user can select. One or more volume names
|
|
can be selected and the corresponding index information is reported in the
|
|
Index Search dialog box.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>semi-automatic help</glossterm>
|
|
<glossdef>
|
|
<para>A style of online help in which the user requests help and the system
|
|
decides, based on the current circumstances, which help information to display. “Context-sensitive”
|
|
help (pressing the F1 key) is an example of semi-automatic help. See also <emphasis>automatic help</emphasis> and <emphasis>manual help</emphasis>.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>standalone help</glossterm>
|
|
<glossdef>
|
|
<para>Help information intended to be used independently of application software.
|
|
For example, online help that explains the basics of computer programming
|
|
may not be associated with a particular application. A standalone help volume
|
|
can be displayed using the <command>dthelpview</command> command.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>Standard Generalized Markup Language (SGML)</glossterm>
|
|
<glossdef>
|
|
<para>An international standard [ISO 8879: 1986] that establishes a method
|
|
for information interchange. SGML prescribes constructs for marking the structure
|
|
of information separate fro its intended presentation or format. The DocBook
|
|
markup language conforms to this SGML standard.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>tag</glossterm>
|
|
<glossdef>
|
|
<para>A text string that marks the beginning or end of an element. A start
|
|
tag consists of a < (left angle bracket) followed by a special character
|
|
string (consisting of only letters), optional attributes and values, and terminated
|
|
by a > (right angle bracket).</para>
|
|
<para>An end tag consists of a < (left angle bracket), a / (forward slash),
|
|
the same special character string, and a > (right angle bracket).</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>Tagged Image File Format (TIFF)</glossterm>
|
|
<glossdef>
|
|
<para>A standard graphics file format. The Help Syste dialog boxes support
|
|
TIFF 5.0 images. TIFF images are identified by the <filename>.tif</filename>
|
|
file-name extension.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>topic</glossterm>
|
|
<glossdef>
|
|
<para>Information about a specific subject. Usually, this is approximately
|
|
one screenful of information. Online help topics are linked to one another
|
|
through hyperlinks.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>topic hierarchy</glossterm>
|
|
<glossdef>
|
|
<para>A help volume's branching structure in which the home topic branches
|
|
out (through hyperlinks) to progressively more detailed topics. See also <emphasis>home topic</emphasis>.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>topic tree</glossterm>
|
|
<glossdef>
|
|
<para>In a general help dialog box, a list of topics that can be selected
|
|
to display help information.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>warning</glossterm>
|
|
<glossdef>
|
|
<para>Information that warns the user about possible injury or unrecoverable
|
|
loss of data. See also <emphasis>caution</emphasis> and <emphasis>note</emphasis>.
|
|
</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>widget</glossterm>
|
|
<glossdef>
|
|
<para>The fundamental building block of graphical user interfaces. The Motif
|
|
widget set provides widgets of all sorts, suitable for constructing an application
|
|
user interface.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>X bitmap</glossterm>
|
|
<glossdef>
|
|
<para>A two-tone image that has one foreground color and one background color.
|
|
Bitmap image files are identified by the<filename>.bm</filename> file-name
|
|
extension.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>X pixmap</glossterm>
|
|
<glossdef>
|
|
<para>A multicolor image. Pixmap image files are identified by the <filename>.pm</filename> file-name extension.</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
<glossentry><glossterm>X window dump</glossterm>
|
|
<glossdef>
|
|
<para>An image captured from an X Window System<?Pub Caret> display. The <command>xwd</command> utility is used to capture a window image. X window dump image
|
|
files are identified by the <filename>.xwd</filename> file-name extension.
|
|
</para>
|
|
</glossdef>
|
|
</glossentry>
|
|
</glossary>
|
|
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->
|