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

CERN -> IPT Group -> FrameMaker at CERN
	Guide for FrameMaker User Guide Templates

Chapter 1

Getting started

1.1 Two document styles to choose from

The structured report or normal style

The STOP method

Why use it ?

Choose the style early

1.2 File organization and set-up

Organisation of the template and document files

Setting up your user guide document

1.3 Managing template customizations

What is a template customization ?

Managing customizations

Naming convention for new formats

Customization checklist

1.4 Page size options

Different page sizes to choose from

Changing the page size

Select the page height as early as possible

Centralize template customizations

1.5 Planning your user guide

The task-oriented approach

Organize the tasks into chapters

The table of contents

1.6 Adding and deleting chapters

Use your customized template

Adding content files

Re-adding automatically updated files

Adding new content files to the book

Deleting files from the book

1.7 Managing imported files

Advantages of importing by reference

Advantages of importing by copy

Chapter 2

Editing the content

2.1 The chapter title page and section headings

The chapter title page

Sections and subsections

Basic pre-defined table formats: 2Col , 3Col , 4Col , 5Col

2.4 Figures, listings and snippets (Normal template)

Inserting a figure

Listings and snippets

Inserting

Listings longer than 1 page

2.5 Illustrations (STOP template)

Right-page illustrations

Formatting illustrations

2.6 Controlling indentation and spacing in listings

Inserting multiple spaces

Importing a listing by copying

Importing a listing by reference

2.7 Function calls

Formatting separate units such as functions

Customizing for more specific paragraph tags

2.8 The zany paragraph formats

Use only few zany paragraph formats

Importing zany formats or creating new ones

Using zany formats

Zany sections

2.9 The front matter

The cover and inside cover

Editing the frontmatter file

Roman page numbering

2.10 The appendix and the bibliography

The appendices

The bibliography

References to bibliography titles

2.11 The index

Importance of the index

Building the index

Chapter 3

Delivering the document

3.1 Routine book procedures

Updating the FrameMaker book

Printing to standard sized paper

Cutting the paper

3.2 The running footer and background text

Resetting the variables in a single file

Propagating to all other files in the book

3.3 Converting to WWW

Before saving as HTML...

After saving as HTML...

Saving as PDF

Dealing with changes to the template

Appendix A

Set-up and maintenance procedures

A.1 Further thoughts on multi-author editing

Version control of the entire document

Author submissions of material in progress to editor

Managing inter-author cross-references

A.2 Changing the page layouts for different page sizes

Page layouts for the cover, the index, and all other files...

Predefined page layouts

Changing the page size

A.3 Deleting and re-adding automatically updated files

Deleting an automatically updated file

Re-adding an automatically updated file

A.4 Updating the formats of your document files

File types

Updating each file

A.5 Copying and creating Zany paragraphs

Copying Zany paragraph formats

Creating your own Zany paragraph formats

Creating a new Zany frame

Creating a new Zany paragraph

A.6 Splitting a chapter into several files

Splitting the content

Setting the running header in subsequent files

Bibliography

Index

15 July 1998 - Mario Ruggier