CERN Accelerating science

CERN | IPT Group | TDR FrameMaker Template

Technical Design Report FrameMaker Template

Table Of Contents

List of Figures

List of Tables

1 TDR management

1.1 The file structure of the FrameMaker Book for the TDR document

1.1.1 The front matter template file

1.1.1.1 The paragraph styles for the front cover

1.1.1.2 The headings in the front matter

1.1.2 The appendix template file

1.2 Adding a new chapter or appendix

1.2.1 Page numbering of first chapter file

1.3 Updating a FrameMaker book

1.4 The running header for all files in the book

1.4.1 Setting the running header variables

1.4.2 Updating running header variables in all files in the book

1.5 Splitting single chapters into multiple files

1.6 Decide whether to import graphics by copy or by reference

1.7 Choose what external graphic formats to adopt

1.8 Updating formats from a newer version of the template

1.8.1 Time saving "customisations" to the template

1.8.2 Updating the files in the volume manually (PC and Mac)

1.8.3 Updating the files in the volume automatically (UNIX)

1.9 ATLAS Collaborations and Members lists

1.9.1 ATLAS Collaboration

1.9.2 Members of the ATLAS Collaboration

1.10 Converting to WWW

1.10.1 HTML

1.10.1.1 Updating documents prepared with FrameMaker 5

1.10.1.2 Before saving as HTML...

1.10.1.3 After saving as HTML...

1.10.2 PDF

2 Editing the TDR

2.1 Formatting headings

2.2 Formatting text

2.2.1 Using character highlights

2.2.2 Non-mathematical text abbreviations

2.2.3 General paragraph formats

2.3 Formatting lists

2.3.1 Three levels of bulleted list styles

2.3.2 Three levels of numbered lists

2.3.3 Two styles of definition lists

2.4 Using tables

2.4.1 The predefined table formats

2.4.2 Recommendations for table customisations

2.5 Formatting Figures

2.5.1 Formatting small figures with runaround text

2.5.2 Formatting double figures

2.5.3 Formatting full-width figures

2.5.4 Formatting full-page figures

2.5.5 Formatting colour figures

2.5.6 Formatting long figure captions

2.6 Formatting mathematics

2.6.1 The FrameMaker equation editor

2.6.2 Small, medium and large equations

2.6.3 Using shortcuts in the equation environment

2.6.4 Using shortcuts in the text environment

2.6.5 Variables in italic, subscripts in roman

2.6.6 The TP mathematic element definitions

2.6.7 Commonly used equations for which there are no shortcuts

2.6.7.1 To copy and paste an equation in the text

2.6.7.2 To copy and paste the contents of an equation into another equation

2.7 Using cross-references

2.8 Bibliographical references and footnotes

3 Some things are not allowed!

A Sample Appendix

A.1 Figures in the appendices

A.2 Equations in the appendices

A.3 Tables in the appendices

A.4 Bibliographical references in the appendices

A.5 Reference lists of notes and papers in the appendix

B Using the predefined UNIX macros

C Updating figures and tables individually

C.1 Updating old half-width figures individually

C.2 Updating old double figures individually

C.3 Updating old full-width figures individually

C.4 Updating old tables individually

D Template numbering scheme

E Miscellaneous pitfalls

E.1 Using Mac extended characters

E.2 Incorrect printing of Symbol font characters on Windows

Copyright © CERN 1998