Chapter 1. FileTemplate 0.94

Stjepan Rajko

Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

FileTemplate is a template processor for files and directories. This could be useful in the following scenarios:

  • There is a generic starting point for a certain type of project. The user can specify information to fine-tune their particular starting point.
  • The user would like to integrate their existing files into a new project for which there is a template. The user can perform a template merge between the template for the new project, and the existing files (acting as a second template). If the template is implemented appropriately, it will integrate the user's existing files.

FileTemplate is being developed to help constructing new projects for the Boost Sandbox. The sandbox template, which is used for this purpose, is currently the only template developed using FileTemplate.

See the sandbox use cases documentation for some examples of how to use the sandbox template.

Note

FileTemplate is not an official part or tool of the Boost libraries.

If you are interested in creating a template for a setting other than the Boost sandbox, FileTemplate provides a basic framework which makes producing templated file/directory trees relatively easy. The philosophy behind the development of the framework is that simple things should be simple, and more complicated things should be doable. By being implemented in Python, and allowing template-specific python scripts to be placed in a template, FileTemplate provides a reasonable degree of flexibility.

See the templates documentation for more information about creating and customizing templates.