CERN Accelerating science

This website is no longer maintained. Its content may be obsolete. Please visit http://home.cern/ for current CERN information.

CERN | API Group | FrameMaker at CERN

User Guide Templates

for Adobe FrameMaker Release 5.5


In this page...
What are they ?
What do you gain ?
How to use
Distribution (CERN only)

Please send comments to DocSys.Support@cern.ch.

Last release: Version 2.0 - 15 July 1998

What are they ?

Complete FrameMaker book templates for the preparation of user documentation.

Package consists of a set of FrameMaker style files, or component templates, that contain pre-defined layout appropriate for the various components that make up a printed book. The different component templates include the cover, the frontmatter, automatically updated table of contents as well as lists of figures, tables, listings, the chapter, the appendix, the bibliography, and the automatically updated index.

A document is produced by organizing these component files into a FrameMaker book, and filling in the content. Additional features include:

  • Designed for multi-author editing.
  • Supports two styles of documentation writing: normal and STOP.
  • Several pre-defined page layout options to choose from.
  • Automatic generation of structured webs.
  • Easy to extend or customise, to better fit your project.
  • Comprehensive user's manual (see How to use below).


What do you gain ?

  • Functional presentation, reducing reader's cognitive overhead, in both printed and online versions of produced documents.
  • Comprehensive pre-defined formats for all typical documentation material.
  • Automatically updated table of contents, lists of figures, tables, listings and index.
  • Consistency and manageability.
  • Advanced exploitation of FrameMaker without the frustration.
  • Common formatting reference, facilitating collaboration.
  • Automatic generation of structured web version of your document.


How to use

Complete user documentation comes in the form of a user's guide, prepared using these same templates in the STOP style. This user's guide is availabe in the following two formats:


CERN Only

Distribution (Version 2.0, 15 July 1998)

HISTORY
Cumulative release notes.

The full distribution package includes two book templates, 80-page PDF manual, and other files providing options and utilities. Please read the manual.

Once you download you can unpack this archive file with WinZip (Windows), Expander (Macintosh) or, for UNIX systems, with the command:
    tar xvf GuideTemplatesV2.0.tar

Pre-installation on UNIX at CERN

CERN UNIX machines can also access the installation of the templates that is maintained by the Software Developments Tools Service (SDTS) under the directory:

  • /pttools/Templates/FrameMaker/Guides/

To access this installation you will need to:

  • NFS: mount pttools:/pttools/Templates under /pttools/Templates
  • AFS: soft link /pttools/Templates to /afs/cern.ch/pttools/Templates

Support

Please send all questions, problem reports, suggestions, appreciations and announcements of published documents to: DocSys.Support@cern.ch.


 


15 July 1998 - Mario Ruggier - API

Copyright © CERN 1998-2000