Re: Rarian again

[Don Scorgie <Don Scorgie org>]

Hi,

On Fri, 2007-07-27 at 04:22 +0200, BJ�Lindqvist wrote:
> On 7/26/07, Don Scorgie <Don scorgie org> wrote:
> > Since the last time I proposed this, I have fixed the various issues
> > people had:
> > * Rarian has now moved to freedesktop, where there's a mailing list,
> > bugzilla and SVN access
> > * A manual is now included and installed (accessible through a Rarian
> > metadata file to read in yelp or in
> > $datadir/librarian/manual/index.xhtml for those that don't like the
> > wonderful yelp.
> > and released 0.5.2 [0], which has a few bug fixes (mostly auto-foo
> > stuff, which I suck at).
> >
> > Attached is a patch for jhbuild that removes scrollkeeper and replaces
> > it with rarian.  I've done one jhbuild with it applied [1] and it goes
> > through fine.
> >
> > I'd like to get this through ASAP as I'd like to get yelp depending on
> > it before feature freeze (I'm happy with our rework branch and want to
> > merge it, but it depends on new rarian features).
> >
> > Any thoughts [2]?
> 
> Here are some:
> 
> * Since librarian is intended to be for general consumption, maybe it
> would make more sense to build the documentation using gtk-doc or
> doxygen? gtk-doc isn't the easiest tool to work with, but the html
> result is quite a bit nicer than what yelp gives you. I can probably
> help you set it up if you like.

The problem with gtk-doc is that it depends on scrollkeeper^W rarian due
to the stupid install-time registration.  So it's out.

I didn't want to introduce a dependency on doxygen and be the odd one to
the party.  I could use the libxml / libxslt solution though I didn't
look at them particularly until about 10 minutes ago.

> 
> * I'd really like some man pages. I know rarian works exactly like
> scrollkeeper so you can just type man scrollkeeper-update to get help
> for rarian-sk-update. But in the future, when rarian has totally
> replaced scrollkeeper, that won't work. Basically, couldn't you just
> copy-paste the man pages from scrollkeeper?

In the future, when rarian has completely replaces scrollkeeper, there
won't be any arcane commands like scrollkeeper-update, just the sweet,
sweet library.  However, until then (*cough* GNOME 3.0 *cough* [1]), the
scrollkeeper compat stuff is here to stay.  I'll sort out man pages
soon.

> 
> Rarian looks really great though.

Cool.  Thanks.
Don

[1] Can't ... break ... API.  The fun that scrollkeeper left me with can
be found in scrollkeeper-get-toc-from-*