Custom Site Templates

Site Templates are 'pre-packaged' blueprints that ColdBricks uses when creating a new site. ColdBricks comes out of the box with a few example templates to help get you started with your own site. However, you can extend ColdBricks with your own site templates. All site templates are stored as sub directories of the SiteTemplates directory inside ColdBricks. The name of the sub-directory is the name of the site template.

Site Templates must have the following file structure:

/ColdBricks
    /siteTemplates
        /your_siteTemplate_name
            /appRoot
                /config
            /contentRoot
            /resourcesRoot

You site template directory must always contain the following sub-directories:

appRoot: This directory contains the contents of the application directory for the new site. All files contained in this directory will be copied to the location where the new site will be created. This directory must contain a directory named Config with the configuration files for the new site.
contentRoot: This is the directory that will become the root for the content pages on the new site.
resourcesRoot: This directory contains the Resource Library for the new site.

Using Tokens

When creating your own site templates, you can use a set of Tokens on some files that will be replaced by different values at the time the site is created. You can use tokens on the Application.cfc file in the appRoot directory, and in any file in the appRoot/Config directory.

ColdBricks allows you to use the following Tokens

• $APP_NAME$:  Any occurrence of this token is replaced by the name given to the new site.
  

• $APP_ROOT$:  Any occurrence of this token is replaced by the path to the location where the new site will be created.

• $CONTENT_ROOT$:   Any occurrence of this token is replaced by the path to new site's content root.
• $RESOURCES_ROOT$: Any occurrence of this token is replaced by the path to new site's resource library root.