Four Major Useful Features of Template Printing Function

Implement Printing Data Creation Process Using Template Printing Function

The following image is a print sample using the template printing function.

Template

A template is a print layout defined by a combination of fixed printing data and replacing specifiers, created with the Star Document Markup.
You can define a field (replacement area) in the template, which is a print layout, using a replacing specifier. A value with the same key from field data in JSON format can be substituted for a replacing specifier.

Specify a replacing specifier in plain text. A replacing specifier can coexist with a normal text.

Date:${date} Time:${time}

Replacing specifier format

A key character string enclosed between ${ and }, like "${key-string}," is treated as a replacing specifier.
If there is a key that matches 'key-string' in the field data, the text in the "${key-string}" area is replaced with the key value.
If there is no matching key, printing is conducted with the "${key-string}" area ignored.

Key specifier

You can specify a key in the field data to identify the field data with which you want to replace.
Only ASCII characters are allowed in keys.

Case of a nested element

To specify a nested element, combine keys with a period (.).

Example of specifying a nested element

“${store.name}"

Field data

{
    "store" : {
        "name" : "Star Store",
        "address" : "123 Star Road, City, State 12345"
    }
}

Case of an array element

Template

[templateArray: start]
[column: left ${item_list.name}; right ${item_list.unit_price%6.2lf}
[underline: on]\
[column: left ; right x${item_list.quantity}]
[underline: off]\
[templateArray: end]
[cut: feed; partial]       

Field data

{
    "item_list" : [
        {
            "name" : "BLT",
            "unit_price" : 13.0,
            "quantity" : 1
        },
        {
            "name" : "Chicken Noodle",
            "unit_price" : 7.5,
            "quantity" : 1
        },
        {
            "name" : "Caesar salad",
            "unit_price" : 10.0,
            "quantity" : 2
        },
        {
            "name" : "Coffee",
            "unit_price" : 3.5,
            "quantity" : 2
        }
    ]
}

Print result

Number format specifier

If a field data value is a numeric type, you can specify the display format using a number format specifier. A number format specifier is a subset of a format specifier in printf function in C language. A number format specifier can be omitted. If omitted, the value is used as a character string without being converted.

Escape characters

When you want to print ${ signifying the start of a replacing specifier, add a ; to the end for escape (${;).

To include the following characters, which have special meanings for the template printing function, in a field data key, when using them in a key specifier, place a \\ before the characters for escape.

% . ; }

Template printing function-compatible tags

You can define a field using a replacing specifier in the following tags.

Field data

Field data is a printing data set different for each printing, written in JSON format.
The template printing function creates printing data by substituting the value of field data specified in a replacing specifier in a template.

Key specifications

Only ASCII characters are allowed in keys.

Value specifications

Which type of character string replaces the field is determined based on the field data value type as shown below.