Fwd: (from Jacob, about applet docs)

[Telsa Gwynne <hobbit aloss ukuu org uk>]

Forwarded with permission from Jacob, in the hope of (ha!) 
clearing up confusion.

----- Forwarded message from Jacob Berkman <jacob@helixcode.com> -----
To: jfleck@inkstain.net
Cc: Telsa Gwynne <hobbit@aloss.ukuu.org.uk>
Subject: Re: 1.2 doc deadline
From: Jacob Berkman <jacob@helixcode.com>
Date: 21 Mar 2000 15:59:24 -0500

Ok, so I will briefly say where I stand.

Currently, the applet docs are done in 2 seperate files.  One is the
actual docs, inside a <sect1>.  The othere is a header, which has the
licensing and title etc.  This second file "includes" the first through
an entity thing.  If this isn't totally clear, just take a look at the
.sgml files in gnome-applets/fifteen/docs/C/.

(aside: these headers currently indicate that the docs are GPL'd (iirc),
they should probably be changed to the new doc license before 1.2, correct?)

When I get the docs, I go in and put the hooks in to show them, build them,
etc.

Now about the deadline, if I get docs on friday, I'll make a 1.1.6 release
over the weekend (which I'd like to do anyway).  Depending on how this
goes, I'll probably release an actual beta version of 1.2 soonish after
that.  So, that's the current plan.

I don't know how many other people know this plan (since other people are
busy doing other things), so if you hear something different from other 
people, don't worry.

Jacob
-- 
"I say, get it while you can." -- Janis Joplin

----- End forwarded message -----

I'd imagine that it's most sensible to go with this for now.
Eric Baudois has already started to (completed?) mark up the FDL 
licence.

For those who spotted it, yes, there is no reference in those 
docs he mentions to an introductory chapter. Yes, that's utterly
at variance with the templates. And yes, this is one of the things 
we didn't get a chance to talk about at GUADEC. The templates were
written (or changed) after those docs went in. This is one of the
reasons I was perplexed about the templates and asked about them,
because they're different in structure from what there was already
in gnome applets and seemed to include things inside other things
in a different way.

An "intro chapter" we can have xrefs to turns out to be a real 
problem (sigh). Whilst it's much much better from a docs point of 
view (logical, less repetitive, etc etc) to have it, apparently 
there is no logical place in gnome-applets to put it, because 
docs are typically put in a particular place in an app's directory, 
and there is currently nowhere logical or obvious for any intro or 
free-standing chapter to go.

Telsa