Re: Abiword documentation update project started

From: Alexander van Loon <svloon_at_xs4all.nl>
Date: Wed Aug 30 2006 - 10:21:17 CEST

Ok. What I meant with "using DocBook" is that I'm going to use the
templates http://developer.gnome.org/projects/gdp/templates.html here
and transfer the documentation to those templates. I think improving the
Abiword exporter so that we can export to DocBook is not worth the time,
I'd prefer to transfer the docs to DocBook XML manually.

By the way, I forgot one very important question. The documentation is
outdated for a few years, in the meanwhile new features must have been
introduced in Abiword which are not documented in the old documentation.
Which new features have not been documented yet (of course the famous
upcoming collaboration feature must documented, for example)?

On Tue, 2006-08-29 at 23:44 +0100, Alan Horkan wrote:
>
> On Tue, 29 Aug 2006, Alexander van Loon wrote:
>
> > Date: Tue, 29 Aug 2006 23:01:39 +0200
> > From: Alexander van Loon <svloon@xs4all.nl>
> > To: abiword-dev@abisource.com
> > Subject: Abiword documentation update project started
> >
> >
> > Hi all,
> >
> > I've set up a wiki for the effort to update the documentation for
> > Abwiord on my website - http://www.svanloon.nl/abiworddocs/ - all the
> > progress can be followed here. Currently I'm the only person working on
> > it, so don't expect to see a lot of work done in a short timespan.
> >
> > We still need to reach consensus on what we should use as the format for
> > documentation. I've discussed this with Alan Horkan and Marc Maurer.
> > Alan Horkan suggested using the Gecko based version of Yelp which uses
> > HTML (I haven't been able to find anything about this functionality in
> > Yelp though) instead of DocBook XML.
>
> I was not suggestion the Gecko based version of Yelp _instead_ of Docbook
> but mentioning it as a possible way to put the existing HTML documentation
> and get it to use the standard Gnome help system which is Yelp.
>
> An alternative is to further improve the abiword exporter so that the
> current master files in ABW format can be converted to a suitable
> formatted Docbook and that would be great since it would work within the
> existing system. It is not clear if that is what you mean by "use
> Docbook".
>
> > I think we will need to use DocBook XML, because that's what the
> > GNOME Documentation Project uses as well.
>
> If you want help files integrated with Gnome Docbook is the standard way
> to do that.
>
> Sincerely
>
> Alan Horkan
>
> Inkscape http://inkscape.org
> Abiword http://www.abisource.com
> Open Clip Art http://OpenClipArt.org
>
> Alan's Diary http://advogato.org/person/AlanHorkan/
>
>
>
>
Received on Wed Aug 30 10:21:56 2006

This archive was generated by hypermail 2.1.8 : Wed Aug 30 2006 - 10:21:57 CEST