possible documentation viewer?

[Henrik Nilsen Omma]

Sean Wheller wrote:

>On Friday 03 June 2005 17:00, Jeff Waugh wrote:
>  
>
>>>Yelp is a *GNOME* help viewer for *GNOME Documents* on *GNOME Apps*.
>>>      
>>>
>>And displays HTML where required.
>>    
>>
>
>Yes, and this, considering the things we want  to do, is why I chose X/HTML so 
>that the docs can still be viewed under Yelp and KHelpcenter and any browser. 
>It's just that we do not have to concern ourselves with the overhead over 
>compatability and support for various things not supported in Yelp.
>  
>
So it's starting to look like we might just have a large
misunderstanding here (at least I have misunderstood). When you say 'web
application' you actually mean static HTML pages that sit on the user's
machine. We just have to generate those to contain internal links and
whatever graphics we want. I've just tested this in Yelp and it works
fine. It renders a local copy of the main Ubuntu homepage and manages
local and external links (launched in Firefox) just fine.

So providing help pages in HTML that Yelp can read is something we can
talk about. We still need to keep the layout simple though; Matthew
Thomas had some examples of this before.

That still leaves the question of the Gnome help files, which we
presumably want to link through to from the Ubuntu help pages. Do we
port those over to DocBook so we can re-export them in an HTML version?
That might be a good opportunity to add some Ubuntu branding to those.
Is that much more trouble than exporting the Ubuntu-specific docs to
standard Yelp-XML and linking them together that way?

Jeff: are there any inherent advantages to storing the help files in
Yelp-type-XML over more standard HTML given that  they would be
displayed by Yelp in either case?

- Henrik