Files
cdesktop/cde/doc/C/guides/progGuide/preface.sgm

375 lines
22 KiB
Plaintext

<!-- Fragment document type declaration subset:
ArborText, Inc., 1988-1995, v.4001
<!DOCTYPE DOCBOOK [
<!ENTITY PG.BIntg.fig.1 SYSTEM "./progGuide/graphics/NoPrint.eps" NDATA eps>
<!ENTITY PG.BIntg.fig.2 SYSTEM "./progGuide/graphics/package.eps" NDATA eps>
<!ENTITY PG.BIntg.fig.3 SYSTEM "./progGuide/graphics/approot.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.1 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.1.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.2 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.2.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.3 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.3.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.4 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.4.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.5 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.5.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.6 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.6.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.7 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.7.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.8 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.8.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.9 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.9.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.10 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.10.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.11 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.11.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.12 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.12.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.13 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.13.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.14 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.14.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.15 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.15.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.16 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.16.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.17 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.17.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.18 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.18.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.19 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.19.eps" NDATA eps>
<!ENTITY PG.dndPG.fig.20 SYSTEM "./progGuide/graphics/PG.dndPG.iFrame.20.eps" NDATA eps>
<!ENTITY PG.widgs.fig.1 SYSTEM "./progGuide/graphics/PG.widgs.iFrame.1.eps" NDATA eps>
<!ENTITY PG.widgs.fig.2 SYSTEM "./progGuide/graphics/ComboBox.rs" NDATA eps>
<!ENTITY PG.widgs.fig.3 SYSTEM "./progGuide/graphics/MenuButton2.rs" NDATA eps>
<!ENTITY PG.calmg.fig.1 SYSTEM "./progGuide/graphics/PG.calmg.iFrame.1.eps" NDATA eps>
<!ENTITY PG.calmg.fig.2 SYSTEM "./progGuide/graphics/PG.calmg.iFrame.2.eps" NDATA eps>
<!ENTITY PG.basc1.fig.1 SYSTEM "./progGuide/graphics/NoPrint.eps" NDATA eps>
<!ENTITY PG.basic.fig.1 SYSTEM "./progGuide/graphics/NoPrint.eps" NDATA eps>
<!ENTITY PG.basic.fig.2 SYSTEM "./progGuide/graphics/package.eps" NDATA eps>
<!ENTITY PG.basic.fig.3 SYSTEM "./progGuide/graphics/approot.eps" NDATA eps>
<!ENTITY Copyr SYSTEM "./progGuide/copyright.sgm">
<!ENTITY prtI SYSTEM "./progGuide/part1.sgm">
<!ENTITY basc1 SYSTEM "./progGuide/ch01.sgm">
<!ENTITY prt2 SYSTEM "./progGuide/part2.sgm">
<!ENTITY fonts SYSTEM "./progGuide/ch02.sgm">
<!ENTITY msgs SYSTEM "./progGuide/ch03.sgm">
<!ENTITY smgr SYSTEM "./progGuide/ch04.sgm">
<!ENTITY dndPG SYSTEM "./progGuide/ch05.sgm">
<!ENTITY prt3 SYSTEM "./progGuide/part3.sgm">
<!ENTITY wsmgr SYSTEM "./progGuide/ch06.sgm">
<!ENTITY widgs SYSTEM "./progGuide/ch07.sgm">
<!ENTITY aIII SYSTEM "./progGuide/ch08.sgm">
<!ENTITY datat SYSTEM "./progGuide/ch09.sgm">
<!ENTITY calmg SYSTEM "./progGuide/ch10.sgm">
<!ENTITY gloss SYSTEM "./progGuide/glossary.sgm">
]>
-->
<!-- $XConsortium: preface.sgm /main/9 1996/09/08 19:38:32 rws $ -->
<!-- (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. -->
<preface id="PG.Pref.div.1">
<title>Preface</title>
<sect1 id="PG.Pref.div.2">
<title>Who Should Use This Book</title>
<para>Use this book if you are a programmer interested in integrating an existing
application into the Common Desktop Environment (CDE), or in developing a
new application that uses the features and functionality of CDE. This book
describes the CDE development environment, and assumes that you are familiar
with Motif&reg;, X, UNIX&reg;, or C programming.</para>
</sect1>
<sect1 id="PG.Pref.div.3">
<title>Before You Read This Book</title>
<para>The Common Desktop Environment: <emphasis>Programmer's Guide</emphasis>
is a collection of programming information. The manuals listed in the section
<!--Original XRef content: '&xd2;Related Books'--><xref role="SectionTitle"
linkend="PG.Pref.mkr.1"> should be read before you begin integration
of any applications to CDE.</para>
<para>The <emphasis>Common Desktop Environment: Programmer's Overview</emphasis>
provides a description of CDE and introduces the programming environment.
</para>
</sect1>
<sect1 id="PG.Pref.div.4">
<title>How This Book Is Organized</title>
<para>The <emphasis>Common Desktop Environment: Programmer's Guide</emphasis>
has two parts. Each part provides a detailed description of each element
of the Common Desktop Environment, a conceptual diagram, and a task-oriented
description of how to use each element, complete with code examples.</para>
<para><emphasis role="Lead-in">Part 1 &ndash;</emphasis> <!--Original XRef
content: '&xd2;Basic Integration'--><xref role="SectionTitleLead-in" linkend="PG.prtI.mkr.1"> introduces how to register your application
and printing levels.</para>
<para><!--Original XRef content: 'Chapter&numsp;1, &xd2;Basic Application
Integration'--><xref role="ChapNumAndTitleLead-in" linkend="PG.basc1.mkr.1">
describes the steps involved with the
basic integration of an existing application into CDE.</para>
<para><emphasis role="Lead-in">Part 2 &ndash;</emphasis> <!--Original XRef
content: '&xd2;Recommended Integration'--><xref role="SectionTitleLead-in"
linkend="PG.prt2.mkr.1"> introduces
how to integrate existing applications into the Common Desktop Environment.
</para>
<para><!--Original XRef content: 'Chapter&numsp;2, &xd2;Integrating Fonts'--><xref
role="ChapNumAndTitleLead-in" linkend="PG.fonts.mkr.1"> describes how to use generic standard font descriptions
to ensure that you get the closest matching font for your application on
any CDE-compliant system.</para>
<para><!--Original XRef content: 'Chapter&numsp;3, &xd2;Displaying Errors
from Your Application'--><xref role="ChapNumAndTitleLead-in" linkend="PG.msgs.mkr.1"> describes a common model for presenting
information and error messages.</para>
<para><!--Original XRef content: 'Chapter&numsp;4, &xd2;Integrating with Session
Manager'--><xref role="ChapNumAndTitleLead-in" linkend="PG.smgr.mkr.1">
describes the ICCM session management
protocol and provides examples of how to integrate your application with
Session Manager.</para>
<para><!--Original XRef content: 'Chapter&numsp;5, &xd2;Integrating with Drag
and Drop'--><xref role="ChapNumAndTitleLead-in" linkend="PG.dndPG.mkr.1">
describes the drag-and-drop user model,
the new drag-and-drop application program interface (API), and how to use
drag and drop.</para>
<para><emphasis role="Lead-in">Part3 &ndash;</emphasis> <!--Original XRef
content: '&xd2;Optional Integration'--><xref role="SectionTitleLead-in" linkend="PG.prt3.mkr.1"> describes how to integrate new applications
with the Session Manager and with drag and drop. It also explains how locales
affect the Login Manager, Window Manager, and the terminal emulator.</para>
<para><!--Original XRef content: 'Chapter&numsp;6, &xd2;Integrating with the
Workspace Manager'--><xref role="ChapNumAndTitleLead-in" linkend="PG.wsmgr.mkr.1"> describes how to integrate your application
with the Workspace Manager in specialized ways.</para>
<para><!--Original XRef content: 'Chapter&numsp;7, &xd2;Common Desktop Environment
Motif Widgets'--><xref role="ChapNumAndTitleLead-in" linkend="PG.widgs.mkr.1">
describes how to use the custom widgets
that are provided as part of CDE.</para>
<para><!--Original XRef content: 'Chapter&numsp;8, &xd2;Invoking Actions from
Applications'--><xref role="ChapNumAndTitleLead-in" linkend="PG.aIII.mkr.1">
describes how to create actions within
your application.</para>
<para><!--Original XRef content: 'Chapter&numsp;9, &xd2;Accessing the Data-Typing
Database'--><xref role="ChapNumAndTitleLead-in" linkend="PG.datat.mkr.1">
describes the data-typing functions and
how to use the data-typing database.</para>
<para><!--Original XRef content: 'Chapter&numsp;10, &xd2;Integrating with
Calendar'--><xref role="ChapNumAndTitleLead-in" linkend="PG.calmg.mkr.1">
introduces the Calendar API, including
functions, data structures, calendar attributes, and entry attributes. It
also describes how to use the Calendar API.</para>
<para>Chapter 11 explains how to integrate
your application with the <command>dtinfo</command> on-line documentation browser; this chapter
also summarizes the DtInfo database engine API, which you may use to write
your own browser.
</para>
<para>Chapter 12 explains the CDE printing widgets and APIs.
</para>
<para><emphasis role="Lead-in">Glossary</emphasis> is a list of words and
phrases found in this book and their definitions.</para>
</sect1>
<sect1 id="PG.Pref.div.5">
<title id="PG.Pref.mkr.1">Related Books</title>
<para>Before beginning integration of your application into CDE, you should
become familiar with the other books in the documentation set. See <!--Original
XRef content: '&xd2;Development
Environment Documentation'--><xref role="SectionTitle" linkend="PG.Pref.mkr.2">
for a list of the companion books.</para>
<para>The run-time environment documentation set consists of:<indexterm>
<primary>documentation set</primary><secondary>run-time</secondary></indexterm><indexterm>
<primary>run-time</primary><secondary>documentation set</secondary></indexterm></para>
<itemizedlist remap="Bullet1"><listitem><para><emphasis>Common Desktop Environment:
User's Guide</emphasis></para>
</listitem><listitem><para><emphasis>Common Desktop Environment: Advanced
User's and System Administrator's Guide</emphasis></para>
</listitem><listitem><para>Online help volumes</para>
</listitem></itemizedlist>
<note>
<para>The <emphasis>Advanced User's and System Administrator's Guide</emphasis>
contains information to help you integrate an application into the desktop.
</para>
</note>
<para>For more information about the Calendaring and Scheduling API, contact
the X.400 API Association for the latest copy of the <emphasis>XAPIA Specification</emphasis>. The address is X.400 API Association, 800 El Camino Real, Mountain
View, California, 94043.</para>
<sect2 id="PG.Pref.div.6">
<title id="PG.Pref.mkr.2">Development Environment Documentation</title>
<para>This section provides an overview of each manual&mdash;except for the <emphasis>Programmer's Guide</emphasis>&mdash;in the developer documentation set. In
addition to the <emphasis>Programmer's Guide</emphasis>, the development
environment documentation set consists of:<indexterm><primary>documentation
set</primary><secondary>development environment</secondary></indexterm></para>
<itemizedlist remap="Bullet1"><listitem><para><emphasis>Common Desktop Environment:
Style Guide and Certification Checklist</emphasis></para>
</listitem><listitem><para><emphasis>Common Desktop Environment: Application
Builder User's Guide</emphasis></para>
</listitem><listitem><para><emphasis>Common Desktop Environment: Programmer's
Overview</emphasis></para>
</listitem><listitem><para><emphasis>Common Desktop Environment: Help System
Author's and Programmer's Guide</emphasis></para>
</listitem><listitem><para><emphasis>Common Desktop Environment: ToolTalk
Messaging Overview</emphasis></para>
</listitem><listitem><para><emphasis>Common Desktop Environment: Internationalization
Programmer's Guide</emphasis></para>
</listitem><listitem><para><emphasis>Common Desktop Environment: Desktop Korn
Shell User's Guide</emphasis></para>
</listitem><listitem><para><emphasis>Common Desktop Environment</emphasis>:
Glossary</para>
</listitem><listitem><para>Online man pages</para>
</listitem></itemizedlist>
<sect3 id="PG.Pref.div.7">
<title>Common Desktop Environment: Programmer's Overview</title>
<para>The <emphasis>Common Desktop Environment: Programmer's Overview</emphasis>
has two parts. Part 1 contains an architectural overview of the Common Desktop
Environment, including high-level information on both the run-time and development
environments. Part 2 contains information useful to know before developing
an application, and describes the development environment components.</para>
<para>The <emphasis>Common Desktop Environment: Programmer's Overview</emphasis>
provides a high-level view of the Common Desktop Environment development
environment and the developer documentation set. Read this book first before
starting application design and development.</para>
</sect3>
<sect3 id="PG.Pref.div.8">
<title>Common Desktop Environment: Style Guide and Certification Checklist</title>
<para>The <emphasis>Common Desktop Environment: Style Guide and Certification
Checklist</emphasis> provides application design style guidelines and the
list of requirements for Common Desktop Environment application-level certification.
These requirements consist of the Motif Version 1.2 requirements with Common
Desktop Environment-specific additions.</para>
<para>The checklist describes keys using a model keyboard mechanism. It assumes
that your application is being designed for a left-to-right language environment
in an English-language locale. Wherever keyboard input is specified, the
keys are indicated by the engravings on the Motif model keyboard. Mouse buttons
are represented using a virtual button mechanism to specify behavior independent
of the number of buttons on the mouse.</para>
<para>This book provides information to assist the application designer in
developing consistent applications and behaviors within the applications.
</para>
</sect3>
<sect3 id="PG.Pref.div.9">
<title>Common Desktop Environment: Application Builder User's Guide</title>
<para>The Common Desktop Environment Application Builder (also called <emphasis>App Builder</emphasis>) is an interactive tool for developing Common Desktop
Environment applications. AppBuilder provides features that facilitate both
the construction of an application graphical user interface (GUI) and the
incorporation of the desktop's many useful desktop services (such as Help,
ToolTalk, and Drag and Drop). The <emphasis>Common Desktop Environment: Application
Builder User's Guide</emphasis> explains how to create an interface by dragging
and dropping &ldquo;objects&rdquo; from a palette. The guide also explains
how to make connections between objects in the interface, use the application
framework editor to easily integrate desktop services, generate C code, and
add application code to the App Builder output to produce a finished application.
</para>
</sect3>
<sect3 id="PG.Pref.div.10">
<title>Common Desktop Environment: Help System Author's and Programmer's
Guide</title>
<para>The <emphasis>Common Desktop Environment: Help System Author's and Programmer's
Guide</emphasis> describes how to develop online help for application software.
It covers how to create help topics and integrate online help into a Motif
application.</para>
<para>The audience for this book includes:</para>
<itemizedlist remap="Bullet1"><listitem><para>Authors who design, create,
and view online help information</para>
</listitem><listitem><para>Developers who want to create software applications
that provide a fully integrated help facility</para>
</listitem></itemizedlist>
<para>This book has four parts. Part1 describes the collaborative role that
authors and developers undertake to design application help. Part 2 provides
information for authors organizing and writing online help. Part 3 describes
the Help System application programmer's toolkit. Part 4 contains information
for both authors and programmers about preparing online help for different
language environments.</para>
</sect3>
<sect3 id="PG.Pref.div.11">
<title>Common Desktop Environment: ToolTalk Messaging Overview</title>
<para>The <emphasis>Common Desktop Environment: ToolTalk Messaging Overview</emphasis> describes the ToolTalk components, commands, and error messages
offered as convenience routines to enable your application to conform to
Media Exchange and Desktop Services message set conventions. This manual
is for developers who create or maintain applications that use the ToolTalk&reg;
service to interoperate with other applications.</para>
<para>The <emphasis>ToolTalk Messaging Overview</emphasis> does <symbol role="Variable">not</symbol> describe general ToolTalk functionality. For detailed information
about the ToolTalk service, refer to <emphasis>The ToolTalk Service: An Inter-Operability
Solution</emphasis>. For tips and techniques to help make using ToolTalk
easier, read <emphasis>ToolTalk and Open Protocols: Inter-Application Communication</emphasis>.</para>
</sect3>
<sect3 id="PG.Pref.div.12">
<title>Common Desktop Environment: Internationalization Programmer's Guide</title>
<para>The <emphasis>Common Desktop Environment: Internationalization Programmer's
Guide</emphasis> provides information for internationalizing an application
so that it can be easily localized to support various languages and cultural
conventions in a consistent user interface.</para>
<para>Specifically, this guide:</para>
<itemizedlist remap="Bullet1"><listitem><para>Provides guidelines and hints
for developers on how to write applications for worldwide distribution.</para>
</listitem><listitem><para>Provides an overall view of internationalization
topics that span different layers within the desktop.</para>
</listitem><listitem><para>Provides pointers to references and more detailed
documentation. In some cases, standard documentation is referenced.</para>
</listitem></itemizedlist>
<para>This guide is not intended to duplicate the existing reference or conceptual
documentation, but rather to provide guidelines and conventions on specific
internationalization topics. It focuses on internationalization topics and
not on any specific component or layer in an open software environment.</para>
</sect3>
<sect3 id="PG.Pref.div.13">
<title>Common Desktop Environment: Desktop Korn Shell User's Guide</title>
<para>The <emphasis>Common Desktop Environment: Desktop Korn Shell User's
Guide</emphasis> describes how to create Motif applications with Desktop
Korn Shell (<command>dtksh</command>) scripts. It contains several example
scripts of increasing complexity, in addition to the basic information a
developer needs to get started.</para>
<para>This guide is intended for developers who find a shell-style scripting
environment suitable for a particular task. It assumes a knowledge of Korn
Shell programming, Motif, the Xt Intrinsics, and, to a lesser extent, Xlib.
</para>
</sect3>
<sect3 id="PG.Pref.div.14">
<title>Common Desktop Environment: Glossary</title>
<para>The <emphasis>Common Desktop Environment: Glossary</emphasis> provides
a comprehensive list of terms used in the Common Desktop Environment. The
Glossary is the source and reference base for all users of the desktop. Because
the audience for this glossary consists of many different types of users&mdash;from
end users to developers to translators&mdash;the format for a glossary definition
may include information about the audience, where the term originated, and
the Common Desktop Environment component that uses the term in its graphical
user interface.</para>
</sect3>
</sect2>
</sect1>
<sect1 id="PG.Pref.div.15">
<title>What DocBook SGML Markup Means</title>
<para>This book is written in the Structured Generalized Markup
Language (SGML) using the DocBook Document Type Definition (DTD).
The following table describes the DocBook markup used for
various semantic elements.
</para>
<table id="PG.Pref.tbl.1" frame="Topbot">
<title>DocBook SGML Markup</title>
<tgroup cols="3" colsep="0" rowsep="0">
<colspec colwidth="1.65in">
<colspec colwidth="2.63in">
<colspec colwidth="2.92in">
<thead>
<row>
<entry align="left" valign="bottom"><para><literal>Markup Appearance</literal></para></entry>
<entry align="left" valign="bottom"><para><literal>Semantic Element(s)</literal></para></entry>
<entry align="left" valign="bottom"><para><literal>Example</literal></para></entry></row>
</thead>
<tbody>
<row>
<entry align="left" valign="top"><para><command>AaBbCc123</command></para></entry>
<entry align="left" valign="top"><para>The names of commands.</para></entry>
<entry align="left" valign="top"><para>Use the <command>ls</command> command to list files.</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><literal>AaBbCc123</literal></para></entry>
<entry align="left" valign="top"><para>The names of command options.</para></entry>
<entry align="left" valign="top"><para>Use <command>ls</command> <literal>&minus;a</literal>
to list all files.</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><symbol role="Variable">AaBbCc123</symbol></para></entry>
<entry align="left" valign="top"><para>Command-line placeholder:
replace with a real name or value.</para></entry>
<entry align="left" valign="top"><para>To delete a file, type <command>rm</command> <symbol role="Variable">filename</symbol>.</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><filename>AaBbCc123</filename></para></entry>
<entry align="left" valign="top"><para>The names of files and
directories.</para></entry>
<entry align="left" valign="top"><para>Edit your <filename>.login</filename>
file.</para></entry>
</row>
<row>
<entry align="left" valign="top"><para><emphasis>AaBbCc123</emphasis></para></entry>
<entry align="left" valign="top"><para>Book titles, new words or terms, or
words to be emphasized.</para></entry>
<entry align="left" valign="top"><para>Read Chapter 6 in <emphasis>User's
Guide</emphasis>.
These are called <emphasis>class</emphasis> options.
You <emphasis>must</emphasis> be root to do this.</para></entry>
</row></tbody></tgroup></table>
</sect1>
</preface>
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 09:54:57-->
<?Pub *0000023383>