Creating Stencils

Step 1

To Create a new stencil, you have to navigate to File | New | Stencil:


Step 2

When the "Stencil" menu is selected, you are prompted with a form that requires you to enter the stencil name and the stencil folder.

Stencil Name: This has to be a valid file name containing valid characters that can be part of a filename. Spaces are also allowed.

Stencil Folder: By default, stencils are located in : Documents Folder\Codestencil/Stencils. However, while developing your stencils, you may need keep your stencil in the folder that you will be using for development and source control.


Step 3

You will be prompted to complete another form that has more details:

Most of the fields would have been pre-filled except:

Description: Here you can add more information to properly describe your stencil.

Stencil Type: The stencil type has no effect on how your code is generated. It merely helps to specify the type of icon that will be display at the root of the code tree after you stencil has been created.

Comments/Notes: You can add your comments here.

Locked: This has to be left unchecked until you are finished with your stencil and you want to package/deploy it.

Node Generation Only: You can leave this unchecked. If this is checked, then it will prevent a top-to-bottom code generation cycle. This means you will only be able to generate your code one node at a time manually. This is very usefull if you want to keep snippets of code generation logic to be used to generate code snippets.

Output Folder: This is usually prefilled for you. However, if you want the code generated to a specific folder, this is where you make your change.


After you save the form, your stencil will be created in the Documents Folder\Codestencil/Stencils folder:

When a stencil is created, there are 2 elements created:

(1) Stencil File - This is the file that will contain all the code and logic for code generation.

(2) Stencil Asset Folder - This folders contains all the assets that form part of the code generation process. These assets can include compressed files (from binary files), assemblies, etc. 


After the stencil has been created and saved, it is automatically loaded:




About CodeStencil

CodeStencil is Published and Marketed by Zera Systems Inc.

© 2018-2019 CodeStencil - Zera Systems Inc. All Rights Reserved.

No