More (sigh) questions: applet docs



I just downloaded the whole of gnome-applets from CVS before wasting
your time again with this one, but I didn't find the answer there.

I wombled over to the doctable to add an applet as "partly documented,
kind of, not yet linked into the program but..". And reading the applet 
guidelines I saw:

All applets should have a Manual, accessible by right clicking on the applet. 
All applets should have an About, accessible by right clicking on the applet. 
The top level of all applet documents should be <sect2>. (This allows us to 
compile all documents into a single work.)

I'm stupid. Does this mean I should just write something omitting this:

<doctype book blah blah>
 <book id="blah">
  <bookinfo>
   <title>Blah</title>
   ....
   <chapter id="whatever">
   ....
   <sect1 id="thingy">

...etc, and just start with 

<sect2 id="appletname">
 <title>Applet Name</title>
 <para>Blah intro blah</para>
  <sect3>

And turn all my sect1s into sect2s and 2s into 3s and so on, or what?

I tried writing something that started with <sect2> and db2html
grumbled and wouldn't validate it, but created something out of it,
at least. (I'm baffled on its naming scheme for the resulting html, 
mind you!)

I haven't quite got as far as entities and making documents that
go (stolen from the ORA DocBook book): 

<!ENTITY ch01 SYSTEM "ch01.sgm">
<!ENTITY ch02 SYSTEM "ch02.sgm">
<book>
&ch01;
&ch02;
</book>       

But is that the intention here? Then how do I decide what to call
the chapter? Just the name of the applet? In that case, will the
same file do for the help in the applet itself, or does that have
to have enough surrounding it for it to parse properly even in
the absence of the other chapters? I would guess the latter.

How do I test whether what I am writing is valid DocBook if it
doesn't have all that gubbins and just starts with sect2? Add
stuff in just for the purpose of testing? db2html won't validate
it, it just attempts to process it. 

I'm sorry, I seem to be asking a lot of questions here :( But I'm
terribly confused. I found DocBook and the other tools hard enough
to understand at first, then finally got a picture in my head of
how they fit together. But having got that far, I still need to
know more before apparently being able to produce anything usable.
I do read stuff and try things, honestly, but I'm beginning to
think it's just too complicated for me. 

I was really looking forward to the documentation workshop at
GUADEC to help me sort some of this out, but apparently that workshop
is not happening now :(

Telsa



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]