Files
cdesktop/cde/doc/C/guides/infoAPg/ch01.sgm

224 lines
6.1 KiB
Plaintext

<!-- $XConsortium: ch01.sgm /main/4 1996/10/11 09:23:23 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. -->
<Chapter id="infoapg.div.1">
<Title id="n0Crl2IBiWmBt8oL">About the Build Process and Tools</Title>
<IndexTerm><Primary>information libraries</Primary>
<Secondary>building</Secondary><Tertiary>process overview</Tertiary></IndexTerm>
<Para>
This section offers a brief overview of the build process you
perform to create an on-line information library. It also discusses
the software tools available in the Information Manager
for performing the build.
</Para>
<Para>
To build an on-line information library with the
Information Manager,
you must supply a set of SGML-conforming document(s) for the
books you will be building, including the appropriate document
type definitions (DTDs), book source documents, a table of
contents (TOC) for each book, the style sheet(s) that control the
on-line and printed format of the books, and a bookcase
specification that organizes the source documents.
</Para>
<Para>
The DTDs associated with your books must use the
Information Manager Architectural Forms. For information on applying these
architectural forms to your DTDs, see
<Link Linkend="nWGeMZBc9og24aK">Using Architectural
Forms</Link>.
</Para>
<Sect1>
<Title id="n4Crl2IBiWmBt8oL">Process Overview</Title>
<IndexTerm><Primary>software tools</Primary><Secondary>process overview</Secondary></IndexTerm>
<Para>
The general process for producing and administering
Information Manager browser files from SGML source is covered in these
sections:
</Para>
<ItemizedList>
<ListItem>
<Para>
<Link Linkend="sidr7JBU3pBt8oL">Preparing to Build</Link>. This section includes:
</Para>
<ItemizedList>
<ListItem>
<Para>A discussion of the files you need to successfully
validate and build a book that is browsable with the Information Manager
including:
</Para>
<ItemizedList>
<ListItem>
<Para>the SGML documents that make up a
book
</Para>
</ListItem>
<ListItem>
<Para>
a hypertext TOC for each book
</Para>
</ListItem>
<ListItem>
<Para>style sheet(s)
</Para>
</ListItem>
<ListItem>
<Para>a bookcase specification
</Para>
</ListItem>
</ItemizedList>
</ListItem>
<ListItem>
<Para>a procedure for creating a valid hypertext TOC
</Para>
</ListItem>
<ListItem>
<Para>
a description of how the Information Manager uses style
sheets and how you specify style sheets in your bookcase specification
</Para>
</ListItem>
<ListItem>
<Para>
a procedure for creating a bookcase specification
</Para>
</ListItem>
<ListItem>
<Para>
an example bookcase specification
</Para>
</ListItem>
</ItemizedList>
</ListItem>
<ListItem>
<Para>
<Link Linkend="fi1SgFBr-1698oL">Building Information Libraries</Link>.
This section explains how to:
</Para>
<ItemizedList>
<ListItem>
<Para>
<Link Linkend="KyEB2dBpuI9X3cS">validate</Link> your SGML documents
</Para>
</ListItem>
<ListItem>
<Para>
<Link Linkend="xXk7ubBtGL9X3cS">build</Link> a new information library
</Para>
</ListItem>
<ListItem>
<Para>
<Link Linkend="n7Ktl2IBUXmBt8oL">add</Link> a bookcase to an existing library
</Para>
</ListItem>
<ListItem>
<Para>
<Link Linkend="pOUExiBLxJ9X3cS">replace</Link> a bookcase in an existing library
</Para>
</ListItem>
<ListItem>
<Para>
<Link Linkend="WmNvZbBE6K9X3cS">update</Link> style sheets in built bookcases
</Para>
</ListItem>
</ItemizedList>
</ListItem>
<ListItem>
<Para>
<Link Linkend="B7XKbKBcgmg24aK">Administering Bookcases</Link>.
This section describes how to copy, remove, list, rename, or rearrange
bookcases in an information library.</Para>
</ListItem>
</ItemizedList>
</Sect1>
<Sect1>
<Title id="n3Crl2IBiWmBt8oL">Tools Overview</Title>
<IndexTerm><Primary>information libraries</Primary>
<Secondary>building</Secondary><Tertiary>tools overview</Tertiary></IndexTerm>
<IndexTerm><Primary>software tools</Primary><Secondary>overview</Secondary></IndexTerm>
<Para>
To build a library using the Information Manager, you:
</Para>
<ItemizedList>
<ListItem>
<Para>
Create a hypertext table of contents for each book based
on the <filename>dtinfoTOC.dtd(5)</filename>.
</Para>
<Para>See
<Link Linkend="n8aJ92dBIsI9X3cS">Creating a Table of Contents</Link>.
</Para>
</ListItem>
<ListItem>
<Para>
Supply or create valid Information Manager style sheet(s), based on the
<filename>dtinfoStyle.dtd(5)</filename> for the SGML documents that will be built.
</Para>
<Para>See
<Link Linkend="tgmdnkb6vm9x3cs">Understanding Information Manager Style Sheets</Link>.</Para>
</ListItem>
<ListItem>
<Para>
Create a bookcase specification based on the <filename>dtinfoBook.dtd(5)</filename>.
</Para>
<Para>
See
<Link Linkend="TcQg4bBSxI9X3cS">Creating a Bookcase Specification</Link>.
</Para>
</ListItem>
<ListItem>
<Para>
Build browser-readable information libraries using the
<Command>dtinfogen build</Command> command.
</Para>
<Para>
See
<Link Linkend="fi1SgFBr-1698oL">Building Information Libraries</Link>.
</Para>
</ListItem>
</ItemizedList>
<Para>
On Information Manager libraries that are already built, you can:
</Para>
<ItemizedList>
<ListItem>
<Para>
Replace existing style sheets or style sheet information
in the document database, without rebuilding the
database, using the <Command>dtinfogen update</Command> command.
</Para>
<Para>
See
<Link Linkend="WmNvZbBE6K9X3cS">Updating Style Sheets in Built Bookcases</Link>.
</Para>
</ListItem>
<ListItem>
<Para>
Add or replace a bookcase in the library using the
<Command>dtinfogen build</Command> command.
</Para>
<Para>
See
<Link Linkend="n7Ktl2IBUXmBt8oL">Adding a Bookcase to an Existing Library</Link> and
<Link Linkend="pOUExiBLxJ9X3cS">Replacing a Bookcase in an Existing Library</Link>.
</Para>
</ListItem>
<ListItem>
<Para>
Copy, remove, rename, list, or rearrange bookcases in a
library using the <Command>dtinfogen admin</Command> command.
</Para>
<Para>See
<Link Linkend="B7XKbKBcgmg24aK">Administering Bookcases</Link>.
</Para>
</ListItem>
</ItemizedList>
</Sect1>
</Chapter>