Several report templates in RTF format are included with the installation kit of the Helium software.
Files related to the report creation are placed in the "Report" subfolder of the folder where the Helium software was installed.
Helium users may take these templates and customize them for their needs or create new templates.
Using RTF report templates
The RTF file defines the appearance of the generated report. The main idea is that the RTF file is a template for the report.
During report creation Helium software searches the RTF file for specific bookmarks and replaces them with parameter values.
All available bookmarks are registered in the "Full report". When you create the new one report you can use any available bookmarks from the"Full report".
The list of all bookmarks includes all parameters and pictures.
To see the list of all available bookmarks in a report RTF template file, to add and delete them you
may use MS Word. Open RTF file in it. To see list with all available bookmarks in the template open
window ";bookmark" from menu "Insert" - > "Bookmark":
All "known" bookmarks will be replaced with the corresponding parameter values. All "unknown" bookmarks
will be left intact. If some parameter value is not available, the corresponding bookmark will be left intact. If you don't
want to see some parameter's value in the report, just remove the corresponding bookmark.
To find the bookmark you need to remove choose this bookmark from the list,
mark it and click button "Go To". The cursor will place to the position with obtained bookmark. Remove the bookmark.
To add a bookmark select the text, which will be later replaced with the parameter's value and choose
menu item "Insert" - "Bookmark...". Write bookmark name and click "Add" button. The bookmark will be added to the list.
Choose menu item "Tools" - "Options", select "View" tab and check the "Bookmarks" option in the "Show" group. All existing
bookmarks will be shown as square brackets right in the document.
All bookmarks in the Helium RTF template file marked as N/A. It is easier to edit the report template
when all bookmarks are visible. To make the bookmarks visible in the document choose menu "Tools" - "Options" - "Bookmarks":
Word does not allow editing of bookmark names once they are defined. You may delete the existing bookmark
and create new. If you try to add a second bookmark with the same name, the first will be deleted.
For example, the text in the file marked with the bookmark "TOTAL_DEPTH_MM" will be replaced with the
total height of the diamond in millimeters. Make sure that all bookmark names are written in capital letters. If it is
necessary to put the same parameter's value several times in the report, you may use the following technique. RTF file
can't contain two bookmarks with the same names, so add a "_COPY_N" suffix to the primary bookmark's name, for example,
"TOTAL_DEPTH_MM_COPY_1". Thus, both bookmarks "TOTAL_DEPTH_MM" and "TOTAL_DEPTH_MM_COPY_1" will be replaced with the value
of the same parameter - the total height of the diamond in millimeters.
Make sure that you save the changed file again in RTF format.
Helium may generate a series of pictures for the report. In order to insert a picture in the report
just add a corresponding bookmark to the desired place. It will be replaced by the picture during report creation. The
size of picture in RTF report may be specified in MS Word. We usually create a table in the Word document and put the
corresponding bookmark within its cell. Then disable the automatic resize of the table. "Table properties" menu, "Options" button,
clear check box "Automatically resize to fit contents". Then specify the "Preferred width" for the column and "Specify
height" for the row. Choose that the row height is exactly the desired value. With these settings the picture will be automatically scaled by MS Word during the creation of report.
If you allow automatic resize for the table or put the bookmark not in the table, the resulting picture will occupy the whole page.
Using initialization files
The RTF template files should be described in the corresponding initialization files. Initialization
files are plain-text files with the INI extension in the following format. INI file consists of sections. A section in the initialization
file must have the following form:
Key1 Name = string value1
Key2 Name = string value2