Freelance 800F Training

Chapter 19 Documentation

TABLE OF CONTENTS
Chapter 19 Documentation ............................................................................................................................................................ 1
19.1 General Information........................................................................................................................................................... 2
19.1.1 Objectives ................................................................................................................................................................... 2
19.1.2 Legend ........................................................................................................................................................................ 2
19.1.3 Reference Manuals ..................................................................................................................................................... 2
19.2 Introduction ....................................................................................................................................................................... 2
19.3 Documentation Manager.................................................................................................................................................... 3
19.3.1 Editing the Documentation Manager .......................................................................................................................... 3
19.3.2 Define a new Documentation Job ............................................................................................................................... 3
19.3.3 Detail of the Documentation Job ................................................................................................................................ 4
19.4 Compilation of the Drawing Header / Footer .................................................................................................................... 4
19.4.1 Editing the Drawing Header ....................................................................................................................................... 5
19.4.2 Editing the Header Title.............................................................................................................................................. 5
19.4.3 Editing the Drawing Footer ........................................................................................................................................ 6
19.4.4 Editing the Footer Title............................................................................................................................................... 6
19.4.5 Program-Specific Drawing Header / Footer ............................................................................................................... 7
19.4.6 Automatic Allocation of Object Parameters ............................................................................................................... 7
19.4.7 Bitmaps in the Drawing Footer................................................................................................................................... 8
19.5 Printing Documentation..................................................................................................................................................... 8
19.6 Variables for Drawing Footer/ Header Inscriptions........................................................................................................... 8

Chapter 19 - 1

Freelance 800F Training

19.1 General Information

19.1.1 Objectives
On completion of this chapter you will be able to:

Document the project.

19.1.2 Legend
<>

Indicates a key name.

Indicates when you go from one menu to a sub-menu.

Bold

Indicates a menu name or an option in a menu, or file structures

Indicates dialog box buttons, tabs, instructions etc.

Indicates start/explanation of student activity

19.1.3 Reference Manuals

3BBD012503R0301 Freelance 2000 System Configuration

19.2 Introduction
All configured objects can be documented from Control Builder F. And a common
layout has been used for all documents. It is possible to incorporate the company logo
into the document header or footer. Document handling is facilitated by a flexible
sorting on outputting documents, as well as by a complete table of contents for all
project parts output.

Chapter 19 - 2

Freelance 800F Training

19.3 Documentation Manager

19.3.1 Editing the Documentation Manager

The documentation manager menu can be accessed in the following ways:

Select project tree > Project > Document

On entering the documentation manager, already available documentation jobs are

shown underneath the menu line. Documentation jobs are structured in the following
manner:
Name

job name, max. 12 characters, must begin with a letter, no special

characters, no blanks.

Comment

max. 34 characters free text (special characters as well).

Last revision the system automatically enters the date and time of the last change.

19.3.2 Define a new Documentation Job

Place cursor on a blank line

> Documentation > Insert new documentation job

> Enter a documentation name into the field Name

Chapter 19 - 3

Freelance 800F Training

19.3.3 Detail of the Documentation Job

> Project > Documentation > Documentation > Detail

Documentation scope

All selected objects on the same level

All objects located on the same project tree level as the selected junctions are
documented.

All successive objects

All objects underneath the present selection in the project tree are documented. The
documentation scope is determined by the selection in the project tree. By selecting, a
summary of the desired documentation contents (sheet type) can be indicated for the
selected job.
The >> field is enabled if the appropriate sheet type is selected.
NOTE!

If you want to have the documentation limited to a

specific scope, you should just make any individual
selection in the print job detail view

19.4 Compilation of the Drawing Header / Footer

A system-wide drawing header/footer is defined on the project level of the project
tree. All settings made in the drawing header or drawing footer are stored as part of the
project file.
Project > Header

Chapter 19 - 4

Freelance 800F Training

The texts entered into the upper section of the mask can be allocated to the drawing
footer as well as to the drawing header.

19.4.1 Editing the Drawing Header

Project > Header > Edit drawing header

19.4.2 Editing the Header Title

Project > Header > Edit header title

Chapter 19 - 5

Freelance 800F Training

Title designations, which can later be superimposed on the header inscription mask,
can be entered into this mask.

19.4.3 Editing the Drawing Footer

Project > Header > Edit drawing footer

19.4.4 Editing the Footer Title

Project > Header > Edit footer title

Chapter 19 - 6

Freelance 800F Training

Title designations, which can later be superimposed on the footer inscription mask, are
entered into this mask.

19.4.5 Program-Specific Drawing Header / Footer

The project-specific frame inscription is valid initially for all sheets printed out from
Control Builder F. Each program features a menu item Program, Header. Both the
drawing header and drawing footer can be defined under this menu item. However,
each modification effected on this level is valid only for this one program (object).
An entry deviating from the default from the file FRAMES.INI is recognized by the
fact the yellow field color changes to green.
Hence, the fields Date and Name are program-specific in the following example.

19.4.6 Automatic Allocation of Object Parameters

To change entries, the cursor must be placed on a field and the required entry made. In
the case of the fields for the header and footer inscription, a list of the frame
inscription variables available in Control Builder F (Documentation variables) can be
called additionally with key F2. On selecting a variable, a corresponding explanatory
text appears in the lower section. For a list of the variables see Variables for Drawing
Footer/ Header Inscriptions on 20.5

Chapter 19 - 7

Freelance 800F Training

19.4.7 Bitmaps in the Drawing Footer

It is possible to implement bitmaps in the drawing footer, header and in the cover
page.
The bitmaps are used from the directory: \freelance\bitmaps.

19.5 Printing Documentation

> Project > Documentation > Documentation > Print

Start printing to a file or directly to the printer.

19.6 Variables for Drawing Footer/ Header Inscriptions

Chapter 19 - 8

Command

Function

Avoids overriding through the project name

$DocEnd

End of the selection range in the project tree (depends on the

documentation job)

$DocStart

Start of the selection range in the project tree (depends on the

documentation job)

Freelance 800F Training

Command

Function

$DocT

DIN number of the current documentation type (Hardcoded,

language dependent).

$DocTypeName1

First part of the name of the current documentation type.

(Hardcoded, language dependent).

$DocTypeName12

Name of the current documentation type. (Hardcoded, lan-guage

dependent)

$DocTypeName2

Second part of the name of the current documentation type.

(Hardcoded, language dependent).

$ObjCDat
Creation date of the current documentation object. (If avail-able)
$ObjComm
Short comment to the current documentation object. (If avail-able)
$ObjDate

Date of the current documentation object. (If available)

$ObjFunct

Name of the current project tree object. (If available)

$ObjId

Short Id to the current documentation object. (hardcoded, language dependent, typically 3 capital letters)

$ObjKz

Documentation identifier of the current object.

$ObjLoc

Localization of the current object.

$ObjName

Name of the current documentation object. (For example name of

the project tree object)

$ObjS

State of the current documentation object. (CORRECT, INCORRECT)

$PgNr

Current page No. of the print job.

$PrintDate

Date of the print issue.

$PrjComm
Comment of the current project. (Editable in the project head-er)
$PrjDate

Date of the current project. (As shown in the project header)

$PrjMan

Manager of the current project. (Editable in the project header)

Command

Function

$PrjName

Name of the current project.

$PrjNr

Number of the current project. (Editable

$PrjOrd

Orderer of the current project. (Editable in the project header)

$PrjOrdNr

Order number of the current project. (Editable in the project

header)

%LogoComp

Default bitmap for your company.

%LogoCover

Default bitmap for your cover page.

%LogoCust

Bitmap for custumer project

in the project header)

Chapter 19 - 9

Freelance 800F Training

Chapter 19 - 10

%LogoLeft

Default bitmap for the upper left corner.

%LogoRight

Default bitmap for the upper right corner.