Author: linus
Date: 2008-02-26 01:16:03-0800
New Revision: 14156
Added:
trunk/documentation/Documentation defaulthtml.launch
trunk/documentation/Documentation pdf.launch
trunk/documentation/eclipse-ant-documentation.properties (contents, props
changed)
Removed:
trunk/documentation/build2.bat
trunk/documentation/build2.sh
Modified:
trunk/documentation/ (props changed)
trunk/documentation/Readme.txt
Log:
Made it possible to build the documentation from within Eclipse (again).
The two configurations are for building defaulthtml and pdf.
There is still a bug on my system that the directory ${argouml.eclipse.root} is
created by mkdir in ant. I don't understand why this variable is sometimes
expanded and sometimes not.
Added: trunk/documentation/Documentation defaulthtml.launch
Url:
http://argouml.tigris.org/source/browse/argouml/trunk/documentation/Documentation%20defaulthtml.launch?view=auto&rev=14156
==============================================================================
--- (empty file)
+++ trunk/documentation/Documentation defaulthtml.launch 2008-02-26
01:16:03-0800
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<launchConfiguration type="org.eclipse.ant.AntLaunchConfigurationType">
+<stringAttribute key="org.eclipse.ant.ui.ATTR_BUILD_SCOPE" value="${none}"/>
+<booleanAttribute key="org.eclipse.ant.ui.DEFAULT_VM_INSTALL" value="true"/>
+<stringAttribute key="org.eclipse.debug.core.ATTR_REFRESH_SCOPE"
value="${working_set:<?xml version="1.0"
encoding="UTF-8"?> <launchConfigurationWorkingSet
editPageId="org.eclipse.ui.resourceWorkingSetPage"
factoryID="org.eclipse.ui.internal.WorkingSetFactory"
label="working set" name="working
set"> <item
factoryID="org.eclipse.ui.internal.model.ResourceFactory"
path="/argouml-documentation"
type="4"/> </launchConfigurationWorkingSet>}"/>
+<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
+<listEntry value="/argouml-documentation/build.xml"/>
+</listAttribute>
+<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
+<listEntry value="1"/>
+</listAttribute>
+<booleanAttribute key="org.eclipse.debug.core.appendEnvironmentVariables"
value="true"/>
+<stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER"
value="org.eclipse.ant.ui.AntClasspathProvider"/>
+<stringAttribute key="org.eclipse.jdt.launching.MAIN_TYPE"
value="org.eclipse.ant.internal.ui.antsupport.InternalAntRunner"/>
+<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR"
value="argouml-documentation"/>
+<stringAttribute key="org.eclipse.jdt.launching.SOURCE_PATH_PROVIDER"
value="org.eclipse.ant.ui.AntClasspathProvider"/>
+<stringAttribute key="org.eclipse.jdt.launching.VM_INSTALL_NAME"
value="jre1.5.0_05"/>
+<stringAttribute key="org.eclipse.jdt.launching.VM_INSTALL_TYPE_ID"
value="org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType"/>
+<mapAttribute key="org.eclipse.ui.externaltools.ATTR_ANT_PROPERTIES">
+<mapEntry key="eclipse.pdebuild.scripts" value="/C:/Program
Files/Eclipse/eclipse33/eclipse/plugins/org.eclipse.pde.build_3.3.0.v20070612/scripts/"/>
+<mapEntry key="eclipse.pdebuild.templates" value="/C:/Program
Files/Eclipse/eclipse33/eclipse/plugins/org.eclipse.pde.build_3.3.0.v20070612/templates/"/>
+<mapEntry key="argouml.eclipse.root" value="${workspace_loc}"/>
+<mapEntry key="eclipse.pdebuild.home" value="/C:/Program
Files/Eclipse/eclipse33/eclipse/plugins/org.eclipse.pde.build_3.3.0.v20070612/./"/>
+</mapAttribute>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_ANT_PROPERTY_FILES"
value="${workspace_loc:/argouml-documentation/eclipse-ant-documentation.properties},"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_ANT_TARGETS"
value="docbook-xsl-get,defaulthtml,"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION"
value="${workspace_loc:/argouml-documentation/build.xml}"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_WORKING_DIRECTORY"
value="${workspace_loc:/argouml-documentation}"/>
+<stringAttribute key="process_factory_id"
value="org.eclipse.ant.ui.remoteAntProcessFactory"/>
+</launchConfiguration>
Added: trunk/documentation/Documentation pdf.launch
Url:
http://argouml.tigris.org/source/browse/argouml/trunk/documentation/Documentation%20pdf.launch?view=auto&rev=14156
==============================================================================
--- (empty file)
+++ trunk/documentation/Documentation pdf.launch 2008-02-26 01:16:03-0800
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<launchConfiguration type="org.eclipse.ant.AntLaunchConfigurationType">
+<stringAttribute key="org.eclipse.ant.ui.ATTR_BUILD_SCOPE" value="${none}"/>
+<booleanAttribute key="org.eclipse.ant.ui.DEFAULT_VM_INSTALL" value="true"/>
+<stringAttribute key="org.eclipse.debug.core.ATTR_REFRESH_SCOPE"
value="${working_set:<?xml version="1.0"
encoding="UTF-8"?> <launchConfigurationWorkingSet
editPageId="org.eclipse.ui.resourceWorkingSetPage"
factoryID="org.eclipse.ui.internal.WorkingSetFactory"
label="working set" name="working
set"> <item
factoryID="org.eclipse.ui.internal.model.ResourceFactory"
path="/argouml-documentation"
type="4"/> </launchConfigurationWorkingSet>}"/>
+<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
+<listEntry value="/argouml-documentation/build.xml"/>
+</listAttribute>
+<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
+<listEntry value="1"/>
+</listAttribute>
+<booleanAttribute key="org.eclipse.debug.core.appendEnvironmentVariables"
value="true"/>
+<stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER"
value="org.eclipse.ant.ui.AntClasspathProvider"/>
+<stringAttribute key="org.eclipse.jdt.launching.MAIN_TYPE"
value="org.eclipse.ant.internal.ui.antsupport.InternalAntRunner"/>
+<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR"
value="argouml-documentation"/>
+<stringAttribute key="org.eclipse.jdt.launching.SOURCE_PATH_PROVIDER"
value="org.eclipse.ant.ui.AntClasspathProvider"/>
+<stringAttribute key="org.eclipse.jdt.launching.VM_INSTALL_NAME"
value="jre1.5.0_05"/>
+<stringAttribute key="org.eclipse.jdt.launching.VM_INSTALL_TYPE_ID"
value="org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType"/>
+<mapAttribute key="org.eclipse.ui.externaltools.ATTR_ANT_PROPERTIES">
+<mapEntry key="eclipse.pdebuild.scripts" value="/C:/Program
Files/Eclipse/eclipse33/eclipse/plugins/org.eclipse.pde.build_3.3.0.v20070612/scripts/"/>
+<mapEntry key="argouml.eclipse.root" value="${workspace_loc}"/>
+<mapEntry key="eclipse.pdebuild.templates" value="/C:/Program
Files/Eclipse/eclipse33/eclipse/plugins/org.eclipse.pde.build_3.3.0.v20070612/templates/"/>
+<mapEntry key="eclipse.pdebuild.home" value="/C:/Program
Files/Eclipse/eclipse33/eclipse/plugins/org.eclipse.pde.build_3.3.0.v20070612/./"/>
+</mapAttribute>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_ANT_PROPERTY_FILES"
value="${workspace_loc:/argouml-documentation/eclipse-ant-documentation.properties},"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_ANT_TARGETS"
value="docbook-xsl-get,pdf,"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION"
value="${workspace_loc:/argouml-documentation/build.xml}"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_WORKING_DIRECTORY"
value="${workspace_loc:/argouml-documentation}"/>
+<stringAttribute key="process_factory_id"
value="org.eclipse.ant.ui.remoteAntProcessFactory"/>
+</launchConfiguration>
Modified: trunk/documentation/Readme.txt
Url:
http://argouml.tigris.org/source/browse/argouml/trunk/documentation/Readme.txt?view=diff&rev=14156&p1=trunk/documentation/Readme.txt&p2=trunk/documentation/Readme.txt&r1=14155&r2=14156
==============================================================================
--- trunk/documentation/Readme.txt (original)
+++ trunk/documentation/Readme.txt 2008-02-26 01:16:03-0800
@@ -10,7 +10,8 @@
This README file should be located in the root directory of the ArgoUML
documentation directory structure. If you are using an Eclipse project
based directory structure, the documentation root is named
-'argouml-documentation' and is at the same level as the argouml directory.
+'argouml-documentation' and is at the same level as the other subsystem
+directories (argouml-core-model, argouml-core-infra, argouml-app, ...).
If you checked out the sources as a single tree for use with Ant from the
command line, the documentation is a subdirectory of the root argouml
directory.
@@ -20,13 +21,13 @@
Eclipse
-------
-argouml <<-- ArgoUML root directory (aka ARGO_HOME)
-argouml-documentation <<-- documentation root directory (aka ARGODOCS_HOME)
+argouml-core-tools <<-- ArgoUML tools directory (checked out from
trunk/tools)
+argouml-documentation <<-- documentation root directory (checked out from
trunk/documentation)
Traditional Ant command line
----------------------------
-argouml <<-- ArgoUML root directory (aka ARGO_HOME)
- documentation <<-- documentation root directory (aka ARGODOCS_HOME)
+argouml <<-- ArgoUML root directory (checked out from trunk)
+ documentation <<-- documentation root directory (checked out from
trunk/documentation)
The ArgoUML directory structure, with explanation of the parts of the
@@ -35,20 +36,11 @@
ARGODOCS_HOME
cookbook <<-- DocBook XML source for developers' cookbook
docbook-setup <<-- DTD, XSL stylesheets and customisation XSL
- docbookx <<-- DocBook XML DTD v4.1.2
- faq <<-- DocBook XML source for the FAQ (moved to html)
- images <<-- images referenced throughout the documentation
- callouts <<-- callout images
- cookbook <<-- images specific to the cookbook
- navigation <<-- images relating to navigation
- reference <<-- images specific to the user manual reference part
- screenshots <<-- screenshots
- tutorial <<-- images specific to the user manual tutorial part
manual <<-- DocBook XML source for the User Manual
quick-guide <<-- DocBook XML source for the Quick Guide
-In addition to this README file, ARGODOCS_HOME should contain at least the
+In addition to this README file, ARGODOCS_HOME contains the
following files:
- build.xml (an Ant build script file)
@@ -56,89 +48,12 @@
the Ant/command line directory structure).
- build.sh (a Linux/Unix shell script file to start the build process when
using the Ant/command line directory structure).
-- build2.bat (a Windows batch file to start the build process when using
- the Eclipse project directory structure).
-- build2.sh (a Linux/Unix shell script file to start the build process when
- using the Eclipse project directory structure).
- default.properties - properties controlling the build process
+- *.launch, eclipse-ant-documentation.properties - Launch configurations
+ and special property file to build within Eclipse.
-2. BUILDING ARGOUML DOCUMENTATION
-The project web site contains the latest stable versions of all the
-documentation in chunked HTML form, and sometimes a snapshot of the most recent
-interim build as a single HTML file.
-
-The ArgoUML source contains almost everything you need to build the
-documentation for yourself as single file HTML, chunked HTML, or PDF.
-
-You need only to provide the following:
-- Java Development Kit v1.5 or later (i.e. JDK1.5 or later).
-- Jimi 1.0 if you wish to produce your own PDF (more on this below).
-
-Get a DOS console and type java. You should see a list of java options appear.
-If not, go get Java from sun.com
-
-1. Open a command prompt (Windows) or terminal window (Linux/Unix)
-
-2. Ensure that the ARGODOCS_HOME directory is your current directory (see
- diagram above for ARGODOCS_HOME)
-
-3. Type one of the following and press the ENTER or RETURN key:
-
- build (on Windows using the command line Ant directory structure)
-
- ./build.sh (on Unix/Linux using the command line Ant directory structure)
-
- build2 (on Windows using the Eclipse project directory structure)
-
- ./build2.sh (on Unix/Linux using the Eclipse project directory structure)
-
-4. This executes the default target in the build file, which is:
-
- build defaulthtml -- builds the documentation in HTML format chunked
- into mutiple pages for online usage.
-
- NOTE: the first execution of the build will need to fetch from the
internet
- a set of files needed for the processing of the docbook files. This is the
- target docbook-xsl-get. So, you must be online to be able to get this, at
- least the first time. If you must use a proxy to access the internet, then
- either you need to change the build file using Ant's setproxy task or get
- it manually (the URL is in the file default.properties).
-
-The resulting documentation files are written into the
-./build/documentation directory.
-
-For example here is the file tree after 'build docs'
-
-
- build
- documentation
- defaulthtml
- cookbook
- images
- manual
- images
- quick-guide
- images
- javahelp
- pdf
- cookbook
- manual
- quick-guide
- printablehtml
- cookbook
- images
- manual
- images
- quick-guide
- images
-
-
-If you have any problems, you can get assistance from the ArgoUML developers'
-mailing list, at http://argouml.tigris.org/
-
-
-3. PROBLEMS WITH PDF
+2. BUILDING PDF
The documentation uses Fop (part of the Apache/XML project) to generate the
PDF. Fop relies on Sun's Jimi 1.0 library to process images in PNG format,
@@ -166,8 +81,9 @@
4. CONTRIBUTING
-If you wish to contribute to an existing manual, please read all the
-documents in the ARGO_DOCS directory, ...there's a lot of material.
+If you wish to contribute to an existing manual, please read the Cookbook
+on how to work with the documentation and contact the editor to discuss
+your contributions. You are most welcome!
Have fun!
Removed: trunk/documentation/build2.bat
Url:
http://argouml.tigris.org/source/browse/argouml/trunk/documentation/build2.bat?view=auto&rev=14155
Removed: trunk/documentation/build2.sh
Url:
http://argouml.tigris.org/source/browse/argouml/trunk/documentation/build2.sh?view=auto&rev=14155
Added: trunk/documentation/eclipse-ant-documentation.properties
Url:
http://argouml.tigris.org/source/browse/argouml/trunk/documentation/eclipse-ant-documentation.properties?view=auto&rev=14156
==============================================================================
--- (empty file)
+++ trunk/documentation/eclipse-ant-documentation.properties 2008-02-26
01:16:03-0800
@@ -0,0 +1,17 @@
+# $Id$
+#
+# This is a file with ant properties used when building
+# the documentation from within Eclipse.
+#
+# The reason for the argouml.eclipse.root variable is just that Linus Tolke
+# didn't manage to get the eclipse expansions to work in this file.
+# Otherwise it would have been ${workspace_loc} or ${project_loc}.
+#
+argo.build.dir=${argouml.eclipse.root}/argouml-documentation/build
+argo.tools.lib=${argouml.eclipse.root}/argouml-core-tools/lib
+
+argo.tools.dir=${argouml.eclipse.root}/argouml-core-tools
+
+
+
+
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
