Configuration

<< Click to Display Table of Contents >>

Navigation:  Document Management > Managing The Library >

Configuration

The Configuration dialog within the Documents module allows you the modification of the header to be inserted on top of each document and you can also define a company logo to be inserted in the header.

 

Please note that the modification of these data should be performed only by trained users as a wrong configuration of the header information may affect the output of all documents in the system.

 

Definition of the Header Layout

 

The header is defined as an HTML snipped to be inserted at the top of each document shown in the system. Most HTML tags and styles can be used.

In some cases it could be useful to apply all style attributes for all elements in the header as other styles defined in the document itself or in any attached CSS style sheet might get applied at the same time.

 

Document Variables

 

For the dynamic updating of the document header with information of the currently shown document, the system supports a number of different document variables that will be replaced with the actual content while preparing the complete document including the header.

 

Each variable in the header source must be inclosed in a special tag sequence:

 

<span class="var">%variable%</span>

 

The following variables are currently available:

 

%DOCUMENTTITLE%

document title

%DOCUMENTFOLDER%

names in folder hierarchy

%DOCUMENTVERSION%

version number

%DOCUMENTSTATUS%

document status (e.g. "new", "checked" etc.)

%COMPANYLOGO%

identifies the place where the company logo shall be shown; for extended formatting you can also assume the availability of the logo file as logo.png, so you may define your own <img> tags with customized styling

%DOCUMENTCREATEINFO%

creation info: name of user and date

%DOCUMENTCHECKINFO%

checking info: name of user and date

%DOCUMENTAPPROVEINFO%

approval info: name of user and date

%DOCUMENTRELEASEINFO%

releasing info: name of user and date

%DOCUMENTARCHIVEINFO%

archiving info: name of user and date

%DOCUMENTFOLDERNAME%

for QDMS compatiblity: shows the folder a document belongs to

%DOCUMENTCHAPTER%

for QDMS compatibilty: shows the chapter a document belongs to

%DOCUMENTAPPROVAL%

shows a one line text with all relevant approval information (can be used as an alternative of using DOCUMENTCREATEINFO etc. seperately)

<!--UC-->

this is not to be enclosed in the <span> tags - this tag will be replaced with a "- uncontrolled copy -" text while printing the document

 

Logo Bitmap

 

The logo bitmap to be defined in the configuration dialog must be provided in PNG format and must contain an Alpha layer defining the transparent parts of the logo.