Creating a new template

Chapters

Summary

Users can create new templates or modify existing templates in order to allow easy creation of default content.

Creating a new file template

New file templates are templates that show up after a user has entered a file name and has clicked the Next button:

1. Open the existing bundle.rb file
2. Add the following content to the bottom of the file:
   
3. Replace the "sample" and "txt" values with values appropriate to your filetype.
4. Create a templates folder underneath the rublename.ruble folder
5. Drop in file sample.txt (or the specific file you have created)
6. Save and close bundle.rb

If you now go to File > New > File... and create a file name of the appropriate extension above, you should see your template in the list.

Creating a new project template

New project templates are templates that show up after a user has entered a project name and has clicked the Next button:

You can create project templates that reference a local .zip file, or retrieve content from the web.

Project types

Project templates can be added to existing project wizards by the specification of the "type" element:

Local content

If your content is hosted locally, you can simply reference a .zip file containing the files in question.

1. Create a templates directory in the bundle and add a project_templates.rb file in the templates directory.
2. Add the following content to the project_templates.rb file:
   
3. Replace the template name, "web", and "sample_project.zip" values with values appropriate to your project.
4. Drop the file sample_project.zip in the templates folder.
5. Save and close project_templates.rb.

File > New > Project... and create a project of the appropriate type above, you should see your template in the list.

Remote content

If you instead have a project template hosted on a Git repo, you can reference that as well:

1. Create a templates directory in the bundle and add a project_templates.rb file in the templates directory.
2. Add the following content to the project_templates.rb file:
   
3. Replace the template name, "web", and "location" values with values appropriate to your project.
4. Save and close project_templates.rb.

File > New > Project... and create a project of the appropriate type above, you should see your template in the list.

The Ruble Specification gives a complete discussion on the new Ruble scripting system in Studio.

Template variables

It's possible to add template-variables in the project's template files. Those variables will be substituted with the appropriate content as the project is created.

The following variables are supported:

Variables should be inserted inside a ${} blocks into your code. For example: