| Problem with Help plugin in RCP app - internationalization [message #471457] |
Fri, 18 January 2008 12:38  |
Eclipse User |
|
|
|
Hi,
I have an RCP product and I have added a help plugin by following this article -
http://www.eclipse.org/articles/article.php?file=Article-Add ingHelpToRCP/index.html
This works fine, and I am able to launch the eclipse help viewer and see the toc, use the index, and
view the topics etc.
I also followed the Internationalization guidelines for the help :
http://help.eclipse.org/help32/index.jsp?topic=/org.eclipse. platform.doc.isv/reference/extension-points/org_eclipse_help _toc.html
So I created a \nl directory with 2 subfolders \en and \de which contains the translated xml files
-index.xml, toc.xml, and also the translated documentation, which i put into a zip file doc.zip.
This also works fine when I debug my product through eclipse, so when I run the product in German
and launch help, it displays the toc, index, and help html files all in German.
However when I build my application and install it on another machine, run the application in German
and launch help, the help viewer launches and shows the toc, index in German, BUT it cannot find the
html documentation.
Does anyone know what could be causing this or point me in the right direction?
Eclipse version 3.2.2
Many thanks,
Conor
|
|
|
|
|
|
|
|
| Re: Problem with Help plugin in RCP app - internationalization [message #471534 is a reply to message #471533] |
Tue, 22 January 2008 11:57  |
| Eclipse User |
|
|
|
http://help.eclipse.org/help33/topic/org.eclipse.platform.do c.isv/guide/ua_help_content_files.htm
Although this is documented only someone who read the documentation very
carefully would discover this detail. I'm open for suggestions as to how
to improve the situation such as generating a warning in the error log
when doc.zip is in a jarred file. My feeling is that doc.zip is an
anachronism since the same compression can be achieved by simply
exporting the plugin as a jar file. I'm not inclined to support doc.zip
in a jar - it may not be trivial to implement, I would rather encourage
users to use jarred plugins and not use doc.zip.
Conor O'Mahony wrote:
> Hi Chris,
>
> Yes that is what I was trying to do, but I have changed it now so that
> the documentation isn't zipped. Thanks for your help. You said this
> behaviour is documented but not well known- where could I have found
> this information?
>
> Thanks again,
>
> Conor
>
> Chris Goldthorpe wrote:
>> It sounds as though you are using doc.zip in a jarred plugin. If that
>> is the case the help pages will not get read (this is documented but
>> is not well known), you should unzip the doc files. There was a
>> discussion about this on a bug report a while back.
|
|
|
| Re: Problem with Help plugin in RCP app - internationalization [message #606943 is a reply to message #471457] |
Fri, 18 January 2008 19:18 |
| Eclipse User |
|
|
|
The first thing to check is whether the nl files got exported. If you
exported your help plugin and transferred it to another system you
should check to make sure that all the files got included in the jar
file (or plugin directory if you didn't jar it). If the nl files are are
missing edit the build.xml file to make sure they get exported.
|
|
|
| Re: Problem with Help plugin in RCP app - internationalization [message #606945 is a reply to message #471458] |
Fri, 18 January 2008 19:25 |
| Eclipse User |
|
|
|
Actually it's build.properties that controls which files get exported,
build.xml is something different.
Chris Goldthorpe wrote:
> The first thing to check is whether the nl files got exported. If you
> exported your help plugin and transferred it to another system you
> should check to make sure that all the files got included in the jar
> file (or plugin directory if you didn't jar it). If the nl files are are
> missing edit the build.xml file to make sure they get exported.
|
|
|
| Re: Problem with Help plugin in RCP app - internationalization [message #606959 is a reply to message #471459] |
Mon, 21 January 2008 05:36 |
| Eclipse User |
|
|
|
Hi Chris,
Thanks for your help, unfortunately this isn't what is causing the problem, the nl directory is
included in the exported plugin.
However as a test I manually edited the help plugin by unzipping the doc.zip files within the nl\de
and nl\en folders into those respective folders. When I ran my application in German, it picked up
the correct documentation from within the nl\de\html directory.
The folder structure of the manually edited plugin with the unzipped documentation that works
correctly is -
nl\de\html\*.html - documentation is contained here
AND the folder structure of the original plugin that doesn't work is -
nl\de\doc.zip
and doc.zip has the following structure -
html\*.html
Any ideas?
Chris Goldthorpe wrote:
> Actually it's build.properties that controls which files get exported,
> build.xml is something different.
>
> Chris Goldthorpe wrote:
>> The first thing to check is whether the nl files got exported. If you
>> exported your help plugin and transferred it to another system you
>> should check to make sure that all the files got included in the jar
>> file (or plugin directory if you didn't jar it). If the nl files are
>> are missing edit the build.xml file to make sure they get exported.
|
|
|
|
| Re: Problem with Help plugin in RCP app - internationalization [message #607674 is a reply to message #471521] |
Tue, 22 January 2008 05:05 |
| Eclipse User |
|
|
|
Hi Chris,
Yes that is what I was trying to do, but I have changed it now so that the documentation isn't
zipped. Thanks for your help. You said this behaviour is documented but not well known- where could
I have found this information?
Thanks again,
Conor
Chris Goldthorpe wrote:
> It sounds as though you are using doc.zip in a jarred plugin. If that is
> the case the help pages will not get read (this is documented but is not
> well known), you should unzip the doc files. There was a discussion
> about this on a bug report a while back.
|
|
|
| Re: Problem with Help plugin in RCP app - internationalization [message #607678 is a reply to message #471533] |
Tue, 22 January 2008 11:57 |
| Eclipse User |
|
|
|
http://help.eclipse.org/help33/topic/org.eclipse.platform.do c.isv/guide/ua_help_content_files.htm
Although this is documented only someone who read the documentation very
carefully would discover this detail. I'm open for suggestions as to how
to improve the situation such as generating a warning in the error log
when doc.zip is in a jarred file. My feeling is that doc.zip is an
anachronism since the same compression can be achieved by simply
exporting the plugin as a jar file. I'm not inclined to support doc.zip
in a jar - it may not be trivial to implement, I would rather encourage
users to use jarred plugins and not use doc.zip.
Conor O'Mahony wrote:
> Hi Chris,
>
> Yes that is what I was trying to do, but I have changed it now so that
> the documentation isn't zipped. Thanks for your help. You said this
> behaviour is documented but not well known- where could I have found
> this information?
>
> Thanks again,
>
> Conor
>
> Chris Goldthorpe wrote:
>> It sounds as though you are using doc.zip in a jarred plugin. If that
>> is the case the help pages will not get read (this is documented but
>> is not well known), you should unzip the doc files. There was a
>> discussion about this on a bug report a while back.
|
|
|
Powered by
FUDForum. Page generated in 0.06370 seconds
Home