implementing TopicBasedHelp

[Richard Johnson]

On Sunday 03 December 2006 11:30, Matthew East wrote:
[snip]
> Unsurprisingly, the Gnome help browser has this feature as well, but I
> explicitly avoided suggesting it, for two reasons. First, which is
> irrelevant to Kubuntu, it requires installing the documents in
> /usr/share/gnome/help/, whereas we've traditionally installed them in
> /usr/share/ubuntu-docs. But more importantly, in order to retain
> DE-neutrality. That way, material which is copied from Ubuntu to
> Kubuntu, or vice versa, we don't have to go around changing all the links.

Good point. All of the KDE/Kubuntu documentation is placed 
in /usr/share/doc/kde/HTML/en/, so Kubuntu is following along with KDE on the 
documentation location, and just adding a kubuntu/ subdirectory.

[snip]
> > With the Edubuntu handbook, I broke each chapter into a seperate file.
> > The best thing about this is it is easier to task out each chapter. This
> > way here you can work on a chapter and not have to worry about someone
> > else needing to work on it as well. So breaking down either each topic
> > into a file, or break each topic down into subtopic files will work as
> > well.
>
> Erm. All our substantial documents (desktop guide, server guide and so
> on) have done this for the last 2 or 3 releases... I'm not quite sure
> where you're going with this.

Well, each chapter is one topic with the Edubuntu Handbook, whereas with our 
Desktop Guide and what not, each chapter could contain a couple different 
topics. With the Handbook, there would be a file for Installing Standalone, 
then one for Post-Installation, and so on. There are roughly 30 xml files for 
the Handbook. Now if we break down each topic or question there will be a 
greater number of files. It is bringing them/linking them to a main document. 
Whereas when we validate, it specifically tells you where the buggered part 
is, with the Handbook it gives you a line number from the handbook.xml file 
when the error is actually in another file. That is what I was referring to 
really.

-- 
.:Richard Johnson
.:nixternal at ubuntu.com
.:ubuntu.com .:kubuntu.com .:edubuntu.com .:xubuntu.com
.:http://nixternal.ubuntu-rocks.org
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20061203/489b1b85/attachment.pgp>