Hi, Now it is:
---- <sect id="doc-base">ex.package.doc-base <p>If your package has documentation other than manual pages and info docs, you should use the `<package/doc-base/' file to register it, so the user can find it with e.g. <manref name="dhelp" section="1">, <manref name="dwww" section="1"> or <manref name="doccentral" section="1">. <p>This usually includes HTML, PS and PDF files, shipped in <file>/usr/share/doc/packagename/</file>. <p>This is how gentoo's doc-base file <tt>gentoo.doc-base</tt> looks like: <p><example> Document: gentoo Title: Gentoo Manual Author: Emil Brink Abstract: This manual describes what Gentoo is, and how it can be used. Section: Apps/Tools Format: HTML Index: /usr/share/doc/gentoo/html/index.html Files: /usr/share/doc/gentoo/html/*.html </example> <p>For information on the file format, see <manref name="install-docs" section="8"> and the <package/doc-base/ manual, in <file>/usr/share/doc/doc-base/doc-base.html/</file>. --- <sect id="doc-base">ex.package.doc-base <p>If your package provides documentation other than manual pages and info docs, you should use the `<package/doc-base/' file to register it, so the user can find it with e.g. <manref name="dhelp" section="1">, <manref name="dwww" section="1"> or <manref name="doccentral" section="1">. <p>This usually includes HTML, PS and PDF files, shipped in <file>/usr/share/doc/packagename/</file>. <footnote> These documentstion files needs to be generated and/or copied to the appropriate location in the package build scripts, e.g. by the <tt>all</tt> target in the <file>Makefile</file> or using debhelper configuration file such as <file>gentoo.install</file> with <manref name="dh_installdocs" section="1">. </footnote> <p>This is how gentoo's doc-base file <tt>gentoo.doc-base</tt> looks like: <p><example> Document: gentoo Title: Gentoo Manual Author: Emil Brink Abstract: This manual describes what Gentoo is, and how it can be used. Section: Apps/Tools Format: HTML Index: /usr/share/doc/gentoo/html/index.html Files: /usr/share/doc/gentoo/html/*.html </example> <p>For information on the file format, see <manref name="install-docs" section="8"> and the <package/doc-base/ manual, in <file>/usr/share/doc/doc-base/doc-base.html/</file>. --- Changed "has" to "provides" and added footnote. What do you think? I changed to "provides" since some package generates these from SGML or TeX source file sets. So we may not be just copying files. Also this can be done with script within build target of debian/rules file to. So many ways to do this. So I want to keep it generic with minimum hints. I think "register" is the key word here. "register it to the doc-base data base" may be full text but I respected the simple style of the original author and avoided redundant English. Osamu -- To UNSUBSCRIBE, email to [EMAIL PROTECTED] with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]
