clone 607498 -1
retitle -1 doc-base: not clear what to do with multiple-file text documents
severity -1 wishlist
quit
Robert Luberda wrote:
> And this is the main problem here - how doc-base or other tools should
> handle documentation consisting of multiple text documents? I've just
> checked how your doc-base file is showed by the available front-ends, and:
> - dhelp shows the first file (/usr/share/doc/fcitx/Develop_Readme) only
> - dwww ignores your doc-base file entirely
> - doc-central fails to show the documentation, because "The requested
> URL /doc/fcitx/Develop_Readme /doc/fcitx/API.txt.gz
> /doc/fcitx/pinyin.txt was not found on this server."
>
> The similar problem exists in case of doc-rfc-* packages, that registers
> entries like this:
> Format: Text
> Files: /usr/share/doc/RFC/informational/*.txt.gz
> Also in this case, none of the available frontends is able to handle
> such entries. (To be honest I've just came up with some idea how to show
> those entries to the user - namely by generating some page with links to
> all registered files - I'll try to implement this solution in dwww at
> spare time).
[and many other useful things]
Thanks for a thorough explanation. I agree with everything you said,
which suggests:
1) the doc-base policy should recommend against multiple-file text
documents for now
2) frontends should be encouraged to support multiple-file text
documents by generating an index
3) Index should probably be allowed, for supplying a cover
page/introductory information to go along with the generated index
Cloning the bug so this is not forgotten.
--
To UNSUBSCRIBE, email to [email protected]
with a subject of "unsubscribe". Trouble? Contact [email protected]
