Plugin reference should be DocBook formatted

[Mario Blättermann]

Hi John,
we had already spoken about the existing PDF manual for the plugin reference. If you are planning a release, please wait, I will convert this to DocBook and translate it before. Be patient, you will get the approriate folder structure in a few days.

Best regards,
Mario

[Mario Blättermann (mario.blaettermann)]

Hi,
the manual migration is finished. Look in the attachment. It includes a complete folder "devhelp" with XML files, Makefile.am, OMF file and a German translation. Normally this manual should be displayed in the Development section of Yelp.

Please make sure that this manual can be opened via a menu entry (e.g. "Help/Plugins"). Furtherly, we should place a link within the plugins section of the user manual.

Best Regards,
Mario

[John S (jcspray)]

Presumably it's possible to get docbook to generate a PDF as well? That
would be useful for the web site.

John

2009/6/21 Mario Blättermann <email address hidden>

> Hi,
> the manual migration is finished. Look in the attachment. It includes a
> complete folder "devhelp" with XML files, Makefile.am, OMF file and a German
> translation. Normally this manual should be displayed in the Development
> section of Yelp.
>
> Please make sure that this manual can be opened via a menu entry (e.g.
> "Help/Plugins"). Furtherly, we should place a link within the plugins
> section of the user manual.
>
> Best Regards,
> Mario
>
> ** Attachment added: "devhelp.tar.bz2"
> http://launchpadlibrarian.net/28167357/devhelp.tar.bz2
>
> --
> Plugin reference should be DocBook formatted
> https://bugs.launchpad.net/bugs/387260
> You received this bug notification because you are subscribed to
> Referencer.
>

[Mario Blättermann (mario.blaettermann)]

Yes, this should be possible. The current PDF seems to be made with a LaTex converter, and some parts are not well readable.

The attached file "referencer-plugins.pdf" is a printout of Yelp. Very nice, but the links doesn't work. That's why I've tried to use another converter. The docbook2odf command produces an *.odt file with well formatted hyperlinks, and we can create a PDF with OpenOffice, but it is buggy. See the file "referencer-plugins.odt.pdf".

At this time, the best way was to present a direct HTML conversion at Referencer's web page. You can get a valid HTML file by running the following command:

xsltproc /usr/share/xml/gnome/xslt/docbook/html/db2html.xsl referencer-plugins.xml > referencer-plugins.html

Be careful, a lot of subfiles will be created. But the appearance is the same as in Yelp. All links are working. And for offline-reading you can set a hint that the users can print a PDF file with Yelp. That's the simplest way. Additionally, you can provide the user manual at the same way at your web page.

Best Regards,
Mario

[Mario Blättermann (mario.blaettermann)]

Hi John,
thanks for committing the manual. However, we have a small bug in the german translation. One of the XML tags is incomplete, that's why the weblink isn't displayed. Please apply the attached patch.
I've just compiled Referencer again from current Mercurial content, it's ok, no errors. Dont't forget to add an entry to the "help" menu.

Best Regards,
Mario