CIB merge technical documentation (EN)

6.43. Parameter --lists

The --lists parameter can be used to disable optimizations that are performed for list tables in the header of the RTF document.

Syntax

--lists=<Option>
<Option>: keep, optimize, expand oder adjust

Description

Every RTF document contains list tables (\listtable, \listoverridetable) in its header. When processing these tables, CIB has to spend merge time for insertion matching and optimization.
With the parameter --lists these optimizations can be switched off.

The following values are possible for <Option> :

Option	Description
keep	The list table of the root document is copied unchanged to the output even if inserted text templates contain additional lists. Unused lists are not removed.
optimize	The list table of the root document is not extended by list tables from inserted text templates. Unused lists are removed.
expand	The list table of the root document is extended by list tables from inserted text templates. Unused lists are not removed.
adjust	The list table of the root document is extended by list tables from inserted text templates. Unused lists are removed. (default)
NEWLISTID	The list table contains new list IDs in the merged document in the result document. It allows to create independent and non-continuous lists if there are multiple includes of a file.

 

„Important Note“

NEWLISTID is a field switch and this is usage when the same file is included in multiple copies.

Example: {INCLUDETEXT "new1.rtf" \* NEWLISTID}

Version 3.13

Attention:

This parameter depends on the parameter "--replace-header".

"replace-header=never"
No control possibility of the handling of the list tables. The behavior is the same as with "lists=keep".

"replace-header=always"
(default value) Here the root document is always extended by list tables from inserted text templates. Only optimization and non-optimization is distinguished.

This means that "lists=keep" is treated like "lists=expand" (no optimization) and "lists=optimize" like "lists=adjust" (optimization).

"--replace-header=auto"

Only in this setting all 4 variants of the "-lists" parameter are executed as described above.

Example

--lists=adjust

Here the list table is to be extended by the lists used in the text templates. Unused lists shall be removed. Thus, the usage lists are available again for later editing in MS Word.

This parameter is demonstrated in the use case example Templates.