[haiku] Re: Documenting your package
- From: pete.goodeve@xxxxxxxxxxxx
- To: haiku@xxxxxxxxxxxxx
- Date: Mon, 4 Apr 2016 11:34:35 -0700
On Mon, Apr 04, 2016 at 11:13:43AM +0300, Rimas Kudelis wrote:
2016-04-04 11:04, Ingo Weinhold raÅ¡Ä:
The point is to avoid burying type-like directories (info, man) and
system documentation under a heap of packages documentation. FWIW the
man package's documentation (if we provided it) would also clash with
the man pages directory.
Wouldn't /system/documentation/[info|man|html|pdf|other]/ make a bit
more sense?
No, I don't like that idea at all. The user is interested in *finding* the
documentation
for a package, not its form. The OS will happily open the right reader on it
(text, HTML,
PDF, etc.).
man and info are not so Haiku friendly, though. You have to use the ***x
command-line
programs to read them, so they do need their own hierarchy. (I wonder if it
would be
worth giving them mimetypes, and preferred apps, so a user *could* click on the
file
to read it? You could even then have links to those pages from the main doc
folder for
that app [I actually long ago set up a xicon script that you can drop a man
file on to read].)
I guess I can live with .../documentation/packages as long it is a clear
standard, documented
somewhere.
-- Pete --
Other related posts:
