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

Chapter 4

Automatically updated lists


The content of these files should never be edited manually. This chapter provides the information required for the maintenance of these files, namely what is required for these files to be re-added to the book. Once part of the book, all that is required for these files to be automatically updated is to Generate/Update the book, as explained in Section 5.1, "Routine book procedures".

The main heading for each of these auto-updated should use one of four heading tags reserved for this purpose, as indicated for each type in Table 4.1. The purpose for the different headings is to have the flexibility of placing an automatically updated list anywhere in the document - in the front matter as a non-numbered chapter, as a numbered chapter or as an appendix.

Automatically updated list files may be deleted from the book just like any other file (book File menu / Rearrange Files... ). However, re-adding any of these lists (book File menu / Add File... ) requires some list-specific information. Table 4.1 specifies exactly this information.

 

Table 4.1   The set-up data needed when re-adding an automatically updated lists to the FrameMaker book.

Type of list

To add

Sources

Filename Suffix

Starting Page Side

Main heading tag

Table of Contents

Book File /
Add File... /
Generated List:
Table of Contents

AbstractH1
AutoH1App
AutoH1Chap
AutoH1NoNum
H1, H1App, H1NoNum
H2, H2App, H2NoNum
H3, H3App, H3NoNum
H4, H4App, H4NoNum
H5, H5App, H5NoNum
H6, H6App, H6NoNum
ItemH1, ItemH1App
ItemH2, ItemH2App
ItemH3, ItemH3App
ItemH4, ItemH4App
ItemH5, ItemH5App
ItemH6, ItemH6App

TOC

Right

AutoH1Contents

List of
Figures

Book File /
Add File... /
Generated List:
List of Figures

FigCaption
FigCaptionApp

LOF

Next Available Side

AutoH1NoNum

List of
Tables

Book File /
Add File... /
Generated List:
List of Tables

TblCaption
TblCaptionApp

LOT

Next Available Side

AutoH1NoNum

List of
Listings

Book File /
Add File... /
Generated List:
List of Paragraphs

CodeCaption
CodeCaptionApp

LOL

Next Available Side

AutoH1NoNum

List of
Items

Book File /
Add File... /
Generated List:
List of Paragraphs

ItemH1, ItemH1App
ItemH2, ItemH2App
ItemH3, ItemH3App
ItemH4, ItemH4App
ItemH5, ItemH5App
ItemH6, ItemH6App
ItemIdentifier
ItemTitle
ItemTitleChanged
ItemTitleRemoved

LOI

Right

AutoH1Chap
or
AutoH1App

Index

Book File /
Add File... /
Generated Index:
Standard Index

Markers of type Index

IX

Right

AutoH1NoNum

 


5 July 1999 - Mario Ruggier
Copyright © CERN 1999