Re: adding docs/* to reference manual
- From: Havoc Pennington <hp redhat com>
- To: Eric Lemings <eric b lemings lmco com>
- Cc: gtk-devel-list gnome org
- Subject: Re: adding docs/* to reference manual
- Date: 01 Feb 2001 16:09:20 -0500
Eric Lemings <eric b lemings lmco com> writes:
> I would suggest NOT putting this information in the Reference Manual
> since this document is, IMHO, specifically used as a programmer's
> reference for API specifications. GLib and Gtk+ programmers go there to
> see how a particular function, macro, or data structure is defined and
> how it should be used. Nothing else is needed in the Reference Manual.
>
> As for the above material, I would suggest however composing this
> information into a SEPARATE document like a User's Guide similar to the
> templates and formats of the gnome-doc tools for example or just plain
> ol' Docbook stylesheets. This document could go into a separate
> directory alongside the reference directory.
>
I don't see the value in splitting it - just makes cross-references
etc. hard to implement.
The manual is already > 1000 pages printed, so it's not like we need
to keep it small. ;-)
Havoc
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]