Skip to main content

FW: [JAVAHELP] What tools do you use

5 replies [Last post]
Anonymous

Hi my name is Mike and I am new around here.

As I use Flare for making help files and it is not able to create Java help
I need to use another tool.

What tools do you people use?

Any assistance appreciated.

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

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.
[att1.html]

Reply viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.
Jim Reinhard

Mike,

Get Helen if you can. It's a great tool and it's written in Java. The
interface is slightly different (not entirely Windows standard), but the
support has been excellent. Stephan Schlecht, the person who developed and
supports it, is VERY knowledgeable about JavaHelp and usually gets back to
you within a few hours, which is pretty amazing considering he's based near
Hamburg, Germany!

I used Helen to do some testing initially when we were looking at JH tools.
I still have Version 1.6 that I use to build JH projects for comparison.
We eventually settled on RoboHelp as the tool we use for all help systems
here at my company, mainly because it can create more than just JavaHelp,
certain not because RH support is great (it isn't, especially for JavaHelp).

Good luck!

Jim

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

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.

Jon Sanders

Hi Mike,

We use WebWorks Publisher for Framemaker and WebWorks Publisher for Word.
http://www.quadralay.com/

Both allow us to source in either FrameMaker or Word and target multiple
output formats.

Take a look at the list of help authoring tools on:

http://java.sun.com/products/javahelp/industry.html

Other JavaHelp Help Authoring Tools (in no particular order) include:
AuthorIT, http://www.author-it.com/
SimplyHTML with JavaHelp Plug-in, http://www.lightdev.com
JHelpDev, http://jhelpdev.sourceforge.net/
HelpBreeze HTML Help and JavaHelp Edition 3.0,
http://www.solutionsoft.com/javahelp.htm
HelpSetMaker, http://www.cantamen.de/helpsetmaker.php?lang=en
JHelpBuilder, http://www.javio.com/
AnetHelpTool, http://www.anetsoft.com/

I'm sure there are others that I am not aware of.

I have not used Flare, but I noticed on the MadCap Flare website the
following feature:

"Easily create content in XML, no programming required

MadCap Flare offers an easy, intuitive XML authoring solution to technical
writers. Designed by writers for writers, MadCap Flare employs a visual
editor that lets you create and edit content much as you would in Microsoft
Word. You can then reuse and repurpose your content as needed to virtually
any format, standard, device, or platform."

So you should be able to continue using Flare.

With JavaHelp the following files are XML based:

Main Help Set file
Table of Contents File
Index File
Map File
Glossary File

So according to the statement on the MadCap website you should be able to
repurpose your content to the XML formats required for JavaHelp.

Either Flare has built in features to target the JavaHelp XML files, or you
can use an XSLT stylesheet processor to convert from the base Flare XML
format to JavaHelp XML files, or you can use an XSLT stylesheet processor to
convert from another target XML format (Microsoft HTML help perhaps?) to
JavaHelp XML files.

The JavaHelp search database is easily created at the command line using the
jhindexer command (as distributed in the JavaHelp release from Sun).

You'll also need to make sure that the HTML topics generated from Flare are
compatible with the JavaHelp reader, which essentially means HTML 3.2.
Flare may only be able to generate XHTML, but don't panic, you can still
have HTML that is HTML 3.2 compliant and XML compliant (XHTML 3.2 if you
like), with the following notes:

All elements must have a closing element, e.g.

Do not use the XML declaration:

Just some food for thought.

All the best.

Jon

On Tue, 22 May 2007 14:44:58 +0200, Michael Altman
wrote:

>Hi my name is Mike and I am new around here.
>
>As I use Flare for making help files and it is not able to create Java help
>I need to use another tool.
>
>What tools do you people use?
>
>Any assistance appreciated.
>
>
>
>
>********************************************************************************
>
>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.
>

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

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.

Michael Altman

Jon thanks for your FEW thoughts. I am always amazed at the knowledge
available and the nice people that can explain it to people like me that are
sometimes at the beginning of a new learning curve. The information you sent
me is like a complete seminar in a bottle and for that I thank you.

Kind Regards

Mike

-----Original Message-----
From: Discussion list of JavaHelp [mailto:JAVAHELP-INTEREST@JAVA.SUN.COM] On
Behalf Of Jon Sanders
Sent: 22 May, 2007 3:48 PM
To: JAVAHELP-INTEREST@JAVA.SUN.COM
Subject: Re: [JAVAHELP] FW: [JAVAHELP] What tools do you use

Hi Mike,

We use WebWorks Publisher for Framemaker and WebWorks Publisher for Word.

http://www.quadralay.com/

Both allow us to source in either FrameMaker or Word and target multiple

output formats.

Take a look at the list of help authoring tools on:

http://java.sun.com/products/javahelp/industry.html

Other JavaHelp Help Authoring Tools (in no particular order) include:

AuthorIT, http://www.author-it.com/

SimplyHTML with JavaHelp Plug-in, http://www.lightdev.com

JHelpDev, http://jhelpdev.sourceforge.net/

HelpBreeze HTML Help and JavaHelp Edition 3.0,

http://www.solutionsoft.com/javahelp.htm

HelpSetMaker, http://www.cantamen.de/helpsetmaker.php?lang=en

JHelpBuilder, http://www.javio.com/

AnetHelpTool, http://www.anetsoft.com/

I'm sure there are others that I am not aware of.

I have not used Flare, but I noticed on the MadCap Flare website the

following feature:

"Easily create content in XML, no programming required

MadCap Flare offers an easy, intuitive XML authoring solution to technical

writers. Designed by writers for writers, MadCap Flare employs a visual

editor that lets you create and edit content much as you would in Microsoft

Word. You can then reuse and repurpose your content as needed to virtually

any format, standard, device, or platform."

So you should be able to continue using Flare.

With JavaHelp the following files are XML based:

Main Help Set file

Table of Contents File

Index File

Map File

Glossary File

So according to the statement on the MadCap website you should be able to

repurpose your content to the XML formats required for JavaHelp.

Either Flare has built in features to target the JavaHelp XML files, or you

can use an XSLT stylesheet processor to convert from the base Flare XML

format to JavaHelp XML files, or you can use an XSLT stylesheet processor to

convert from another target XML format (Microsoft HTML help perhaps?) to

JavaHelp XML files.

The JavaHelp search database is easily created at the command line using the

jhindexer command (as distributed in the JavaHelp release from Sun).

You'll also need to make sure that the HTML topics generated from Flare are

compatible with the JavaHelp reader, which essentially means HTML 3.2.

Flare may only be able to generate XHTML, but don't panic, you can still

have HTML that is HTML 3.2 compliant and XML compliant (XHTML 3.2 if you

like), with the following notes:

All elements must have a closing element, e.g.

Do not use the XML declaration:

Just some food for thought.

All the best.

Jon

On Tue, 22 May 2007 14:44:58 +0200, Michael Altman

wrote:

>Hi my name is Mike and I am new around here.

>

>As I use Flare for making help files and it is not able to create Java help

>I need to use another tool.

>

>What tools do you people use?

>

>Any assistance appreciated.

>

>

>

>

>***************************************************************************
*****

>

>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.

>

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

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.

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

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.
[att1.html]

Chris.Morris@saaconsultants.com

Hi Mike,

I use a tool called Helen available at http://www.software7.biz

Currently at version 1.6 but V2.0 shipping soon. This is an excelent tool
for all your JavaHelp needs and I use it to produce and maintain multiple
JavaHelp projects.

Hope this helps,
Chris.

====================================================
Chris Morris
Technical Author
SAA Consultants Ltd
http://www.saaconsultants.com
http://www.reims.net
====================================================

Discussion list of JavaHelp wrote on
22/05/2007 13:44:58:

> Hi my name is Mike and I am new around here.
> As I use Flare for making help files and it is not able to create Java
help I
> need to use another tool.
> What tools do you people use?
> Any assistance appreciated.
>
>
********************************************************************************

> 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.

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

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.

Michael Altman

Chris thanks what an amazingly helpful and friendly list this is.

Mike

-----Original Message-----
From: Discussion list of JavaHelp [mailto:JAVAHELP-INTEREST@JAVA.SUN.COM] On
Behalf Of Chris Morris
Sent: 22 May, 2007 3:07 PM
To: JAVAHELP-INTEREST@JAVA.SUN.COM
Subject: Re: [JAVAHELP] FW: [JAVAHELP] What tools do you use

Hi Mike,

I use a tool called Helen available at http://www.software7.biz

Currently at version 1.6 but V2.0 shipping soon. This is an excelent tool

for all your JavaHelp needs and I use it to produce and maintain multiple

JavaHelp projects.

Hope this helps,

Chris.

====================================================

Chris Morris

Technical Author

SAA Consultants Ltd

http://www.saaconsultants.com

http://www.reims.net

====================================================

Discussion list of JavaHelp wrote on

22/05/2007 13:44:58:

> Hi my name is Mike and I am new around here.

> As I use Flare for making help files and it is not able to create Java

help I

> need to use another tool.

> What tools do you people use?

> Any assistance appreciated.

>

>

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

> 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.

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

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.

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

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.
[att1.html]