Conventions
On generation of HTML-report templates, the following conventions are used:
| # | |
comment, is placed in the beginning of a line.
A text that follows this sign is not included at report generation |
| [%%. . .%%] | report section |
| %%. . .%% | keyword |
| @@. . .@@ | field title |
| $$. . .$$ | field value |
Sections
[%% . . . %%] - report section. A report template contains seven obligatory sections in a strictly defined order.
| |
|
[%%ReportType=Notes%%]
[%%ReportCaption="Notes"%%]
[%%ReportDescription=" "%%]
...
[%%HEADER%%]
...
[%%ROWTABLE%%]
...
[%%COMMENTS%%]
...
[%%FOOTER%%]
...
|
| [%%ReportType=. . .%%] | |
section for a report type, where ". . ." is substituted by one
of the following values:
Notes - for notes,
selText- for printing selected text from any document type,
Tree- for printing the document tree
|
| [%%ReportCaption=". . ."%%] | section, in which a report name is given in quotation marks |
| [%%ReportDescription=". . ."%%] | section, in which a report description is given in quotation marks |
| [%%HEADER%%] | report heading section |
| [%%ROWTABLE%%] | data section |
| [%%COMMENTS%%] | comment section |
| [%%FOOTER%%] | report end section |
Keywords
%%. . .%% - keyword.
On report template generation, the program uses
a number of keywords that are substituted upon printing - by a certain text,
images, text blocks, etc.
Keywords are divided into two groups: general (for all reports) and unique
(for reports of a certain type).
The full list of keywords with brief comments is given below.
General keywords:
| %%ReportTitle%% | | report name |
| %%Caption%% | report title |
| %%Charset%% | codepage |
| %%ImgCaption%% | image of the printed report |
| %%BGColor%% | background color |
| %%FontColor%% | font color |
| %%Comments%% | comments |
| %%IgnoreHtmlTitle%% | value of the Title field. If the title field contains HTML structures, they will be ignored. |
| %%AllFields%% | all fields for the current document, in the "name - value" format |
Keywords for printing selected text:
%%SelectText%% selected text;
Keywords for printing the document tree:
%%Tree%% outputs the document tree with icons;
Titles and field values
| @@. . .@@ | | field title
|
| $$. . .$$ | field value |
Each report type has its own list of fields available for printing both as titles and field values. For instance, to output the Title field name, you need to use the @@Title@@ record, and to output its content - $$Title$$.
The list of all fields grouped by a document type and written without special characters (@@ and $$) is given below.
General fields for all document types:
| Title | | record title |
| Created | date and time of record creation |
| Updated | date and time of the last record modification |
| Date | date |
| Time | time |
List of fields for notes:
No unique fields.
|
