Home » Eclipse Projects » Platform - User Assistance (UA) » Eclipse help authoring tools
| Eclipse help authoring tools [message #468978] |
Thu, 08 February 2007 17:49  |
Eclipse User |
|
|
|
We recently started using MIF2Go to generate Eclipse help plugins from
FrameMaker source.
Do any other help authoring tools support Eclipse out of the box?
RoboHelp, Doc-To-Help, and MadCap Flare currently do not.
|
|
| |
| Re: Eclipse help authoring tools [message #468987 is a reply to message #468983] |
Wed, 14 February 2007 18:49  |
| Eclipse User |
|
|
|
What's the source format, and what do people generally write and edit
their source in when using that?
From the docs it sounds like a toolkit for programmers building custom
delivery-format generation tools, not a tool for technical writers.
Dave Resch wrote:
> Not an authoring tool, actually, but the DITA-OT (DITA Open Toolkit)
> supports generating Eclipse plug-ins out-of-the-box.
>
> Several authoring tools support the DITA (XML) DTD, so you could use a
> combination of a DITA-compliant authoring tool and the DITA-OT to build
> Eclipse plug-ins, as well as other output formats supported by the DITA-OT.
>
> Of course, you have to buy in to the DITA information architecture
> paradigm, which might entail some source file conversion from whatever
> structured or unstructured format you use now. (BTW, FrameMaker
> supposedly has some support for DITA XML in their newer versions.)
>
> Here's a link to the DITA-OT open source project:
>
> http://sourceforge.net/projects/dita-ot/
>
> Dave R
>
|
|
|
| Re: Eclipse help authoring tools [message #468993 is a reply to message #468987] |
Fri, 16 February 2007 19:02 |
| Eclipse User |
|
|
|
The source format is DITA-XML (i.e., XML documents validated against the
DITA DTD).
To write and edit content, you could use any validating XML editor (such
as XMetaL Author, XMLSpy, oXygen, to name a few), or any more specialized
desktop publishing editor that supports XML (such as Arbortext Epic
Editor, or structured FrameMaker). Aside from specifics of functionality
that vary from one tool to another, the authoring tool is mostly a matter
of taste.
The DITA-OT is effectively a delivery-format-generating tool by itself,
though you could embed it into your own build system (or output tool) to
provide more specialized processing.
At Sybase, we have a production build system that wraps the DITA-OT to
generate Eclipse doc plug-ins (along with PDF and Web/HTML output
formats), and we have an "ad hoc" build system that wraps the DITA-OT for
deployment on writer's desktop machines.
The EclipseCon 2007 tutorial, (3672) Eclipse & DITA: Write Once, Use
Everywhere! ( http://www.eclipsecon.org/2007/index.php?page=sub/&id=36 72)
includes a sample integration of the DITA-OT with the Eclipse workbench.
This sample is the core of our "ad hoc" build system. (The sample should
be available for download from Eclipsezilla by late February.)
|
|
| | | |
| Re: Eclipse help authoring tools [message #560251 is a reply to message #468978] |
Wed, 14 February 2007 13:14 |
| Eclipse User |
|
|
|
Not an authoring tool, actually, but the DITA-OT (DITA Open Toolkit)
supports generating Eclipse plug-ins out-of-the-box.
Several authoring tools support the DITA (XML) DTD, so you could use a
combination of a DITA-compliant authoring tool and the DITA-OT to build
Eclipse plug-ins, as well as other output formats supported by the DITA-OT.
Of course, you have to buy in to the DITA information architecture
paradigm, which might entail some source file conversion from whatever
structured or unstructured format you use now. (BTW, FrameMaker supposedly
has some support for DITA XML in their newer versions.)
Here's a link to the DITA-OT open source project:
http://sourceforge.net/projects/dita-ot/
Dave R
|
|
|
| Re: Eclipse help authoring tools [message #560254 is a reply to message #468983] |
Wed, 14 February 2007 18:49 |
| Eclipse User |
|
|
|
What's the source format, and what do people generally write and edit
their source in when using that?
From the docs it sounds like a toolkit for programmers building custom
delivery-format generation tools, not a tool for technical writers.
Dave Resch wrote:
> Not an authoring tool, actually, but the DITA-OT (DITA Open Toolkit)
> supports generating Eclipse plug-ins out-of-the-box.
>
> Several authoring tools support the DITA (XML) DTD, so you could use a
> combination of a DITA-compliant authoring tool and the DITA-OT to build
> Eclipse plug-ins, as well as other output formats supported by the DITA-OT.
>
> Of course, you have to buy in to the DITA information architecture
> paradigm, which might entail some source file conversion from whatever
> structured or unstructured format you use now. (BTW, FrameMaker
> supposedly has some support for DITA XML in their newer versions.)
>
> Here's a link to the DITA-OT open source project:
>
> http://sourceforge.net/projects/dita-ot/
>
> Dave R
>
|
|
|
| Re: Eclipse help authoring tools [message #560260 is a reply to message #468987] |
Fri, 16 February 2007 19:02 |
| Eclipse User |
|
|
|
The source format is DITA-XML (i.e., XML documents validated against the
DITA DTD).
To write and edit content, you could use any validating XML editor (such
as XMetaL Author, XMLSpy, oXygen, to name a few), or any more specialized
desktop publishing editor that supports XML (such as Arbortext Epic
Editor, or structured FrameMaker). Aside from specifics of functionality
that vary from one tool to another, the authoring tool is mostly a matter
of taste.
The DITA-OT is effectively a delivery-format-generating tool by itself,
though you could embed it into your own build system (or output tool) to
provide more specialized processing.
At Sybase, we have a production build system that wraps the DITA-OT to
generate Eclipse doc plug-ins (along with PDF and Web/HTML output
formats), and we have an "ad hoc" build system that wraps the DITA-OT for
deployment on writer's desktop machines.
The EclipseCon 2007 tutorial, (3672) Eclipse & DITA: Write Once, Use
Everywhere! ( http://www.eclipsecon.org/2007/index.php?page=sub/&id=36 72)
includes a sample integration of the DITA-OT with the Eclipse workbench.
This sample is the core of our "ad hoc" build system. (The sample should
be available for download from Eclipsezilla by late February.)
|
|
| |
| Re: Eclipse help authoring tools [message #560333 is a reply to message #468978] |
Mon, 07 May 2007 22:55 |
| Eclipse User |
|
|
|
Originally posted by: graham.hannington.gmail.com
I've just developed a small, free utility named hh2e that converts a
Microsoft HTML Help 1.x contents (.hhc) file into an Eclipse help TOC file.
I'm hoping that hh2e will prove useful to anyone who wants to produce
Eclipse help from Microsoft HTML Help source. I developed hh2e to create
Eclipse help from HTML produced by doxygen: while doxygen can produce HTML
Help files, it cannot produce an Eclipse help TOC file.
hh2e consists of an XSLT 1.0 stylesheet and a Windows batch (.bat) file. The
..bat file calls the free utility HTML Tidy to convert your .hhc file to
XHTML, then calls the free utility msxsl.exe (provided by Microsoft) with
the hh2e XSLT stylesheet to transform the XHTML version of your .hhc file
into an Eclipse TOC file.
A few days after developing hh2e, I found a similar XSLT stylesheet on the
doxygen users mailing list dating from 2003. I was a little deflated by this
;-), but at least hh2e provides an out-of-the-box "wrapper" (the .bat file)
for Windows users.
For more information, and to download hh2e, go to:
http://home.amnet.net.au/~ghannington/hh2e/hh2e-readme.html
|
|
| |
Goto Forum:
Current Time: Thu May 22 19:23:20 EDT 2025
Powered by FUDForum. Page generated in 0.04240 seconds |
Home