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

---

Numerics

2Col ,  22

2-page spreads,  3, 26

3Col ,  22

4Col ,  22

5Col ,  22

A

A4 paper size,  8, 49

acknowledgements,  viii

adding

automatically updated files,  12, 54

chapters,  12

content files to book,  12, 13

advantages

of good documentation,  iv

of importing by copy,  14

of importing by reference,  14

appendices,  36

automatically updated files

deleting,  54

re-adding,  12, 54

availability, of templates,  vii

B

background text,  43

BackgroundText ,  43

base directory,  4

BiblioBody ,  36

bibliographic references,  36

bibliography,  36, 61

BiblioItem ,  36

BiblioSection ,  36

Body ,  18, 20

BodyPlaceHolder ,  20, 22, 24, 25

BodyTabular ,  20

BodyVerbatim ,  20

book

closing all files in,  57

deleting files in,  13

opening all files in,  43, 56

routine procedures,  42

saving all files in,  43, 57

updating,  42

book template,  1, 5

brain, left and right side,  2

breaking up information,  2

C

cerebral hemispheres,  2

chapter.fm ,  6, 49, 58

ChapterNumber ,  18

chapters,  vi

adding and deleting,  12

section headings,  18

splitting into files,  60

title pages,  18

ChapterSection ,  18, 60

ChapterSubSection ,  18

ChapterSubSubSection ,  18

ChapterTitle ,  18

character formats,  20

customizing,  20

Input ,  6, 20

Output ,  6, 20

checklist, for customizations,  6

ChepterSectionList ,  18

chunks, manageable,  2

closing all files in book,  57

comments, sending,  vii

component files,  4

see also file types

see also files

ConceptDescription ,  20

ConceptTerm ,  20

content, editing,  17

conventions

in this manual,  vi

naming new format,  6

converting to WWW,  44

cover,  34, 50

page layouts for,  49

cover.fm ,  34, 49, 52

cross-reference formats,  20

Bibliography ,  36

cross-references

managing across authors,  48

customizations, standard,  6

customizing,  8

adding character tags,  20

adding paragraph tags,  30

and management,  6

checklist for,  6

naming new formats,  6

reference template for,  4, 6, 12

WWW conversion,  46

Zany formats,  32

cutting paper copies,  42, 49

D

deleting

automatically updated files,  54

chapters,  12

content files from book,  13

delivering the document,  41

directories

icons ,  59

lib ,  8, 49, 50, 51, 52, 58

normal ,  49

STOP ,  49

DL1Term ,  20

DocSys.Support@cern.ch ,  vii

document

consistency,  6

delivering,  41

directory structure,  4

hierarchical structure,  2, 45

organization,  2

presentation,  iii

setting up,  4

styles,  2

usability,  iv

documentation,  iv

and document usability,  v

and manpower problem,  iv

as part of software,  iv

different styles for,  2

for FrameMaker,  vi

planning,  iv

production difficulty,  v

DocumentTitle ,  43

double page spreads,  3, 26

E

editing

content,  17

front matter,  34

multi-author,  48

running text,  20

F

FcnCall ,  6, 30

FcnInput ,  6, 30

FcnOutput ,  6, 30

FcnParameters ,  6, 30

FcnSynopsis ,  6, 30

feedback,  vii

Figure ,  24

FigureCaption ,  24

figures

inserting,  24

list of,  55

file types,  56

appendix,  36

bibliography,  36

chapter,  6, 12

cover,  34, 50

frontmatter,  34

index,  38, 51

table of contents,  10

updating page layouts in,  51

files,  4, 51, 52

adding and deleting in book,  12

chapter.fm ,  6, 49, 58

cover.fm ,  34, 49, 52

deleting in book,  13

FrameMaker hypertext,  39, 51

frontmatter.fm ,  52

locking and unlocking,  52

MasterPages210x210Cover.fm ,  49, 50, 51, 52

MasterPages210x210Index.fm ,  49

MasterPages210x254Cover.fm ,  49

MasterPages210x254Index.fm ,  49

MasterPages210x279Cover.fm ,  49

MasterPages210x279Index.fm ,  49

normal.tar ,  4

NormalMasterPages210x210.fm ,  49, 51, 52

NormalMasterPages210x254.fm ,  49

NormalMasterPages210x279.fm ,  49

organization of,  4

size increase per Zany format,  32

STOPMasterPages210x210.fm ,  49

STOPMasterPages210x254.fm ,  49

STOPMasterPages210x279.fm ,  49

usersguideIX.fm ,  49, 51, 52

usersguideTOC.fm ,  51

Zany.fm ,  58

formats

character, see character formats

cross-reference, see cross-reference formats

graphics files,  14

naming new,  6

page layouts, see page layouts

paragraph, see paragraph formats

reference pages, see reference pages

table, see table formats

updating in document files,  56

variable, see variable formats

FrameMaker,  vi

book template,  1, 5

documentation,  vi

hypertext files,  39, 51

locking and unlocking,  52

Frank Stearns Associates,  38

front matter,  34

frontmatter.fm ,  52

function calls,  30

G

generated web,  45

getting started,  1

graphics

generating list of imported,  14

hiding,  14

imported file formats,  14

importing by copy,  14

importing by reference,  14

H

HardSpaces ,  28

Header/Footer $1 ,  60

Header/Footer $2 ,  60

headings,  18

hiding graphics,  14

hierarchy level indicator,  45

HTML, converting to,  44

hypertext files,  39, 51

in generated web,  45

locking and unlocking,  52

I

icons ,  59

Illustration ,  26

IllustrationCaption ,  26

IllustrationPlaceHolder ,  26

IllustrationRight ,  26

illustrations,  26

on left pages,  26

on right pages,  26

imported files

generating a list of,  14

managing,  14

number of formats,  14

tips,  14

importing

graphics, by copy,  14

graphics, by reference,  14

listings, by copy,  28

listings, by reference,  28

indentation and spacing in listings,  28

index,  38, 51

building blocks,  38

importance of,  38

IXgen tool,  38

markers,  38

page layouts for,  49

information chunks,  2

Input ,  6, 20

inserting

figures,  24

multiple spaces,  28

tables,  22

inside cover,  34

installation,  4

introduction,  1

IXgen,  38

K

KeepRestOfPageClear ,  20

L

L1Aplha ,  20

L1Bullet ,  20

L1Continuation ,  20

L1Hyphen ,  20

L1Number ,  20

left brain,  2

lib ,  8, 49, 50, 51, 52, 58

linear logic,  2

list of

figures,  55

listings,  55

tables,  55

Listing ,  24

listing

list of,  55

ListingCaption ,  24

ListingLine ,  24, 25

ListingLineFirst ,  24, 28

listings,  24

importing by copy,  28

importing by reference,  28

indentation and spacing,  28

longer than 1 page,  24

ListingVerbatim ,  24, 28

logging template changes,  6

logic, linear and sequential,  2

M

maintenance procedures,  47

manageable chunks,  2

managing

imported files,  14

inter-author cross-references,  48

template customizations,  6

markers, for the index,  38

MasterPages210x210Cover.fm ,  49, 50, 51, 52

MasterPages210x210Index.fm ,  49, 52

MasterPages210x254Cover.fm ,  49

MasterPages210x254Index.fm ,  49

MasterPages210x279Cover.fm ,  49

MasterPages210x279Index.fm ,  49

multi-author editing,  6, 48

N

naming new formats,  6

navigation aid, in generated web,  45

normal ,  49

normal style,  2

normal template,  24

figures,  24

listings,  24

snippets,  24

normal.tar ,  4

NormalMasterPages210x210.fm ,  49, 51, 52

NormalMasterPages210x254.fm ,  49

NormalMasterPages210x279.fm ,  49

O

opening all files in book,  43, 56

organization

of document files,  4

of tasks into chapters,  10

of the template,  4

orientation aids, in generated web,  45

Output ,  6, 20

overview,  1

P

package, templates,  vii

page layouts

210mm x 210mm,  8

254mm x 210mm,  8

changing,  49

cover, index, other files,  49

format filesets,  49

IllustrationRight ,  26

pre-defined,  49

Right ,  26, 34

selecting,  8

updating different file types,  51

page numbering, roman,  34

page sizes, see page layouts

paper copies, cutting,  42

paper size

A4,  8, 49

A4 width x US Letter height,  49

US Letter,  8

paragraph formats,  20, 32

BiblioBody ,  36

Bibliography ,  61

BiblioItem ,  36

BiblioSection ,  36

Body ,  18, 20

BodyPlaceHolder ,  20, 22, 24, 25

BodyTabular ,  20

BodyVerbatim ,  20

ChapterNumber ,  18

ChapterSection ,  18, 60

ChapterSubSection ,  18

ChapterSubSubSection ,  18

ChapterTitle ,  18

ChepterSectionList ,  18

ConceptDescription ,  20

ConceptTerm ,  20

customizing,  30

DL1Description ,  20

DL1Term , DL1Description ,  20

FcnCall ,  6, 30

FcnInput ,  6, 30

FcnOutput ,  6, 30

FcnParameters ,  6, 30

FcnSynopsis ,  6, 30

FigureCaption ,  24

IllustrationCaption ,  26

IllustrationPlaceHolder ,  26

KeepRestOfPageClear ,  20

L1Aplha ,  20

L1Bullet ,  20

L1ContinuationVerbatim ,  20

L1Hyphen ,  20

L1Number ,  20

ListingCaption ,  24

ListingLine ,  24, 25

ListingLineFirst ,  24, 28

ListingVerbatim ,  24, 28

Quote ,  20

QuoteBullet ,  20

SideHeadSection ,  6, 30

SideHeadStep ,  20

SideHeadSubSection ,  6, 30

TableCaption ,  22

Zany , see Zany formats

part of software, documentation,  iv

PDF,  46

planning, user guide,  10

pre-defined formats

characters, see character formats

cross-reference, see cross-reference formats

page layouts, see page layouts

paragraphs, see paragraph formats

reference pages, see reference pages

tables, see table formats

variable, see variable formats

presentation,  iii

and usability,  iv

importance of,  iv

printing, to standard sized paper,  42

procedures

book routine,  42

set-up and maintenance,  47

process,  4, 6, 48

Q

Quote ,  20

QuoteBullet ,  20

R

re-adding

automatically updated files,  12, 54

reference pages

ZanyIcons ,  58, 59

reference template,  4

references, bibliographic,  36

required software,  vii

Right ,  26, 34

right brain,  2

roman page numbering,  34

routine book procedures,  42

running footer,  43

running header

in multi-file chapters,  60

S

saving all files in book,  43, 57

saving as PDF,  46

section headings,  18

sequential logic,  2

setting up your document,  4

set-up procedures,  47

SideHeadSection ,  6, 30

SideHeadStep ,  20

SideHeadSubSection ,  6, 30

Smart Spaces ,  28

Snippet ,  24

software, required,  vii

spaces, hard,  28

spacing and indentation in listings,  28

special sections,  30

splitting a chapter into several files,  60

spreads, 2-page,  3

standard customizations,  6

STOP ,  49

STOP method,  vi, 2

STOP template

illustrations,  26

STOPMasterPages210x210.fm ,  49

STOPMasterPages210x254.fm ,  49

STOPMasterPages210x279.fm ,  49

structure,  4

structured report style,  2

structured writing,  2

style,  2

choosing,  2

normal,  2

of documentation,  2

STOP,  2

structured report,  2

submissions of material to editor,  48

subsection headings,  18

support,  vii

T

table formats,  22

2Col , 3Col , 4Col , 5Col ,  22

Figure ,  24

Illustration ,  26

Listing ,  24

Snippet ,  24

ZanyTextSection ,  32

table of contents,  10

TableCaption ,  22

tables

inserting,  22

list of,  55

tips,  22

task-oriented approach,  10

template customizations,  6, 8

managing,  6

page layouts,  49

templates

and availability,  vii

and efficiency,  iv, v

and results,  v

availability,  vii

chapter title page,  18

customizing WWW conversion,  46

directory structure,  4

file types, see file types

for better results,  v

getting started,  1

logging changes,  6

normal.tar ,  4

options,  1

package,  vii

problem addressed by,  v

required software,  vii

setting up,  4

subdirectory,  4

support,  vii

two different styles,  2

two-page spreads,  3, 26

U

updating

formats,  56

FrameMaker book,  42

US Letter paper size,  8

usability

of documentation,  v

user documentation, see documentation

user guide templates, see templates

usersguideIX.fm ,  49, 51, 52

usersguideOUTLINE.fm ,  51

usersguideTOC.fm ,  51

V

variable formats

BackgroundText ,  43

DocumentTitle ,  43

Header/Footer $1 ,  60

Header/Footer $2 ,  60

propagating across book,  43

resetting in a single file,  43

running footer,  43

version control,  48

W

web, generated,  45

WWW, converting to,  44

Z

zanni,  32

Zany formats

and file size,  32

copying,  32, 58

creating,  32, 58, 59

number of,  32

Zany formats,  32

Zany sections,  32

Zany.fm ,  58

ZanyIcons ,  58, 59

ZanyTextSection ,  32