chiark / gitweb /
man: include the target name when linking to man pages in html output
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Mon, 23 Nov 2015 04:43:36 +0000 (23:43 -0500)
committerSven Eden <yamakuzure@gmx.net>
Wed, 17 May 2017 13:22:14 +0000 (15:22 +0200)
commit9ac0cc095b2d17cd0029048d902ff7b5e353e23e
treef3b54bd4b3036a5aadceea82f06dca046615e707
parentc3911d51469ebfc35075b48ef37ea57742731059
man: include the target name when linking to man pages in html output

Links like http://www.freedesktop.org/software/elogind/man/elogind.socket.html
are changed to http://www.freedesktop.org/software/elogind/man/elogind.socket.html#Accept=.

This implementation is quick & dirty, and misses various corner
cases. A fairly important one is that when a few directives share the
same anchor (which happens when multiple directives are described in
the same paragraph), generated links for everything except the first
one link to an invalid anchor. Another shortcoming is that the
formatting does not use the proper generateID machinery, so the anchor
name could be wrong in some cases. But it seems to work for a large
percentage of links, so seems to be an improvement in usability. When
the anchor is missing, we land at the top of the page, which is the
same as before. If the anchor were to point to different spot, this
would be more confusing... Not sure if that ever happens. Anyway, the
user should be able to recover from landing on the wrong place in the
page.

(Mostly) fixes https://github.com/elogind/elogind/issues/1956.
man/custom-html.xsl
tools/make-directive-index.py