texttemplate

Provides support for text template files. More...

• List of all members, including inherited members

Properties

• dict : var
• outputFileName : string
• outputTag : string
• placeholder : string (since Qbs 3.1)

Detailed Description

The texttemplate module provides support for text template files.

Example

Consider the following text file greeting.txt.in.

${greeting} ${name}!

This can be used in a project like this:

Product {
    type: ["text"]
    files: ["greeting.txt.in"]
    Depends { name: "texttemplate" }
    texttemplate.dict: ({
            greeting: "Hello",
            name: "World"
        })
}

Which will create the file greeting.txt.

Hello World!

The same result can be achieved using the alternative placeholder format:

Product {
    type: ["text"]
    files: ["greeting.txt.in"]
    Depends { name: "texttemplate" }
    texttemplate.placeholder: "@@"
    texttemplate.dict: ({
            greeting: "Hello",
            name: "World"
        })
}

Where greeting.txt.in contains:

@greeting@ @name@!

Placeholder Syntax

The texttemplate module supports two placeholder formats, controlled by the placeholder property.

A placeholder ${foo} is replaced by its corresponding value in texttemplate.dict. Placeholder names consist of alphanumeric characters only.

The placeholder ${$} is always replaced with $. If you need a literal ${foo} in your template, use ${$}{foo}.

When texttemplate.placeholder is set to "@@", placeholders use the format @foo@ instead.

Placeholders that are not defined in the dictionary will produce an error.

Relevant File Tags

Property Documentation