Re: Milestones document

Ali Abdin wrote:
> I think its a bit 'difficult' to write documentation - There is no
> DOCUMENTED way of writing API documentation - Although there is
> documentation for writing whitepapers.
> Also - I think people who want to contribute (well, me at least) - get
> discouraged because I have to learn DocBook (all I know is that I
> installed these RPMS for documentation). Also, I heard that people author
> DocBook stuff using emacs in PSGML mode. A) I use vi B) What the hell is
> PSGML mode? C) see my reference for documentation on writing API
> documentation (i.e. what are the procedures one should take?)

PSGML mode is simply a set of custom keybindings in emacs
to make common SGML authoring tasks easier.  Since the
docbook input files are plain text to begin with, you can
use whatever editor you desire.  If you surf around for 
a while, you'll find the official docbook reference guide,
which is quite extensive.  The tutorial available from 
cygnus is pretty good to start out with, too.

-- ebm
|  __                         a.k.a. Eric B. Mitchell |
|  |_) .  _  _|      _|  _    |
|  | \ ( (_ (_| (_| (_| (/_  |
| How's My Programming?   Call:  1 - 800 - DEV - NULL |

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