Contributed by rueda on Wed Mar 15 22:12:10 2017 (GMT)
from the doctoring mandoc dept.
Ingo Schwarze (schwarze@) has written in with another (beautifully formatted)
report on even more great mandoc(1)
Half a dozen new features in mandoc -T html
The HTML output mode of
just grew a couple of new features.
I'm providing this short summary because it's all user-visible and might
make using the online manuals easier.
is a semantic markup language, traditionally none of the
were communicated to the reader: at display time, semantic annotation
is whittled down to presentational markup of bold, italic,
typewriter and little else.
Now, at least in
html output mode, you can see the
semantic function of marked-up words by hovering your mouse over them.
That is useful because it may occasionally help understanding the text,
because it definitely helps to develop the ability of using
semantic search efficiently, and because slowly becoming familiar
with the macro keys also helps to lower the entry barrier
for users who consider sending patches.
In terminal output modes, we have the
internal search facility built around the
feature for quite some time now, see the description of the
variable in the
We now have a similar feature in
html output mode.
To jump to (almost) the same places in the text, go to the address
bar of the browser, type a hash mark ('#') after the URI, then the
name of the option, command, variable, error code etc. you want ot
jump to, and hit enter.
These internal jump targets suitable for deep linking have
a dotted underline
in HTML+CSS output,
and if you hover over them, you can easily copy out the deep link
URI because these places also link to themselves for convenience.
Macro key display and deep linking as described in the
items 1-3 above are also available for manuals written in the old
language, but since that language doesn't provide semantic markup,
.UR macros provide anchors for now.
Obviously, these improvements are most useful in the context of
The CGI frontend itself was also improved
with respect to two details:
<title> element now
shows the name and section number of the manual page.
When using the search form, you now get redirected
to concise URIs of the form:
The optional parts are omitted whenever possible.
Important parts of these features are based on ideas proposed by
Thomas Güttler and