CDE/cde/doc/C/guides/infoAPg/preface.sgm

<!-- $XConsortium: preface.sgm /main/4 1996/10/03 10:50:52 cdedoc $ -->
<!-- (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="InfoAPG.Pref">
<title>Preface</title>
<Para>
The <CiteTitle>Information System Author's and Programmer's Guide</CiteTitle>
does the following:
</para>
<itemizedlist>
<listitem>
<para>
Provides information on building SGML-conforming document files into 
a form you can view with the Information Manager.
</para>
</listitem>
<listitem>
<para>
Describes how to create and use style sheets.
</para>
</listitem>
<listitem>
<para>
Describes architectural forms, and explains how to apply them to a DTD so users can
build SGML documents into a form viewable with the Information Manager.
</para>
</listitem>
</itemizedlist>
<Note>
<Para>
To use the Information Manager successfully, your
SGML source must use the generalized
markup specified by the Standard Generalized Markup Language [SGML (ISO-8879)].
</Para>
</Note>
<sect1 id="InfoAPG.Pref.div.1">
<Title>Who Should Use This Book</Title>
<Para>
This guide is intended for technical writers, administrators, and publishers who
are responsible for creating, validating, and building SGML
documents into on-line information libraries viewable in the
CDE Information Manager. Readers should have an
understanding of SGML and the ability to edit an SGML DTD.</Para>
</Sect1>
<sect1 id="InfoAPG.Pref.div.2">
<title>How This Book Is Organized</title>
<para>Explanations of the contents of this book follow:</para>
<ItemizedList>
<listitem>
<para>
Chapter 1, &ldquo;About the Build Process and Tools,&rdquo; 
provides an overview of the
Information Manager build process
along with a brief description of the documents and
commands associated with that process.
</para>
</listitem>
<listitem>
<para>
Chapter 2, &ldquo;SGML and Information Manager Document Structure&rdquo;
provides a brief overview of SGML concepts and of the
Information Manager on-line information structure.
</para>
</listitem>
<listitem>
<para>
Chapter 3, &ldquo;Preparing to Build&rdquo;
describes the SGML components you need in order to
build an information library.
</para>
</listitem>
<listitem>
<para>
Chapter 4, &ldquo;Building Information Libraries&rdquo;
covers the process of building and updating an
information library using the <command>dtinfogen</command> commands.
</para>
</listitem>
<listitem>
<para>
Chapter 5, &ldquo;Administering Bookcases&rdquo;
describes how you can modify an existing information
library by copying, removing, rearranging, renaming,
and listing the bookcases in a library.
</para>
</listitem>
<listitem>
<para>
Chapter 6, &ldquo;Troubleshooting&rdquo;
gives troubleshooting advice and discusses build errors, style sheet errors,
and library administration messages.
</para>
</listitem>
<listitem>
<para>
Chapter 7, &ldquo;Understanding Style Sheets&rdquo;
describes the DtInfo Style Sheet model and provides general guidelines
for developing style sheet structure, setting up element path specifications,
and using the Select feature. It also describes element inheritance.
</para>
</listitem>
<listitem>
<para>
Chapter 8, &ldquo;Creating a Style Sheet&rdquo; describes 
the available style sheet features
and defines their attributes and values. Provides instructions for 
creating a style sheet. Includes examples illustrating
how the features might be used in a style sheet. 
</para>
</listitem>
<listitem>
<para>
Chapter 9, &ldquo;Understanding Architectural Forms&rdquo; 
describes Information Manager architectural forms and shows how they
fit in the model for the Information Manager build process and tools.
</para>
</listitem>
<listitem>
<para>
Chapter 10, &ldquo;Using Architectural Forms&rdquo; 
describes Information Manager 
architectural forms and how to apply them in your DTD(s).
</para>
</listitem>
<listitem>
<para>
Chapter 11, &ldquo;Table of Contents Architectural Forms&rdquo; describes 
how to apply architectural forms to the elements in your table of contents
DTD so the Information Manager knows how to treat the table of contents
information.
</para>
</listitem>
</itemizedlist>
</sect1>
<sect1 id="Q3yRgFBsz1698oL">
<title>Related Documentation</title>
<Para>For additional information about SGML, see:</Para>
<ItemizedList>
<ListItem>
<Para>ISO 8879:
<CiteTitle Pubwork=Book>1986 Information Processing - Text and Office
Systems - Standard Generalized Markup Language
(SGML)</CiteTitle> Geneva, 15 October 1986.
</Para>
</ListItem>
<ListItem>
<Para>
<CiteTitle Pubwork=Book>The SGML Handbook</CiteTitle>, C.F. Goldfarb, Clarendon Press,
Oxford University Press, 1990.
</Para>
</ListItem>
<ListItem>
<Para>
<CiteTitle Pubwork=Book>Practical SGML, Second Edition</CiteTitle>, Eric van Herwijnen,
Kluwer Academic Publishers, 1994.
</Para>
</ListItem>
<ListItem>
<Para>
SGML Open Home Page, http://www.sgmlopen.org/sgml/docs/index.html
</Para>
</ListItem>
</ItemizedList>
</Sect1>
<sect1 id="InfoAPG.Pref.div.4">
<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="InfoAPG.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>