Wizard Engine Service - Revision history

Paulb at 23:22, 17 October 2008

2008-10-17T23:22:18Z

Paulb: /* Service API */

2008-10-17T23:18:18Z

‎Service API

Paulb at 22:50, 17 October 2008

2008-10-17T22:50:21Z

Paulb: /* Template Files */

2008-10-17T22:14:28Z

‎Template Files

Paulb at 19:54, 17 October 2008

2008-10-17T19:54:03Z

Paulb at 19:41, 17 October 2008

2008-10-17T19:41:02Z

New page

The Wizard Engine Service is currently in it's nascency but provides a full template rendering engine for consuming tokenized templates (either from files or in-memory) and rendering them using a variable table. The results are just as flexible as the consumption, the rendered text may be generated into a in-memory representation or stored into a file.

The service makes use of a core engine called the '''Code Templates Engine''', which performs actual rendering and is vastly more structured and verbose to work with. This same engine is also used by the [[Code Templates Catalog Service]], ensuring all manner of templates are defined and rendered in the same fashion though out [[:Category:EiffelStudio|EiffelStudio]].

== Template Files ==

=== Common Locations ===
When working with templates in EiffelStudio, most templates are located under a common ''template'' folder, in the [[:Category:EiffelStudio|EiffelStudio]] installation.

If using template files, and installing the template files under the [[:Category:EiffelStudio|EiffelStudio]] ''templates'' folder, you are encouraged to support [[Replaceable User Files|User Replaceable Files]], so end-users are free to redefine the templates in their own way. Extra precaution needs to be taken however because user files are more susceptible to changes and updates which may result in erroneous rendering.

← Older revision		Revision as of 23:22, 17 October 2008
Line 1:		Line 1:
		+	[[Category:EiffelStudio Services]]
		+	[[Category:Extending EiffelStudio]]
	The Wizard Engine Service is currently in it's nascency but provides a full template rendering engine for consuming tokenized templates (either from files or in-memory) and rendering them using a variable table. The results are just as flexible as the consumption, the rendered text may be generated into a in-memory representation or stored into a file.		The Wizard Engine Service is currently in it's nascency but provides a full template rendering engine for consuming tokenized templates (either from files or in-memory) and rendering them using a variable table. The results are just as flexible as the consumption, the rendered text may be generated into a in-memory representation or stored into a file.

@@ Line 22: / Line 22: @@
 == Service API ==
-=== Examples ===
+=== Template Rendering ===
 <e>
@@ Line 61: / Line 74: @@
      template: !STRING =
          "Hello $NAME!%N%
-         %You passed the index no${VAR}."
+         %You passed the index $VAR, which can be used like th${VAR}is too."
      name_variable: !STRING = "NAME"
@@ Line 75: / Line 88: @@
 <code>
 Hello Eiffel User
-You passed the index no10.
+You passed the index 10, which can be used like th10is too.
 </code>

@@ Line 3: / Line 3: @@
 The service makes use of an internal core engine called the '''Code Templates Engine''', which performs actual rendering and is vastly more structured and verbose to work with. This same engine is also used by the [[Code Templates Catalog Service]], ensuring all manner of templates are defined and rendered in the same fashion though out [[:Category:EiffelStudio|EiffelStudio]]. The purpose of the Wizard Engine Service is to facilitate quick and easy translation of code templates without the overhead involved when using the Code Template Engine directly.
-== Template Files ==
+== Template Text ==
-Template files are simple files tokenized with variable declarations. The variables will be expanded with those specified in a table passed to the service's rendering functions.
+Template are simple text blobs tokenized with variable declarations. The variables will be expanded with those specified in a table passed to the service's rendering functions.
 A variable is tokenized with a <code>$</code> specified followed by an Eiffel-like identifier. By convention all variables are specified in uppercase characters in the template. Variables are not actual case-sensitive so this is by convention only. For example, here is the simplest form of a variable declaration:
@@ Line 20: / Line 20: @@
 Due to the special meaning of <code>$</code> it might be necessary to escape it to use in the template text itself. To escape the token specifier use <code>$$</code>, which will be expanded (or shrunk) to <code>$</code> in the rendered template.
 === Common Locations ===
 When working with templates in EiffelStudio, most templates are located under a common ''template'' folder, in the [[:Category:EiffelStudio|EiffelStudio]] installation.
 If using template files, and installing the template files under the [[:Category:EiffelStudio|EiffelStudio]] ''templates'' folder, you are encouraged to support [[Replaceable User Files|User Replaceable Files]], so end-users are free to redefine the templates in their own way. Extra precaution needs to be taken however because user files are more susceptible to changes and updates which may result in erroneous rendering.

← Older revision		Revision as of 22:14, 17 October 2008
Line 4:		Line 4:

	== Template Files ==		== Template Files ==
		+	Template files are simple files tokenized with variable declarations. The variables will be expanded with those specified in a table passed to the service's rendering functions.

		+	A variable is tokenized with a <code>$</code> specified followed by an Eiffel-like identifier. By convention all variables are specified in uppercase characters in the template. Variables are not actual case-sensitive so this is by convention only. For example, here is the simplest form of a variable declaration:

		+	<code>
		+	$VARIABLE_NAME
		+	</code>
		+
		+	When inserting variables adjacent to template text the variable declaration name may be blurred. To be more explicit with variable declarations, wrapped the variable name in curly braces (<code>{...}</code>). The token specifier <code>$</code> must remain before the opening <code>{</code>:
		+
		+	<code>
		+	${VARIABLE_NAME}
		+	</code>
		+
		+	Due to the special meaning of <code>$</code> it might be necessary to escape it to use in the template text itself. To escape the token specifier use <code>$$</code>, which will be expanded (or shrunk) to <code>$</code> in the rendered template.

	=== Common Locations ===		=== Common Locations ===