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

CERN FrameMaker at CERN SDLT
	Guide for using the Software Documentation Layout Templates

Chapter 1

Getting Started

1.1 Editor's road map

1.2 Which layout template?

1.3 Which content template?

1.4 File organization

The layout template files

Your document

1.5 Combining with the content template

1.6 Which style of headings?

1.7 No template customizations!

1.8 Adding and deleting chapters

Adding a new chapter file to the book

Restarting page numbering for first chapter file in the book

Deleting a chapter file from the book

1.9 Managing imported files

Chapter 2

Editing the front matter

2.1 Cover page

Editing the document meta-data

The document title

To change the project logo

2.2 Other front matter

Chapter 3

Laying out the content

3.1 Headings

3.2 Running text paragraphs

3.3 Character highlights

3.4 Cross-references

3.5 Bulleted and numbered lists

3.6 Definition lists

Defining and using acronyms

3.7 Figures

Normal figures (half page or less)

Large figures (full page)

Cross-referencing figures

3.8 Tables

Customizing

Adding formats

Cross-referencing tables

3.9 Code listings

Controlling indentation and spacing

Cross-referencing listings

3.10 Mathematical formulae

The FrameMaker equation editor

Small, medium or large equations

Cross-referencing equations

Fine-tuning equation formatting

3.11 Bibliographical references

3.12 Footnotes

3.13 Items

Formatting items

Special heading for grouping items

3.14 Other utility paragraph formats

Chapter 4

Automatically updated lists

Chapter 5

Delivering the document

5.1 Routine book procedures

Setting the running headers/footers

Updating the FrameMaker book

Saving as PDF

5.2 Converting to HTML

3-step conversion procedure

Step 1: Customizing the conversion, before saving as HTML...

Step 2: Save as... HTML

Step 3: File system modifications, after saving as HTML...

Chapter 6

Making content templates

6.1 Definition of a content template

6.2 The sample material files

6.3 The guide document for a content template

Appendix A

Miscellanea

A.1 The distribution file

A.2 Acceptable additions of format tags

A.3 Updating formats from new template

Updating formats in all files in a book document

A.4 Splitting a chapter into several files

A.5 Some useful FrameMaker tips

Index

5 July 1999 - Mario Ruggier

Contents

Preface