Re: Help Documentation



On Fri, Dec 10, 1999 at 03:40:07PM +0000, u07ih@abdn.ac.uk wrote:
> Is there any standard to follow when writing help documentation? Say like the
> page background should be white, there should be a gnome logo at the top, then a
> horizontal rule.
> If there isn't, would it be a good idea to write one?
> 

Just use DocBook syntax (this is SGML/XML).  You don't have to care about
the appearance when writing the documentation, but just the structure.
All the look and feel will be determined by stylesheets when the
documentation is translated to HTML.

The advantage of this approach is that printable documentation can be
generated from the same source as well.

Hope this helps, Laurent.
-- 
Laurent Gauthier is lolo@seul.org +;+ ``Keep it simple: as simple as possible,
             at home              ;:;   but no simpler.''                    
        in Nozay (France)         +;+                          -- A. Einstein



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