bug-gnulib
[Top][All Lists]
Advanced

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

Re: [Bug-gnulib] html/doc target in coding standards


From: Alexandre Duret-Lutz
Subject: Re: [Bug-gnulib] html/doc target in coding standards
Date: Mon, 11 Oct 2004 21:09:02 +0200
User-agent: Gnus/5.1003 (Gnus v5.10.3) Emacs/21.3.50 (gnu/linux)

Hi Bruno!

>>> "Bruno" == Bruno Haible <address@hidden> writes:

[...]

 Bruno> What does "documentation in XML format" mean? Do you
 Bruno> mean a particular instantiation of XML (such as
 Bruno> DocBook)? What program do you assume people use for
 Bruno> "viewing" XML documentation?

Being not an XML freak myself I enquired about this too.  Here
is Karl's answer.

 |     is XML really used as installed documentation?  
 | 
 | It can be.  You can view XML files directly in mozilla (and
 | other browsers, I suppose).  You're right that it's usually
 | used as a basis for further transformations, but even then, I
 | don't see a reason not to install it -- could be useful to
 | have it there for that purpose.  And finally, not treating it
 | like the others will be huge source of confusion, I feel
 | sure.

 >> +If your package has multiple manuals, or you wish to install HTML
 >> +documentation with many files (such as the ``split'' mode output by
 >> address@hidden --html}, we recommend that you avoid collisions and
 >> +clutter by arranging for these targets to install in subdirectories of
 >> +the appropriate installation directory, such as @code{htmldir}.

 Bruno> What does this paragraph mean? As I understand, htmldir
 Bruno> defaults to $(docdir), and @docdir@ depends on
 Bruno> @address@hidden So there is no "clutter" problem in this
 Bruno> case.

The paragraph is about packages with multiple manuals.  For
instance consider the mess it would be if emacs were to install
split HTML for all its manuals in $(htmldir) directly, with all
the nodes `emacs.texi', `elisp.texi', `gnus.texi', etc. mixed in
the same directory.  The point is just to state that creating
subdirectories is OK.
-- 
Alexandre Duret-Lutz





reply via email to

[Prev in Thread] Current Thread [Next in Thread]