Skip to main content

JavaHelp or Oracle Help for Java?

4 replies [Last post]
Anonymous

Hello,

In the next version of one of our pure Java products, due next June, we will provide online help, and I'm about to decide what format of help I'm going to choose:

JavaHelp or Oracle Help for Java

I would prefer basing my decision on the most recent formats. the first version of the Help will not be anything fancy. It won't even include context-sensitive Help. Only an online version of a good (We are working hard for this) User Guide, displayed with the Help menu or the F1 key. But future versions will probably probably provide some level of context-sensitivity.

The application is a client-server architecture with Oracle or MS SQL databases. Only the client portion is pure Java, to provide flexibility of deployment and accessibility for users, and is developped with JDK 1.4.2 and running on JRE 1.4.2.

I haven't done thorough texting, but the conversion tests I've done do not indicate any problems with either format.

Although I haven't experienced this personnaly, the JavaHelp 1 format is said to be buggy, especially for displaying images.

There seems to be some issues with help files when using Java WebStart. I already found some info for setting the .jnp correctly

Views, advice comments or hints on the subject?

______________________
Richard Coulombe
Documentation Specialist

Amadeus International
418.525.0606 x242

********************************************************************************

You may leave the list at any time by sending message with no subject and
"SIGNOFF JAVAHELP-INTEREST" in the body to LISTSERV@JAVA.SUN.COM. Archives
are available at http://archives.java.sun.com/archives/javahelp-interest.html.
Submit bug reports at http://java.sun.com/cgi-bin/bugreport.cgi.

Reply viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.
Thomas Kr�

Hi,

We have a big JavaHelp project (FrameMaker >>> WWP >>> JavaHelp) The FrameMaker Files are translated by a professional agency into German. Sometimes we get the typical German quote marks in the TOC. As soon as those quote marks appear in the TOC, JavaHelp will not start anymore -if I take the quote marks out of the TOC, everything is fine. Those quote marks are no problem
in content.
Any ideas?

Thomas Kr�hner

********************************************************************************

You may leave the list at any time by sending message with no subject and
"SIGNOFF JAVAHELP-INTEREST" in the body to LISTSERV@JAVA.SUN.COM. Archives
are available at http://archives.java.sun.com/archives/javahelp-interest.html.
Submit bug reports at http://java.sun.com/cgi-bin/bugreport.cgi.

Stephan Schlecht

TOC.xml is a XML file, therefore you have to use character
entities, e.g. for quotes use "

If you use character entities, the quotes are displayed like
expected (because then TOC.xml is a valid XML file).

Hope this helps,

Stephan
--
Software 7 GmbH
*** Helen 1.5, the JavaHelp 2.0 Authoring Tool ***
http://www.software7.biz

At 10:19 04.05.2004 +0200, you wrote:
>Hi,
>
>We have a big JavaHelp project (FrameMaker >>> WWP >>> JavaHelp) The
>FrameMaker Files are translated by a professional agency into German.
>Sometimes we get the typical German quote marks in the TOC. As soon as
>those quote marks appear in the TOC, JavaHelp will not start anymore -if I
>take the quote marks out of the TOC, everything is fine. Those quote marks
>are no problem
>in content.
>Any ideas?
>
>Thomas Kr�hner

********************************************************************************

You may leave the list at any time by sending message with no subject and
"SIGNOFF JAVAHELP-INTEREST" in the body to LISTSERV@JAVA.SUN.COM. Archives
are available at http://archives.java.sun.com/archives/javahelp-interest.html.
Submit bug reports at http://java.sun.com/cgi-bin/bugreport.cgi.

Thomas Kr�

Hi,

thanks

" is no problem, the problems are

” and „ (the tilted ones)

funny though, it seems adding a blank before and after the entities solves the
problem, then it displays. Just that you have the blank then.

Thank You, Thomas

Stephan Schlecht schrieb:

> TOC.xml is a XML file, therefore you have to use character
> entities, e.g. for quotes use "
>
> If you use character entities, the quotes are displayed like
> expected (because then TOC.xml is a valid XML file).
>
> Hope this helps,
>
> Stephan
> --
> Software 7 GmbH
> *** Helen 1.5, the JavaHelp 2.0 Authoring Tool ***
> http://www.software7.biz
>
> At 10:19 04.05.2004 +0200, you wrote:
> >Hi,
> >
> >We have a big JavaHelp project (FrameMaker >>> WWP >>> JavaHelp) The
> >FrameMaker Files are translated by a professional agency into German.
> >Sometimes we get the typical German quote marks in the TOC. As soon as
> >those quote marks appear in the TOC, JavaHelp will not start anymore -if I
> >take the quote marks out of the TOC, everything is fine. Those quote marks
> >are no problem
> >in content.
> >Any ideas?
> >
> >Thomas Kr�hner
>
> ********************************************************************************
>
> You may leave the list at any time by sending message with no subject and
> "SIGNOFF JAVAHELP-INTEREST" in the body to LISTSERV@JAVA.SUN.COM. Archives
> are available at http://archives.java.sun.com/archives/javahelp-interest.html.
> Submit bug reports at http://java.sun.com/cgi-bin/bugreport.cgi.
>
> --
> This message has been scanned for viruses and
> dangerous content by www.cmo.de, and is
> believed to be clean.

--
---------------------------------------------------------------------
torborg & hahn GbR - Produktdokumentationen
Ilsahl 5 - 24536 Neum�nster
Tel. 04321-306 352 - Fax. 04321-306 351
www.torborg-hahn.de
----------------------------------------------------------------------

********************************************************************************

You may leave the list at any time by sending message with no subject and
"SIGNOFF JAVAHELP-INTEREST" in the body to LISTSERV@JAVA.SUN.COM. Archives
are available at http://archives.java.sun.com/archives/javahelp-interest.html.
Submit bug reports at http://java.sun.com/cgi-bin/bugreport.cgi.

Stephan Schlecht

What always works without the need of using unwanted blanks is
the UTF-8 encoding. The first line of your XML file would look
like .

Then convert the XML file (e.g. with a text editor that supports
different encodings) from the current encoding (most likely
ISO-8859-1) to UTF-8.

In the UTF-8 TOC file the quotes would look like „ and “
There is no need for additional blanks, and the tilted
quotes would be displayed correctly in JavaHelp.

Stephan
--
Software 7 GmbH
*** Helen 1.5, the JavaHelp 2.0 Authoring Tool ***
http://www.software7.biz

At 11:54 04.05.2004 +0200, you wrote:
>Hi,
>
>thanks
>
>" is no problem, the problems are
>
>” and „ (the tilted ones)
>
>funny though, it seems adding a blank before and after the entities solves the
>problem, then it displays. Just that you have the blank then.
>
>Thank You, Thomas
>
>
>Stephan Schlecht schrieb:
>
> > TOC.xml is a XML file, therefore you have to use character
> > entities, e.g. for quotes use "
> >
> > If you use character entities, the quotes are displayed like
> > expected (because then TOC.xml is a valid XML file).
> >
> > Hope this helps,
> >
> > Stephan
> > --
> > Software 7 GmbH
> > *** Helen 1.5, the JavaHelp 2.0 Authoring Tool ***
> > http://www.software7.biz
> >
> > At 10:19 04.05.2004 +0200, you wrote:
> > >Hi,
> > >
> > >We have a big JavaHelp project (FrameMaker >>> WWP >>> JavaHelp) The
> > >FrameMaker Files are translated by a professional agency into German.
> > >Sometimes we get the typical German quote marks in the TOC. As soon as
> > >those quote marks appear in the TOC, JavaHelp will not start anymore -if I
> > >take the quote marks out of the TOC, everything is fine. Those quote marks
> > >are no problem
> > >in content.
> > >Any ideas?
> > >
> > >Thomas Kr�hner
> >
> >
> ********************************************************************************
> >
> > You may leave the list at any time by sending message with no subject and
> > "SIGNOFF JAVAHELP-INTEREST" in the body to LISTSERV@JAVA.SUN.COM. Archives
> > are available at
> http://archives.java.sun.com/archives/javahelp-interest.html.
> > Submit bug reports at http://java.sun.com/cgi-bin/bugreport.cgi.
> >
> > --
> > This message has been scanned for viruses and
> > dangerous content by www.cmo.de, and is
> > believed to be clean.
>
>--
>---------------------------------------------------------------------
>torborg & hahn GbR - Produktdokumentationen
>Ilsahl 5 - 24536 Neum�nster
>Tel. 04321-306 352 - Fax. 04321-306 351
>www.torborg-hahn.de
>----------------------------------------------------------------------
>
>********************************************************************************
>
>You may leave the list at any time by sending message with no subject and
>"SIGNOFF JAVAHELP-INTEREST" in the body to LISTSERV@JAVA.SUN.COM. Archives
>are available at http://archives.java.sun.com/archives/javahelp-interest.html.
>Submit bug reports at http://java.sun.com/cgi-bin/bugreport.cgi.

Stephan Schlecht
--
Software 7 GmbH Tel: +49 941-7979682
Ludwig-Eckert-Str. 8 Fax: +49 941-7979683
93049 Regensburg http://www.software7.biz

********************************************************************************

You may leave the list at any time by sending message with no subject and
"SIGNOFF JAVAHELP-INTEREST" in the body to LISTSERV@JAVA.SUN.COM. Archives
are available at http://archives.java.sun.com/archives/javahelp-interest.html.
Submit bug reports at http://java.sun.com/cgi-bin/bugreport.cgi.