Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
RE: [platform-ua-dev] pre-building the eclipse help index errors:[help.buildHelpIndex]Locale 'en_US': cannot find document: guide/pde_schema_editor.htm, etc

Hello David,

I can't debug what's going on from your output, but I can tell you
what's
worked for me. I'm using Eclipse 3.3, which may or may not matter...

I inherited a 100-line Windows batch script that launches Ant builds
from 
the command line. It does this by finding the equinox launcher and
building
up a command to call the antRunner class with the appropriate options.
(Many of the options set in the script are just set to default values; I
suspect you could just leave the flags off and everything would be
okay.)

Anyway, the text of the batch script is included below. Pretty easy to 
rewrite as a shell script, I think. I use the script at the end of an
automated build process (WebWorks) by calling it with the name of the
plugin directory, like so:

  indexbuild.bat -plugindir name.of.plugin.directory

I have the indexbuild.bat file sitting in the same directory as the
plugin directory.

Each plugin has a build.xml file that looks like this:

<project name="$IDL_HelpPluginName;" default="build.index"  basedir="."
> 
   <target name="build.index" if="eclipse.running">
      <eclipse.refreshLocal resource="\${basedir}" depth="infinite" />
      <help.buildHelpIndex manifest="\${basedir}/plugin.xml"
destination="\${basedir}"/> 
   </target> 
</project> 

(where "$IDL_HelpPluginName;" is replaced by the actual name of the
plugin).

I think that's everything. I'm a bit out of my depth here, but I *was*
able
to get the index build process automated.

Best of luck,
Doug

------------------------------------------------------------------------
--------
contents of indexbuild.bat Windows batch file
------------------------------------------------------------------------
--------
@echo off
REM This batch file calls ANT on an Eclipse project to build the
REM documentation plugin's full-text search index.
REM
REM syntax:
REM
REM    indexbuild -plugdir com.rsi.idl.doc.test
REM
REM where the plugin directory is located relative to this
REM batch file.
REM

REM Specify path to Java executable
set vm=c:\\Java\\jre1.5.0_12\\bin\\java.exe

REM specify default plugin directory (this parameter is
REM usually supplied at the command line)
set plugdir=com.rsi.idl.doc.test

REM reset list of ant targets in test.xml to execute
set jobs=build.index

REM default switch to determine if eclipse should be reinstalled
REM between running of jobs
set installmode=clean

REM property file to pass to Ant scripts
set properties=

REM default values for os, ws and arch
set os=win32
set ws=win32
set arch=x86

REM The default location for the XML and HTML result files
set resultsDir=results

REM reset ant command line args
set ANT_CMD_LINE_ARGS=

REM set path to eclipse folder. If local folder, use '.';
REM otherwise, use c:\path\to\eclipse
REM set ECLIPSEHOME=.
set ECLIPSEHOME=c:\eclipse_3.3
 
REM get path to equinox jar inside ECLIPSEHOME folder
for /f "delims= tokens=1" %%c in ('dir /b
%ECLIPSEHOME%\plugins\org.eclipse.equinox.launcher_*') do set
EQUINOXJAR=%ECLIPSEHOME%\plugins\%%c 

:processcmdlineargs

REM ****************************************************************
REM
REM Process command line arguments
REM
REM ****************************************************************

if x%1==x goto run
if x%1==x-plugdir set plugdir=%2 && shift && shift && goto
processcmdlineargs
if x%1==x-ws set ws=%2 && shift && shift && goto processcmdlineargs
if x%1==x-os set os=%2 && shift && shift && goto processcmdlineargs
if x%1==x-arch set arch=%2 && shift && shift && goto processcmdlineargs
if x%1==x-resultsDir set resultsDir=%2 && shift && shift && goto
processcmdlineargs
if x%1==x-noclean set installmode=noclean&& shift && goto
processcmdlineargs
if x%1==x-properties set properties=-propertyfile %2 && shift && shift
&& goto processcmdlineargs
if x%1==x-vm set vm=%2 && shift && shift && goto processcmdlineargs

set jobs=%jobs% %1 && shift && goto processcmdlineargs


:run
REM
************************************************************************
***
REM	Run jobs by running Ant in Eclipse on the test.xml script
REM
************************************************************************
***
::echo plugdir is "%plugdir%"
::echo "%plugdir:~-1%"
REM If we got the plugdir from the command line, we need to strip
REM off a trailing space.
if "%plugdir:~-1%"==" " (set plugdir=%plugdir:~0,-1%)

set buildfile=%plugdir%\build.xml
::echo buildfile is %buildfile%

REM Remove any existing index files
del /q %plugdir%\index\*
del /q %plugdir%\index\*.*

REM Launch Eclipse and call antRunner to build the index
%vm% -cp "%EQUINOXJAR%" ^
-Dosgi.ws=%ws% ^
-Dosgi.os=%os% ^
-Dosgi.arch=%arch% ^
org.eclipse.equinox.launcher.Main -data workspace ^
-application org.eclipse.ant.core.antRunner -file %buildfile% %jobs% ^
-DresultsDir=%resultsDir% ^
-Dws=%ws% ^
-Dos=%os% ^
-Darch=%arch% ^
-Dplatform=%ws%.%os%.%arch% %properties%  ^
-D%installmode%=true ^
-logger org.apache.tools.ant.DefaultLogger
goto end

:end
------------------------------------------------------------------------
--------



|| -----Original Message-----
|| From: platform-ua-dev-bounces@xxxxxxxxxxx 
|| [mailto:platform-ua-dev-bounces@xxxxxxxxxxx] On Behalf Of 
|| David Cramer
|| Sent: Tuesday, October 30, 2007 1:44 PM
|| To: platform-ua-dev@xxxxxxxxxxx
|| Subject: [platform-ua-dev] pre-building the eclipse help 
|| index errors:[help.buildHelpIndex]Locale 'en_US': cannot 
|| find document: guide/pde_schema_editor.htm, etc
|| 
|| I've studied these posts on this list and am also trying to 
|| pre-build the search indexes for my doc plugins:
|| 
|| http://dev.eclipse.org/mhonarc/lists/platform-ua-dev/msg00132.html
|| http://dev.eclipse.org/mhonarc/lists/platform-ua-dev/msg00109.html
|| 
|| The build completes with errors and produces only 1 KB index 
|| files. The errors are:
|| 
|| [help.buildHelpIndex] Help documentation could not be 
|| indexed completely.
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_schema_editor.htm
|| etc, one for every page in the toc.
|| 
|| Is there some trick to getting it to build the indexes and 
|| find the html files? All the details I could think of are are below.
|| 
|| Thanks,
|| David
|| ---------------------------------------------
|| Details:
|| 
|| In case it matters:
|| 
|| $ java -version
|| java version "1.5.0_06"
|| 
|| I'm using the following build.xml file (and pointing to an 
|| unmodified version of org.eclipse.pde.doc.user_3.1.2 for testing):
|| 
|| <project name="Test Project" default="build.index"  basedir="." >
||   <target name="build.index" if="eclipse.running">
||     <help.buildHelpIndex
|| manifest="org.eclipse.pde.doc.user_3.1.2/plugin.xml"
|| destination="org.eclipse.pde.doc.user_3.1.2"/>
||   </target>
|| </project>
|| 
|| And the following command:
|| 
|| java -classpath ../eclipse-3.1.2/startup.jar 
|| org.eclipse.core.launcher.Main -application 
|| org.eclipse.ant.core.antRunner -buildfile build.xml -verbose -debug
|| 
|| I'm getting the following too-small-to-be-real index files:
|| 
|| dcramer@dcramerxp
|| ~/Desktop/Eclipses/eclipse-index-test/org.eclipse.pde.doc.user
|| _3.1.2/index
|| $ ls -lh
|| total 9.0K
|| -rwx------+ 1 dcramer Domain Users 1.1K Oct 30 14:36 _1.cfs
|| -rwx------+ 1 dcramer Domain Users    4 Oct 30 14:36 deletable
|| -rwx------+ 1 dcramer Domain Users  130 Oct 30 14:36 
|| -rwx------+ indexed_contributions
|| -rwx------+ 1 dcramer Domain Users  136 Oct 30 14:36 
|| -rwx------+ indexed_dependencies
|| -rwx------+ 1 dcramer Domain Users  114 Oct 30 14:36 indexed_docs
|| -rwx------+ 1 dcramer Domain Users   27 Oct 30 14:36 segments
|| 
|| And the following error messages:
|| 
|| Install location:
||     file:/c:/Documents and 
|| Settings/dcramer/Desktop/Eclipses/eclipse-3.1.2/
|| Configuration file:
||     file:/c:/Documents and
|| Settings/dcramer/Desktop/Eclipses/eclipse-3.1.2/configuration
|| /config.ini
|| loaded
|| Configuration location:
||     file:/c:/Documents and
|| Settings/dcramer/Desktop/Eclipses/eclipse-3.1.2/configuration/
|| Framework located:
||     file:/c:/Documents and
|| Settings/dcramer/Desktop/Eclipses/eclipse-3.1.2/plugins/org.e
|| clipse.osgi_3.1.2.jar
|| Framework classpath:
||     file:/c:/Documents and
|| Settings/dcramer/Desktop/Eclipses/eclipse-3.1.2/plugins/org.e
|| clipse.osgi_3.1.2.jar
|| Debug options:
||     file:/C:/Documents and
|| Settings/dcramer/Desktop/Eclipses/eclipse-index-test/.options
||  not found Time to load bundles: 16 Starting application: 
|| 766 Apache Ant version 1.6.5 compiled on June 2 2005 Apache 
|| Ant version 1.6.5 compiled on June 2 2005 Setting ro project 
|| property: ant.file -> build.xml
|| Buildfile: build.xml
||  +Datatype eclipse.convertPath 
|| org.eclipse.core.resources.ant.ConvertPath
||  +Datatype eclipse.incrementalBuild
|| org.eclipse.core.resources.ant.IncrementalBuild
||  +Datatype eclipse.refreshLocal
|| org.eclipse.core.resources.ant.RefreshLocalTask
||  +Datatype help.buildHelpIndex
|| org.eclipse.help.internal.base.ant.BuildHelpIndex
||  +Datatype eclipse.checkDebugAttributes
|| org.eclipse.jdt.core.CheckDebugAttributes
||  +Datatype eclipse.brand 
|| org.eclipse.pde.internal.build.tasks.BrandTask
||  +Datatype eclipse.fetch 
|| org.eclipse.pde.internal.build.tasks.FetchTask
||  +Datatype eclipse.buildScript
|| org.eclipse.pde.internal.build.tasks.BuildScriptGeneratorTask
||  +Datatype eclipse.buildManifest
|| org.eclipse.pde.internal.build.tasks.BuildManifestTask
||  +Datatype eclipse.assembler
|| org.eclipse.pde.internal.build.tasks.PackagerTask
||  +Datatype eclipse.idReplacer
|| org.eclipse.pde.internal.build.tasks.IdReplaceTask
||  +Datatype eclipse.jnlpGenerator
|| org.eclipse.pde.internal.build.tasks.JNLPGeneratorTask
||  +Datatype eclipse.unzipperBuilder
|| org.eclipse.pde.internal.build.tasks.UnzipperGeneratorTask
||  +Datatype eclipse.fetchFilesGenerator
|| org.eclipse.pde.internal.build.tasks.FetchFileGeneratorTask
||  +Datatype eclipse.versionReplacer
|| org.eclipse.pde.internal.build.tasks.GenericVersionReplacer
||  +Datatype pde.exportPlugins
|| org.eclipse.pde.internal.ui.ant.PluginExportTask
||  +Datatype pde.exportFeatures
|| org.eclipse.pde.internal.ui.ant.FeatureExportTask
||  +Datatype pde.convertSchemaToHTML 
|| org.eclipse.pde.ant.ConvertSchemaToHTML
|| Adding reference: ant.projectHelper
|| Adding reference: ant.parsing.context
|| Adding reference: ant.targets
|| parsing buildfile C:\Documents and
|| Settings\dcramer\Desktop\Eclipses\eclipse-index-test\build.xm
|| l with URI = 
|| file:///C:/Documents%20and%20Settings/dcramer/Desktop/Eclipse
|| s/eclipse-index-test/build.xml
|| Setting ro project property: ant.project.name -> Test 
|| Project Adding reference: Test Project Setting ro project 
|| property: ant.file.Test Project -> C:\Documents and 
|| Settings\dcramer\Desktop\Eclipses\eclipse-index-test\build.xml
|| Project base dir set to: C:\Documents and 
|| Settings\dcramer\Desktop\Eclipses\eclipse-index-test
||  +Target:
||  +Target: build.index
|| Adding reference: eclipse.ant.targetVector Build sequence 
|| for target(s) `build.index' is [build.index] Complete build 
|| sequence is [build.index, ]
|| 
|| build.index:
|| [help.buildHelpIndex] Help documentation could not be 
|| indexed completely.
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_schema_editor.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_sites.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_manifest_extensionpoints.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/product_export.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_site_setup.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_setup.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_feature_generating.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_manifest_overview.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_features.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_build_editor.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_manifest_dependencies.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_site_previewing.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| reference/misc/index.html
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_manifest_extensions.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_feature_generating_ant.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_site_building.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_schema.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_running_tracing.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| whatsNew/pde_whatsnew.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/dynamic-classpaths.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_feature_generating_build.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_fragment_example.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| tips/pde_tips.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/product_editor.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_running.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_manifest_runtime.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_feature_synchronizing.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/plugins_as_jars.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/restrictions.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/feature_based_product.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_feature_generating_antcommandline.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_feature_setup.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| reference/extension-points/index.html
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/rcp_project.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_creating.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_feature_manifest.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_manifest.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| reference/api/overview-summary.html
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_schema_using.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_running_plugins.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/product_configuration.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_deploy.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_convert.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_manifest_source.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_configuring.htm
|| [help.buildHelpIndex]     Locale 'en_US': cannot find document:
|| guide/pde_fragment.htm
|| BUILD SUCCESSFUL
|| 
|| BUILD SUCCESSFUL
|| Total time: 1 second
|| 
|| 
|| _______________________________________________
|| platform-ua-dev mailing list
|| platform-ua-dev@xxxxxxxxxxx
|| https://dev.eclipse.org/mailman/listinfo/platform-ua-dev
|| 


Back to the top