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

Documentation formats



[ Please don't Cc: me when replying to my message on a mailing list. ]

Kai Henningsen:
> Maybe for people that like Emacs. Info has the same significantly less- 
> than-intuitive user interface, so at least for me, man pages work far  
> better as tutorials ... fighting with the interface *does* tend to  
> distract from the text.

Since I think I managed not to break that one... info2www
is fairly good for browsing Info. You need a httpd and a web
browser, though. Making HTML from Texinfo with texi2html is
even better.

Debian packages should provide HTML versions of Info files
as well. Fortunately, this is pretty trivial. You need to
install texi2html and format the documentation using a command
such as
  
    texi2html -split_node -expandinfo -menu -glossary -number <texinfo file>

And, of course, install the generated files somewhere below
/usr/doc/<package>. The options may need tweaking for different
documents.

One more thing: Add a file /usr/doc/<package>/.dwww-index, which
looks something like

	#section general
	<dt><a href="hello/hello.html">GNU Hello</a>
	<dd>The Hello program greets the users. This is the GNU version of
		this popular utility. (Really: This is an example package
		that shows Debian developers how packages are created.)

Also add the following command to postinst and postrm:

	if [ -x /usr/sbin/dwww-doc-index ]
	then
		/usr/sbin/dwww-doc-index
	fi

This will create a long and a short index of documents for dwww.
If you don't run dwww-doc-index, then it will be run by dwww's
daily crontab entry, but it's better to do it at once.

(We'll get a working dwww soonish. The index stuff doesn't work
with the current version in unstable. The info2www stuff is not
directly a part of dwww, and it works fine.)

-- 
Please read <http://www.iki.fi/liw/mail-to-lasu.html> before mailing me.
Please don't Cc: me when replying to my message on a mailing list.


Attachment: pgpaPOgbYdCV0.pgp
Description: PGP signature


Reply to: