jostraca Element |
| Attribute | Description |
|---|
template
required: yes
[ top ] |
The name of the template file to execute.
|
templateList
required: no
[ top ] |
A comma or space separated list of template files to execute.
Equivalent to using -l on the command line.
|
templateListFile
required: no
[ top ] |
File containing a list template files to execute. One per line.
Equivalent to using -t on the command line.
|
templateOptions
required: no
[ top ] |
A comma or space separated list of options for the
template. Equivalent to using -a on the
command line.
|
outputFolder
required: no
[ top ] |
Generated files are saved to this folder. Equivalent to using -o on the command line.
|
workFolder
required: no
[ top ] |
Temporary work files are saved to this folder. Equivalent to using -w on the command line.
|
backupFolder
required: no
[ top ] |
Backup files are saved to this folder. Equivalent to using -b on the command line.
|
homeFolder
required: no
[ top ] |
Home folder of the jostraca distribution. Used to find configuration
and WriterFormat files. If this option is
not specified, the default internal configuration is used. If you
have a customised configuration in the local.conf file, you should provide a value for
this attribute.
|
classPathRef
required: no
[ top ] |
Set the classpath to be used when executing and generating the template.
This attribute accepts an Ant path reference.
NOTE: when compiling and executing templates internally (the default), this option
cannot be used. Instead, ensure that the classpath used to execute the JostracaTask in ant
contains any jar files needed by the template.
|
classPathPrefix
required: no
[ top ] |
Prepend a partial classpath to the existing classpath for executing and
generating the template.
NOTE: when compiling and executing templates internally (the default), this option
cannot be used. Instead, ensure that the classpath used to execute the JostracaTask in ant
contains any jar files needed by the template.
|
classPathSuffix
required: no
[ top ] |
Append a partial classpath to the existing classpath for executing and
generating the template.
NOTE: when compiling and executing templates internally (the default), this option
cannot be used. Instead, ensure that the classpath used to execute the JostracaTask in ant
contains any jar files needed by the template.
|
configFile
required: no
[ top ] |
Location of main configuration file. Equivalent to using -f on the command line. Used to find other
configuration and WriterFormat files. If
this option is not specified, and the homeFolder is also not specified, the default
internal configuration is used. If you have a customised
configuration in the local.conf file, you
should provide a value either for this attribute or the homeFolder attribute.
|
additionalConfigFile
required: no
[ top ] |
Location of additional configuration file. Equivalent to using -F on the command line.
|
backup
required: no
[ top ] |
Specify "yes" to create backups of existing generated files, "no" to
avoid creating backups. Specifying "no" is equivalent to using -B on the command line.
|
compile
required: no
[ top ] |
Specify "yes" to compile template files, "no" to avoid compiling
template files. Specifying "yes" is equivalent to using -c on the command line. Specifying "no" is
equivalent to using -C on the command
line.
|
generate
required: no
[ top ] |
Specify "yes" to save generated files, "no" to avoid saving
generated files. Specifying "yes" is equivalent to using -g on the command line. Specifying "no" is
equivalent to using -G on the command
line.
|
verbose
required: no
[ top ] |
Specify "yes" to enable additional status messages. Specifying "yes"
is equivalent to using -v on the command
line. Specifying "no" is equivalent to the default level of status
messages.
|
quiet
required: no
[ top ] |
Specify "yes" to disable status messages. Specifying "yes"
is equivalent to using -V on the command
line. Specifying "no" is equivalent to the default level of status
messages.
|
enable
required: no
[ top ] |
Specify "true" to enable generation. Specify "false"
to disable generation. Ant property references (${name})
can be used as values.
|
disable
required: no
[ top ] |
Specify "true" to disable generation. Specify "false"
to enable generation. Ant property references (${name})
can be used as values.
|
writerFormat
required: no
[ top ] |
Specify the WriterFormat file to use.
Equivalent to using -W on the command
line.
|
define
required: no
[ top ] |
A comma or space separated list of name=value settings
definitions. Equivalent to using -D on
the command line.
|
dump
required: no
[ top ] |
Dump debugging data to external files, using a comma separated list
of dump options. Current options are "settings" and
"template". Equivalent to using -d on the
command line.
|
classPathRef
required: no
[ top ] |
When using Java-based code writers, use this option to set the classpath used to compile and
execute them. This applies to Java, Jython, and JavaScript (Rhino) templates for release 0.4.1.
Note that you may also need to specify an external compiler and controller. The value of this
attibute is not a literal classpath, but an Ant classpath reference, as created with a
Ant path element.
|
classPathPrefix
required: no
[ top ] |
When using Java-based code writers, use this option to prepend items to the classpath used to compile and
execute them. This applies to Java, Jython, and JavaScript (Rhino) templates for release 0.4.1.
Note that you may also need to specify an external compiler and controller.
The value of this attribute must be a literal classpath. Both : and ; can be used as separators.
|
classPathSuffix
required: no
[ top ] |
When using Java-based code writers, use this option to append items to the classpath used to compile and
execute them. This applies to Java, Jython, and JavaScript (Rhino) templates for release 0.4.1.
Note that you may also need to specify an external compiler and controller.
The value of this attribute must be a literal classpath. Both : and ; can be used as separators.
|
template Subelement |
| Attribute | Description |
|---|
name
required: yes
[ top ] |
The name of the template file to execute.
|
[text]
required: no
[ top ] |
Additional template specific properties can be placed inside the text of the template subelement.
They are then available via the _getProperty template service method.
|