diff --git a/rse/doc/org.eclipse.dstore.doc.isv/.cvsignore b/rse/doc/org.eclipse.dstore.doc.isv/.cvsignore index 092357e47d3..4ec109d13fd 100755 --- a/rse/doc/org.eclipse.dstore.doc.isv/.cvsignore +++ b/rse/doc/org.eclipse.dstore.doc.isv/.cvsignore @@ -1 +1,6 @@ -bin +bin +index +build.xml +temp.bin.log +temp.options.txt +temp.convert.txt diff --git a/rse/doc/org.eclipse.dstore.doc.isv/aaa-how-to-add-things.txt b/rse/doc/org.eclipse.dstore.doc.isv/aaa-how-to-add-things.txt index aaf41262711..d73e72b8e5c 100755 --- a/rse/doc/org.eclipse.dstore.doc.isv/aaa-how-to-add-things.txt +++ b/rse/doc/org.eclipse.dstore.doc.isv/aaa-how-to-add-things.txt @@ -1,23 +1,29 @@ -Last revised May 31, 2006 -(This file is for information only; it is not included in the release.) - -To add new plug-ins you need to make changes in several places in -this doc plug-in: - -1) options.txt -- the plug-in's source folder(s) must be included on the -sourcepath -- code of required plug-ins must be added on the -classpath (the JAR(s)for non-JARed plug-ins and /@dot for JARed plug-ins -- the API package names must be included in the (alphabetical) package list at the end of the file -- note that the @sep@ token is replaced during build by the appropriate separator character for the build platform. - -2) buildDoc.xml -- add a line in convertSchemaToHtml target to handle a new plug-ins extension point schemas - -Adding new extension points: - -1) reference/extension-points/index.html -- add a line for each extension point - -2) topics_Reference.xml -- add a line for each extension point +Last revised July 27, 2006 +(This file is for information only; it is not included in the release.) + +See also + http://wiki.eclipse.org/index.php/How_to_add_things_to_the_Eclipse_doc +with the following exceptions: +- platformOptions.txt -> options.txt +- overview-platform.html -> /reference/misc/overview-rse.html + +To add new plug-ins you need to make changes in several places in +this doc plug-in: + +1) options.txt +- the plug-in's source folder(s) must be included on the -sourcepath +- code of required plug-ins must be added on the -classpath (the JAR(s)for non-JARed plug-ins and /@dot for JARed plug-ins +- the API package names must be included in the (alphabetical) package list at the end of the file +- note that the @sep@ token is replaced during build by the appropriate separator character for the build platform. + +2) buildDoc.xml +- add a line in convertSchemaToHtml target to handle a new plug-ins extension point schemas + +Adding new extension points: + +1) reference/extension-points/index.html +- add a line for each extension point + +2) topics_Reference.xml +- add a line for each extension point - add a line for each API package \ No newline at end of file diff --git a/rse/doc/org.eclipse.dstore.doc.isv/build.properties b/rse/doc/org.eclipse.dstore.doc.isv/build.properties index f8178df1644..8788dc44d04 100755 --- a/rse/doc/org.eclipse.dstore.doc.isv/build.properties +++ b/rse/doc/org.eclipse.dstore.doc.isv/build.properties @@ -1,21 +1,22 @@ -############################################################################### -# Copyright (c) 2000, 2006 IBM Corporation 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 -# http://www.eclipse.org/legal/epl-v10.html -# -# Contributors: -# IBM Corporation - initial API and implementation -############################################################################### -bin.includes = META-INF/,\ - about.html,\ - book.css,\ - notices.html,\ - plugin.properties,\ - plugin.xml,\ - toc.html,\ - toc.xml,\ - guide/,\ - reference/ -customBuildCallbacks = customBuildCallbacks.xml +############################################################################### +# Copyright (c) 2000, 2006 IBM Corporation 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 +# http://www.eclipse.org/legal/epl-v10.html +# +# Contributors: +# IBM Corporation - initial API and implementation +############################################################################### +bin.includes = META-INF/,\ + about.html,\ + book.css,\ + notices.html,\ + plugin.properties,\ + plugin.xml,\ + toc.html,\ + toc.xml,\ + guide/,\ + index/,\ + reference/ +customBuildCallbacks = customBuildCallbacks.xml diff --git a/rse/doc/org.eclipse.dstore.doc.isv/buildDoc.xml b/rse/doc/org.eclipse.dstore.doc.isv/buildDoc.xml index e99ebdf0196..1a676795247 100755 --- a/rse/doc/org.eclipse.dstore.doc.isv/buildDoc.xml +++ b/rse/doc/org.eclipse.dstore.doc.isv/buildDoc.xml @@ -1,66 +1,131 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/rse/doc/org.eclipse.dstore.doc.isv/options.txt b/rse/doc/org.eclipse.dstore.doc.isv/options.txt index 6381ee059bb..10a15d4846b 100755 --- a/rse/doc/org.eclipse.dstore.doc.isv/options.txt +++ b/rse/doc/org.eclipse.dstore.doc.isv/options.txt @@ -1,21 +1,22 @@ --charset "iso-8859-1" --sourcepath "../org.eclipse.dstore.core/src@sep@../org.eclipse.dstore.extra/src" --d reference/api --classpath @rt@ --breakiterator --use --splitIndex --windowtitle "Remote System Explorer DataStore API Specification" --doctitle "Remote System Explorer DataStore API Specification" --header "Remote System Explorer DataStore
Release 1.0" --bottom '

Guidelines for using DataStore APIs.

' --link http://java.sun.com/j2se/1.4.2/docs/api --linkoffline ../org.eclipse.rse.doc.isv/reference/api .. - -org.eclipse.dstore.core.model -org.eclipse.dstore.core.client -org.eclipse.dstore.core.server -org.eclipse.dstore.core.util -org.eclipse.dstore.core.util.ssl -org.eclipse.dstore.core.java +-charset "iso-8859-1" +-sourcepath "../org.eclipse.dstore.core/src +;../org.eclipse.dstore.extra/src" +-d reference/api +-classpath @rt@ +-breakiterator +-use +-splitIndex +-windowtitle "Remote System Explorer DataStore API Specification" +-doctitle "Remote System Explorer DataStore API Specification" +-header "Remote System Explorer DataStore
Release 1.0" +-bottom '

Guidelines for using DataStore APIs.

' +-link http://java.sun.com/j2se/1.4.2/docs/api +-linkoffline ../org.eclipse.rse.doc.isv/reference/api .. + +org.eclipse.dstore.core.model +org.eclipse.dstore.core.client +org.eclipse.dstore.core.server +org.eclipse.dstore.core.util +org.eclipse.dstore.core.util.ssl +org.eclipse.dstore.core.java org.eclipse.dstore.core.miners.miner \ No newline at end of file diff --git a/rse/doc/org.eclipse.dstore.doc.isv/reference/.cvsignore b/rse/doc/org.eclipse.dstore.doc.isv/reference/.cvsignore new file mode 100644 index 00000000000..eedd89b455e --- /dev/null +++ b/rse/doc/org.eclipse.dstore.doc.isv/reference/.cvsignore @@ -0,0 +1 @@ +api