From: Kristaps Dzonsons <kristaps@bsd.lv>
To: "discuss@mdocml.bsd.lv" <discuss@mdocml.bsd.lv>
Subject: Giving up on emulating SYNOPSIS vspace.
Date: Mon, 07 Jun 2010 01:18:28 +0200 [thread overview]
Message-ID: <4C0C2CC4.3040306@bsd.lv> (raw)
Hi,
As you may know from the commits, I've been trying to normal-form
groff's SYNOPSIS behaviour regarding vertical spacing. I have failed.
Anything but using "normal" SYNOPSIS macros produces catshit.
If you really want to cover groff's behaviour, send me patches and I'll
find behaviour that breaks them. Instead I propose making consistent
rules out of observed, normative behaviour, then going from there.
*Please give feedback on this*: the SYNOPSIS is very important. I will
hold off on implementing my suggestion until I have some oks. It's a
trivial implementation and will result in some nice cleanup, and is
easily documented.
Note that I'll only discuss 'function' manual sections in this email,
i.e., Fn/Ft/etc., not Nm/Op/etc, which is much easier. You'll see what
I mean. Nm/Op is more straightforward (let's leave this discussion for
later).
First, I propose that SYNOPSIS sections be grouped into the following
macro sets,
.In
.Ft/Fn ("combo", i.e., one after the other)
.Ft/Fo (same)
.Fo
.Fn
.Fd
with rules as follows. Any macro/combo of these sets will be preceded
and proceeded by a newline. It doesn't matter what the hell comes
before or after or whether these are line macros or not.
Next, non-like pair-wise sets will be separated by a single vertical space.
Lastly, like pairwise Ft/Fn, Ft/Fo, Fo, and Fn are separated by a single
vertical space.
That's it. Simple, no?
Please let me know ASAP, as I want to tag version 1.10.1 and move on
with PostScript and Ingo's block-breaking patches.
Thanks,
Kristaps
--
To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv
next reply other threads:[~2010-06-06 23:18 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-06-06 23:18 Kristaps Dzonsons [this message]
2010-06-06 23:42 ` Jason McIntyre
2010-06-07 11:12 ` Kristaps Dzonsons
2010-06-07 23:26 ` Ingo Schwarze
2010-06-07 23:42 ` Kristaps Dzonsons
2010-06-08 0:06 ` Ingo Schwarze
2010-06-08 9:13 ` OT: Vt vs. Ft/Fn (WAS: Giving up on emulating SYNOPSIS vspace.) Kristaps Dzonsons
2010-06-08 10:02 ` Thomas Klausner
2010-06-08 12:06 ` Kristaps Dzonsons
2010-06-12 18:05 ` Vt vs. Ft/Fn Ingo Schwarze
2010-06-07 0:35 ` Giving up on emulating SYNOPSIS vspace 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=4C0C2CC4.3040306@bsd.lv \
--to=kristaps@bsd.lv \
--cc=discuss@mdocml.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).