summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorpelder2006-09-19 10:31:18 (EDT)
committer pelder2006-09-19 10:31:18 (EDT)
commitf198ff1c4fe12289a1836794ee3617804ec8be83 (patch)
tree3f3848e9fb7503c7865622bbc3f1ab0abfc5ed13
parent74a775108b034dc8118f1c72e97d4fe71e834394 (diff)
downloadorg.eclipse.jet-f198ff1c4fe12289a1836794ee3617804ec8be83.zip
org.eclipse.jet-f198ff1c4fe12289a1836794ee3617804ec8be83.tar.gz
org.eclipse.jet-f198ff1c4fe12289a1836794ee3617804ec8be83.tar.bz2
[157811] Add additional JET documentation.
-rw-r--r--doc/org.eclipse.jet.doc/gettingStarted/index.xhtml2
-rw-r--r--doc/org.eclipse.jet.doc/references/xpath/predefinedVariables.xhtml162
-rw-r--r--doc/org.eclipse.jet.doc/toc.xml1
3 files changed, 164 insertions, 1 deletions
diff --git a/doc/org.eclipse.jet.doc/gettingStarted/index.xhtml b/doc/org.eclipse.jet.doc/gettingStarted/index.xhtml
index 2a7e046..b4038f2 100644
--- a/doc/org.eclipse.jet.doc/gettingStarted/index.xhtml
+++ b/doc/org.eclipse.jet.doc/gettingStarted/index.xhtml
@@ -17,7 +17,7 @@ template. JET then writes the expanded template to the Eclipse workspace. A coll
understanding the <a href="transformStructure.xhtml">structure of a JET project</a>
and learning the <a href="commonTags.xhtml">most common JET tags</a>.
JET transformations extract information from an input model via XPath expressions. You can learn the basics of XPath
-by reading <a href="essentialXpath.xhtml">Essential XPath</a> </p>
+by reading <a href="essentialXPath.xhtml">Essential XPath</a> </p>
<p>In order to test your JET transformation, see <a href="runningTransforms.xhtml">Running JET Transformations</a></p>
<p>Once completed, you can share your transformation with others. See <a href="deployingTransforms.xhtml">Deploying Transformations</a>.</p>
</body>
diff --git a/doc/org.eclipse.jet.doc/references/xpath/predefinedVariables.xhtml b/doc/org.eclipse.jet.doc/references/xpath/predefinedVariables.xhtml
new file mode 100644
index 0000000..919ccf5
--- /dev/null
+++ b/doc/org.eclipse.jet.doc/references/xpath/predefinedVariables.xhtml
@@ -0,0 +1,162 @@
+<?xml version='1.0'?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+
+ <head>
+
+ <title>Predefined XPath Variables</title>
+
+ <link charset="ISO-8859-1" href="../../book.css" rel="STYLESHEET"
+ type="text/css"/>
+
+ </head>
+
+ <body>
+
+ <h2>Predefined XPath Variables</h2>
+
+ <p>When a JET transformation loads a model from an Eclipse
+ resource, the following XPath variables are set.</p>
+
+ <table border="1">
+
+ <tr>
+
+ <th>Variable</th>
+
+ <th>Contents</th>
+
+ </tr>
+
+ <tr>
+
+ <td>org.eclipse.jet.resource.name</td>
+
+ <td>the name of the loaded resource</td>
+
+ </tr>
+
+ <tr>
+
+ <td>org.eclipse.jet.resource.type</td>
+
+ <td>the resource type (file, folder, project)</td>
+
+ </tr>
+
+ <tr>
+
+ <td>org.eclipse.jet.resource.location</td>
+
+ <td>the resource location (absolute file system path)</td>
+
+ </tr>
+
+ <tr>
+
+ <td>org.eclipse.jet.resource.rawLocation</td>
+
+ <td>the resource raw location. See
+ <a href="PLUGINS_ROOT/org.eclipse.platform.doc.isv/reference/api/org/eclipse/core/resources/IResource.html#getRawLocation()">
+ IResource.getRawLocation()</a>.</td>
+
+ </tr>
+
+ <tr>
+
+ <td>org.eclipse.jet.resource.fullPath</td>
+
+ <td>the Eclipse workspace relative path of the resource.</td>
+
+ </tr>
+
+ <tr>
+
+ <td>org.eclipse.jet.resource.projectRelativePath</td>
+
+ <td>the Eclipse project relative path of the resource.</td>
+
+ </tr>
+
+ <tr>
+
+ <td>org.eclipse.jet.resource.fileExtension</td>
+
+ <td>the resource file extension</td>
+
+ </tr>
+
+ <tr>
+
+ <td>org.eclipse.jet.resource.fileName</td>
+
+ <td>the resource file name (without path).</td>
+
+ </tr>
+
+ </table>
+
+ <p>The following variables are defined if the loaded resource is a
+ file or folder.</p>
+
+ <table border="1">
+
+ <tr>
+
+ <th>Variable</th>
+
+ <th>Contents</th>
+
+ </tr>
+
+ <tr>
+
+ <td>org.eclipse.jet.resource.parent.name</td>
+
+ <td>The resource&apos;s parent name (files and folders
+ only)</td>
+
+ </tr>
+
+ <tr>
+
+ <td>org.eclipse.jet.resource.parent.location</td>
+
+ <td>The resource&apos;s parent location (files and folders
+ only).</td>
+
+ </tr>
+
+ <tr>
+
+ <td>org.eclipse.jet.resource.parent.rawLocation</td>
+
+ <td>the resource&apos;s parent raw location (files and folders
+ only).</td>
+
+ </tr>
+
+ <tr>
+
+ <td>org.eclipse.jet.resource.parent.fullPath</td>
+
+ <td>the resource&apos;s parent full path (files and folders
+ only).</td>
+
+ </tr>
+
+ <tr>
+
+ <td>org.eclipse.jet.resource.parent.projectRelativePath</td>
+
+ <td>the resource&apos;s parent project relative path (files and
+ folders only).</td>
+
+ </tr>
+
+ </table>
+
+ </body>
+
+</html>
+
diff --git a/doc/org.eclipse.jet.doc/toc.xml b/doc/org.eclipse.jet.doc/toc.xml
index d05d62d..89883c6 100644
--- a/doc/org.eclipse.jet.doc/toc.xml
+++ b/doc/org.eclipse.jet.doc/toc.xml
@@ -53,6 +53,7 @@
<anchor id="xpathFunctions"/>
</topic>
<topic label="Ant Tasks Provided by JET" href="references/ant/antTasks.xhtml"/>
+ <topic label="Predefine XPath Variables" href="references/xpath/predefinedVariables.xhtml"/>
<link toc="topics_Reference.xml"/>
<anchor id="reference"/>