Template Tags

The code generator processes the following template tags inside the templates to generate the working codes, intermediate or advanced users can make use of these tags to create custom templates. These tags are case-insensitive. All template tags have the same basic syntax:

Syntax:

<!--##...##-->

Due to the HTML comment style format, these script blocks will be treated as HTML comments in any editors. Therefore, you can use your favorite editor to edit the template provided that these special tags are kept in place.

It is important to understand how templates tags works. During code generation, the code generator reads the template file, executes the scripts in the template tags, and finally, write the codes to the output file.

 

1. Session Tags

Syntax:

<!--##session session_name##-->
...session content here...
<!--##/session##-->
Notes
  1. The keyword "session" is immediately after the start tag <!--##,
  2. The session_name is the name of the session, only alphanumerical characters should be used, no spaces, and it is not quoted,
  3. The tags must be in pairs, with a start session tag and an end session tag,
  4. The end session tags contain a "/" immediately after the tag, i.e. <!--##/.

The code generator locates the source of a output file according to the sequence of sessions specified in the control.xml of the template. Each session tag carries a session name that identifies the lines of code that will be extracted.


2. Script Block

To generate codes according to the project settings, there are many script blocks in each session. Each script block is enclosed by special start and end tags.

Syntax:

<!--##
...Script here...
##-->

The scripting language used in the script block is JavaScript as supported by Node.js. To customize template, you need to know JavaScript.

In a script block, you can create variables and constants, use conditional statements, do looping, write procedures, etc. You can also access all settings in the project within the script block. (See Template Object Properties for details.) With script blocks, you can generate virtually any codes you want.

Example

<!--## if (TABLE.TblType == "VIEW") { ##-->
...code here...
<!--# } ##-->

In this example the codes in between will only be generated if the table is a view. "TABLE" is a template object and "TblType" is one of its properties.

 

3. Function Block

Function block output an object property as string or output a string return by a function.

Syntax:

<!--##=...##-->

Note the "=" symbol immediately after the start tag.

The function can be a built-in system function or an user function defined in user code file (see Using User Code). You can refer to the System Functions list for functions that you can call or override.



Format

Syntax:

<!--##=Object.Property##-->

 

Example 1 - Accessing object property

<!--##=PROJ.ProjName##-->

This line will write the project name in the output file.

Example 2 - Calling a function

<!--##
// This is a script block
function MyFunction() {
    return "This is my custom function";
}
##-->

<!--##=MyFunction()##-->

This line calls the function "MyFunction" and write the string returned by the function in the output file. In real cases, the returned string is the code you want to generate.

 

4. Function Block with Indentation

Syntax:

<!--##~...##-->

Note the "~" symbol immediately after the start tag. This function is same as function block above except that output block will be indented with the space before the block.

 

Also See:

Object Properties
System Functions
Using User Code

 

 ©2004-2017 e.World Technology Ltd. All rights reserved.