Structuring Documents with FrameMaker+SGML
[ Previous Page ] [ Next Page ] [ Contents ] [ Getting help ]
Last modified on: April 4, 1997
Preface
This guide provides an introduction to structuring Frame
documents for publication in both traditional hard copy and in a
format viewable by DynaText and PinPoint.
The PostScript file of this document (56 pages) is available at:
/home/scox/Public/sdFMSGML/sdFMSGML.book.ps.
This document is available on the web at:
http://wwwcpress.rsn.hp.com/tutorials/frame/struct_fmSGML_docs/toc.sdFMSGML.html.
The main parts of this guide are:
- Chapter 1, "Process" provides an overview of the document
conversion process, fundamental rules that must be followed,
and step-by-step procedures for converting.
- Chapter 2, "Tools" contains information on using tools.
- Chapter 3, "Tips and other flashes of inspiration" provides
information that eases the conversion process and results in
better online documents.
The following conventions are used (in addition to the regular
CPress notational conventions) throughout this document:
- Angled brackets (< >) designate the names of
FM+SGML elements. For example, <Para> represents the
Para element.
- Arrows (->) represent the following of menu items through
pull-down menus. For example, File -> New -> Convex/ ->
Chapter indicates that you should select the New menu item
from the File menu bar item. Selecting New opens a dialog for
selecting a file. Enter the Convex directory, then open the
Chapter template.
The following documents may be helpful:
- The Useful tools web page lists various utilities that can
be used in developing documentation
http://wwwcpress.convex.com/%7Eseads/tools.html
Some of these tools are discussed in Chapter 2, "Tools."
- Bob Ramer of Hewlett Packard developed the
FM+SGML/DocBook Training manual
(approximately 250 pages); there are copies available in the
Doc Lab (c2w43) and on icarus
icarus:/home/cash/work/training/Ramer_course/workbook.ps
- The materials that Peter Cash used in a course on structuring
with FrameBuilder are available in the directory
icarus:/home/cash/work/training. Although this document
demonstrates FrameBuilder, it also provides good
background information on what SGML is about, how DTDs
work, and so forth
icarus:/home/cash/work/training
- The DocBook elements are described in the
web page at
http://wwwcpress.convex.com/tutorials/fm5/DocElements.html
You can get a PostScript version of the DocBook elements
information by going to the page at http://wwwcpress.convex.com/tutorials/tutorials.html and going to the "Frame5 & Docbook News" section
on that page
- The MifMucker Home Page gives instructions on and
examples of using
mifmucker
http://hawkwind.rsn.hp.com/mifmucker/index.html
- The Structuring Documents
with FrameBuilder manual--although it refers to
working with FrameBuilder using the OpenBook DTD--can
still be a good source of information
http://wwwcpress.convex.com/tutorials/frame/struct_frame_docs/sdf.contents.html
- The web document Working
with Raster and Vector Graphics gives information on
taking screen captures. With FM+SGML, however, you can
use the original graphic in your document; you do not need
to create one graphic for hard copy and one for online.
http://wwwcpress.convex.com/tutorials/frame/screen_captures_proc/screen.captures.proc.html
- The PinPoint Book QA Process and Checklist gives
details of how to do a QA of an online
book.
http://wwwcpress.convex.com/pinpoint/ppbookQA.html
- The PinPoint Style Issues and Bugs page
explains how to request a style sheet
change
http://wwwcpress.convex.com/pinpoint/ppstyle_changes.html
- The PinPoint document check-in procedures page
explains how and where to check-in a book for distribution
with PinPoint
http://wwwcpress.convex.com/pinpoint/ppcheckin.html
- The About PinPoint page points to information about
the various releases. Check the current release for the names
to use when saving your books to SGML for PinPoint
check-in.
http://wwwcpress.convex.com/pinpoint/pinpoint.html
If you have questions that are not answered by this manual,
contact one of the persons listed below.
General structuring experience:
- Peter Cash (cash, x4389)
- Scott Cox (scox, x4710)
DynaText/PinPoint knowledge:
- Peter Cash (cash, x4389)--stylesheets
- Ken Harward (harward, x4980)--software
Peter Cash is in charge of templates, the conversion table, and
FM+SGML documentation. Ken Harward developed
mifmucker
, which does all the work and is called by
open2doc-1.pl
and open2doc-2.pl
.
Terms used in this manual include the following:
- Child element
Given an element, any element that is on the first level of the
subtree (in the structure view) coming from that element is a
child element to the original element.
EDD
- The Element Definition Document (EDD) is used by
FrameMaker+SGML to define the elements and their
contents; hence, the EDD governs the organization of
documents by allowing only certain combinations of
elements.
- SGML
Standard Generalized Markup Language (SGML) is a
specification for how markup languages should be written.
- Sibling element
Given an element, any element that is on the same subtree (in
the structure view) and at the same level as the original
element is a sibling element to the original element.
Please direct any feedback you have regarding this document to
Scott Cox (scox, x4710).
Updates of this document are available in postscript version in the
idiom:/home/scox/Public/sdFMSGML directory and on the
web. The date that the file was last modified is given in the
sdFMSGML.README file and on the title page of the document.
[ Previous Page ] [ Next Page ] [ Contents ]
[ Getting help ]