Substitution templates

Substitution templates are the simplest form of template customization. For specified file extensions, the template processor will replace each occurence of a substitution template with the substituted text. For some examples, see the substitutions of the sandbox template.

Substitution templates are divided into two categories - specific and general. Specific substitution templates are only applied to specific file extensions. General substitution templates are applied to any file extension that has at least one specific substitution defined. Files with no specific substitution templates will be copied verbatim.

Tip

Substitutions are applied in the order they are specified in the template scripts, so substituted text for one substitution template can include substitution templates specified after it. For example, in the sandbox template $template_copyright$ expands into text which includes $template_authors$.

Special templates

There are also special templates, which are also applied whenever substitution templates are applied (i.e., for file extensions with at least one specific extension defined). The FileTemplate processor uses one special template:

Table 1.7. Special templates used by the FileTemplate template processor

special template

desctiption

$template_start$

Everything up to the line of the file containing the first occurrence of this special template will be ignored.