CERN Accelerating science

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

 

Index


A

abstract,  11
AbstractBody,  11
AbstractH1,  11
acceptable additions of format tags,  36
Acrobat setup,  29
Acronym,  18
acronyms, defining and using,  17
adding a new chapter file to the book,  7
adding chapters,  6
adding formats,  19
audience,  iv
automatically updated lists,  27

B

BasicTable,  19
bibliographical references,  22
book
deleting file from,  7
updating,  29
book document,  v
book template,  v
bulleted lists,  16

C

cascading style sheet,  32
Change Record,  12
chapters
adding,  6
deleting,  6
splitting into several files,  39
character highlights,  14
character map, FrameMaker,  39
character map, windows,  39
character tag,  14
Acronym,  18
FigCallout,  14
Italic,  14
Roman,  22
code listings,  20
CodeCaption,  20, 21
CodeLine,  20
CodeLineFst,  20, 21
CodeLineNth,  20
CodeListing,  20
CodeVerbatim,  20, 21
combining with the content template,  4
component file,  v
component template,  v
content and layout templates, separate,  i
content template,  iii, v
adding new formats,  36
choosing,  2
combing with layout template,  4
definition of,  33
files for,  34
guide document for,  34
information blocks,  34
making,  33
new format tags for,  34
sample material files,  34
content template maker,  iv
content, laying out,  13
contents.html,  32
Control Sheet,  11
controlling indentation and spacing,  20
converting to HTML,  30
cover page,  9
cross-reference tag
Paranum,  19, 20, 21, 22
cross-references,  15
equations,  22
figures,  19
listings,  21
tables,  20
customizations, template,  6
customizing tables,  19
customizing WWW conversion,  30

D

definition lists,  17
deleting a file from book,  7
deleting chapters,  6
delivering the document,  29
Dfn1Part1TermRIH,  17
Dfn1Part2Desc,  17
DfnPart1Term,  14
distribution file,  35
Distribution List,  12
DocMetaData reference page,  10
DocName,  11
DocProjectName,  11
document
delivering,  29
Document Control Sheet,  10
document meta-data
editing,  10
propagating to entire book,  10
document title,  11

E

editing the document meta-data,  10
editing the front matter,  9
editor, role of,  iv
editor's road map,  1
Equation,  22
equation,  21
cross-reference to,  22
editor,  21
fine-tuning formatting,  22
size,  22
small, medium or large,  21
Expander,  35

F

feedback,  ii
FigCallout,  14
FigCaption,  19
FigFullPage,  18
figures,  18
cross-references,  19
FigFullPage table tag,  18
Figures table tag,  18
full page,  18
half page or less,  18
file organization,  3
filename suffix,  27
files
deleting from book,  7
distribution,  35
formats for heading styles,  5
footnotes,  23
format customizations,  6
format files for headings,  5
formats, adding,  19
formats, updating,  38
formatting items,  24
FrameMaker file
frontmatter.fm,  9
heading style formats,  5
lib/logos.fm,  11
sdlt.bk,  3
sdltsinglefile.fm,  3
front matter
editing,  9
Front Page,  11
frontmatter.fm,  9
FrontMatterTables reference page,  11

G

generated lists,  27
getting started,  1
guide document for content template,  34

H

H1,  6
H1App,  6
H1NoNum,  6
HardSpaces,  20
Header/Footer $1,  39
headers/footers, setting,  29
heading style files,  5
headings,  13
automatically updated lists,  27
items,  24
pagination,  5
styles of,  5
HTML, converting to,  30

I

imported files, managing,  8
Imported Graphics
generating a list of,  8
importing a listing
by copying,  20
by reference,  21
importing by copy,  8
importing by reference,  8
indentation, controlling,  20
index.html,  32
information blocks,  34
intended audience,  iv
Italic,  14
item headings
appendix,  24
chapter,  24
ItemAttribBody,  24
ItemAttribName,  24
ItemIdentifier,  24
items,  23
elements,  24
formatting,  24
headings,  24
ItemStatement,  24
ItemTitle,  24

K

key map,  39
keyboard shortcuts,  39

L

language, None,  15
layout and content templates, separate,  i
layout template,  v
choosing,  2
files,  3, 35
lib/
heading style files,  5
logos.fm,  11
listings,  20
cross-references,  21
Snippet table tag,  20
types of,  20
lists
bulleted,  16
definition,  17
numbered,  16
logo
changing,  11
long/short document,  5

M

making content templates,  33
master page
Front Page,  11
mathematical formulae,  21
meta-data, propagating to entire document,  10

N

new format tags for content template,  34
numbered lists,  16

O

organization, of files,  3

P

page numbering
restarting at 1,  7
pagination,  5
paragraph numbering,  7
paragraph tag
AbstractBody,  11
AbstractH1,  11
CodeCaption,  20, 21
CodeLine,  20
CodeLineFst,  20, 21
CodeLineNth,  20
CodeListing,  20
CodeVerbatim,  20, 21
Dfn1Part1TermRIH,  17
Dfn1Part2Desc,  17
DfnPart1Term,  14
Equation,  22
FigCaption,  19
Footnote,  23
H1,  6
H1App,  6
H1NoNum,  6
ItemAttribBody,  24
ItemAttribName,  24
ItemIdentifier,  24
ItemStatement,  24
ItemTitle,  24
PlaceHolder,  18, 19, 20
RefLiterature,  22, 23
Tbl...,  19
TblCaption,  20
utilities,  25
Paranum,  19, 20, 21, 22
PlaceHolder,  18, 19, 20
problems, reporting,  ii
project document,  v
project logo, changing,  11

R

reference page
DocMetaData,  10
FrontMatterTables,  11
WWWVariables,  30
references, bibliographic,  22
RefLiterature,  22, 23
road map,  1
Roman,  22
running headers/footers, setting,  29

S

sample material files
content template,  34
saving as HTML
do after saving...,  32
do before saving...,  30
Saving as PDF,  29
SDLT
main features,  ii
sdlt.bk,  3
sdltbook.tar,  3
sdlt-master.css,  32
sdltsinglefile.fm,  3
sdltsinglefile.tar,  3
separate layout and content templates,  i
short/long document,  5
single file template,  v, 2
Smart Spaces,  20
Snippet,  20
spacing
controlling,  20
splitting a chapter into several files,  39
starting page side,  7
Status Sheet,  12
styles of headings,  5
suggestions, reporting,  ii

T

table tag
BasicTable,  19
tables,  19
cross-references,  20
customizing,  19
tables, frontmatter,  11
tar file, unpacking
Macintosh,  35
Windows,  35
Tbl...,  19
TblCaption,  20
template customizations,  6
title, document,  11

U

updating formats,  38
user variable
DocName,  11
DocProjectName,  11
utility paragraph formats,  25

V

variables, and document meta-data,  11

W

welcome.html,  32
windows character map,  39
WinZip,  35
working model,  ii
WWW conversion, customizing,  30
WWWVariables, reference page,  30


5 July 1999 - Mario Ruggier
Copyright © CERN 1999