discuss@mandoc.bsd.lv
 help / color / mirror / Atom feed
From: Robert Mustacchi <rm@fingolfin.org>
To: discuss@mandoc.bsd.lv
Subject: Cross references to specific sections in other manual pages
Date: Sun, 17 Feb 2019 16:09:38 -0800	[thread overview]
Message-ID: <dd505850-fb15-e56d-226a-8bbe7263df32@fingolfin.org> (raw)

Hi,

While writing manual pages for illumos, I've often wanted to
semantically indicate a cross-reference to a specific section of another
manual page. One place this comes up for us is in library documentation
where we have an introductory page that contains information about
errors or required locking. It also sometimes comes up in our device
driver manual pages. An example of this is a sentence of the form 'For
more information, see the LOCKING section of libproc(3LIB).'

I don't believe there's a good way to do this today as the .Sx macro
always is supposed to be internal to the page and the .Xr macro doesn't
allow one to target a specific section or sub-section header (.Sh / .Ss).

Would a new macro (or extension to an existing one) that semantically
indicated such a cross-reference to a particular .Sh/.Ss in another page
be of interest to others? I'm not sure if this is something that should
be elevated into its own macro. If folks think it might be useful, I'm
happy to take a look at implementing it.

Thanks,
Robert
--
 To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv

             reply	other threads:[~2019-02-18  0:09 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-02-18  0:09 Robert Mustacchi [this message]
2019-02-19 22:35 ` Ingo Schwarze
2019-02-27  0:51   ` Robert Mustacchi
2019-02-27 13:57     ` Ingo Schwarze

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=dd505850-fb15-e56d-226a-8bbe7263df32@fingolfin.org \
    --to=rm@fingolfin.org \
    --cc=discuss@mandoc.bsd.lv \
    /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).