Packaging the FAQ Guide (was #ubuntu-doc report for 2004-01-06)

[Alexander Poslavsky]

On Sun, 9 Jan 2005 09:12:48 +0200, Sean Wheller <sean at inwords.co.za> wrote:
> On Sunday 09 January 2005 01:10, Alexander Poslavsky wrote:
> > On Sat, 8 Jan 2005 16:58:31 +0200, Sean Wheller <sean at inwords.co.za> wrote:
> > > On Saturday 08 January 2005 08:51, Christoph Haas wrote:
> > > > > * Packaging the FAQ Guide
> > > > >
> > > > > Since the FAQ Guide is now complete, plovs wished for a Debian
> > > > > package for it.  ChrisH offered to create the debian/ structure,
> > > > > plovs then offered to maintain it so he could learn how to do the
> > > > > packaging thing.
> > > > >
> > > > > sivang also offered clues on how to register the documents with
> > > > > scrollkeeper and doc-base.
> > > >
> > > > I still lack clue whether we also ship an HTML version. Do we just need
> > > > the XML files and included pictures in the package?
> > >
> > > We do not have to pack a static version. However, this forces KDE users
> > > to install scrollkeeper and yelp.
> > >
> > > IMHO it will not hurt to install both.
> >
> > This document is primarely aimed at desktop users so most peope would
> > have these apps anyway.
> 
> Yes, if they have GNOME installed. My concern in for future compatability. As
> we know, Ubuntu will eventually include KDE as a desktop. At which point,
> should a use install KDE and not GNOME, then none of the XML documents will
> be available. In which case it is good to install HTML.
> 
> So, while it is not urgent to package static HTML versions for now, we must
> keep inmind possible future options.

Which would leave us with two solutions:
1. Install yelp anyway (this would install a whole bunch of libs as
well, as well as scrollkeeper etc. This would give us one paltform to
work for.
2. Make a seperate package for kde (kubuntu), in kde-helpfiles
    note: What does kde use for its helpfiles? not docbook/xml, how
can we convert our docs to what they use?
3. Make a seperate html package, this should be easy.

I vaguely remember some web-server or something for scrollkeeper

Anyway, for starters I would like to get this to work for gnome. If we
could get a reasonably good documentation platform than others will
join. But we need a working platform, extesible, with linking between
the docs etc.

BTW I upgraded to hoary and the new version of help is much nicer,
stuff lines up now etc.

greets, AP