Handbook Conventions
English, Revision 02, Date: 20.01.2015
34
9
Handbook Conventions
In documentations of Götting KG the following symbols and assignments are being
used at the time of printing this manual:
Security advices have the following symbols, depending on the emphasis and the
degree of exposure:
NOTE!
ATTENTION!
CAUTION!
WARNING!
Continuative information and tips are identified as follows:
Tip!
Program texts and variables are highlighted by using the
font ’Courier’
.
Whenever input of key combinations is required for the operation of programms,
the corresponding
eys are
ighlighted (in Götting KG programs it is usually
possible to use small and capitalized characters equally).
Sections, figures and tables are automatically numbered consecutively through-
out the entire document. In addition, each document has an index listed behind
the front page, including pages and - whenever the document has more than 10
pages - following the actual system description a figure and table index in the
back. In certain cases (for long and/or complicated documents) a subject index is
added.
Each document provides a table block with metainformation on the front page,
indicating the system designer, auther, revision and date of issue. In addition, the
information regarding revision and date of issue are included within the footer of
each page, enabling the exact allocation of the information with a date and cer-
tain a system revision.
Online-Version (PDF) and printed manual are generated from the same source.
Due to the consistent use of Adobe FrameMaker for the generation of documenta-
tion, all directory entries (including page numbers and subject index) and cross
references in the PDF file can be clicked on with the mouse and will lead to the
corresponding linked contents.
