summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorpelder2007-02-08 10:32:08 (EST)
committerpelder2007-02-08 10:32:08 (EST)
commit99718aa4eff8823a9ba987ccb5a1bdbd0722e6ee (patch)
treef7192d6c150b99924a2fcae51b05f3f26a1da177
parent9600c78b3b917ebe1c9443a80c71b1b2d2d459d9 (diff)
downloadorg.eclipse.jet-99718aa4eff8823a9ba987ccb5a1bdbd0722e6ee.zip
org.eclipse.jet-99718aa4eff8823a9ba987ccb5a1bdbd0722e6ee.tar.gz
org.eclipse.jet-99718aa4eff8823a9ba987ccb5a1bdbd0722e6ee.tar.bz2
[171451] Fix Help TOC, clean-up XHTML docs
-rw-r--r--doc/org.eclipse.jet.doc/gettingStarted/deployingTransforms.xhtml6
-rw-r--r--doc/org.eclipse.jet.doc/gettingStarted/essentialXPath.xhtml12
-rw-r--r--doc/org.eclipse.jet.doc/plugin.xml4
-rw-r--r--doc/org.eclipse.jet.doc/references/extensionpoints/index.xhtml8
-rw-r--r--doc/org.eclipse.jet.doc/references/syntax/implicitJavaObjectsReference.xhtml2
-rw-r--r--doc/org.eclipse.jet.doc/references/taglibs/index.xhtml3
-rw-r--r--doc/org.eclipse.jet.doc/toc.xml6
-rw-r--r--doc/org.eclipse.jet.doc/topics_Reference.xml5
8 files changed, 22 insertions, 24 deletions
diff --git a/doc/org.eclipse.jet.doc/gettingStarted/deployingTransforms.xhtml b/doc/org.eclipse.jet.doc/gettingStarted/deployingTransforms.xhtml
index e7613c6..c6315af 100644
--- a/doc/org.eclipse.jet.doc/gettingStarted/deployingTransforms.xhtml
+++ b/doc/org.eclipse.jet.doc/gettingStarted/deployingTransforms.xhtml
@@ -9,7 +9,7 @@
</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>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
@@ -18,19 +18,23 @@
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
index d761d19..d41430c 100644
--- a/doc/org.eclipse.jet.doc/gettingStarted/essentialXPath.xhtml
+++ b/doc/org.eclipse.jet.doc/gettingStarted/essentialXPath.xhtml
@@ -19,18 +19,17 @@ certainly include XML documents (the X in XPath), it can include many other kind
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>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> Path expressions can also start with a variable, which is a name preceded by a dollar sign ($). </li>
</ul>
-</p>
<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>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>
@@ -38,14 +37,11 @@ JET supports XML documents and any model that is represented by EMF.
<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>
<p>The following tutorials provide a quick introduction to XPath expressions. The first tutorial allows you to
-type expressions, and see their results!
+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>
-
-</p>
</body>
</html>
diff --git a/doc/org.eclipse.jet.doc/plugin.xml b/doc/org.eclipse.jet.doc/plugin.xml
index b986e20..3a49ebc 100644
--- a/doc/org.eclipse.jet.doc/plugin.xml
+++ b/doc/org.eclipse.jet.doc/plugin.xml
@@ -38,7 +38,9 @@
<toc
file="tocExtensionPointiReference.xml"
primary="false"/>
- <toc file="topics_Reference.xml" />
+ <toc
+ file="topics_Reference.xml"
+ primary="false"/>
</extension>
<!-- ============================= -->
diff --git a/doc/org.eclipse.jet.doc/references/extensionpoints/index.xhtml b/doc/org.eclipse.jet.doc/references/extensionpoints/index.xhtml
index 7777cf8..8ac320c 100644
--- a/doc/org.eclipse.jet.doc/references/extensionpoints/index.xhtml
+++ b/doc/org.eclipse.jet.doc/references/extensionpoints/index.xhtml
@@ -11,30 +11,22 @@
<h2>JET Extension points</h2>
<p>The following extension points can be used to extend the capabilities of JET:</p>
<h3>Custom tags and XPath functions</h3>
-<p>
<ul>
<li><a href="org_eclipse_jet_tagLibraries.html">org.eclipse.jet.tagLibraries</a></li>
<li><a href="org_eclipse_jet_xpathFunctions.html">org.eclipse.jet.xpathFunctions</a></li>
</ul>
-</p>
<h3>Provide additional information on a JET transformation</h3>
-<p>
<ul>
<li><a href="org_eclipse_jet_transform.html">org.eclipse.jet.transform</a></li>
</ul>
-</p>
<h3>Add additional models that JET can load and manipulate</h3>
-<p>
<ul>
<li><a href="org_eclipse_jet_modelInspectors.html">org.eclipse.jet.modelInspectors</a></li>
<li><a href="org_eclipse_jet_modelLoaders.html">org.eclipse.jet.modelLoaders</a></li>
</ul>
-</p>
<h3>Deploy JET Transformations in another plug-in</h3>
-<p>
<ul>
<li><a href="org_eclipse_jet_deployedTransforms.html">org.eclipse.jet.deployedTransforms</a></li>
</ul>
-</p>
</body>
</html>
diff --git a/doc/org.eclipse.jet.doc/references/syntax/implicitJavaObjectsReference.xhtml b/doc/org.eclipse.jet.doc/references/syntax/implicitJavaObjectsReference.xhtml
index c9b8845..fb371d4 100644
--- a/doc/org.eclipse.jet.doc/references/syntax/implicitJavaObjectsReference.xhtml
+++ b/doc/org.eclipse.jet.doc/references/syntax/implicitJavaObjectsReference.xhtml
@@ -60,8 +60,6 @@
</table>
- <ul />
-
</body>
</html>
diff --git a/doc/org.eclipse.jet.doc/references/taglibs/index.xhtml b/doc/org.eclipse.jet.doc/references/taglibs/index.xhtml
index 69d9e31..7faf83f 100644
--- a/doc/org.eclipse.jet.doc/references/taglibs/index.xhtml
+++ b/doc/org.eclipse.jet.doc/references/taglibs/index.xhtml
@@ -9,14 +9,11 @@
</head>
<body>
<h2>Tag Library Reference</h2>
-<p>
<ul>
<li> <a href="controlTags/overview.html">org.eclipse.jet.controlTags</a> </li>
<li> <a href="formatTags/overview.html">org.eclipse.jet.formatTags</a> </li>
<li> <a href="javaTags/overview.html">org.eclipse.jet.javaTags</a> </li>
<li> <a href="workspaceTags/overview.html">org.eclipse.jet.workspaceTags</a> </li>
</ul>
-
-</p>
</body>
</html>
diff --git a/doc/org.eclipse.jet.doc/toc.xml b/doc/org.eclipse.jet.doc/toc.xml
index 89883c6..6d26cdf 100644
--- a/doc/org.eclipse.jet.doc/toc.xml
+++ b/doc/org.eclipse.jet.doc/toc.xml
@@ -2,9 +2,11 @@
<?NLS TYPE="org.eclipse.help.toc"?>
<toc label="EMFT JET Developer Guide">
+<!--
<topic label="What's New">
<anchor id="whatsnew"/>
</topic>
+ -->
<topic label="Getting Started" href="gettingStarted/index.xhtml">
<topic label="Create a JET Project" href="gettingStarted/newProject.xhtml"/>
<topic label="JET Transformation Structure" href="gettingStarted/transformStructure.xhtml"/>
@@ -14,9 +16,11 @@
<topic label="Deploy a JET Transformations" href="gettingStarted/deployingTransforms.xhtml"/>
<anchor id="gettingstarted"/>
</topic>
+<!--
<topic label="Concepts">
<anchor id="concepts"/>
</topic>
+ -->
<topic label="Tasks">
<topic label="Using JET Transformations with XML Documents" href="tasks/usingJetWithXML.xhtml"/>
<topic label="Using JET Transformations with EMF Documents" href="tasks/usingJetWithEMF.xhtml"/>
@@ -54,7 +58,7 @@
</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"/>
+<!-- <link toc="topics_Reference.xml"/> -->
<anchor id="reference"/>
</topic>
diff --git a/doc/org.eclipse.jet.doc/topics_Reference.xml b/doc/org.eclipse.jet.doc/topics_Reference.xml
new file mode 100644
index 0000000..a652464
--- /dev/null
+++ b/doc/org.eclipse.jet.doc/topics_Reference.xml
@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?NLS TYPE="org.eclipse.help.toc"?>
+
+<toc label="Javadoc place holder" link_to="toc.xml#reference">
+</toc>