CIB merge technical documentation (EN)

6.29. Parameter --field-results

[-r / -rp]

The --field-results parameter can be used to control whether all field-results are removed in Rich Text Format, thus reducing the size of the output file.

Syntax

--field-results

or

--field-results=p

Or (from CIB merge 3.9.183)

--field-results= Keepswitch

Description

MS Word generates field results in RTF. In most cases, these entries are not required by the CIB office modules. The parameter --field-results removes these entries.

For certain graphic objects, CIB format requires certain parts of the field results for positioning and scaling in individual cases (e.g. positioning graphics over text). The switch p "print" (short: -rp) causes CIB merge to receive these data. In addition, further entries are removed from the RTF, which are not required for further processing with CIB format. If in doubt, --field-results=p should be used, as the output file size increases only slightly compared to --field-results, and CIB format will certainly have all the necessary information available.

--field-results is usually used to optimize the file size of an RTF project before testing and delivery. On request, CIB Support will provide you with detailed information on the optimization of RTF projects.

Keepswitch (from CIB merge 3.9.183):
There are use cases in which the data supply of a document must be carried out over several merge processes, because not all information is available at the time of the first run. In this case, the field contents of the previous merge processes must be retained for the subsequent ones.

The parameter "keepswitch" is used for variables (REF fields) in the input document of the CIB merge, which are provided with a KEEP/LASSEN switch. If there is no data supply for these variables, an existing field result is retained.

Example

--inputfile=wurzelbaustein.rtf
--outputfile=!..\result\wurzelbaustein_FieldResults.rtf
--field-results=p
--filter=f

CIB merge does not merge field contents (--filter=f), removes all field-results which are not relevant for CIB format (--field-results=p) and writes the output file accordingly.

The use of this parameter is illustrated in the application example blocks. CIB merge does not merge field contents (--filter=f), removes all field-results which are not relevant for CIB format (--field-results=p) and writes the output file accordingly.

The use of this parameter is demonstrated in the usage example Templates.

 

Note:

RTF files created with --field-results should no longer be edited with MS Word. Documents with scaled graphics or graphics positioned over text can no longer be displayed and edited correctly in MS Word. When saving with MS Word, the advantage of the reduced file size is also lost again.

The file size of the output file can be additionally reduced by CIBrtf output with --short-tokens and compressed with --compress.