summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorpelder2006-09-19 11:19:12 (EDT)
committerpelder2006-09-19 11:19:12 (EDT)
commita3613267c93c6547cb4e0daf81bf8fed972250e1 (patch)
tree2c9e099aed6d7dac81e3a236b9aa7220979ecf89
parentf198ff1c4fe12289a1836794ee3617804ec8be83 (diff)
downloadorg.eclipse.jet-a3613267c93c6547cb4e0daf81bf8fed972250e1.zip
org.eclipse.jet-a3613267c93c6547cb4e0daf81bf8fed972250e1.tar.gz
org.eclipse.jet-a3613267c93c6547cb4e0daf81bf8fed972250e1.tar.bz2
[157811] Sort JET tags in documentation.
-rw-r--r--doc/org.eclipse.jet.doc/references/taglibs/controlTags/overview.html197
-rw-r--r--doc/org.eclipse.jet.doc/references/taglibs/formatTags/overview.html42
-rw-r--r--doc/org.eclipse.jet.doc/references/taglibs/javaTags/overview.html36
-rw-r--r--doc/org.eclipse.jet.doc/references/taglibs/workspaceTags/overview.html30
-rw-r--r--doc/org.eclipse.jet.doc/toccontrolTags.xml39
-rw-r--r--doc/org.eclipse.jet.doc/tocformatTags.xml6
-rw-r--r--doc/org.eclipse.jet.doc/tocjavaTags.xml6
-rw-r--r--doc/org.eclipse.jet.doc/tocworkspaceTags.xml6
-rw-r--r--plugins/org.eclipse.jet/plugin.xml1246
9 files changed, 648 insertions, 960 deletions
diff --git a/doc/org.eclipse.jet.doc/references/taglibs/controlTags/overview.html b/doc/org.eclipse.jet.doc/references/taglibs/controlTags/overview.html
index 813469c..2b15aa8 100644
--- a/doc/org.eclipse.jet.doc/references/taglibs/controlTags/overview.html
+++ b/doc/org.eclipse.jet.doc/references/taglibs/controlTags/overview.html
@@ -25,24 +25,24 @@
<TR>
<TH colspan="2" align="left">Tag Summary</TH></TR>
<TR>
- <TD width="10%"><A href="iterateTag.html">&lt;c:iterate&gt;</A></TD>
- <TD><!-- Begin iterate description -->
- <P> Write the tag contents for each in the template input model identified by an XPath expression
- <!-- End iterate description -->
+ <TD width="10%"><A href="addElementTag.html">&lt;c:addElement&gt;</A></TD>
+ <TD><!-- Begin addElement description -->
+ <P> Create a new model element under the selected node
+ <!-- End addElement description -->
</TD>
</TR>
<TR>
- <TD width="10%"><A href="ifTag.html">&lt;c:if&gt;</A></TD>
- <TD><!-- Begin if description -->
- <P> Process the tag contents if a test condition is satisfied
- <!-- End if description -->
+ <TD width="10%"><A href="addTextElementTag.html">&lt;c:addTextElement&gt;</A></TD>
+ <TD><!-- Begin addTextElement description -->
+ <P> Create a new model element node under the selected element, and whose text content is the content of this tag
+ <!-- End addTextElement description -->
</TD>
</TR>
<TR>
- <TD width="10%"><A href="getTag.html">&lt;c:get&gt;</A></TD>
- <TD><!-- Begin get description -->
- <P> Write a the result of an XPath expression
- <!-- End get description -->
+ <TD width="10%"><A href="caseTag.html">&lt;c:case&gt;</A></TD>
+ <TD><!-- Begin case description -->
+ <P> *** DEPRECATED - use 'when' tag instead
+ <!-- End case description -->
</TD>
</TR>
<TR>
@@ -53,38 +53,31 @@
</TD>
</TR>
<TR>
- <TD width="10%"><A href="caseTag.html">&lt;c:case&gt;</A></TD>
- <TD><!-- Begin case description -->
- <P> *** DEPRECATED - use 'when' tag instead
- <!-- End case description -->
- </TD>
- </TR>
- <TR>
- <TD width="10%"><A href="otherwiseTag.html">&lt;c:otherwise&gt;</A></TD>
- <TD><!-- Begin otherwise description -->
- <P> Define a default case for a 'choose' tag
- <!-- End otherwise description -->
+ <TD width="10%"><A href="copyElementTag.html">&lt;c:copyElement&gt;</A></TD>
+ <TD><!-- Begin copyElement description -->
+ <P> Copy the selected node to the selected location
+ <!-- End copyElement description -->
</TD>
</TR>
<TR>
- <TD width="10%"><A href="visitorTag.html">&lt;c:visitor&gt;</A></TD>
- <TD><!-- Begin visitor description -->
- <P> *** PROTOTYPE *** Iterate over an object and all its contained objects, typically be doing a depth-first traversal
- <!-- End visitor description -->
+ <TD width="10%"><A href="dumpTag.html">&lt;c:dump&gt;</A></TD>
+ <TD><!-- Begin dump description -->
+ Writes out the DOM subtree under a specified model node
+ <!-- End dump description -->
</TD>
</TR>
<TR>
- <TD width="10%"><A href="visitTag.html">&lt;c:visit&gt;</A></TD>
- <TD><!-- Begin visit description -->
- <P> Define content to process for an object found by the parent 'visitor' tag, provided a condition is met
- <!-- End visit description -->
+ <TD width="10%"><A href="getTag.html">&lt;c:get&gt;</A></TD>
+ <TD><!-- Begin get description -->
+ <P> Write a the result of an XPath expression
+ <!-- End get description -->
</TD>
</TR>
<TR>
- <TD width="10%"><A href="userRegionTag.html">&lt;c:userRegion&gt;</A></TD>
- <TD><!-- Begin userRegion description -->
- <P> Define a region in the generated text where users may write customized code
- <!-- End userRegion description -->
+ <TD width="10%"><A href="ifTag.html">&lt;c:if&gt;</A></TD>
+ <TD><!-- Begin if description -->
+ <P> Process the tag contents if a test condition is satisfied
+ <!-- End if description -->
</TD>
</TR>
<TR>
@@ -95,13 +88,6 @@
</TD>
</TR>
<TR>
- <TD width="10%"><A href="logTag.html">&lt;c:log&gt;</A></TD>
- <TD><!-- Begin log description -->
- <P> Write a message to the transformation log
- <!-- End log description -->
- </TD>
- </TR>
- <TR>
<TD width="10%"><A href="initialCodeTag.html">&lt;c:initialCode&gt;</A></TD>
<TD><!-- Begin initialCode description -->
<P> A child tag of the 'userRegion' tag containing the initial code to write
@@ -109,38 +95,17 @@
</TD>
</TR>
<TR>
- <TD width="10%"><A href="setVariableTag.html">&lt;c:setVariable&gt;</A></TD>
- <TD><!-- Begin setVariable description -->
- <P> Create a variable whose value is set to the result of the provided XPath expression
- <!-- End setVariable description -->
- </TD>
- </TR>
- <TR>
- <TD width="10%"><A href="addElementTag.html">&lt;c:addElement&gt;</A></TD>
- <TD><!-- Begin addElement description -->
- <P> Create a new model element under the selected node
- <!-- End addElement description -->
- </TD>
- </TR>
- <TR>
- <TD width="10%"><A href="addTextElementTag.html">&lt;c:addTextElement&gt;</A></TD>
- <TD><!-- Begin addTextElement description -->
- <P> Create a new model element node under the selected element, and whose text content is the content of this tag
- <!-- End addTextElement description -->
- </TD>
- </TR>
- <TR>
- <TD width="10%"><A href="removeElementTag.html">&lt;c:removeElement&gt;</A></TD>
- <TD><!-- Begin removeElement description -->
- <P> Remove the selected node from the document tree
- <!-- End removeElement description -->
+ <TD width="10%"><A href="invokeTransformTag.html">&lt;c:invokeTransform&gt;</A></TD>
+ <TD><!-- Begin invokeTransform description -->
+ <P> Invoke the another transformation, passing it the current transformation's source model and context variables
+ <!-- End invokeTransform description -->
</TD>
</TR>
<TR>
- <TD width="10%"><A href="copyElementTag.html">&lt;c:copyElement&gt;</A></TD>
- <TD><!-- Begin copyElement description -->
- <P> Copy the selected node to the selected location
- <!-- End copyElement description -->
+ <TD width="10%"><A href="iterateTag.html">&lt;c:iterate&gt;</A></TD>
+ <TD><!-- Begin iterate description -->
+ <P> Write the tag contents for each in the template input model identified by an XPath expression
+ <!-- End iterate description -->
</TD>
</TR>
<TR>
@@ -151,17 +116,17 @@
</TD>
</TR>
<TR>
- <TD width="10%"><A href="whenTag.html">&lt;c:when&gt;</A></TD>
- <TD><!-- Begin when description -->
- <P> Define a one of the mutually exclusive cases of a 'choose' tag
- <!-- End when description -->
+ <TD width="10%"><A href="loadContentTag.html">&lt;c:loadContent&gt;</A></TD>
+ <TD><!-- Begin loadContent description -->
+ Extends the model by parsing its contents as XML
+ <!-- End loadContent description -->
</TD>
</TR>
<TR>
- <TD width="10%"><A href="setTag.html">&lt;c:set&gt;</A></TD>
- <TD><!-- Begin set description -->
- <P> Set an attribute on an object selected by an XPath expression
- <!-- End set description -->
+ <TD width="10%"><A href="logTag.html">&lt;c:log&gt;</A></TD>
+ <TD><!-- Begin log description -->
+ <P> Write a message to the transformation log
+ <!-- End log description -->
</TD>
</TR>
<TR>
@@ -172,6 +137,13 @@
</TD>
</TR>
<TR>
+ <TD width="10%"><A href="otherwiseTag.html">&lt;c:otherwise&gt;</A></TD>
+ <TD><!-- Begin otherwise description -->
+ <P> Define a default case for a 'choose' tag
+ <!-- End otherwise description -->
+ </TD>
+ </TR>
+ <TR>
<TD width="10%"><A href="overrideTag.html">&lt;c:override&gt;</A></TD>
<TD><!-- Begin override description -->
<P> *** Deprecated: Use the 'overrides' attribute on 'transform' extension in plugin
@@ -179,38 +151,31 @@
</TD>
</TR>
<TR>
- <TD width="10%"><A href="invokeTransformTag.html">&lt;c:invokeTransform&gt;</A></TD>
- <TD><!-- Begin invokeTransform description -->
- <P> Invoke the another transformation, passing it the current transformation's source model and context variables
- <!-- End invokeTransform description -->
- </TD>
- </TR>
- <TR>
- <TD width="10%"><A href="dumpTag.html">&lt;c:dump&gt;</A></TD>
- <TD><!-- Begin dump description -->
- Writes out the DOM subtree under a specified model node
- <!-- End dump description -->
+ <TD width="10%"><A href="removeElementTag.html">&lt;c:removeElement&gt;</A></TD>
+ <TD><!-- Begin removeElement description -->
+ <P> Remove the selected node from the document tree
+ <!-- End removeElement description -->
</TD>
</TR>
<TR>
- <TD width="10%"><A href="loadContentTag.html">&lt;c:loadContent&gt;</A></TD>
- <TD><!-- Begin loadContent description -->
- Extends the model by parsing its contents as XML
- <!-- End loadContent description -->
+ <TD width="10%"><A href="replaceStringsTag.html">&lt;c:replaceStrings&gt;</A></TD>
+ <TD><!-- Begin replaceStrings description -->
+ Replaces one set of strings in its content with another set of strings and writes out the result
+ <!-- End replaceStrings description -->
</TD>
</TR>
<TR>
- <TD width="10%"><A href="nodeAttributesTag.html">&lt;c:nodeAttributes&gt;</A></TD>
- <TD><!-- Begin nodeAttributes description -->
- Iterates over the attributes for a given node
- <!-- End nodeAttributes description -->
+ <TD width="10%"><A href="setTag.html">&lt;c:set&gt;</A></TD>
+ <TD><!-- Begin set description -->
+ <P> Set an attribute on an object selected by an XPath expression
+ <!-- End set description -->
</TD>
</TR>
<TR>
- <TD width="10%"><A href="replaceStringsTag.html">&lt;c:replaceStrings&gt;</A></TD>
- <TD><!-- Begin replaceStrings description -->
- Replaces one set of strings in its content with another set of strings and writes out the result
- <!-- End replaceStrings description -->
+ <TD width="10%"><A href="setVariableTag.html">&lt;c:setVariable&gt;</A></TD>
+ <TD><!-- Begin setVariable description -->
+ <P> Create a variable whose value is set to the result of the provided XPath expression
+ <!-- End setVariable description -->
</TD>
</TR>
<TR>
@@ -220,6 +185,34 @@
<!-- End stringTokens description -->
</TD>
</TR>
+ <TR>
+ <TD width="10%"><A href="userRegionTag.html">&lt;c:userRegion&gt;</A></TD>
+ <TD><!-- Begin userRegion description -->
+ <P> Define a region in the generated text where users may write customized code
+ <!-- End userRegion description -->
+ </TD>
+ </TR>
+ <TR>
+ <TD width="10%"><A href="visitTag.html">&lt;c:visit&gt;</A></TD>
+ <TD><!-- Begin visit description -->
+ <P> Define content to process for an object found by the parent 'visitor' tag, provided a condition is met
+ <!-- End visit description -->
+ </TD>
+ </TR>
+ <TR>
+ <TD width="10%"><A href="visitorTag.html">&lt;c:visitor&gt;</A></TD>
+ <TD><!-- Begin visitor description -->
+ <P> *** PROTOTYPE *** Iterate over an object and all its contained objects, typically be doing a depth-first traversal
+ <!-- End visitor description -->
+ </TD>
+ </TR>
+ <TR>
+ <TD width="10%"><A href="whenTag.html">&lt;c:when&gt;</A></TD>
+ <TD><!-- Begin when description -->
+ <P> Define a one of the mutually exclusive cases of a 'choose' tag
+ <!-- End when description -->
+ </TD>
+ </TR>
</TBODY>
</TABLE>
<HR>
diff --git a/doc/org.eclipse.jet.doc/references/taglibs/formatTags/overview.html b/doc/org.eclipse.jet.doc/references/taglibs/formatTags/overview.html
index e5b988e..cb40757 100644
--- a/doc/org.eclipse.jet.doc/references/taglibs/formatTags/overview.html
+++ b/doc/org.eclipse.jet.doc/references/taglibs/formatTags/overview.html
@@ -25,6 +25,27 @@
<TR>
<TH colspan="2" align="left">Tag Summary</TH></TR>
<TR>
+ <TD width="10%"><A href="formatNowTag.html">&lt;f:formatNow&gt;</A></TD>
+ <TD><!-- Begin formatNow description -->
+ Formats and writes out the current date and time
+ <!-- End formatNow description -->
+ </TD>
+ </TR>
+ <TR>
+ <TD width="10%"><A href="lcTag.html">&lt;f:lc&gt;</A></TD>
+ <TD><!-- Begin lc description -->
+ <P> Convert the tag contents to lower case
+ <!-- End lc description -->
+ </TD>
+ </TR>
+ <TR>
+ <TD width="10%"><A href="millisecondsTag.html">&lt;f:milliseconds&gt;</A></TD>
+ <TD><!-- Begin milliseconds description -->
+ Writes out a current system milliseconds value
+ <!-- End milliseconds description -->
+ </TD>
+ </TR>
+ <TR>
<TD width="10%"><A href="replaceAllTag.html">&lt;f:replaceAll&gt;</A></TD>
<TD><!-- Begin replaceAll description -->
<P> Replace all instances of a value in the tag's content with a new value
@@ -46,27 +67,6 @@
</TD>
</TR>
<TR>
- <TD width="10%"><A href="lcTag.html">&lt;f:lc&gt;</A></TD>
- <TD><!-- Begin lc description -->
- <P> Convert the tag contents to lower case
- <!-- End lc description -->
- </TD>
- </TR>
- <TR>
- <TD width="10%"><A href="formatNowTag.html">&lt;f:formatNow&gt;</A></TD>
- <TD><!-- Begin formatNow description -->
- Formats and writes out the current date and time
- <!-- End formatNow description -->
- </TD>
- </TR>
- <TR>
- <TD width="10%"><A href="millisecondsTag.html">&lt;f:milliseconds&gt;</A></TD>
- <TD><!-- Begin milliseconds description -->
- Writes out a current system milliseconds value
- <!-- End milliseconds description -->
- </TD>
- </TR>
- <TR>
<TD width="10%"><A href="uniqueTag.html">&lt;f:unique&gt;</A></TD>
<TD><!-- Begin unique description -->
Writes out a unique integer value
diff --git a/doc/org.eclipse.jet.doc/references/taglibs/javaTags/overview.html b/doc/org.eclipse.jet.doc/references/taglibs/javaTags/overview.html
index 4bb7a61..41b3da9 100644
--- a/doc/org.eclipse.jet.doc/references/taglibs/javaTags/overview.html
+++ b/doc/org.eclipse.jet.doc/references/taglibs/javaTags/overview.html
@@ -25,10 +25,10 @@
<TR>
<TH colspan="2" align="left">Tag Summary</TH></TR>
<TR>
- <TD width="10%"><A href="importsLocationTag.html">&lt;java:importsLocation&gt;</A></TD>
- <TD><!-- Begin importsLocation description -->
- <P> Identify the location for Java import statement generation
- <!-- End importsLocation description -->
+ <TD width="10%"><A href="classTag.html">&lt;java:class&gt;</A></TD>
+ <TD><!-- Begin class description -->
+ <P> Create a Java class with the specified name and write its contents by evaluating the supplied template
+ <!-- End class description -->
</TD>
</TR>
<TR>
@@ -46,6 +46,20 @@
</TD>
</TR>
<TR>
+ <TD width="10%"><A href="importsLocationTag.html">&lt;java:importsLocation&gt;</A></TD>
+ <TD><!-- Begin importsLocation description -->
+ <P> Identify the location for Java import statement generation
+ <!-- End importsLocation description -->
+ </TD>
+ </TR>
+ <TR>
+ <TD width="10%"><A href="mergeTag.html">&lt;java:merge&gt;</A></TD>
+ <TD><!-- Begin merge description -->
+ <P> Cause the template contents to be merged with the existing Java file using the EMF JMerge engine
+ <!-- End merge description -->
+ </TD>
+ </TR>
+ <TR>
<TD width="10%"><A href="packageTag.html">&lt;java:package&gt;</A></TD>
<TD><!-- Begin package description -->
<P> Create a Java package
@@ -59,20 +73,6 @@
<!-- End resource description -->
</TD>
</TR>
- <TR>
- <TD width="10%"><A href="classTag.html">&lt;java:class&gt;</A></TD>
- <TD><!-- Begin class description -->
- <P> Create a Java class with the specified name and write its contents by evaluating the supplied template
- <!-- End class description -->
- </TD>
- </TR>
- <TR>
- <TD width="10%"><A href="mergeTag.html">&lt;java:merge&gt;</A></TD>
- <TD><!-- Begin merge description -->
- <P> Cause the template contents to be merged with the existing Java file using the EMF JMerge engine
- <!-- End merge description -->
- </TD>
- </TR>
</TBODY>
</TABLE>
<HR>
diff --git a/doc/org.eclipse.jet.doc/references/taglibs/workspaceTags/overview.html b/doc/org.eclipse.jet.doc/references/taglibs/workspaceTags/overview.html
index 6ebbb7a..dcbbac0 100644
--- a/doc/org.eclipse.jet.doc/references/taglibs/workspaceTags/overview.html
+++ b/doc/org.eclipse.jet.doc/references/taglibs/workspaceTags/overview.html
@@ -25,17 +25,10 @@
<TR>
<TH colspan="2" align="left">Tag Summary</TH></TR>
<TR>
- <TD width="10%"><A href="projectTag.html">&lt;ws:project&gt;</A></TD>
- <TD><!-- Begin project description -->
- <P> Ensure the existence of an Eclipse Project of a given name
- <!-- End project description -->
- </TD>
- </TR>
- <TR>
- <TD width="10%"><A href="folderTag.html">&lt;ws:folder&gt;</A></TD>
- <TD><!-- Begin folder description -->
- <P> Ensure the existence on an Eclipse Workspace Folder
- <!-- End folder description -->
+ <TD width="10%"><A href="copyFileTag.html">&lt;ws:copyFile&gt;</A></TD>
+ <TD><!-- Begin copyFile description -->
+ <P> Copy the file refered to by 'url' to the location refered to by 'path'
+ <!-- End copyFile description -->
</TD>
</TR>
<TR>
@@ -46,10 +39,17 @@
</TD>
</TR>
<TR>
- <TD width="10%"><A href="copyFileTag.html">&lt;ws:copyFile&gt;</A></TD>
- <TD><!-- Begin copyFile description -->
- <P> Copy the file refered to by 'url' to the location refered to by 'path'
- <!-- End copyFile description -->
+ <TD width="10%"><A href="folderTag.html">&lt;ws:folder&gt;</A></TD>
+ <TD><!-- Begin folder description -->
+ <P> Ensure the existence on an Eclipse Workspace Folder
+ <!-- End folder description -->
+ </TD>
+ </TR>
+ <TR>
+ <TD width="10%"><A href="projectTag.html">&lt;ws:project&gt;</A></TD>
+ <TD><!-- Begin project description -->
+ <P> Ensure the existence of an Eclipse Project of a given name
+ <!-- End project description -->
</TD>
</TR>
<TR>
diff --git a/doc/org.eclipse.jet.doc/toccontrolTags.xml b/doc/org.eclipse.jet.doc/toccontrolTags.xml
index 40cc2de..71a66e2 100644
--- a/doc/org.eclipse.jet.doc/toccontrolTags.xml
+++ b/doc/org.eclipse.jet.doc/toccontrolTags.xml
@@ -3,33 +3,32 @@
<toc label="Standard JET2 Control Tags" link_to="toc.xml#tagReference">
<topic label="Standard JET2 Control Tags" href="references/taglibs/controlTags/overview.html" >
- <topic label="c:iterate" href="references/taglibs/controlTags/iterateTag.html"/>
- <topic label="c:if" href="references/taglibs/controlTags/ifTag.html"/>
- <topic label="c:get" href="references/taglibs/controlTags/getTag.html"/>
- <topic label="c:choose" href="references/taglibs/controlTags/chooseTag.html"/>
- <topic label="c:case" href="references/taglibs/controlTags/caseTag.html"/>
- <topic label="c:otherwise" href="references/taglibs/controlTags/otherwiseTag.html"/>
- <topic label="c:visitor" href="references/taglibs/controlTags/visitorTag.html"/>
- <topic label="c:visit" href="references/taglibs/controlTags/visitTag.html"/>
- <topic label="c:userRegion" href="references/taglibs/controlTags/userRegionTag.html"/>
- <topic label="c:include" href="references/taglibs/controlTags/includeTag.html"/>
- <topic label="c:log" href="references/taglibs/controlTags/logTag.html"/>
- <topic label="c:initialCode" href="references/taglibs/controlTags/initialCodeTag.html"/>
- <topic label="c:setVariable" href="references/taglibs/controlTags/setVariableTag.html"/>
<topic label="c:addElement" href="references/taglibs/controlTags/addElementTag.html"/>
<topic label="c:addTextElement" href="references/taglibs/controlTags/addTextElementTag.html"/>
- <topic label="c:removeElement" href="references/taglibs/controlTags/removeElementTag.html"/>
+ <topic label="c:case" href="references/taglibs/controlTags/caseTag.html"/>
+ <topic label="c:choose" href="references/taglibs/controlTags/chooseTag.html"/>
<topic label="c:copyElement" href="references/taglibs/controlTags/copyElementTag.html"/>
+ <topic label="c:dump" href="references/taglibs/controlTags/dumpTag.html"/>
+ <topic label="c:get" href="references/taglibs/controlTags/getTag.html"/>
+ <topic label="c:if" href="references/taglibs/controlTags/ifTag.html"/>
+ <topic label="c:include" href="references/taglibs/controlTags/includeTag.html"/>
+ <topic label="c:initialCode" href="references/taglibs/controlTags/initialCodeTag.html"/>
+ <topic label="c:invokeTransform" href="references/taglibs/controlTags/invokeTransformTag.html"/>
+ <topic label="c:iterate" href="references/taglibs/controlTags/iterateTag.html"/>
<topic label="c:load" href="references/taglibs/controlTags/loadTag.html"/>
- <topic label="c:when" href="references/taglibs/controlTags/whenTag.html"/>
- <topic label="c:set" href="references/taglibs/controlTags/setTag.html"/>
+ <topic label="c:loadContent" href="references/taglibs/controlTags/loadContentTag.html"/>
+ <topic label="c:log" href="references/taglibs/controlTags/logTag.html"/>
<topic label="c:marker" href="references/taglibs/controlTags/markerTag.html"/>
+ <topic label="c:otherwise" href="references/taglibs/controlTags/otherwiseTag.html"/>
<topic label="c:override" href="references/taglibs/controlTags/overrideTag.html"/>
- <topic label="c:invokeTransform" href="references/taglibs/controlTags/invokeTransformTag.html"/>
- <topic label="c:dump" href="references/taglibs/controlTags/dumpTag.html"/>
- <topic label="c:loadContent" href="references/taglibs/controlTags/loadContentTag.html"/>
- <topic label="c:nodeAttributes" href="references/taglibs/controlTags/nodeAttributesTag.html"/>
+ <topic label="c:removeElement" href="references/taglibs/controlTags/removeElementTag.html"/>
<topic label="c:replaceStrings" href="references/taglibs/controlTags/replaceStringsTag.html"/>
+ <topic label="c:set" href="references/taglibs/controlTags/setTag.html"/>
+ <topic label="c:setVariable" href="references/taglibs/controlTags/setVariableTag.html"/>
<topic label="c:stringTokens" href="references/taglibs/controlTags/stringTokensTag.html"/>
+ <topic label="c:userRegion" href="references/taglibs/controlTags/userRegionTag.html"/>
+ <topic label="c:visit" href="references/taglibs/controlTags/visitTag.html"/>
+ <topic label="c:visitor" href="references/taglibs/controlTags/visitorTag.html"/>
+ <topic label="c:when" href="references/taglibs/controlTags/whenTag.html"/>
</topic>
</toc>
diff --git a/doc/org.eclipse.jet.doc/tocformatTags.xml b/doc/org.eclipse.jet.doc/tocformatTags.xml
index c793e45..0e70708 100644
--- a/doc/org.eclipse.jet.doc/tocformatTags.xml
+++ b/doc/org.eclipse.jet.doc/tocformatTags.xml
@@ -3,12 +3,12 @@
<toc label="Standard JET2 Format Tags" link_to="toc.xml#tagReference">
<topic label="Standard JET2 Format Tags" href="references/taglibs/formatTags/overview.html" >
+ <topic label="f:formatNow" href="references/taglibs/formatTags/formatNowTag.html"/>
+ <topic label="f:lc" href="references/taglibs/formatTags/lcTag.html"/>
+ <topic label="f:milliseconds" href="references/taglibs/formatTags/millisecondsTag.html"/>
<topic label="f:replaceAll" href="references/taglibs/formatTags/replaceAllTag.html"/>
<topic label="f:strip" href="references/taglibs/formatTags/stripTag.html"/>
<topic label="f:uc" href="references/taglibs/formatTags/ucTag.html"/>
- <topic label="f:lc" href="references/taglibs/formatTags/lcTag.html"/>
- <topic label="f:formatNow" href="references/taglibs/formatTags/formatNowTag.html"/>
- <topic label="f:milliseconds" href="references/taglibs/formatTags/millisecondsTag.html"/>
<topic label="f:unique" href="references/taglibs/formatTags/uniqueTag.html"/>
<topic label="f:uuid" href="references/taglibs/formatTags/uuidTag.html"/>
</topic>
diff --git a/doc/org.eclipse.jet.doc/tocjavaTags.xml b/doc/org.eclipse.jet.doc/tocjavaTags.xml
index 00a0944..902a614 100644
--- a/doc/org.eclipse.jet.doc/tocjavaTags.xml
+++ b/doc/org.eclipse.jet.doc/tocjavaTags.xml
@@ -3,12 +3,12 @@
<toc label="Standard JET2 Java Tags" link_to="toc.xml#tagReference">
<topic label="Standard JET2 Java Tags" href="references/taglibs/javaTags/overview.html" >
- <topic label="java:importsLocation" href="references/taglibs/javaTags/importsLocationTag.html"/>
+ <topic label="java:class" href="references/taglibs/javaTags/classTag.html"/>
<topic label="java:impliedImport" href="references/taglibs/javaTags/impliedImportTag.html"/>
<topic label="java:import" href="references/taglibs/javaTags/importTag.html"/>
+ <topic label="java:importsLocation" href="references/taglibs/javaTags/importsLocationTag.html"/>
+ <topic label="java:merge" href="references/taglibs/javaTags/mergeTag.html"/>
<topic label="java:package" href="references/taglibs/javaTags/packageTag.html"/>
<topic label="java:resource" href="references/taglibs/javaTags/resourceTag.html"/>
- <topic label="java:class" href="references/taglibs/javaTags/classTag.html"/>
- <topic label="java:merge" href="references/taglibs/javaTags/mergeTag.html"/>
</topic>
</toc>
diff --git a/doc/org.eclipse.jet.doc/tocworkspaceTags.xml b/doc/org.eclipse.jet.doc/tocworkspaceTags.xml
index 811e550..1691272 100644
--- a/doc/org.eclipse.jet.doc/tocworkspaceTags.xml
+++ b/doc/org.eclipse.jet.doc/tocworkspaceTags.xml
@@ -3,10 +3,10 @@
<toc label="Standard JET2 Workspace Tags" link_to="toc.xml#tagReference">
<topic label="Standard JET2 Workspace Tags" href="references/taglibs/workspaceTags/overview.html" >
- <topic label="ws:project" href="references/taglibs/workspaceTags/projectTag.html"/>
- <topic label="ws:folder" href="references/taglibs/workspaceTags/folderTag.html"/>
- <topic label="ws:file" href="references/taglibs/workspaceTags/fileTag.html"/>
<topic label="ws:copyFile" href="references/taglibs/workspaceTags/copyFileTag.html"/>
+ <topic label="ws:file" href="references/taglibs/workspaceTags/fileTag.html"/>
+ <topic label="ws:folder" href="references/taglibs/workspaceTags/folderTag.html"/>
+ <topic label="ws:project" href="references/taglibs/workspaceTags/projectTag.html"/>
<topic label="ws:rebuildWorkspace" href="references/taglibs/workspaceTags/rebuildWorkspaceTag.html"/>
</topic>
</toc>
diff --git a/plugins/org.eclipse.jet/plugin.xml b/plugins/org.eclipse.jet/plugin.xml
index 264083b..1761b62 100644
--- a/plugins/org.eclipse.jet/plugin.xml
+++ b/plugins/org.eclipse.jet/plugin.xml
@@ -38,130 +38,57 @@
id="controlTags"
name="Standard JET2 Control Tags"
standardPrefix="c">
- <iteratingTag
- class="org.eclipse.jet.internal.taglib.control.IterateTag"
- name="iterate"
- whenContainingLineIsEmpty="remove">
+ <description>
+ Control flow and data management tags. This tags allow templates to evaluate conditions, perform loops and access and set information in the template input.
+ </description><emptyTag class="org.eclipse.jet.internal.taglib.control.AddElementTag" name="addElement" whenContainingLineIsEmpty="remove">
- <attribute
- name="select"
- type="xpath"
- use="required">
- <description>
- An XPath expression that returns either a node set (a collection of elements or attributes) or a number.
- </description>
- </attribute>
- <attribute
- name="var"
- type="string"
- use="required">
+
+ <description>
+ Create a new model element under the selected node.
+ </description>
+ <attribute name="select" type="xpath" use="required">
<description>
- A variable name. During each iteration, the value of the variable is an object from the set of objects selected by the &apos;select&apos; XPath expression.
+ An XPath expression identifying the parent of the new element.
</description>
</attribute>
- <description>
- Write the tag contents for each in the template input model identified by an XPath expression.
-
-If the &amp;apos;select&amp;apos; XPath expression selects no objects, then the contents of the tag are not processed. If the XPath expression is not well-formed, then an error results.
-
-If the &apos;select&apos; XPath expression returns a number, then the body of the loop is processed that number of times, and the variable named by &apos;var&apos; is set to 1 for the first iteration, and incremented by one for each successive iteration.
-
-If there is a variable in scope with the same name as the value &amp;apos;var&amp;apos; attribute, then it is hidden during the execution of this tag.
- </description>
- <attribute
- name="delimiter"
- type="string"
- use="optional">
-
+ <attribute name="name" type="string" use="required">
<description>
- A string that is written to the tag's output between iteration of the tag. The text is not written after the last iteration.
+ The name of the new element.
</description>
</attribute>
- </iteratingTag>
- <conditionalTag
- class="org.eclipse.jet.internal.taglib.control.IfTag"
- name="if"
- whenContainingLineIsEmpty="remove">
- <attribute
- name="test"
- type="xpath"
- use="required">
+ <attribute name="var" type="string" use="optional">
<description>
- An expression expression, that, if true, causes the tag contents to be evaluated.
+ A variable name that will refer to the newly created element.
</description>
</attribute>
+ </emptyTag><functionTag class="org.eclipse.jet.internal.taglib.control.AddTextElementTag" name="addTextElement">
+
+
<description>
- Process the tag contents if a test condition is satisfied.
-
-If the 'test' XPath expression is does not result in a boolean value, then it is converted to a boolean value according the the XPath 1.0 specification. In particular, if the XPath expression results in a set of objects, then 'test' is considered to be true if and only if the set is not empty.
-
-If the 'test' XPath expression is not well formed, then an error results.
+ Create a new model element node under the selected element, and whose text content is the content of this tag.
</description>
- <attribute
- name="var"
- type="string"
- use="optional">
+ <attribute name="select" type="xpath" use="required">
<description>
- The name of a variable that will refer to the value of the 'test' expression prior to it being converted to a boolean value'. The variable has the scope of the tag contents.
+ An XPath expression determining the parent of the new element.
</description>
</attribute>
- </conditionalTag>
- <emptyTag
- class="org.eclipse.jet.internal.taglib.control.GetTag"
- name="get"
- whenContainingLineIsEmpty="preserve">
-
- <attribute
- name="select"
- type="xpath"
- use="required">
+ <attribute name="name" type="string" use="required">
<description>
- The XPath expression to evaluate.
+ The name of the new element.
</description>
</attribute>
- <attribute
- name="default"
- type="string"
- use="optional">
+ <attribute name="var" type="string" use="optional">
<description>
- The value to write, if the XPath expression selects no objects.
+ A variable name that will refer to the newly created element.
</description>
</attribute>
- <description>
- Write a the result of an XPath expression.
-
-If the 'select' XPath expression returns more than one object, only the first is written. If the XPath expression selects no objects, then an error occurs, unless the 'default' attribute is specified. If the 'select' XPath expression is malformed, then an error occurs.
- </description>
- </emptyTag>
- <containerTag
- class="org.eclipse.jet.internal.taglib.control.ChooseTag"
- name="choose"
- processContents="custom"
- whenContainingLineIsEmpty="remove">
- <description>
- Define a group of mutually exclusive choices. The contents of this tag are restricted to &apos;when&apos; and &apos;otherwise&apos; tags only.
-
-During execution of this tag, each &apos;when&apos; and &apos;otherwise&apos; tag is evaluated in sequence. If one of these tags evaluates to &apos;true&apos;, then any subsequent tags are ignored. A &apos;when&apos; tag evaluates to &apos;true&apos; if its &apos;test&apos; attribute&apos;s XPath expression evaluates to &apos;true&apos;. An &apos;otherwise&apos; tag evaluates to &apos;true&apos; if no preceeding &apos;when&apos; (or &apos;otherwise&apos;) tag has evaluated to true.
- </description>
- <attribute
- name="select"
- type="string"
- use="optional">
+ <attribute name="cdata" type="boolean" use="optional">
<description>
- Optional test expression. When specified, each 'when' tag 'test' expression is tested for equality against this value. When not specified, this is the equivalent of the XPath expression 'true()'.
+ Add the text as a CData section. Default is 'false'.
</description>
</attribute>
- </containerTag>
- <conditionalTag
- class="org.eclipse.jet.internal.taglib.control.WhenTag"
- deprecated="true"
- name="case"
- processContents="custom"
- whenContainingLineIsEmpty="remove">
- <attribute
- name="test"
- type="xpath"
- use="required">
+ </functionTag><conditionalTag class="org.eclipse.jet.internal.taglib.control.WhenTag" deprecated="true" name="case" processContents="custom" whenContainingLineIsEmpty="remove">
+ <attribute name="test" type="xpath" use="required">
<description>
An expression expression, that, if true, causes the tag contents to be evaluated.
</description>
@@ -176,81 +103,94 @@ If the &apos;test&apos; XPath expression is not well formed, then an error resul
If this tag is not directly contained by a &apos;choose&apos; tag, then an error results.
</description>
- </conditionalTag>
- <conditionalTag
- class="org.eclipse.jet.internal.taglib.control.OtherwiseTag"
- name="otherwise"
- processContents="custom"
- whenContainingLineIsEmpty="remove">
+ </conditionalTag><containerTag class="org.eclipse.jet.internal.taglib.control.ChooseTag" name="choose" processContents="custom" whenContainingLineIsEmpty="remove">
<description>
- Define a default case for a 'choose' tag. The body of this tag is processed only if no previous 'case' or 'otherwise' tag in the containing 'choose' tag has processed its body content.
+ Define a group of mutually exclusive choices. The contents of this tag are restricted to &apos;when&apos; and &apos;otherwise&apos; tags only.
-An error occurs if the 'otherwise' is not directly contained by a 'choose' tag.
+During execution of this tag, each &apos;when&apos; and &apos;otherwise&apos; tag is evaluated in sequence. If one of these tags evaluates to &apos;true&apos;, then any subsequent tags are ignored. A &apos;when&apos; tag evaluates to &apos;true&apos; if its &apos;test&apos; attribute&apos;s XPath expression evaluates to &apos;true&apos;. An &apos;otherwise&apos; tag evaluates to &apos;true&apos; if no preceeding &apos;when&apos; (or &apos;otherwise&apos;) tag has evaluated to true.
</description>
- </conditionalTag>
- <iteratingTag
- class="org.eclipse.jet.internal.taglib.control.VisitorTag"
- name="visitor"
- whenContainingLineIsEmpty="remove">
- <attribute
- name="select"
- type="xpath"
- use="required">
+ <attribute name="select" type="string" use="optional">
+ <description>
+ Optional test expression. When specified, each 'when' tag 'test' expression is tested for equality against this value. When not specified, this is the equivalent of the XPath expression 'true()'.
+ </description>
+ </attribute>
+ </containerTag><emptyTag class="org.eclipse.jet.internal.taglib.control.CopyElementTag" name="copyElement" whenContainingLineIsEmpty="remove">
+
+ <description>
+ Copy the selected node to the selected location.
+ </description>
+ <attribute name="select" type="xpath" use="required">
+ <description>
+ An XPath expression selecting the element node to copy.
+ </description>
+ </attribute>
+ <attribute name="toSelect" type="xpath" use="required">
+ <description>
+ An XPath expression identifying the parent of the newly selected node.
+ </description>
+ </attribute>
+ <attribute name="name" type="string" use="required">
+ <description>
+ The name for the newly created element.
+ </description>
+ </attribute>
+ <attribute name="recursive" type="boolean" use="optional">
+ <description>
+ Determine whether child elements of the copied element are copied, too. Default is &apos;true&apos;.
+ </description>
+ </attribute>
+ <attribute name="var" type="string" use="optional">
+ <description>
+ The name of a variable that will be set to the newly copied element.
+ </description>
+ </attribute>
+ </emptyTag><emptyTag name="dump" class="org.eclipse.jet.internal.taglib.control.DumpTag">
+ <attribute name="select" type="xpath" use="required">
+ <description>A query expression specifying a single node in the model</description>
+ </attribute>
+ <attribute name="format" type="boolean" use="optional">
+ <description>A true/false value indicating whether the tag should try to write out whitespace to cause the output to be nicely formatted and indented.</description>
+ </attribute>
+ <attribute name="entities" type="boolean" use="optional">
+ <description>A true/false value indicating whether characters that can cause XML parsing problems (left and right angle brackets, quotes, apostrophes, etc) should be written as entities (e.g. "%lt;" for the left angle bracket).</description>
+ </attribute>
+ <description>Writes out the DOM subtree under a specified model node.</description>
+ </emptyTag><emptyTag class="org.eclipse.jet.internal.taglib.control.GetTag" name="get" whenContainingLineIsEmpty="preserve">
+
+ <attribute name="select" type="xpath" use="required">
<description>
The XPath expression to evaluate.
</description>
</attribute>
- <attribute
- name="var"
- type="string"
- use="required">
+ <attribute name="default" type="string" use="optional">
<description>
- The name of a variable that will contain the current object in the iteration.
+ The value to write, if the XPath expression selects no objects.
</description>
</attribute>
<description>
- *** PROTOTYPE *** Iterate over an object and all its contained objects, typically be doing a depth-first traversal. For each identified object, the tag evaluates the 'test' condition on its contained 'visit' tags. Only those tags whose test condition is true have their contents processed.
+ Write a the result of an XPath expression.
If the 'select' XPath expression returns more than one object, only the first is written. If the XPath expression selects no objects, then an error occurs, unless the 'default' attribute is specified. If the 'select' XPath expression is malformed, then an error occurs.
</description>
- </iteratingTag>
- <conditionalTag
- class="org.eclipse.jet.internal.taglib.control.VisitTag"
- name="visit"
- whenContainingLineIsEmpty="remove">
- <attribute
- name="test"
- type="xpath"
- use="required"/>
+ </emptyTag><conditionalTag class="org.eclipse.jet.internal.taglib.control.IfTag" name="if" whenContainingLineIsEmpty="remove">
+ <attribute name="test" type="xpath" use="required">
+ <description>
+ An expression expression, that, if true, causes the tag contents to be evaluated.
+ </description>
+ </attribute>
<description>
- Define content to process for an object found by the parent 'visitor' tag, provided a condition is met. The contents of this tag are evaluated if the current object of the 'visitor' iteration satisfies the 'test' XPath expression.
-
-The 'test' XPath expression is relative to the current object of the parent 'visitor' tag. If the 'test' XPath expression is does not result in a boolean value, then it is converted to a boolean value according the the XPath 1.0 specification. In particular, if the XPath expression results in a set of objects, then 'test' is considered to be true if and only if the set is not empty.
+ Process the tag contents if a test condition is satisfied.
-Note that more than one 'visit' tag may be executed for the same object identified by the parent 'visitor' tag.
- </description>
- </conditionalTag>
- <description>
- Control flow and data management tags. This tags allow templates to evaluate conditions, perform loops and access and set information in the template input.
- </description>
- <containerTag
- class="org.eclipse.jet.internal.taglib.control.UserRegionTag"
- name="userRegion"
- whenContainingLineIsEmpty="remove">
-
- <description>
- Define a region in the generated text where users may write customized code.
+If the 'test' XPath expression is does not result in a boolean value, then it is converted to a boolean value according the the XPath 1.0 specification. In particular, if the XPath expression results in a set of objects, then 'test' is considered to be true if and only if the set is not empty.
-The tag must contain a single &apos;initialCode&apos; tag. Content before the initialCode tag is considered a &apos;begin marker&apos;, while content after it is considered an
-&apos;end marker&apos;. During execution, the existing file is searched for the begin and end markers. If found, the content of the user region tag is replaced with
-the content found in the existing file. If the markers are not found (or the file does not exist), then the markers, along with the content of the initialCode
-tag are written.
+If the 'test' XPath expression is not well formed, then an error results.
</description>
- </containerTag>
- <emptyTag
- class="org.eclipse.jet.internal.taglib.control.IncludeTag"
- name="include"
- whenContainingLineIsEmpty="remove">
+ <attribute name="var" type="string" use="optional">
+ <description>
+ The name of a variable that will refer to the value of the 'test' expression prior to it being converted to a boolean value'. The variable has the scope of the tag contents.
+ </description>
+ </attribute>
+ </conditionalTag><emptyTag class="org.eclipse.jet.internal.taglib.control.IncludeTag" name="include" whenContainingLineIsEmpty="remove">
<description>
Process the referenced template, and include its results in the output of the current template.
@@ -261,293 +201,322 @@ The deprecated &amp;apos;restoreNames&amp;apos; attribute is useful in recursive
The &apos;restoreNames&apos; and &apos;passVariables&apos; options are mutually exclusive.
</description>
- <attribute
- name="template"
- type="string"
- use="required">
+ <attribute name="template" type="string" use="required">
<description>
A transformation project relative path to the template to execute.
</description>
</attribute>
- <attribute
- deprecated="true"
- name="restoreNames"
- type="string"
- use="optional">
+ <attribute deprecated="true" name="restoreNames" type="string" use="optional">
<description>
A comma separated list of variable names (without the $ sign). Mutually exclusive with &apos;passVariables&apos;.
</description>
</attribute>
- <attribute
- name="passVariables"
- type="string"
- use="optional">
+ <attribute name="passVariables" type="string" use="optional">
<description>
A comma separated list of variable names (without the $ sign). Mutually exclusive with 'restoreNames'.
</description>
</attribute>
- <attribute
- name="super"
- type="boolean"
- use="optional">
+ <attribute name="super" type="boolean" use="optional">
<description>
If set to &apos;true&apos;, the template loader attempts to load directly from the overriden transformation (as specified by the &apos;override&apos; tag or by the &apos;overrides&apos; attribute of the &apos;transform&apos; element of the &apos;org.eclipse.jet.transform&apos; extension in the transforms plugin.xml). If no &apos;super&apos; template can be found, an error occurs. The default is &apos;false&apos;, indicating normal template loading.
</description>
</attribute>
- </emptyTag>
- <functionTag
- class="org.eclipse.jet.internal.taglib.control.LogTag"
- name="log"
- whenContainingLineIsEmpty="remove">
- <description>
- Write a message to the transformation log. The contents of the tag are written to the log. Nothing is written the template output.
-
-The optional 'severity' attribute may have one of the following values: 'info', 'warning' or 'error'. The default is 'info'.
- </description>
- <attribute
- name="severity"
- type="string"
- use="optional">
- <description>
- The message severity level. Default is 'info'.
- </description>
- </attribute>
- </functionTag>
- <containerTag
- class="org.eclipse.jet.internal.taglib.control.InitialCodeTag"
- name="initialCode"
- whenContainingLineIsEmpty="remove">
+ </emptyTag><containerTag class="org.eclipse.jet.internal.taglib.control.InitialCodeTag" name="initialCode" whenContainingLineIsEmpty="remove">
<description>
A child tag of the 'userRegion' tag containing the initial code to write. See 'userRegion' for more information.
</description>
- <attribute
- name="unmodifiedMarker"
- type="string"
- use="optional">
+ <attribute name="unmodifiedMarker" type="string" use="optional">
<description>
A string that when present in the content of the existing code indicates that the code has not been modified by the user, and should be replace with the contents of this initial code block.
</description>
</attribute>
- </containerTag>
- <emptyTag
- class="org.eclipse.jet.internal.taglib.control.SetVariableTag"
- name="setVariable"
- whenContainingLineIsEmpty="remove">
+ </containerTag><emptyTag class="org.eclipse.jet.internal.taglib.control.InvokeTransformTag" name="invokeTransform" whenContainingLineIsEmpty="remove">
<description>
- Create a variable whose value is set to the result of the provided XPath expression.
+ Invoke the another transformation, passing it the current transformation&apos;s source model and context variables. The transformation&apos;s actions will be accumulated, and commit when the invoking transformation commits.
+
+The attribute &apos;passVariables&apos; allows explicit declaration of the variables that are passed to the transformation. By default, all context variables are available. With this parameter, only those variables specified are available. In addition, any changes to passed variables are not reflected in the invoking context.
+
+The deprecated &apos;restoreNames&apos; attribute allows for the restoration of variables set by the invoked transformation back to their pre-invocation value.
+
+The &apos;restoreNames&apos; and &apos;passVariables&apos; options are mutually exclusive.
</description>
- <attribute
- name="select"
- type="xpath"
- use="required">
+ <attribute name="transformId" type="string" use="required">
<description>
- An XPath expression to creates the variable's value.
+ The transformation id of the transformation to invoke.
</description>
</attribute>
- <attribute
- name="var"
- type="string"
- use="required">
+ <attribute deprecated="true" name="restoreNames" type="string" use="optional">
<description>
- The name of the variable to set.
+ A comma separated list of variable names (without the $ sign). Mutually exclusive with 'passVariables'.
</description>
+
</attribute>
- </emptyTag>
- <emptyTag
- class="org.eclipse.jet.internal.taglib.control.AddElementTag"
- name="addElement"
+ <attribute name="passVariables" type="string" use="optional">
+ <description>
+ A comma separated list of variable names (without the $ sign). Mutually exclusive with 'restoreNames'.
+ </description>
+ </attribute>
+ </emptyTag><iteratingTag
+ class="org.eclipse.jet.internal.taglib.control.IterateTag"
+ name="iterate"
whenContainingLineIsEmpty="remove">
-
- <description>
- Create a new model element under the selected node.
- </description>
<attribute
name="select"
type="xpath"
use="required">
<description>
- An XPath expression identifying the parent of the new element.
+ An XPath expression that returns either a node set (a collection of elements or attributes) or a number.
</description>
</attribute>
<attribute
- name="name"
+ name="var"
type="string"
use="required">
<description>
- The name of the new element.
+ A variable name. During each iteration, the value of the variable is an object from the set of objects selected by the &apos;select&apos; XPath expression.
</description>
</attribute>
+ <description>
+ Write the tag contents for each in the template input model identified by an XPath expression.
+
+If the &amp;apos;select&amp;apos; XPath expression selects no objects, then the contents of the tag are not processed. If the XPath expression is not well-formed, then an error results.
+
+If the &apos;select&apos; XPath expression returns a number, then the body of the loop is processed that number of times, and the variable named by &apos;var&apos; is set to 1 for the first iteration, and incremented by one for each successive iteration.
+
+If there is a variable in scope with the same name as the value &amp;apos;var&amp;apos; attribute, then it is hidden during the execution of this tag.
+ </description>
<attribute
- name="var"
+ name="delimiter"
type="string"
use="optional">
+
<description>
- A variable name that will refer to the newly created element.
+ A string that is written to the tag's output between iteration of the tag. The text is not written after the last iteration.
</description>
</attribute>
- </emptyTag>
- <functionTag
- class="org.eclipse.jet.internal.taglib.control.AddTextElementTag"
- name="addTextElement">
-
-
+ </iteratingTag>
+
+
+
+
+ <emptyTag class="org.eclipse.jet.internal.taglib.control.LoadTag" name="load" whenContainingLineIsEmpty="remove">
<description>
- Create a new model element node under the selected element, and whose text content is the content of this tag.
+ Load the referenced model, and set the passed variable to the loaded document root.
+
+The optional urlContext attribute determines how relative URL in the url attribute are resolved. Predefined constants: &apos;transform&apos;, indicating that URL is relative to the root directory of the transformation; &apos;workspace&apos;, indicating the URL is relative to the current Eclipse workspace.
+
+The optional loader attribute determines which loader is used to load the model. The default loader is &apos;emf&apos;, although other loaders may have been contributed.
</description>
- <attribute
- name="select"
- type="xpath"
- use="required">
+ <attribute name="url" type="string" use="required">
<description>
- An XPath expression determining the parent of the new element.
+ The URL of the model to load. Usually, this is a relative URL, and is interpretation is controlled by the urlContext attribute.
</description>
</attribute>
- <attribute
- name="name"
- type="string"
- use="required">
+ <attribute name="var" type="string" use="required">
+ A variable name which will be set to the root of the loaded model.
<description>
- The name of the new element.
+ A variable name. The root of the loaded document is set to this variable.
</description>
</attribute>
- <attribute
- name="var"
- type="string"
- use="optional">
+ <attribute name="urlContext" type="string" use="optional">
<description>
- A variable name that will refer to the newly created element.
+ A url context constant. See tag comments for possible values. The default is 'transform'.
</description>
</attribute>
- <attribute
- name="cdata"
- type="boolean"
- use="optional">
+ <attribute name="loader" type="string" use="optional">
+
<description>
- Add the text as a CData section. Default is 'false'.
+ A constant defining the loader to use. The default is determined by the system, depending upon the value of &apos;type&apos; if specified, or the extension specified on &apos;url&apos;.
</description>
</attribute>
- </functionTag>
- <emptyTag
- class="org.eclipse.jet.internal.taglib.control.RemoveElementTag"
- name="removeElement"
- whenContainingLineIsEmpty="remove">
- <description>
- Remove the selected node from the document tree.
- </description>
- <attribute
- name="select"
- type="xpath"
- use="required">
+ <attribute name="type" type="string" use="optional">
<description>
- An XPath expression determining the document to remove.
+ The type (typically the extension) of the model. That may be required if the URL does not have a standard extension.
</description>
</attribute>
- </emptyTag>
- <emptyTag
- class="org.eclipse.jet.internal.taglib.control.CopyElementTag"
- name="copyElement"
- whenContainingLineIsEmpty="remove">
-
+ </emptyTag><functionTag name="loadContent" class="org.eclipse.jet.internal.taglib.control.LoadContentTag">
+ <attribute name="var" use="required">
+ <description>A name to associate with the document root of the DOM created by the parse. Subsequent template tags can use this name in query expressions to access the data in this DOM.</description>
+ </attribute>
+ <attribute name="type" use="optional">
+ <description>A content type with which to search for an appropriate loader for the content. Defaults to "xml" if null.</description>
+ </attribute>
+ <attribute name="loader" use="optional">
+ <description>The id of a specific loader which will parse the content and build a model.</description>
+ </attribute>
+ <description>Extends the model by parsing its contents as XML.</description>
+ </functionTag><functionTag class="org.eclipse.jet.internal.taglib.control.LogTag" name="log" whenContainingLineIsEmpty="remove">
<description>
- Copy the selected node to the selected location.
+ Write a message to the transformation log. The contents of the tag are written to the log. Nothing is written the template output.
+
+The optional 'severity' attribute may have one of the following values: 'info', 'warning' or 'error'. The default is 'info'.
</description>
- <attribute
- name="select"
- type="xpath"
- use="required">
+ <attribute name="severity" type="string" use="optional">
<description>
- An XPath expression selecting the element node to copy.
+ The message severity level. Default is 'info'.
</description>
</attribute>
- <attribute
- name="toSelect"
- type="xpath"
- use="required">
+ </functionTag><containerTag allowAsEmpty="false" class="org.eclipse.jet.internal.taglib.control.MarkerTag" name="marker" processContents="standard" whenContainingLineIsEmpty="remove">
+ <description>
+ Create an Eclipse task marker refering to the text contained in the tag. If the description attribute is specified, then the tasks description is the value of that attribute, otherwise, it is the same as the text refered to by the marker.
+ </description>
+ <attribute name="description" type="string" use="optional">
<description>
- An XPath expression identifying the parent of the newly selected node.
+ The description to use in the task marker. The default is to use the text the marker refers to (the tag's content).
</description>
</attribute>
- <attribute
- name="name"
- type="string"
- use="required">
+ </containerTag><conditionalTag
+ class="org.eclipse.jet.internal.taglib.control.OtherwiseTag"
+ name="otherwise"
+ processContents="custom"
+ whenContainingLineIsEmpty="remove">
+ <description>
+ Define a default case for a 'choose' tag. The body of this tag is processed only if no previous 'case' or 'otherwise' tag in the containing 'choose' tag has processed its body content.
+
+An error occurs if the 'otherwise' is not directly contained by a 'choose' tag.
+ </description>
+ </conditionalTag>
+ <emptyTag class="org.eclipse.jet.internal.taglib.control.OverrideTag" deprecated="false" name="override" whenContainingLineIsEmpty="remove">
+ <description>
+ *** Deprecated: Use the 'overrides' attribute on 'transform' extension in plugin.xml instead. *** Declares that this transformation overrides templates in the identified transformation.
+ </description>
+ <attribute name="transformId" type="string" use="required">
<description>
- The name for the newly created element.
+ The transformation id of the transformation which is being overriden.
</description>
</attribute>
- <attribute
- name="recursive"
- type="boolean"
- use="optional">
+ </emptyTag><emptyTag class="org.eclipse.jet.internal.taglib.control.RemoveElementTag" name="removeElement" whenContainingLineIsEmpty="remove">
+ <description>
+ Remove the selected node from the document tree.
+ </description>
+ <attribute name="select" type="xpath" use="required">
<description>
- Determine whether child elements of the copied element are copied, too. Default is &apos;true&apos;.
+ An XPath expression determining the document to remove.
</description>
</attribute>
- <attribute
- name="var"
- type="string"
- use="optional">
- <description>
- The name of a variable that will be set to the newly copied element.
- </description>
+ </emptyTag><functionTag name="replaceStrings" class="org.eclipse.jet.internal.taglib.control.ReplaceStringsTag">
+ <attribute name="replace" use="required">
+ <description>A comma-separated list of strings to be replaced. The backslash ("\") acts as an escape character for special characters</description>
</attribute>
- </emptyTag>
- <emptyTag
- class="org.eclipse.jet.internal.taglib.control.LoadTag"
- name="load"
- whenContainingLineIsEmpty="remove">
+ <attribute name="with" use="required">
+ <description>A comma-separated list of replacement strings corresponding to the strings in the replace attribute.</description>
+ </attribute>
+ <description>Replaces one set of strings in its content with another set of strings and writes out the result.</description>
+ </functionTag><containerTag allowAsEmpty="false" class="org.eclipse.jet.internal.taglib.control.SetTag" name="set" processContents="custom" whenContainingLineIsEmpty="remove">
<description>
- Load the referenced model, and set the passed variable to the loaded document root.
+ Set an attribute on an object selected by an XPath expression. The value of the attribute is determined by the contents of the tag.
-The optional urlContext attribute determines how relative URL in the url attribute are resolved. Predefined constants: &apos;transform&apos;, indicating that URL is relative to the root directory of the transformation; &apos;workspace&apos;, indicating the URL is relative to the current Eclipse workspace.
+If the XPath expression results in more than one object being selected, then that attribute is created on only the first selected object.
-The optional loader attribute determines which loader is used to load the model. The default loader is &apos;emf&apos;, although other loaders may have been contributed.
+If the XPath expression does not select an object, or if the XPath expression is malformed, then an error occurs.
+
+The 'name' attribute need not refer to an attribute defined on the selected object. If the attribute does not exist, one is created dynamically. Such dynamically created attributes are not permanent - they are destroyed when the JET2Context object passed to the template is destroyed.
+
+If the 'name' attribute refers to an existing attribute on the selected object, then the tag attempts to convert the string contents of this tag to the appropriate attribute data type. If this conversion fails, then an error occurs.
</description>
- <attribute
- name="url"
- type="string"
- use="required">
+ <attribute name="select" type="xpath" use="required">
<description>
- The URL of the model to load. Usually, this is a relative URL, and is interpretation is controlled by the urlContext attribute.
+ The XPath expression to evaluate.
</description>
</attribute>
- <attribute
- name="var"
- type="string"
- use="required">
- A variable name which will be set to the root of the loaded model.
+ <attribute name="name" type="string" use="required">
<description>
- A variable name. The root of the loaded document is set to this variable.
+ The name of the attribute to set or create and set.
</description>
</attribute>
- <attribute
- name="urlContext"
- type="string"
- use="optional">
+ </containerTag><emptyTag class="org.eclipse.jet.internal.taglib.control.SetVariableTag" name="setVariable" whenContainingLineIsEmpty="remove">
+ <description>
+ Create a variable whose value is set to the result of the provided XPath expression.
+ </description>
+ <attribute name="select" type="xpath" use="required">
<description>
- A url context constant. See tag comments for possible values. The default is 'transform'.
+ An XPath expression to creates the variable's value.
</description>
</attribute>
+ <attribute name="var" type="string" use="required">
+ <description>
+ The name of the variable to set.
+ </description>
+ </attribute>
+ </emptyTag><iteratingTag name="stringTokens" class="org.eclipse.jet.internal.taglib.control.StringTokensTag">
+ <attribute name="string" use="required">
+ <description>The string to be parsed</description>
+ </attribute>
+ <attribute name="delimitedBy" use="optional">
+ <description>The tokens that delimit the tokens in the string</description>
+ </attribute>
+ <attribute name="name" use="required">
+ <description>The variable name to be associated with the temporary model nodes describing the tokens. Nested tags can use this variable name to refer to the temporary node.</description>
+ </attribute>
+ <attribute name="delimiter" use="optional">
+ <description>The string to write after every iteration except the last</description>
+ </attribute>
+ <attribute name="reverse" use="optional">
+ <description>A true/false value indicating whether the tokens should be iterated over first-to-last (false) or last-to-first (true)</description>
+ </attribute>
+ <attribute name="tokenLength" use="optional">
+ <description>Default description for attribute tokenLength</description>
+ </attribute>
+ <description>Parses a string into tokens and iterates over its content for each token.</description>
+ </iteratingTag><containerTag class="org.eclipse.jet.internal.taglib.control.UserRegionTag" name="userRegion" whenContainingLineIsEmpty="remove">
+
+ <description>
+ Define a region in the generated text where users may write customized code.
+
+The tag must contain a single &apos;initialCode&apos; tag. Content before the initialCode tag is considered a &apos;begin marker&apos;, while content after it is considered an
+&apos;end marker&apos;. During execution, the existing file is searched for the begin and end markers. If found, the content of the user region tag is replaced with
+the content found in the existing file. If the markers are not found (or the file does not exist), then the markers, along with the content of the initialCode
+tag are written.
+ </description>
+ </containerTag><conditionalTag class="org.eclipse.jet.internal.taglib.control.VisitTag" name="visit" whenContainingLineIsEmpty="remove">
+ <attribute name="test" type="xpath" use="required" />
+ <description>
+ Define content to process for an object found by the parent 'visitor' tag, provided a condition is met. The contents of this tag are evaluated if the current object of the 'visitor' iteration satisfies the 'test' XPath expression.
+
+The 'test' XPath expression is relative to the current object of the parent 'visitor' tag. If the 'test' XPath expression is does not result in a boolean value, then it is converted to a boolean value according the the XPath 1.0 specification. In particular, if the XPath expression results in a set of objects, then 'test' is considered to be true if and only if the set is not empty.
+
+Note that more than one 'visit' tag may be executed for the same object identified by the parent 'visitor' tag.
+ </description>
+ </conditionalTag><iteratingTag
+ class="org.eclipse.jet.internal.taglib.control.VisitorTag"
+ name="visitor"
+ whenContainingLineIsEmpty="remove">
<attribute
- name="loader"
- type="string"
- use="optional">
-
+ name="select"
+ type="xpath"
+ use="required">
<description>
- A constant defining the loader to use. The default is determined by the system, depending upon the value of &apos;type&apos; if specified, or the extension specified on &apos;url&apos;.
+ The XPath expression to evaluate.
</description>
</attribute>
<attribute
- name="type"
+ name="var"
type="string"
- use="optional">
+ use="required">
<description>
- The type (typically the extension) of the model. That may be required if the URL does not have a standard extension.
+ The name of a variable that will contain the current object in the iteration.
</description>
</attribute>
- </emptyTag>
+ <description>
+ *** PROTOTYPE *** Iterate over an object and all its contained objects, typically be doing a depth-first traversal. For each identified object, the tag evaluates the 'test' condition on its contained 'visit' tags. Only those tags whose test condition is true have their contents processed.
+
+If the 'select' XPath expression returns more than one object, only the first is written. If the XPath expression selects no objects, then an error occurs, unless the 'default' attribute is specified. If the 'select' XPath expression is malformed, then an error occurs.
+ </description>
+ </iteratingTag>
+
+
+
+
+
+
+
+
+
+
+
+
<conditionalTag
class="org.eclipse.jet.internal.taglib.control.WhenTag"
name="when"
@@ -571,229 +540,100 @@ If this tag is not directly contained by a 'choose' tag, then an error results.
</description>
</attribute>
</conditionalTag>
- <containerTag
- allowAsEmpty="false"
- class="org.eclipse.jet.internal.taglib.control.SetTag"
- name="set"
- processContents="custom"
- whenContainingLineIsEmpty="remove">
+
+
+
+
+
+
+
+
+ </tagLibrary>
+ <tagLibrary
+ id="workspaceTags"
+ name="Standard JET2 Workspace Tags"
+ standardPrefix="ws">
+
+ <description>
+ A library of tags for performing actions against the Eclipse workspace.
+ </description><emptyTag class="org.eclipse.jet.internal.taglib.workspace.CopyFileTag" name="copyFile">
+
<description>
- Set an attribute on an object selected by an XPath expression. The value of the attribute is determined by the contents of the tag.
-
-If the XPath expression results in more than one object being selected, then that attribute is created on only the first selected object.
-
-If the XPath expression does not select an object, or if the XPath expression is malformed, then an error occurs.
-
-The 'name' attribute need not refer to an attribute defined on the selected object. If the attribute does not exist, one is created dynamically. Such dynamically created attributes are not permanent - they are destroyed when the JET2Context object passed to the template is destroyed.
-
-If the 'name' attribute refers to an existing attribute on the selected object, then the tag attempts to convert the string contents of this tag to the appropriate attribute data type. If this conversion fails, then an error occurs.
+ Copy the file refered to by 'url' to the location refered to by 'path'.
</description>
- <attribute
- name="select"
- type="xpath"
- use="required">
+ <attribute name="binary" type="boolean" use="optional">
<description>
- The XPath expression to evaluate.
+ Indicates whether the copy is binary or text base. Possible values: 'true' or 'false'. Default: 'false'.
</description>
</attribute>
- <attribute
- name="name"
- type="string"
- use="required">
+ <attribute name="replace" type="boolean" use="optional">
<description>
- The name of the attribute to set or create and set.
+ Indicates if any existing version of the file should be replaced. Possible values: 'true' or 'false'. Default: 'true'.
</description>
</attribute>
- </containerTag>
- <containerTag
- allowAsEmpty="false"
- class="org.eclipse.jet.internal.taglib.control.MarkerTag"
- name="marker"
- processContents="standard"
- whenContainingLineIsEmpty="remove">
- <description>
- Create an Eclipse task marker refering to the text contained in the tag. If the description attribute is specified, then the tasks description is the value of that attribute, otherwise, it is the same as the text refered to by the marker.
- </description>
- <attribute
- name="description"
- type="string"
- use="optional">
+ <attribute name="srcEncoding" type="string" use="optional">
<description>
- The description to use in the task marker. The default is to use the text the marker refers to (the tag's content).
+ Defines the default text encoding of the source file. This is only meaningful if the 'binary' attribute is not 'false'. Default is the platform default text encoding.
</description>
</attribute>
- </containerTag>
- <emptyTag
- class="org.eclipse.jet.internal.taglib.control.OverrideTag"
- deprecated="false"
- name="override"
- whenContainingLineIsEmpty="remove">
- <description>
- *** Deprecated: Use the 'overrides' attribute on 'transform' extension in plugin.xml instead. *** Declares that this transformation overrides templates in the identified transformation.
- </description>
- <attribute
- name="transformId"
- type="string"
- use="required">
+ <attribute name="targetEncoding" type="string" use="optional">
<description>
- The transformation id of the transformation which is being overriden.
+ Identifies the text encoding to use when writing the target file. This is only meaningful if the 'binary' attribute is not 'true'. The default text encoding is determined by the platform.
</description>
</attribute>
- </emptyTag>
- <emptyTag
- class="org.eclipse.jet.internal.taglib.control.InvokeTransformTag"
- name="invokeTransform"
- whenContainingLineIsEmpty="remove">
- <description>
- Invoke the another transformation, passing it the current transformation&apos;s source model and context variables. The transformation&apos;s actions will be accumulated, and commit when the invoking transformation commits.
-
-The attribute &apos;passVariables&apos; allows explicit declaration of the variables that are passed to the transformation. By default, all context variables are available. With this parameter, only those variables specified are available. In addition, any changes to passed variables are not reflected in the invoking context.
-
-The deprecated &apos;restoreNames&apos; attribute allows for the restoration of variables set by the invoked transformation back to their pre-invocation value.
-
-The &apos;restoreNames&apos; and &apos;passVariables&apos; options are mutually exclusive.
- </description>
- <attribute
- name="transformId"
- type="string"
- use="required">
+ <attribute name="src" type="string" use="required">
<description>
- The transformation id of the transformation to invoke.
+ An absolute or relative URL identifying the file to copy. If a relative URL, the 'srcContext' attribute controls resolution of the URL.
</description>
</attribute>
- <attribute
- deprecated="true"
- name="restoreNames"
- type="string"
- use="optional">
+ <attribute name="srcContext" type="string" use="optional">
<description>
- A comma separated list of variable names (without the $ sign). Mutually exclusive with 'passVariables'.
+ Determines the context of relative URL in the 'src' attribute. Default value is 'transform'. Possible values: 'transform', 'workspace'.
</description>
-
</attribute>
- <attribute
- name="passVariables"
- type="string"
- use="optional">
+ <attribute name="target" type="string" use="required">
<description>
- A comma separated list of variable names (without the $ sign). Mutually exclusive with 'restoreNames'.
+ The destination path of the resource. If relative, this is relative to any containing 'folder' or 'project' tag, otherwise, the first path element is treated as a project name.
</description>
</attribute>
- </emptyTag>
- <emptyTag name="dump" class="org.eclipse.jet.internal.taglib.control.DumpTag" >
- <attribute
- name="select"
- type="xpath"
- use="required">
- <description>A query expression specifying a single node in the model</description>
- </attribute>
- <attribute
- name="format"
- type="boolean"
- use="optional">
- <description>A true/false value indicating whether the tag should try to write out whitespace to cause the output to be nicely formatted and indented.</description>
- </attribute>
- <attribute
- name="entities"
- type="boolean"
- use="optional">
- <description>A true/false value indicating whether characters that can cause XML parsing problems (left and right angle brackets, quotes, apostrophes, etc) should be written as entities (e.g. "%lt;" for the left angle bracket).</description>
- </attribute>
- <description>Writes out the DOM subtree under a specified model node.</description>
- </emptyTag>
- <functionTag name="loadContent" class="org.eclipse.jet.internal.taglib.control.LoadContentTag" >
- <attribute name="var" use="required">
- <description>A name to associate with the document root of the DOM created by the parse. Subsequent template tags can use this name in query expressions to access the data in this DOM.</description>
- </attribute>
- <attribute name="type" use="optional">
- <description>A content type with which to search for an appropriate loader for the content. Defaults to "xml" if null.</description>
- </attribute>
- <attribute name="loader" use="optional">
- <description>The id of a specific loader which will parse the content and build a model.</description>
- </attribute>
- <description>Extends the model by parsing its contents as XML.</description>
- </functionTag>
- <iteratingTag
- class="org.eclipse.jet.internal.taglib.control.NodeAttributesTag"
- deprecated="true"
- name="nodeAttributes">
- <attribute name="node" use="required">
- <description>A query expression that resolves to a single node. The nodeAttributes tag will iterate over this node's attributes.</description>
- </attribute>
- <attribute name="name" use="required">
- <description>The variable name to associate with each temporary node describing an attribute. Once the variable name is assigned to the temporary node, the nodeAttributes tag will process its contents once.</description>
- </attribute>
- <attribute name="delimiter" use="optional">
- <description>A string to write out after every iteration except the last.</description>
- </attribute>
- <description>Iterates over the attributes for a given node.</description>
- </iteratingTag>
- <functionTag name="replaceStrings" class="org.eclipse.jet.internal.taglib.control.ReplaceStringsTag" >
- <attribute name="replace" use="required">
- <description>A comma-separated list of strings to be replaced. The backslash ("\") acts as an escape character for special characters</description>
- </attribute>
- <attribute name="with" use="required">
- <description>A comma-separated list of replacement strings corresponding to the strings in the replace attribute.</description>
- </attribute>
- <description>Replaces one set of strings in its content with another set of strings and writes out the result.</description>
- </functionTag>
- <iteratingTag name="stringTokens" class="org.eclipse.jet.internal.taglib.control.StringTokensTag" >
- <attribute name="string" use="required">
- <description>The string to be parsed</description>
- </attribute>
- <attribute name="delimitedBy" use="optional">
- <description>The tokens that delimit the tokens in the string</description>
- </attribute>
- <attribute name="name" use="required">
- <description>The variable name to be associated with the temporary model nodes describing the tokens. Nested tags can use this variable name to refer to the temporary node.</description>
+ </emptyTag><emptyTag class="org.eclipse.jet.internal.taglib.workspace.FileTag" name="file">
+ <attribute name="path" type="string" use="required">
+ <description>
+ A relative path (no initial '/') or an absolute path.
+ </description>
</attribute>
- <attribute name="delimiter" use="optional">
- <description>The string to write after every iteration except the last</description>
+ <attribute name="template" type="string" use="required">
+ <description>
+ A project-relative path of a JET template to execute. The template provides the file&apos;s contents.
+ </description>
</attribute>
- <attribute name="reverse" use="optional">
- <description>A true/false value indicating whether the tokens should be iterated over first-to-last (false) or last-to-first (true)</description>
+ <attribute name="encoding" type="string" use="optional">
+ <description>
+ The character encoding of the file. If omitted, then the Eclipse workspace determines the encoding. If provided, then the encoding is changed to the specified value. A value of &apos;#default&apos; restores the encoding of the file to the workspace determined default.
+ </description>
</attribute>
- <attribute name="tokenLength" use="optional">
- <description>Default description for attribute tokenLength</description>
+ <attribute name="replace" type="boolean" use="optional">
+ <description>
+ A boolean (&apos;true&apos; or &apos;false&apos;) value. If &apos;true&apos;, the tag will overwrite an existing file, otherwise it will not. If omitted, a value of &apos;true&apos; is assumed.
+ </description>
</attribute>
- <description>Parses a string into tokens and iterates over its content for each token.</description>
- </iteratingTag>
- </tagLibrary>
- <tagLibrary
- id="workspaceTags"
- name="Standard JET2 Workspace Tags"
- standardPrefix="ws">
- <containerTag
- allowAsEmpty="true"
- class="org.eclipse.jet.internal.taglib.workspace.ProjectTag"
- name="project">
- <attribute
- name="name"
- type="string"
- use="required">
+ <attribute name="derived" type="boolean" use="optional">
<description>
- The name of the project.
+ A boolean value (&apos;true&apos; or &apos;false&apos;) determining the value of the workspace &apos;derived&apos; attribute for the file. If omitted, a value of &apos;false&apos; is assumed.
</description>
</attribute>
<description>
- Ensure the existence of an Eclipse Project of a given name. If the project does not exist, it is created. If the project is not opened, it is opened.
+ Create or write an Eclipse workspace file. If the file does not exist, the tag attempts to create it and any containing folders. An error occurs if the file does not exist and cannot be created.
-Note that the actual creation of the workspace project is deferred until the JET2Context passed to the executing template has the 'commit' method calls. If the template is part of a JET2 transformation, this occurs once all templates have executed.
+Note that the actual creation of the workspace file is deferred until the JET2Context passed to the executing template has the 'commit' method calls. If the template is part of a JET2 transformation, this occurs once all templates have executed.
-An error occurs of the project does not exist and cannot be created, or if the project exists, but cannot be opened.
+If the 'file' tag is contained directly or indirectly by a 'folder' or 'project' tag AND the 'path' attribute on this tag is relative (does not start with a '/'), then the 'path' attribute is treated as relative to the containing 'folder' or 'project'.
-The 'project' tag may contain other tags. Contained 'folder' and 'file' tags will have relative path names iterpreted as being relative to the project defined by this tag.
+An absolute 'path' (one starting with '/') is treated as a workspace relative path. That is, the first component after the slash is interpreted as the name of an Eclipse Project, and subsequence segments are treated as folder names, with the last segment being interpreted as the file name.
+
+When executing, this tag will cause the implicit creation of any folders containing the folder to be created. It will not implicitly create a containing workspace project.
</description>
- <attribute
- name="location"
- type="string"
- use="optional">
- <description>
- An optional absolute file-system location for the new project. If not specified, the project is created in a directory under the workspace directory.
- </description>
- </attribute>
- </containerTag>
- <containerTag
+ </emptyTag><containerTag
allowAsEmpty="true"
class="org.eclipse.jet.internal.taglib.workspace.FolderTag"
name="folder">
@@ -819,138 +659,98 @@ An absolute &apos;path&apos; (one starting with &apos;/&apos;) is treated as a w
When executing, this tag will cause the implicit creation of any folders containing the folder to be created. It will not implicitly create a containing workspace project.
</description>
</containerTag>
- <emptyTag
- class="org.eclipse.jet.internal.taglib.workspace.FileTag"
- name="file">
- <attribute
- name="path"
- type="string"
- use="required">
- <description>
- A relative path (no initial '/') or an absolute path.
- </description>
- </attribute>
- <attribute
- name="template"
- type="string"
- use="required">
- <description>
- A project-relative path of a JET template to execute. The template provides the file&apos;s contents.
- </description>
- </attribute>
- <attribute
- name="encoding"
- type="string"
- use="optional">
- <description>
- The character encoding of the file. If omitted, then the Eclipse workspace determines the encoding. If provided, then the encoding is changed to the specified value. A value of &apos;#default&apos; restores the encoding of the file to the workspace determined default.
- </description>
- </attribute>
- <attribute
- name="replace"
- type="boolean"
- use="optional">
- <description>
- A boolean (&apos;true&apos; or &apos;false&apos;) value. If &apos;true&apos;, the tag will overwrite an existing file, otherwise it will not. If omitted, a value of &apos;true&apos; is assumed.
- </description>
- </attribute>
- <attribute
- name="derived"
- type="boolean"
- use="optional">
+
+ <containerTag allowAsEmpty="true" class="org.eclipse.jet.internal.taglib.workspace.ProjectTag" name="project">
+ <attribute name="name" type="string" use="required">
<description>
- A boolean value (&apos;true&apos; or &apos;false&apos;) determining the value of the workspace &apos;derived&apos; attribute for the file. If omitted, a value of &apos;false&apos; is assumed.
+ The name of the project.
</description>
</attribute>
<description>
- Create or write an Eclipse workspace file. If the file does not exist, the tag attempts to create it and any containing folders. An error occurs if the file does not exist and cannot be created.
-
-Note that the actual creation of the workspace file is deferred until the JET2Context passed to the executing template has the 'commit' method calls. If the template is part of a JET2 transformation, this occurs once all templates have executed.
+ Ensure the existence of an Eclipse Project of a given name. If the project does not exist, it is created. If the project is not opened, it is opened.
-If the 'file' tag is contained directly or indirectly by a 'folder' or 'project' tag AND the 'path' attribute on this tag is relative (does not start with a '/'), then the 'path' attribute is treated as relative to the containing 'folder' or 'project'.
+Note that the actual creation of the workspace project is deferred until the JET2Context passed to the executing template has the 'commit' method calls. If the template is part of a JET2 transformation, this occurs once all templates have executed.
-An absolute 'path' (one starting with '/') is treated as a workspace relative path. That is, the first component after the slash is interpreted as the name of an Eclipse Project, and subsequence segments are treated as folder names, with the last segment being interpreted as the file name.
+An error occurs of the project does not exist and cannot be created, or if the project exists, but cannot be opened.
-When executing, this tag will cause the implicit creation of any folders containing the folder to be created. It will not implicitly create a containing workspace project.
+The 'project' tag may contain other tags. Contained 'folder' and 'file' tags will have relative path names iterpreted as being relative to the project defined by this tag.
</description>
+ <attribute name="location" type="string" use="optional">
+ <description>
+ An optional absolute file-system location for the new project. If not specified, the project is created in a directory under the workspace directory.
+ </description>
+ </attribute>
+ </containerTag><emptyTag name="rebuildWorkspace" class="org.eclipse.jet.internal.taglib.workspace.RebuildWorkspaceTag">
+ <description>Causes the Eclipse workspace to process resources that were changed or created by the pattern.</description>
</emptyTag>
+
+
+ </tagLibrary>
+ <tagLibrary
+ id="javaTags"
+ name="Standard JET2 Java Tags"
+ standardPrefix="java">
+
<description>
- A library of tags for performing actions against the Eclipse workspace.
- </description>
- <emptyTag
- class="org.eclipse.jet.internal.taglib.workspace.CopyFileTag"
- name="copyFile">
-
+ Tags useful in generating Java code.
+ </description><emptyTag class="org.eclipse.jet.internal.taglib.java.JavaClassTag" name="class">
<description>
- Copy the file refered to by 'url' to the location refered to by 'path'.
+ Create a Java class with the specified name and write its contents by evaluating the supplied template.
</description>
- <attribute
- name="binary"
- type="boolean"
- use="optional">
+ <attribute name="name" type="string" use="required">
<description>
- Indicates whether the copy is binary or text base. Possible values: 'true' or 'false'. Default: 'false'.
+ The name unqualified name of the Java class.
</description>
</attribute>
- <attribute
- name="replace"
- type="boolean"
- use="optional">
+ <attribute name="package" type="string" use="optional">
<description>
- Indicates if any existing version of the file should be replaced. Possible values: 'true' or 'false'. Default: 'true'.
+ The name of the java package. If not specified, then the name of the containing 'java:package' tag is used, otherwise, the default package is used.
</description>
</attribute>
- <attribute
- name="srcEncoding"
- type="string"
- use="optional">
+ <attribute name="srcFolder" type="string" use="optional">
<description>
- Defines the default text encoding of the source file. This is only meaningful if the 'binary' attribute is not 'false'. Default is the platform default text encoding.
+ The a path of source folder. If a relative path, this relative to any containing 'ws:project' or 'ws:folder' tags. If absolute, it is treated as a workspace relative path. If omitted, the first source folder of the containing project is used.
</description>
</attribute>
- <attribute
- name="targetEncoding"
- type="string"
- use="optional">
+ <attribute name="template" type="string" use="required">
<description>
- Identifies the text encoding to use when writing the target file. This is only meaningful if the 'binary' attribute is not 'true'. The default text encoding is determined by the platform.
+ A project-relative path of a JET template to execute. The template provides the class file&apos;s contents.
</description>
</attribute>
- <attribute
- name="src"
- type="string"
- use="required">
+ <attribute name="replace" type="boolean" use="optional">
<description>
- An absolute or relative URL identifying the file to copy. If a relative URL, the 'srcContext' attribute controls resolution of the URL.
+ A boolean (&apos;true&apos; or &apos;false&apos;) value. If &apos;true&apos;, the tag will overwrite an existing file, otherwise it will not. If omitted, a value of &apos;true&apos; is assumed.
</description>
</attribute>
- <attribute
- name="srcContext"
- type="string"
- use="optional">
+ <attribute name="encoding" type="string" use="optional">
<description>
- Determines the context of relative URL in the 'src' attribute. Default value is 'transform'. Possible values: 'transform', 'workspace'.
+ The character encoding of the file. If omitted, then the Eclipse workspace determines the encoding. If provided, then the encoding is changed to the specified value. A value of &apos;#default&apos; restores the encoding of the file to the workspace determined default.
</description>
</attribute>
- <attribute
- name="target"
- type="string"
- use="required">
+ <attribute name="derived" type="boolean" use="optional">
<description>
- The destination path of the resource. If relative, this is relative to any containing 'folder' or 'project' tag, otherwise, the first path element is treated as a project name.
+ A boolean value (&apos;true&apos; or &apos;false&apos;) determining the value of the workspace &apos;derived&apos; attribute for the file. If omitted, a value of &apos;false&apos; is assumed.
</description>
</attribute>
- </emptyTag>
- <emptyTag name="rebuildWorkspace" class="org.eclipse.jet.internal.taglib.workspace.RebuildWorkspaceTag" >
- <description>Causes the Eclipse workspace to process resources that were changed or created by the pattern.</description>
- </emptyTag>
- </tagLibrary>
- <tagLibrary
- id="javaTags"
- name="Standard JET2 Java Tags"
- standardPrefix="java">
-
- <emptyTag
+ </emptyTag><emptyTag class="org.eclipse.jet.internal.taglib.java.ImpliedImportTag" name="impliedImport">
+ <attribute name="name" type="string" use="required">
+ <description>
+ The name of the class (unqualified) for which there is an implicit import.
+ </description>
+ </attribute>
+ <description>
+ Record a name as being implicitly imported. This is a name that a sibling class of the one being generated by the current template.
+
+This tag must occur after the initial &amp;apos;importsLocation&amp;apos; tag, but before any &amp;apos;imports&amp;apos; tags in the template.
+ </description>
+ </emptyTag><functionTag class="org.eclipse.jet.internal.taglib.java.ImportTag" name="import">
+ <description>
+ Replace the enclosed content with the equivalent unqualified Java name (if possible), and ensure an appropriate Java import statement is generated.
+
+This tag must be preceded by a 'importsLocation' tag.
+
+ </description>
+ </functionTag><emptyTag
class="org.eclipse.jet.internal.taglib.java.ImportsLocationTag"
name="importsLocation">
<attribute
@@ -967,37 +767,25 @@ When executing, this tag will cause the implicit creation of any folders contain
This tag may occur only once in a template.
</description>
</emptyTag>
- <emptyTag
- class="org.eclipse.jet.internal.taglib.java.ImpliedImportTag"
- name="impliedImport">
- <attribute
- name="name"
- type="string"
- use="required">
+
+
+
+ <emptyTag class="org.eclipse.jet.internal.taglib.java.MergeTag" name="merge" whenContainingLineIsEmpty="preserve">
+
+ <description>
+ Cause the template contents to be merged with the existing Java file using the EMF JMerge engine.
+ </description>
+ <attribute name="rules" type="string" use="optional">
<description>
- The name of the class (unqualified) for which there is an implicit import.
+ A URL to the JMerge rules file. If the path is relative, then it is relative to the location specified by the rulesContext attribute. If not specified, the default is the JMerge rules used by the EMF Code Generator.
</description>
</attribute>
- <description>
- Record a name as being implicitly imported. This is a name that a sibling class of the one being generated by the current template.
-
-This tag must occur after the initial &amp;apos;importsLocation&amp;apos; tag, but before any &amp;apos;imports&amp;apos; tags in the template.
- </description>
- </emptyTag>
- <functionTag
- class="org.eclipse.jet.internal.taglib.java.ImportTag"
- name="import">
- <description>
- Replace the enclosed content with the equivalent unqualified Java name (if possible), and ensure an appropriate Java import statement is generated.
-
-This tag must be preceded by a 'importsLocation' tag.
-
- </description>
- </functionTag>
- <description>
- Tags useful in generating Java code.
- </description>
- <containerTag
+ <attribute name="rulesContext" type="string" use="optional">
+ <description>
+ The context for resolving relative 'rules' URLs. Possible values are 'transform' or 'workspace'. If the value is 'transform', then the 'rules' URL is treated as a JET project relative path. If the value is 'workspace', then the 'rules' URL is treated as an Eclipse workspace relative path. The default is 'transform'.
+ </description>
+ </attribute>
+ </emptyTag><containerTag
class="org.eclipse.jet.internal.taglib.java.PackageTag"
name="package"
processContents="standard">
@@ -1082,101 +870,42 @@ This tag must be preceded by a 'importsLocation' tag.
</description>
</attribute>
</emptyTag>
- <emptyTag
- class="org.eclipse.jet.internal.taglib.java.JavaClassTag"
- name="class">
- <description>
- Create a Java class with the specified name and write its contents by evaluating the supplied template.
- </description>
- <attribute
- name="name"
- type="string"
- use="required">
- <description>
- The name unqualified name of the Java class.
- </description>
- </attribute>
- <attribute
- name="package"
- type="string"
- use="optional">
- <description>
- The name of the java package. If not specified, then the name of the containing 'java:package' tag is used, otherwise, the default package is used.
- </description>
- </attribute>
- <attribute
- name="srcFolder"
- type="string"
- use="optional">
- <description>
- The a path of source folder. If a relative path, this relative to any containing 'ws:project' or 'ws:folder' tags. If absolute, it is treated as a workspace relative path. If omitted, the first source folder of the containing project is used.
- </description>
- </attribute>
- <attribute
- name="template"
- type="string"
- use="required">
- <description>
- A project-relative path of a JET template to execute. The template provides the class file&apos;s contents.
- </description>
- </attribute>
- <attribute
- name="replace"
- type="boolean"
- use="optional">
- <description>
- A boolean (&apos;true&apos; or &apos;false&apos;) value. If &apos;true&apos;, the tag will overwrite an existing file, otherwise it will not. If omitted, a value of &apos;true&apos; is assumed.
- </description>
+
+
+ </tagLibrary>
+ <tagLibrary
+ id="formatTags"
+ name="Standard JET2 Format Tags"
+ standardPrefix="f">
+
+ <description>
+ Standard utility tags that rewrite their content in a different format.
+ </description><emptyTag name="formatNow" class="org.eclipse.jet.internal.taglib.format.FormatNowTag">
+ <attribute name="pattern" use="required">
+ <description>The pattern with which to format the current data and time. See documentation for the Java class java.util.SimpleDateFormat for more details.</description>
</attribute>
- <attribute
- name="encoding"
- type="string"
- use="optional">
+ <description>Formats and writes out the current date and time</description>
+ </emptyTag><functionTag class="org.eclipse.jet.internal.taglib.format.LowerCaseTag" name="lc">
+ <attribute name="offset" use="optional">
<description>
- The character encoding of the file. If omitted, then the Eclipse workspace determines the encoding. If provided, then the encoding is changed to the specified value. A value of &apos;#default&apos; restores the encoding of the file to the workspace determined default.
+ The starting offset (0-based) of the conversion. When omitted, 0 (the start of the content to be converted) is assumed.
</description>
</attribute>
- <attribute
- name="derived"
- type="boolean"
- use="optional">
+ <attribute name="length" use="optional">
<description>
- A boolean value (&apos;true&apos; or &apos;false&apos;) determining the value of the workspace &apos;derived&apos; attribute for the file. If omitted, a value of &apos;false&apos; is assumed.
+ The number of characters to convert. When omitted, it is assumed that all characters after (and including) the starting character will be converted.
</description>
</attribute>
- </emptyTag>
- <emptyTag
- class="org.eclipse.jet.internal.taglib.java.MergeTag"
- name="merge"
- whenContainingLineIsEmpty="preserve">
-
<description>
- Cause the template contents to be merged with the existing Java file using the EMF JMerge engine.
+ Convert the tag contents to lower case.
+
+If 'offset' is specified, start conversion from the specified character, otherwise, start conversion from the first character.
+
+if 'length' is specified, convert only the specified number of characters, otherwise, convert all characters from the start character on.
</description>
- <attribute
- name="rules"
- type="string"
- use="optional">
- <description>
- A URL to the JMerge rules file. If the path is relative, then it is relative to the location specified by the rulesContext attribute. If not specified, the default is the JMerge rules used by the EMF Code Generator.
- </description>
- </attribute>
- <attribute
- name="rulesContext"
- type="string"
- use="optional">
- <description>
- The context for resolving relative 'rules' URLs. Possible values are 'transform' or 'workspace'. If the value is 'transform', then the 'rules' URL is treated as a JET project relative path. If the value is 'workspace', then the 'rules' URL is treated as an Eclipse workspace relative path. The default is 'transform'.
- </description>
- </attribute>
- </emptyTag>
- </tagLibrary>
- <tagLibrary
- id="formatTags"
- name="Standard JET2 Format Tags"
- standardPrefix="f">
-
- <functionTag
+ </functionTag><emptyTag name="milliseconds" class="org.eclipse.jet.internal.taglib.format.MillisecondsTag">
+ <description>Writes out a current system milliseconds value.</description>
+ </emptyTag><functionTag
class="org.eclipse.jet.internal.taglib.format.ReplaceAllTag"
name="replaceAll">
@@ -1242,43 +971,10 @@ If 'offset' is specified, start conversion from the specified character, otherwi
if 'length' is specified, convert only the specified number of characters, otherwise, convert all characters from the start character on.
</description>
- </functionTag> <functionTag
- class="org.eclipse.jet.internal.taglib.format.LowerCaseTag"
- name="lc">
- <attribute
- name="offset"
- use="optional">
- <description>
- The starting offset (0-based) of the conversion. When omitted, 0 (the start of the content to be converted) is assumed.
- </description>
- </attribute>
- <attribute
- name="length"
- use="optional">
- <description>
- The number of characters to convert. When omitted, it is assumed that all characters after (and including) the starting character will be converted.
- </description>
- </attribute>
- <description>
- Convert the tag contents to lower case.
-
-If 'offset' is specified, start conversion from the specified character, otherwise, start conversion from the first character.
-
-if 'length' is specified, convert only the specified number of characters, otherwise, convert all characters from the start character on.
- </description>
- </functionTag>
- <description>
- Standard utility tags that rewrite their content in a different format.
- </description>
- <emptyTag name="formatNow" class="org.eclipse.jet.internal.taglib.format.FormatNowTag" >
- <attribute name="pattern" use="required">
- <description>The pattern with which to format the current data and time. See documentation for the Java class java.util.SimpleDateFormat for more details.</description>
- </attribute>
- <description>Formats and writes out the current date and time</description>
- </emptyTag>
- <emptyTag name="milliseconds" class="org.eclipse.jet.internal.taglib.format.MillisecondsTag" >
- <description>Writes out a current system milliseconds value.</description>
- </emptyTag>
+ </functionTag>
+
+
+
<emptyTag name="unique" class="org.eclipse.jet.internal.taglib.format.UniqueTag" >
<description>Writes out a unique integer value</description>
</emptyTag>