#164 Eclipse 3.x Help Generator

closed-fixed
nobody
None
5
2010-09-29
2009-02-21
KingArgyle
No

The attached file will allow generation of Eclipse 3.x versions of the plugin.xml as well as the manifest.mf files. The current Eclipse based help generator does not generate the newer formats. This leverages the existing formats, and adds a couple of paramaters to control whether the manifest is created as well as if the plugin.xml is created. There are times when you may not want to recreate the plugin.xml or manifest.mf if you already have these created.

This change is licensed under an EPL 1.0 license. I wrote all the code for this, and leverage the existing eclipse.xsl as an import.

Discussion

  • KingArgyle
    KingArgyle
    2009-02-21

    XSL for Eclipse 3.x help and file formats

     
    Attachments
  • Sorry for the delay in responding.

    The description of this patch led me to assume that eclipse33.xsl should generate a MANIFEST.MF file if the manifest parameter is set. But if this is right, something is missing. The stylesheet module does not contain any code for actually generating a manifest file. Or am I misunderstanding how it is supposed to work?

     
  • KingArgyle
    KingArgyle
    2010-08-01

    Sorry been a while since I looked at this. There is a paramater called: manifest in the stylesheet. This controls whether we are generating an old style eclipse 2.x formatted plugin, or whether we already have a Manifest.MF for an existing eclipse 3.x/4.x style plugin.

    Based on this information it will generate a plugin.xml file in the appropriate format. It could be enhanced to genrate the MANIFEST.MF file if necessary but in most of my use cases I'm using this in a plugin that already has the MANIFEST.MF created, and just needed to control what format of a plugin.xml was created.

    An example running this is as follows from ant:
    <xslt style="${docbookeclipsedir}/eclipse33.xsl" in="${workspace}/Documentation/Tutorials/Output/Tutorial.xml" out="${workspace}/Documentation/Tutorials/Output/HTML-Eclipse/Tutorial.html">
    <factory name="${saxon6}" />
    <param name="manifest" expression="1"/>
    <param name="manifest.in.base.dir" expression="1"/>
    <param name="create.plugin.xml" expression="1"/>
    <param name="chunker.output.indent" expression="yes"/>
    <param name="navig.showtitles" expression="0"/>
    <param name="suppress.navigation" expression="1"/>
    <param name="base.dir" expression="${workspace}/Documentation/Tutorials/Output/HTML-Eclipse/" />
    <param name="generate.toc" expression="book toc,title,figure
    chapter toc,title" />
    </xslt>

     
  • | There is a paramater called:
    | manifest in the stylesheet. This controls whether we are
    | generating an old
    | style eclipse 2.x formatted plugin, or whether we already have a
    | Manifest.MF for an existing eclipse 3.x/4.x style plugin.

    What are the drawbacks of "old style" plugins? Will they stop working at some point?

    | Based on this information it will generate a plugin.xml file in the
    | appropriate format. It could be enhanced to genrate the
    | MANIFEST.MF file
    | if necessary but in most of my use cases I'm using this in a
    | plugin that
    | already has the MANIFEST.MF created, and just needed to
    | control what format of a plugin.xml was created.

    Would you say that already having a MANIFEST.MF file is the "normal/standard" use case?

    I also had a look at http://wiki.eclipse.org/Authoring_Eclipse_Help_Using_DocBook. On this page, it says:

    * manifest - The default value for this is 1, which means that it should generate a Manifest file for the documentation plugin. Set this to 0 to turn this feature off.

    I find this misleading, since no manifest file is actually generated.

     
  • KingArgyle
    KingArgyle
    2010-08-01

    The old style plugin.xml format is not supported or guaranteed to work.

    I can easily make a few tweaks to the stylesheet so that it generates a MANIFEST.MF or rework the code a bit to bring it in line with what it actually does.

     
  • An updated module that generates a manifest file

     
    Attachments
  • I have uploaded an augmented stylesheet module that generates a manifest file. Do you have time to take a look at it? If it's OK, I'll check it in to the DocBook repository so that it can be included in the next release.

     
  • KingArgyle
    KingArgyle
    2010-08-05

    The changes look good.

     
    • status: open --> pending-fixed
     
  • OK, thanks!

     
  • A fix for this issue has been added to the current codebase.
    Please test the fix with the latest snapshot from:

    http://docbook.sourceforge.net/snapshots/

     
    • status: pending-fixed --> closed-fixed
     
  • This Tracker item was closed automatically by the system. It was
    previously set to a Pending status, and the original submitter
    did not respond within 14 days (the time period specified by
    the administrator of this Tracker).