summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbkolb2007-09-27 04:19:05 (EDT)
committer bkolb2007-09-27 04:19:05 (EDT)
commit08a6c65e0c3e850156b68ee458388e0bf6e7731e (patch)
tree0059bca3d2fdd87cfc31b2c6150517dc8a75e24d
parent03ded228c3ce3fb113469908e70e364f072ed516 (diff)
downloadorg.eclipse.mwe-08a6c65e0c3e850156b68ee458388e0bf6e7731e.zip
org.eclipse.mwe-08a6c65e0c3e850156b68ee458388e0bf6e7731e.tar.gz
org.eclipse.mwe-08a6c65e0c3e850156b68ee458388e0bf6e7731e.tar.bz2
updated doc
-rw-r--r--doc/org.eclipse.emf.mwe.doc/.classpath6
-rw-r--r--doc/org.eclipse.emf.mwe.doc/.project17
-rw-r--r--doc/org.eclipse.emf.mwe.doc/META-INF/MANIFEST.MF2
-rw-r--r--doc/org.eclipse.emf.mwe.doc/build.properties8
-rw-r--r--doc/org.eclipse.emf.mwe.doc/build.xml95
-rw-r--r--doc/org.eclipse.emf.mwe.doc/build/antJavadoc.sh6
-rw-r--r--doc/org.eclipse.emf.mwe.doc/build/javadoc.xml.template6
-rw-r--r--doc/org.eclipse.emf.mwe.doc/build/overview.html4
-rw-r--r--doc/org.eclipse.emf.mwe.doc/html/toc.html12
-rw-r--r--doc/org.eclipse.emf.mwe.doc/images/placeholder (renamed from doc/org.eclipse.emf.mwe.doc/references/EMPTY_DIR)0
-rw-r--r--doc/org.eclipse.emf.mwe.doc/plugin.properties4
-rw-r--r--doc/org.eclipse.emf.mwe.doc/toc.xml33
-rw-r--r--doc/org.eclipse.emf.mwe.doc/topics_Reference.xml2
-rw-r--r--doc/org.eclipse.emf.mwe.doc/tutorials/placeholder0
14 files changed, 134 insertions, 61 deletions
diff --git a/doc/org.eclipse.emf.mwe.doc/.classpath b/doc/org.eclipse.emf.mwe.doc/.classpath
new file mode 100644
index 0000000..acad1c2
--- /dev/null
+++ b/doc/org.eclipse.emf.mwe.doc/.classpath
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+ <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
+ <classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
+ <classpathentry kind="output" path="bin"/>
+</classpath>
diff --git a/doc/org.eclipse.emf.mwe.doc/.project b/doc/org.eclipse.emf.mwe.doc/.project
index 4bad51f..023182f 100644
--- a/doc/org.eclipse.emf.mwe.doc/.project
+++ b/doc/org.eclipse.emf.mwe.doc/.project
@@ -5,7 +5,24 @@
<projects>
</projects>
<buildSpec>
+ <buildCommand>
+ <name>org.eclipse.jdt.core.javabuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ <buildCommand>
+ <name>org.eclipse.pde.ManifestBuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ <buildCommand>
+ <name>org.eclipse.pde.SchemaBuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
</buildSpec>
<natures>
+ <nature>org.eclipse.pde.PluginNature</nature>
+ <nature>org.eclipse.jdt.core.javanature</nature>
</natures>
</projectDescription>
diff --git a/doc/org.eclipse.emf.mwe.doc/META-INF/MANIFEST.MF b/doc/org.eclipse.emf.mwe.doc/META-INF/MANIFEST.MF
index 6fc00c3..5f4fb56 100644
--- a/doc/org.eclipse.emf.mwe.doc/META-INF/MANIFEST.MF
+++ b/doc/org.eclipse.emf.mwe.doc/META-INF/MANIFEST.MF
@@ -5,6 +5,4 @@ Bundle-SymbolicName: org.eclipse.emf.mwe.doc;singleton:=true
Bundle-Version: 0.7.0.qualifier
Bundle-Vendor: %providerName
Bundle-Localization: plugin
-Bundle-RequiredExecutionEnvironment: J2SE-1.5
-Require-Bundle: org.eclipse.help
Eclipse-LazyStart: true
diff --git a/doc/org.eclipse.emf.mwe.doc/build.properties b/doc/org.eclipse.emf.mwe.doc/build.properties
index 0c5277d..023d2b4 100644
--- a/doc/org.eclipse.emf.mwe.doc/build.properties
+++ b/doc/org.eclipse.emf.mwe.doc/build.properties
@@ -1,6 +1,10 @@
output.. = bin/
custom=true
-bin.includes = plugin.xml,\
+bin.includes = about.html,\
+ about.ini,\
+ about.mappings,\
+ about.properties,\
+ plugin.xml,\
META-INF/,\
*.xml,\
*.zip
@@ -10,4 +14,4 @@ src.includes = toc.xml,\
tocreference.xml,\
tocsamples.xml,\
plugin.xml,\
- META-INF/ \ No newline at end of file
+ META-INF/
diff --git a/doc/org.eclipse.emf.mwe.doc/build.xml b/doc/org.eclipse.emf.mwe.doc/build.xml
index 56515a8..ba775bf 100644
--- a/doc/org.eclipse.emf.mwe.doc/build.xml
+++ b/doc/org.eclipse.emf.mwe.doc/build.xml
@@ -1,37 +1,44 @@
<?xml version="1.0" encoding="UTF-8"?>
<project name="org.eclipse.emf.mwe.doc" default="build.jars" basedir=".">
+
+ <property file="${buildDirectory}/finalPluginsVersions.properties"/>
+ <property name="pluginVersion" value="${org.eclipse.emf.mwe.doc}"/>
- <property name="pluginVersion" value="2.3.0"/>
- <property name="projectName" value="mwe"/>
- <property name="basews" value="${ws}"/>
- <property name="baseos" value="${os}"/>
- <property name="basearch" value="${arch}"/>
- <property name="basenl" value="${nl}"/>
+ <property name="plugin" value="org.eclipse.emf.mwe.core"/>
+ <property name="docPlugin" value="org.eclipse.emf.mwe.doc"/>
+
+ <property name="filesToInclude" value="META-INF/**,about.html,about.ini,about.mappings,about.properties,modeling*.png,plugin.xml,plugin.properties,doc.zip,*.xml,index/**"/>
+ <property name="filesToExclude" value="**/*.dnx"/>
- <!-- Compiler settings -->
+ <!-- Compiler settings. -->
<property name="javacFailOnError" value="false"/>
<property name="javacDebugInfo" value="on"/>
<property name="javacVerbose" value="true"/>
- <property name="compilerArg" value=""/>
<property name="javacSource" value="1.5"/>
<property name="javacTarget" value="1.5"/>
+ <property name="compilerArg" value=""/>
<path id="path_bootclasspath">
<fileset dir="${java.home}/lib">
<include name="*.jar"/>
</fileset>
</path>
<property name="bootclasspath" refid="path_bootclasspath"/>
+
<property name="bundleJavacSource" value="${javacSource}"/>
<property name="bundleJavacTarget" value="${javacTarget}"/>
<property name="bundleBootClasspath" value="${bootclasspath}"/>
+ <property name="basews" value="${ws}"/>
+ <property name="baseos" value="${os}"/>
+ <property name="basearch" value="${arch}"/>
+ <property name="basenl" value="${nl}"/>
<target name="init" depends="properties">
<condition property="pluginTemp" value="${buildTempFolder}/plugins">
<isset property="buildTempFolder"/>
</condition>
<property name="pluginTemp" value="${basedir}"/>
- <condition property="build.result.folder" value="${pluginTemp}/org.eclipse.${projectName}.doc">
+ <condition property="build.result.folder" value="${pluginTemp}/${docPlugin}">
<isset property="buildTempFolder"/>
</condition>
<property name="build.result.folder" value="${basedir}"/>
@@ -41,53 +48,58 @@
<target name="properties" if="eclipse.running">
<property name="build.compiler" value="org.eclipse.jdt.core.JDTCompilerAdapter"/>
+
</target>
- <target name="build.update.jar" depends="init" description="Build the plug-in: org.eclipse.${projectName}.doc for an update site.">
+ <target name="build.update.jar" depends="init" description="Build the plug-in: ${plugin} for an update site.">
<delete dir="${temp.folder}"/>
<mkdir dir="${temp.folder}"/>
<antcall target="build.jars"/>
<antcall target="gather.bin.parts">
<param name="destination.temp.folder" value="${temp.folder}/"/>
</antcall>
- <zip destfile="${plugin.destination}/org.eclipse.${projectName}.doc_${pluginVersion}.${forceContextQualifier}.jar" basedir="${temp.folder}/org.eclipse.${projectName}.doc_${pluginVersion}.${forceContextQualifier}" filesonly="false" whenempty="skip" update="false"/>
+ <zip destfile="${plugin.destination}/${docPlugin}_${pluginVersion}.jar" basedir="${temp.folder}/${docPlugin}_${pluginVersion}" filesonly="false" whenempty="skip" update="false"/>
<delete dir="${temp.folder}"/>
</target>
- <target name="gather.bin.parts" depends="init" if="destination.temp.folder">
- <mkdir dir="${destination.temp.folder}/org.eclipse.${projectName}.doc_${pluginVersion}.${forceContextQualifier}"/>
- <copy todir="${destination.temp.folder}/org.eclipse.${projectName}.doc_${pluginVersion}.${forceContextQualifier}" failonerror="true" overwrite="false">
- <fileset dir="${build.result.folder}"
- includes="about.*,modeling*.png,plugin.*,toc*.xml,topics_*.xml,doc.zip,index/**,META-INF/**"/>
- </copy>
- <eclipse.versionReplacer path="${destination.temp.folder}/org.eclipse.${projectName}.doc_${pluginVersion}.${forceContextQualifier}" version="${pluginVersion}.${forceContextQualifier}"/>
- </target>
-
- <target name="build.jars" depends="init" description="Build all the jars for the plug-in: org.eclipse.${projectName}.doc.">
- <property name="eclipseDir" location="../.."/>
-
- <chmod perm="754" file="build/antJavadoc.sh"/>
- <exec executable="bash" dir="build">
- <arg line="./antJavadoc.sh ${eclipseDir}"/>
- </exec>
-
+ <target name="build.jars" depends="init" description="Build all the jars for the plug-in: ${docPlugin}.">
+ <!-- Execute a shell script that will create an ant javadoc script and then run it for us -->
+ <exec executable="sh">
+ <arg value="build/antJavadoc.sh"/>
+ <arg value="${eclipse.home}/../eclipse"/>
+ </exec>
+ <!--
<antcall target="build.index"/>
-
- <zip destfile="${build.result.folder}/doc.zip" compress="true">
- <zipfileset dir="css" prefix="css"/>
+ -->
+
+ <!-- Zip up all of the documentation artifacts - references(including javadoc), images, tutorials, etc. -->
+ <zip destfile="doc.zip" compress="true">
+ <!-- Add new folders for documentation zip here. -->
+ <zipfileset dir="references" prefix="references" excludes="**/impl,**/impl/**"/>
<zipfileset dir="images" prefix="images"/>
- <zipfileset dir="references" prefix="references"/>
<zipfileset dir="tutorials" prefix="tutorials"/>
+ <zipfileset dir="html" prefix="html"/>
</zip>
</target>
<target name="build.index" depends="init" description="Builds search index for the plug-in" if="eclipse.running">
<help.buildHelpIndex manifest="plugin.xml" destination="."/>
</target>
-
+
<target name="build.sources" depends="init">
</target>
-
+ <target name="gather.bin.parts" depends="init" if="destination.temp.folder">
+ <mkdir dir="${destination.temp.folder}/${docPlugin}_${pluginVersion}"/>
+ <copy todir="${destination.temp.folder}/${docPlugin}_${pluginVersion}" failonerror="true" overwrite="false">
+ <fileset dir="${basedir}"
+ includes="${filesToInclude}"
+ excludes="${filesToExclude}"/>
+ </copy>
+ <eclipse.versionReplacer
+ path="${destination.temp.folder}/${docPlugin}_${pluginVersion}"
+ version="${pluginVersion}"/>
+ </target>
+
<target name="build.zips" depends="init">
</target>
@@ -97,18 +109,13 @@
<target name="gather.logs" depends="init" if="destination.temp.folder">
</target>
- <target name="clean" depends="init" description="Clean the plug-in: org.eclipse.${projectName}.doc of all the zips, jars and logs created.">
- <delete file="${plugin.destination}/org.eclipse.${projectName}.doc_${pluginVersion}.${forceContextQualifier}.jar"/>
- <delete file="${plugin.destination}/org.eclipse.${projectName}.doc_${pluginVersion}.${forceContextQualifier}.zip"/>
+ <target name="clean" depends="init" description="Clean the plug-in: ${docPlugin} of all the zips, jars and logs created.">
+ <delete file="${plugin.destination}/${docPlugin}_${pluginVersion}.jar"/>
+ <delete file="${plugin.destination}/${docPlugin}_${pluginVersion}.zip"/>
<delete dir="${temp.folder}"/>
</target>
- <target name="refresh" depends="init" if="eclipse.running" description="Refresh this folder.">
- <eclipse.convertPath fileSystemPath="D:/eclipse/${projectName}/eclipse/plugins/org.eclipse.${projectName}.doc" property="resourcePath"/>
- <eclipse.refreshLocal resource="${resourcePath}" depth="infinite"/>
- </target>
-
- <target name="zip.plugin" depends="init" description="Create a zip containing all the elements for the plug-in: org.eclipse.${projectName}.doc.">
+ <target name="zip.plugin" depends="init" description="Create a zip containing all the elements for the plug-in: ${docPlugin}.">
<delete dir="${temp.folder}"/>
<mkdir dir="${temp.folder}"/>
<antcall target="build.jars"/>
@@ -122,7 +129,7 @@
<delete>
<fileset dir="${temp.folder}" includes="**/*.bin.log" />
</delete>
- <zip destfile="${plugin.destination}/org.eclipse.${projectName}.doc_${pluginVersion}.${forceContextQualifier}.zip" basedir="${temp.folder}" filesonly="true" whenempty="skip" update="false"/>
+ <zip destfile="${plugin.destination}/${docPlugin}_${pluginVersion}.zip" basedir="${temp.folder}" filesonly="true" whenempty="skip" update="false"/>
<delete dir="${temp.folder}"/>
</target>
diff --git a/doc/org.eclipse.emf.mwe.doc/build/antJavadoc.sh b/doc/org.eclipse.emf.mwe.doc/build/antJavadoc.sh
index 2a0bbe4..6c079ae 100644
--- a/doc/org.eclipse.emf.mwe.doc/build/antJavadoc.sh
+++ b/doc/org.eclipse.emf.mwe.doc/build/antJavadoc.sh
@@ -7,7 +7,7 @@ pluginName="org.eclipse.emf.mwe.core";
# string labels for javadoc content
windowTitle="Modeling Workflow Engine Javadoc";
-groupTitle="Modeling Workflow Engine";
+groupTitle="Modeling Workflow Engine Compare";
# files to exclude from javadoc process - use Ant syntax
javadocExclusions="<exclude name=\"**/internal/**\"/> <exclude name=\"**/examples/**\"/> <exclude name=\"**/tests/**\"/>";
@@ -71,6 +71,8 @@ if [ $debug -gt 0 ]; then
for pluginDir in $pluginDirs; do echo "[antJd] "$pluginDir; done
fi
+### TODO?: missing emf/sdo/xsd plugins in $eclipseDir - need to copy them over or reference source so that all classes/packages (and thus @links) can be resolved
+
# All the jars in the plugins directory
classpath="."`find $eclipseDir/plugins -name "*.jar" -printf ":%p"`; if [ $debug -gt 0 ]; then echo "[antJd] classpath: "$classpath; fi
@@ -128,7 +130,7 @@ rm -f $antScript $antScript.template.tmp $antScript.template.tmp2;
# Generate topics_Reference.xml (replacement for doclet).
trXML=$currentPath"/../topics_Reference.xml";
-echo '<?xml version="1.0" encoding="UTF-8"?>' >> $trXML;
+echo '<?xml version="1.0" encoding="UTF-8"?>' > $trXML;
echo '<?NLS TYPE="org.eclipse.help.toc"?>' >> $trXML;
echo '<toc label="Reference">' >> $trXML;
echo ' <topic label="API Reference" href="references/javadoc/overview-summary.html">' >> $trXML;
diff --git a/doc/org.eclipse.emf.mwe.doc/build/javadoc.xml.template b/doc/org.eclipse.emf.mwe.doc/build/javadoc.xml.template
index 9099dee..6639d2b 100644
--- a/doc/org.eclipse.emf.mwe.doc/build/javadoc.xml.template
+++ b/doc/org.eclipse.emf.mwe.doc/build/javadoc.xml.template
@@ -4,7 +4,7 @@
<property name="classpath" value="bin"/>
<property name="overview" value="build/overview.html"/>
<property name="eclipseDir" value="."/>
- <property name="docjar" value="org.eclipse.platform.doc.isv.jar"/>
+ <property name="docjar" value="org.eclipse.emf.mwe.doc.isv.jar"/>
<!-- other properties that must be passed to this script include:
windowTitle
@@ -39,7 +39,7 @@
overview="${overview}"
windowtitle="${windowTitle}"
- footer="Copyright 2007 IBM Corporation and others.&lt;br&gt; All Rights Reserved."
+ footer="Copyright 2007 openArchitectureWare committers and others.&lt;br&gt; All Rights Reserved."
access="protected"
additionalparam="-breakiterator -tag model:X -tag generated:X -tag ordered:X"
@@ -52,7 +52,7 @@
noindex="false"
nonavbar="false"
notree="false"
- source="1.4"
+ source="1.5"
splitindex="true"
use="true"
version="true">
diff --git a/doc/org.eclipse.emf.mwe.doc/build/overview.html b/doc/org.eclipse.emf.mwe.doc/build/overview.html
index 961a2a9..6ed84fa 100644
--- a/doc/org.eclipse.emf.mwe.doc/build/overview.html
+++ b/doc/org.eclipse.emf.mwe.doc/build/overview.html
@@ -6,7 +6,7 @@
/**
* <copyright>
*
- * Copyright (c) 2007 IBM Corporation and others.
+ * Copyright (c) 2007 openArchitectureWare committers and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -17,7 +17,7 @@
*
* </copyright>
*
- * $Id: overview.html,v 1.1 2007/09/25 19:22:33 bkolb Exp $
+ * $Id: overview.html,v 1.2 2007/09/27 08:23:17 bkolb Exp $
*/
-->
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
diff --git a/doc/org.eclipse.emf.mwe.doc/html/toc.html b/doc/org.eclipse.emf.mwe.doc/html/toc.html
new file mode 100644
index 0000000..b627796
--- /dev/null
+++ b/doc/org.eclipse.emf.mwe.doc/html/toc.html
@@ -0,0 +1,12 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <title>Modeling Workflow Engine - Developer Guide</title>
+</head>
+
+<body>
+<h1>Table of Contents</h1>
+</body>
+</html> \ No newline at end of file
diff --git a/doc/org.eclipse.emf.mwe.doc/references/EMPTY_DIR b/doc/org.eclipse.emf.mwe.doc/images/placeholder
index e69de29..e69de29 100644
--- a/doc/org.eclipse.emf.mwe.doc/references/EMPTY_DIR
+++ b/doc/org.eclipse.emf.mwe.doc/images/placeholder
diff --git a/doc/org.eclipse.emf.mwe.doc/plugin.properties b/doc/org.eclipse.emf.mwe.doc/plugin.properties
index 9aceaae..f2f2a31 100644
--- a/doc/org.eclipse.emf.mwe.doc/plugin.properties
+++ b/doc/org.eclipse.emf.mwe.doc/plugin.properties
@@ -1,4 +1,2 @@
-# NLS_MESSAGEFORMAT_VAR
-pluginName = Modeling Workflow Engine Programmers Guide
providerName=Eclipse.org
-
+pluginName=Modeling Workflow Engine Documentation
diff --git a/doc/org.eclipse.emf.mwe.doc/toc.xml b/doc/org.eclipse.emf.mwe.doc/toc.xml
index 8456be9..427ba8a 100644
--- a/doc/org.eclipse.emf.mwe.doc/toc.xml
+++ b/doc/org.eclipse.emf.mwe.doc/toc.xml
@@ -1,6 +1,35 @@
<?xml version="1.0" encoding="UTF-8"?>
<?NLS TYPE="org.eclipse.help.toc"?>
-<toc label="EMFT MWE Table of Contents">
- <topic label="Javadoc" href="references/javadoc/index.html"/>
+<toc label="EMF Compare Developer Guide">
+ <!--
+ <topic label="Programmer&apos;s Guides">
+ <topic label="EMF Framework Programmer&apos;s Guide" href="references/overview/EMF.html" />
+ <topic label="EMF.Edit Framework Programmer&apos;s Guide" href="references/overview/EMF.Edit.html" />
+ <topic label="EMF Validation Framework Programmer&apos;s Guide" href="references/overview/EMF.Validation.html" />
+ </topic>
+ <topic label="Tutorials">
+ <topic label="Generating an EMF Model" href="tutorials/clibmod/clibmod.html" />
+ <topic label="Generating an Extended EMF Model" href="tutorials/slibmod/slibmod.html" />
+ <topic label="Generating an EMF Model using XML Schema" href="tutorials/xlibmod/xlibmod.html" />
+ <topic label="JET Tutorial Part 1 (Introduction to JET)" href="tutorials/jet1/jet_tutorial1.html" />
+ <topic label="JET Tutorial Part 2 (Write Code that Writes Code)" href="tutorials/jet2/jet_tutorial2.html" />
+ <topic label="Specifying Package Information in Rose" href="tutorials/rosepkg/rosepkg.html" />
+ </topic>
+ <topic label="Online Docs">
+ <topic label="Release Notes">
+ <topic label="What's New in v2.3" href="http://www.eclipse.org/modeling/emf/news/relnotes.php?project=emf&amp;version=2.3" />
+ <topic label="What's New in v2.2" href="http://www.eclipse.org/modeling/emf/news/relnotes.php?project=emf&amp;version=2.2" />
+ <topic label="What's New in v2.1" href="http://www.eclipse.org/modeling/emf/news/relnotes.php?project=emf&amp;version=2.1" />
+ <topic label="What's New in v2.0" href="http://www.eclipse.org/modeling/emf/news/relnotes.php?project=emf&amp;version=2.0" />
+ <topic label="What's New in v1.x" href="http://www.eclipse.org/modeling/emf/emf/news/relnotes1.x.php" />
+ </topic>
+ <topic label="EMF FAQ" href="http://www.eclipse.org/modeling/emf/faq/?project=emf" />
+ </topic>
+ -->
+
+ <topic label="Reference">
+ <link toc="topics_Reference.xml"/>
+ </topic>
</toc>
+
diff --git a/doc/org.eclipse.emf.mwe.doc/topics_Reference.xml b/doc/org.eclipse.emf.mwe.doc/topics_Reference.xml
index 714e7f9..0e1b38e 100644
--- a/doc/org.eclipse.emf.mwe.doc/topics_Reference.xml
+++ b/doc/org.eclipse.emf.mwe.doc/topics_Reference.xml
@@ -1,3 +1,3 @@
<?xml version="1.0" encoding="UTF-8"?>
<span>File created to avoid PDE warnings.
-The actual content is created during the build.</span>
+The actual content is created during the build.</span> \ No newline at end of file
diff --git a/doc/org.eclipse.emf.mwe.doc/tutorials/placeholder b/doc/org.eclipse.emf.mwe.doc/tutorials/placeholder
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/doc/org.eclipse.emf.mwe.doc/tutorials/placeholder