From: Ingo Schwarze <schwarze@usta.de>
To: mario.blaettermann@gmail.com
Cc: discuss@mandoc.bsd.lv
Subject: Re: HTML output: section headers with diacritics not in table of contents
Date: Sat, 26 Mar 2022 10:25:43 +0100 [thread overview]
Message-ID: <Yj7cF7D3DiE73t4z@asta-kit.de> (raw)
In-Reply-To: <Yj4yHgDADlRCBZFd@www.stare.cz>
Hi Mario,
Jan Stary wrote on Fri, Mar 25, 2022 at 10:20:30PM +0100:
> On Mar 25 21:59:26, mario.blaettermann@gmail.com wrote:
>> Am Fr., 25. März 2022 um 21:36 Uhr schrieb Jan Stary <hans@stare.cz>:
>>> On Mar 25 17:57:21, mario.blaettermann@gmail.com wrote:
>>>>> Regarding -O toc, you should be aware that a number of senior OpenBSD
>>>>> developers hated the feature so much that i disabled it completely
>>>>> on man.openbsd.org. They argue the feature is superfluous, noisy,
>>>>> and the whole idea of prefixing a TOC to a manual page is misguided.
>>>> To mention, the TOC works at man.openbsd.org, for example:
>>>> http://man.openbsd.org/mandoc#Syntax_tree_output
>>> I don't see a TOC on that page.
>> What you've expected is probably a TOC like [1].
> Yes, because that's what mandoc calls a TOC:
>
> toc If an input file contains at least two non-standard sections,
> print a table of contents near the beginning of the output.
Exactly.
To see what a "TABLE OF CONTENTS" (TOC) is, please look at
https://man.bsd.lv/pf.conf.5
where i just enabled TOCs for demonstrational purposes and compare
that page to
https://man.openbsd.org/pf.conf.5
where TOCs are disabled.
The mandoc(1) page never gets a TOC because it does not contain two
custom sections (in fact, not even one).
>> But the TOC generated
>> by Mandoc doesn't mean a real table of contents in this case, it's
>> merely a »hidden« TOC, which enables to click on section headers and
>> options to generate hyperlinks for that position. If you can open the
>> link mentioned above, and »Syntax tree output« is on top of the page
>> displayed in the browser, then this kind of TOC works.
>> [1] https://archlinux.org/pacman/makepkg.8.html
> I think these are 'tags' in the mandoc parlance.
> http://man.openbsd.org/mandoc#tag
Exactly, and that mandoc(1) terminology is motivated by this
pre-existing terminology:
https://man.openbsd.org/less.1#T
https://man.openbsd.org/ctags.1
Yours,
Ingo
--
To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv
prev parent reply other threads:[~2022-03-26 9:25 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-24 17:13 Mario Blättermann
2022-03-24 17:33 ` Michael Stapelberg
2022-03-24 18:00 ` Mario Blättermann
2022-03-25 12:27 ` Ingo Schwarze
2022-03-25 16:07 ` Mario Blättermann
2022-03-25 20:58 ` Jan Stary
2022-03-26 12:34 ` Ingo Schwarze
2022-03-26 13:35 ` Mario Blättermann
2022-03-25 16:21 ` Anthony J. Bentley
2022-03-25 21:15 ` Jan Stary
2022-03-26 10:33 ` Ingo Schwarze
2022-03-26 17:55 ` Anthony J. Bentley
2022-03-27 11:17 ` Ingo Schwarze
2022-03-27 11:44 ` Ingo Schwarze
2022-03-25 16:57 ` Mario Blättermann
2022-03-25 20:36 ` Jan Stary
2022-03-25 20:59 ` Mario Blättermann
2022-03-25 21:20 ` Jan Stary
2022-03-26 9:25 ` Ingo Schwarze [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=Yj7cF7D3DiE73t4z@asta-kit.de \
--to=schwarze@usta.de \
--cc=discuss@mandoc.bsd.lv \
--cc=mario.blaettermann@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).