Structuring Documents with FrameMaker+SGML

[ Previous Page ] [ Next Page ] [ Contents ] [ Getting help ]

Last modified on: April 4, 1997

Tools

This chapter provides a listing of utilities that may be helpful in the structuring process. Also, additional information on the open2doc-1.pl and open2doc-2.pl scripts is provided.

This chapter is divided into the following units:

Available utilities
open2doc-1.pl/open2doc-2.pl

Available utilities

This section lists the tools that are used in structuring documents. Current versions of most tools are on icarus. To set up an account on icarus, send email to the alias articket requesting an account.

Table 3 lists tools available to help you produce documents for DynaText, PinPoint, and the World Wide Web.

Table 3 Utilities
If you want to:	Use:	Available on:	For more info:
Author documents in FM+SGML	`makersgml`	icarus:/work/packages/frame/fmsgml/bin/makersgml idiom:/frame/fmsgml/bin/makersgml your workstation--contact Peter Cash for a tar bundle of the required files	Contact Peter Cash (login: cash, phone: 4389)
Automate some steps of the conversion to FM+SGML and Ramer's template	`open2doc-1.pl`and `open2doc-2.pl`	icarus:/usr/local/doctools/open2doc/open2doc-1.pl icarus:/usr/local/doctools/open2doc/open2doc-2.pl	Contact Ken Harward (login: harward, phone: 4980)
Capture X screens for your graphics	`xgrab`	bipod:/usr/local/bin/xgrab hawkwind:/usr/local/hp/bin/xgrab	See the man page
Compile your sgml files for use by DynaText or PinPoint	`mkbook`	icarus:/usr/ebt/bin/mkbook
Convert Frame files to html or ASCII	`mifmucker`	icarus:/usr/local/doctools/bin/mifmucker	Enter `mifmucker` for usage
Create an online document	FM+SGML templates	Select from Frame's menu bar File -> New -> Convex/ -> `desired_template` Files are also available on any machine at /usr/spool/globdata/etc/FrameTemplates/FMSGML/	Read the Chapter template
Create a Frame document that you can easily convert to html	Frame-to-html template	icarus:/frame/local/lib/mm/docs/HTMLTemplate.doc idiom:/frame/local/lib/mm/docs/HTMLTemplate.doc hawkwind:/frame/local/lib/mm/docs/HTMLTemplate.doc	Read the template
Generate DocBook structure automatically	conversion table	Select from Frame's menu bar File -> New -> Convex/ -> conversion/ -> conversion.table The table is also available on any machine at /usr/spool/globdata/etc/FrameTemplates/FMSGML/conversion.table	Read the table
Read in element definitions	FM+SGML templates	Select from Frame's menu bar File -> New -> Convex/ -> `desired_template` The files are also available on any machine at /usr/spool/globdata/etc/FrameTemplates/FMSGML/
Shrink your tiff graphic files	shrinktif.pl	icarus:/usr/local/doctools/bin/shrinktif.pl	Contact Ken Harward (login: harward, phone: 4980)
Touch up graphics you have captured	`xpaint`	bipod:/usr/local/bin/xpaint	See the man page
View online documents	`dtext` or `pinpoint`	icarus:/usr/ebt/bin/dtext icarus:/usr/pinpoint/bin/pinpoint	Enter `dtext` or `pinpoint` and read the Help

Also see the Useful tools web page at http://wwwcpress.convex.com/%7Eseads/tools.html for a list of various utilities that can be used in developing documentation.

`open2doc-1.pl/open2doc-2.pl`

The open2doc-1.pl and open2doc-2.pl commands are wrappers for mifmucker. They perform several tasks for you to facilitate the use of mifmucker. Both scripts are located in icarus:/usr/local/doctools/open2doc/.

Run open2doc-1.pl to:

Remove any Openbook structure in the file
Fix tables and figures to conform to the DocBook convention
Empty the character and paragraph catalogs
Remove the master pages and reference pages
Remove the anchored frame that contains the chapter number or appendix letter

After running your file through open2doc-1.pl, import the element definitions from the appropriate template (Chapter, Sample_Preface, etc.) and generate structure using the conversion.table. Then validate all the structure--except for the cross-references--and run the file through open2doc-2.pl. Validate the cross-references after using open2doc-2.pl.

Use open2doc-2.pl to:

Fix vector graphics (fill anchored frames to 0%)

NOTE: Run only one open2doc script at a time. If you use a script or alias named either maker or makersgml onicarus, temporarily disable the script/alias before using open2doc-1.pl or open2doc-2.pl.

Assumptions made in the open2doc scripts

This section lists assumptions that the open2doc-1.pl and open2doc-2.pl scripts make about the input files.

The file being converted follows the Convex FrameMaker/FrameBuilder v4.x templates--paragraph and character tags were not modified or added. For example,
- Figure titles must be named FigTitleN or FigTitleW.
- Tables must have a tag name from the template.
When processing a figure, mifmucker assumes the immediately following paragraph is the figure's caption. If there is no following paragraph, the figure is lost. (mifmucker processes a figure by placing the figure's caption above the figure--as required by the DocBook DTD.)
Anchored frames must be anchored in a paragraph named Graphic. The anchored frame symbol must be the only thing in the Graphic paragraph.
The Graphic paragraph must come before the anchored frame and the figure title must come after the anchored frame.

[ Previous Page ] [ Next Page ] [ Contents ] [ Getting help ]