Label Fields
Label fields are placeholders for labels, side labels, column labels etc.
Label fields are only set once for the entire document, unlike, regular fields which are set every time a bookmark is pasted.
Label fields are set by adding the label option to the field.
For example: {order label}: {order 00000}
Note that the label option can be added to any field type not just text fields so it can also be used for any field that only needs to be set once.
Label CSV File
The label CSV file is used to set the label fields according to the current locale.
The label CSV file contains 3 columns -
- Locale
- Field name
- Value
See the attached sample label CSV file - sample.csv.
The label CSV file is set by the setLabelFile() method in the WordProcessingMerger class before loading the template.
Note that when setting the label fields, the label value with the same current locale is first searched. Then the same language (in the current locale) and finally the fallback locale is used.
AKIOMA.Offer! Notes -
AKIOMA.Offer! supports the new label fields and label CSV file features.
To use the new label fields and label CSV file features, insert a CSV file in the template label file and add the label option to all the label fields in the template.
To continue using the old label behavior, insert an XML file in the template label file.
Note that to migrate the old label behavior to the new label fields and label CSV file, both a new label CSV file needs to be created and the label option needs to be added to all the label fields in the template.