Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorpelder2010-11-02 16:43:58 -0400
committerpelder2010-11-02 16:43:58 -0400
commit4c6c9ff3bb1d821f73ed3c3703c545a99d6c07fc (patch)
tree7b53d650e546f121613c0e080ea89f3789f177b2 /doc/org.eclipse.jet.doc/gettingStarted
parent15ccba1e74a55349bdce44c7e99858795f7925b1 (diff)
downloadorg.eclipse.jet-4c6c9ff3bb1d821f73ed3c3703c545a99d6c07fc.tar.gz
org.eclipse.jet-4c6c9ff3bb1d821f73ed3c3703c545a99d6c07fc.tar.xz
org.eclipse.jet-4c6c9ff3bb1d821f73ed3c3703c545a99d6c07fc.zip
This commit was manufactured by cvs2svn to create tag 'v201011021646'.v201011021646
Diffstat (limited to 'doc/org.eclipse.jet.doc/gettingStarted')
-rw-r--r--doc/org.eclipse.jet.doc/gettingStarted/commonTags.xhtml66
-rw-r--r--doc/org.eclipse.jet.doc/gettingStarted/deployingTransforms.xhtml40
-rw-r--r--doc/org.eclipse.jet.doc/gettingStarted/essentialXPath.xhtml47
-rw-r--r--doc/org.eclipse.jet.doc/gettingStarted/index.xhtml24
-rw-r--r--doc/org.eclipse.jet.doc/gettingStarted/newProject.xhtml24
-rw-r--r--doc/org.eclipse.jet.doc/gettingStarted/runningTransforms.xhtml29
-rw-r--r--doc/org.eclipse.jet.doc/gettingStarted/transformStructure.xhtml34
7 files changed, 0 insertions, 264 deletions
diff --git a/doc/org.eclipse.jet.doc/gettingStarted/commonTags.xhtml b/doc/org.eclipse.jet.doc/gettingStarted/commonTags.xhtml
deleted file mode 100644
index c9e5912..0000000
--- a/doc/org.eclipse.jet.doc/gettingStarted/commonTags.xhtml
+++ /dev/null
@@ -1,66 +0,0 @@
-<?xml version="1.0" encoding="ISO-8859-1" ?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta name="copyright" content="Copyright (c) IBM Corporation and others 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." />
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
-<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css"/>
-<title>Common JET Tags</title>
-</head>
-<body>
-<h2>Common JET Tags</h2>
-<p>JET includes four <b>tag libraries</b>, which are collections of related tags. These are:
-<ul>
- <li> Control tags - used for accessing the input model, and controlling template execution.</li>
- <li> Format tags - used to alter (format) text in templates according to certain rules. </li>
- <li> Java tags - special tags useful to generating Java code.</li>
- <li> Workspace tags - used for creating workspace resources, such as files, folders and projects.</li>
-</ul>
-</p>
-<p>Although there are many tags available, only a few are needed to get started.
-These tags are either control or workspace tags</p>
-<h3>Most common control tags</h3>
-<p>Control tags usually access the input model, and either produce a value, or cause an action based on the information
-extracted from the input model. The control tags access the input model via <b>XPath expressions</b>.
-(See <a href="essentialXPath.xhtml">Essential XPath</a>).
-Three control tags are used frequently:
-<ul>
- <li> <code><a href="../references/taglibs/controlTags/getTag.html">c:get</a></code> - Write a value from the input model into the expanded template.</li>
- <li> <code><a href="../references/taglibs/controlTags/iterateTag.html">c:iterate</a></code> - Traverse elements in the input model and evaluate the contained template text once for each element. </li>
- <li> <code><a href="../references/taglibs/controlTags/setTag.html">c:set</a></code> - create or set an attribute on a model element. This is frequently used to store the result of a calculation. </li>
-</ul>
-
-</p>
-<h3>Most common workspace tags</h3>
-<p>Three workspace tags are used frequently:
-<ul>
- <li> <code><a href="../references/taglibs/workspaceTags/fileTag.html">ws:file</a></code> - Write a workspace file, settings its contents to the result of expanding a template.</li>
- <li> <code><a href="../references/taglibs/workspaceTags/folderTag.html">ws:folder</a></code> - Create a workspace folder. </li>
- <li> <code><a href="../references/taglibs/workspaceTags/projectTag.html">ws:project</a></code> - Create a workspace project. </li>
-</ul>
-</p>
-<h3>Accessing model elements within tag attributes</h3>
-<p>Frequently, templates must use a model value in a tag's attribute. For example, the name of a generated file
-might depend on a value from the input model. To do this, the <code>main.jet</code> template would require a <code>ws:file</code> that looks like:
-<br/><br/>
-<samp>
-&nbsp;&nbsp;&nbsp;&nbsp;&lt;ws:file template="..." path="... value from the model..."/&gt;
-</samp>
-<br/><br/>
-Because JET does not permit one XML tag to be embedded in an attribute value of another, JET provides
-<b>Dynamic XPath Expressions</b>, which can be used only in tag attribute values. The format of a dynamic
-XPath expression is:
-<br/><br/>
-<samp>
-&nbsp;&nbsp;&nbsp;&nbsp;{<i>XPath expression</i>}
-</samp>
-<br/><br/>
-So, the <code>ws:file</code> tag above would be written as:
-<br/><br/>
-<samp>
-&nbsp;&nbsp;&nbsp;&nbsp;&lt;ws:file template="..." path="{<i>XPath expression</i>}"/&gt;
-</samp>
-<br/><br/>
-</p>
-</body>
-</html>
diff --git a/doc/org.eclipse.jet.doc/gettingStarted/deployingTransforms.xhtml b/doc/org.eclipse.jet.doc/gettingStarted/deployingTransforms.xhtml
deleted file mode 100644
index b92802d..0000000
--- a/doc/org.eclipse.jet.doc/gettingStarted/deployingTransforms.xhtml
+++ /dev/null
@@ -1,40 +0,0 @@
-<?xml version="1.0" encoding="ISO-8859-1" ?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta name="copyright" content="Copyright (c) IBM Corporation and others 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." />
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
-<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css"/>
-<title>Deploy a JET Transformations</title>
-</head>
-<body>
-<h2>Deploying JET Transformations</h2>
-<p>Once a JET transformation is complete, it can be shared with other users. There are a number of possibilities:</p>
-<ul>
- <li> Share the JET Project via a Team environment </li>
- <li> <a href="#exportProject">Export the JET Project</a> to a "Deployable JAR", and place it in a common file system location, and have
- others reference that location in the Preferences dialog (Preference category <b>JET Transformations</b>.</li>
- <li> Use the <a href="../references/extensionpoints/org_eclipse_jet_deployedTransforms.html">org.eclipse.jet.deployedTransforms</a>
- extension point to share an exported JET Project via a standard Eclipse plug-in.</li>
- <li> Include the JET Project in an Eclipse Feature. (JET Projects are Eclipse plug-ins.)</li>
-</ul>
-<p>
-The latter two options require some knowledge of the Eclipse Plug-in Development Environment (PDE).
-</p>
-<h3>Exporting a JET Project a Deployable JAR</h3>
-<p>
-Creating deployable JET transformations makes use of the Eclipse PDE Deployable plug-ins export wizard:
-</p>
-<ul>
- <li> Right-click over the JET project, and choose <b>Export...</b>. </li>
- <li> Select <b>Plug-in Development -&gt; Deployable plug-ins and fragments</b>, and click <b>Next</b>. </li>
- <li> Click <b>Browse...</b> to select the directory to contain the exported JAR file.</li>
- <li> Click <b>Finish</b>.</li>
-</ul>
-<p>
-The JAR file will be exported to a subdirectory called <code>plugins</code>. The JAR file itself will be of the form:
-<br/><br/>
-&nbsp;&nbsp;&nbsp;&nbsp;<code><i>id</i>_<i>version</i>.jar</code>.
-</p>
-</body>
-</html>
diff --git a/doc/org.eclipse.jet.doc/gettingStarted/essentialXPath.xhtml b/doc/org.eclipse.jet.doc/gettingStarted/essentialXPath.xhtml
deleted file mode 100644
index d41430c..0000000
--- a/doc/org.eclipse.jet.doc/gettingStarted/essentialXPath.xhtml
+++ /dev/null
@@ -1,47 +0,0 @@
-<?xml version="1.0" encoding="ISO-8859-1" ?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta name="copyright" content="Copyright (c) IBM Corporation and others 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." />
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
-<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css"/>
-<title>Essential XPath</title>
-</head>
-<body>
-<h2>Essential XPath</h2>
-<p>
-JET implements the <a href="http://www.w3.org/TR/xpath">W3C XPath 1.0 Specification</a>, with a few minor exceptions.
-Although the XPath language is rich, there are only a small part of the XPath language that is required to use most
-JET tags.
-</p>
-<p>XPath (and JET) assumes that it is working on a model that has a tree structure. While this
-certainly include XML documents (the X in XPath), it can include many other kinds of models as well. Out of the box,
-JET supports XML documents and any model that is represented by EMF.
-(See <a href="http://www.eclipse.org/emf">Eclipse Modeling Framework</a>).
-</p>
-<p>A major element of XPath is the <b>path expression</b>. These are similar to file system paths. </p>
-<ul>
- <li> An path is a series of <b>steps</b> separated by forward slashes (/).</li>
- <li> The steps are evaluated from left to right, and generally decend the model's tree as they do so. </li>
- <li> Each step generally identifies tree nodes by their name (although other possibilities exist).</li>
- <li> Steps may have an optional filter condition which is written in square brackets ([ and ]) at the end of the step.</li>
- <li> An initial slash (/) indicates an expression starts at the root of the model tree.</li>
- <li> Path expressions can also start with a variable, which is a name preceded by a dollar sign ($). </li>
-</ul>
-<p>XPath also supports general mathematical, boolean and comparison expressions as well as function calls.</p>
-<p>JET tags that use XPath expressions have common characteristics:</p>
-<ul>
- <li>Variables are defined by several JET tags - look for a <code>var</code> attribute. They may also be defined by
- the <code><a href="../references/taglibs/controlTags/setVariableTag.html">c:setVariable</a></code> tag.</li>
- <li> JET tags requiring a path expresion have a <code>select</code> attribute.</li>
- <li> JET tags requiring a boolean expression have a <code>test</code>.</li>
- <li> Any tag attribute may include a dynamic XPath expression - an XPath expression surrounded by braces ({ and }).</li>
-</ul>
-<p>The following tutorials provide a quick introduction to XPath expressions. The first tutorial allows you to
-type expressions, and see their results!</p>
-<ul>
- <li> <a href="http://www.zvon.org/xxl/XPathTutorial/General/examples.html">http://www.zvon.org/xxl/XPathTutorial/General/examples.html</a> </li>
- <li> <a href="http://www.w3schools.com/xpath/xpath_intro.asp">http://www.w3schools.com/xpath/xpath_intro.asp</a> </li>
-</ul>
-</body>
-</html>
diff --git a/doc/org.eclipse.jet.doc/gettingStarted/index.xhtml b/doc/org.eclipse.jet.doc/gettingStarted/index.xhtml
deleted file mode 100644
index b4038f2..0000000
--- a/doc/org.eclipse.jet.doc/gettingStarted/index.xhtml
+++ /dev/null
@@ -1,24 +0,0 @@
-<?xml version="1.0" encoding="ISO-8859-1" ?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta name="copyright" content="Copyright (c) IBM Corporation and others 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." />
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
-<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css"/>
-<title>Getting Started</title>
-</head>
-<body>
-<h2>Getting Started</h2>
-<p>JET is a tool for generating one or more files from a model using <b>templates</b>. Templates are a mixture of
-text and JET commands (know as <b>tags</b>). The tags extract information from a model, and place it into the expanded
-template. JET then writes the expanded template to the Eclipse workspace. A collection of JET templates is called a
-<b>transformation</b>. Each transformation is created as a separate JET project.</p>
-<p>You can start learning JET by <a href="newProject.xhtml">creating a JET project</a>,
-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>
-<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>
-</html>
diff --git a/doc/org.eclipse.jet.doc/gettingStarted/newProject.xhtml b/doc/org.eclipse.jet.doc/gettingStarted/newProject.xhtml
deleted file mode 100644
index 86197f0..0000000
--- a/doc/org.eclipse.jet.doc/gettingStarted/newProject.xhtml
+++ /dev/null
@@ -1,24 +0,0 @@
-<?xml version="1.0" encoding="ISO-8859-1" ?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta name="copyright" content="Copyright (c) IBM Corporation and others 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." />
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
-<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css"/>
-<title>Create a JET Project</title>
-</head>
-<body>
-<h2>Create a JET Project</h2>
-<p>JET Transformations are created with a New Project Wizard.
-<ul>
-<li>From the menu, choose <b>File -&gt; New -&gt; Project...</b></li>
-<li>Choose the wizard <b>JET Transformations -&gt; JET Transformation Project</b></li>
-<li>Click <b>Next</b></li>
-<li>Supply a project name. The name should be a letter follows by letters, numbers, hyphens and dots.</li>
-<li>Click <b>Finish</b></li>
-</ul>
-</p>
-<p>To learn more about the newly created project, see <a href="transformStructure.xhtml">JET Transformation Structure</a>.</p>
-<p>To run the new transformation, see <a href="runningTransforms.xhtml">Run a JET Transformation</a>.</p>
-</body>
-</html> \ No newline at end of file
diff --git a/doc/org.eclipse.jet.doc/gettingStarted/runningTransforms.xhtml b/doc/org.eclipse.jet.doc/gettingStarted/runningTransforms.xhtml
deleted file mode 100644
index 480b8b1..0000000
--- a/doc/org.eclipse.jet.doc/gettingStarted/runningTransforms.xhtml
+++ /dev/null
@@ -1,29 +0,0 @@
-<?xml version="1.0" encoding="ISO-8859-1" ?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta name="copyright" content="Copyright (c) IBM Corporation and others 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." />
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
-<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css"/>
-<title>Run a JET Transformation</title>
-</head>
-<body>
-<h2>Run a JET Transformation</h2>
-<p>JET Transformations can be run via the Eclipse Run menue:
-<ul>
- <li> Select <b>Run -&gt; Run...</b> from the menu. </li>
- <li> Provide a name for the configuration (so you can re-run it quickly). </li>
- <li> Select the <b>JET Transformation</b> category, and then click 'New' button. </li>
- <li> Browse for the input file, and select the desired transformation from the <b>ID</b> drop down.</li>
- <li> Click <b>Run</b>.</li>
-</ul>
-The transformation will execute, and produce some output in a console view.
-</p>
-<p>For XML documents in a transformation project, there is a launch short cut that lets you configure a JET transformation quickly:
-<ul>
- <li> Right click over the document, and choose <b>Run As-&gt;Input for JET Transformation</b> </li>
-</ul>
-This will create a run configuration (if necessary), and then launch it.
-</p>
-</body>
-</html>
diff --git a/doc/org.eclipse.jet.doc/gettingStarted/transformStructure.xhtml b/doc/org.eclipse.jet.doc/gettingStarted/transformStructure.xhtml
deleted file mode 100644
index 0bb381b..0000000
--- a/doc/org.eclipse.jet.doc/gettingStarted/transformStructure.xhtml
+++ /dev/null
@@ -1,34 +0,0 @@
-<?xml version="1.0" encoding="ISO-8859-1" ?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta name="copyright" content="Copyright (c) IBM Corporation and others 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." />
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
-<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css"/>
-<title>JET Transformation Project Structure</title>
-</head>
-<body>
-<h2>JET Transformation Project Structure</h2>
-<p>The new transformation includes two templates, in a directory called <code>templates</code>:
-<ul>
- <li> <code>main.jet</code> - which serves an entry point to the transformation, and generally invokes one
- or more templates that write content.</li>
- <li> <code>dump.jet</code> - which merely writes the input model to a file <code>dump.xml</code> in the
- JET project's root. The dump.jet template is invoked by <code>main.jet</code>.</li>
-</ul>
-</p>
-<p>Other files found in the project are:
-<ul>
- <li> <code>META-INF/MANIFEST.MF</code> - the project 'manifest', which declares unique identifier of the
- transformation (which, by default, is the project name, too). </li>
- <li> <code>build.properties</code> - a text file that defines information for correctly building a
- distributable version of the transformation.</li>
- <li> <code>plugin.xml</code> - a supplement to MANIFEST.MF, which declares additional information about the
- transformation.</li>
- <li> <code>sample.xml</code> - an XML document that can be used as test input to the transformation.</li>
-</ul>
-</p>
-<p>JET Templates are automatically compiled into Java classes. By default, these are hidden from view by
-a Package Explorer filter.</p>
-</body>
-</html>

Back to the top