From: Ingo Schwarze <schwarze@usta.de>
To: Steffen Nurpmeso <sdaoden@yandex.com>
Cc: tech@mdocml.bsd.lv
Subject: Re: mdocml's .Ql doesn't map to original and GNU mdoc(7)
Date: Fri, 2 Jan 2015 17:03:34 +0100 [thread overview]
Message-ID: <20150102160333.GI32031@iris.usta.de> (raw)
In-Reply-To: <20150102142922.fUbQrsIoLBuOlbo2@yandex.com>
Hi Steffen,
Steffen Nurpmeso wrote on Fri, Jan 02, 2015 at 03:29:22PM +0100:
> No, no that is not how i see it. I _think_ of it in terms of
> <code></code> rather than <tt></tt>. Because i only know .Dl
> (which rather requires a leading .Pp) and ".Bd -literal" to
> achieve the same for a block, no macro that i know of except .Ql
> can be used to display some code inline.
Oh. Now i understand why you consider it semantic markup.
You don't consider "literal" as a font specification, but
in the sense of "literal display", "text copied verbatim".
I have no idea whether Cynthia originally considered it as
semantic markup or as physical markup, and how much she even
thought about the distinction (one day, i might ask her :).
But i'm always happy if we can tweak the documentation to make stuff
usable for semantic purposes, as long as that doesn't totally break
existing usage - which doesn't seem the case here.
So, what do you think about the following patch, documenting
it as semantic rather than physical markup? I think i now like
the idea, one more semantic macro, one less physical. :-)
Yours,
Ingo
Index: mdoc.7
===================================================================
RCS file: /cvs/src/share/man/man7/mdoc.7,v
retrieving revision 1.128
diff -u -r1.128 mdoc.7
--- mdoc.7 31 Dec 2014 20:41:53 -0000 1.128
+++ mdoc.7 2 Jan 2015 15:45:00 -0000
@@ -454,6 +454,7 @@
.Op Fl compact
.It Sx \&D1 Ta indented display (one line)
.It Sx \&Dl Ta indented literal display (one line)
+.It Sx \&Ql Ta in-line literal display: Ql text
.It Sx \&Bl , \&El Ta list block:
.Fl Ar type
.Op Fl width Ar val
@@ -528,7 +529,6 @@
.It Sx \&Dq , \&Do , \&Dc Ta enclose in typographic double quotes: Dq text
.It Sx \&Qq , \&Qo , \&Qc Ta enclose in typewriter double quotes: Qq text
.It Sx \&Sq , \&So , \&Sc Ta enclose in single quotes: Sq text
-.It Sx \&Ql Ta single-quoted literal text: Ql text
.It Sx \&Pq , \&Po , \&Pc Ta enclose in parentheses: Pq text
.It Sx \&Bq , \&Bo , \&Bc Ta enclose in square brackets: Bq text
.It Sx \&Brq , \&Bro , \&Brc Ta enclose in curly braces: Brq text
@@ -1256,7 +1256,9 @@
.Dl \&.Dl % mandoc mdoc.7 \e(ba less
.Pp
See also
+.Sx \&Ql ,
.Sx \&Bd
+.Fl literal ,
and
.Sx \&D1 .
.Ss \&Do
@@ -2221,14 +2223,21 @@
Close quoted context opened by
.Sx \&Qo .
.Ss \&Ql
-Request a literal font and enclose in single quotes.
-For arguments of three or more characters, formatters other than
+In-line literal display.
+This can for example be used for complete command invocations and
+for multi-word code fragments when more specific markup is not
+appropriate and an indented display is not desired.
+While
.Xr mandoc 1
-usually omit the quotes on non-terminal output devices.
+always encloses the arguments in single quotes, other formatters
+usually omit the quotes on non-terminal output devices when the
+arguments have three or more characters.
+.Pp
See also
-.Sx \&Li
+.Sx \&Dl
and
-.Sx \&Sq .
+.Sx \&Bd
+.Fl literal .
.Ss \&Qo
Multi-line version of
.Sx \&Qq .
--
To unsubscribe send an email to tech+unsubscribe@mdocml.bsd.lv
next prev parent reply other threads:[~2015-01-02 16:03 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-12-29 12:17 Steffen Nurpmeso
2014-12-29 19:36 ` Ingo Schwarze
2014-12-29 20:20 ` Steffen Nurpmeso
2014-12-31 20:51 ` Ingo Schwarze
2015-01-01 19:01 ` Steffen Nurpmeso
2015-01-02 12:36 ` Ingo Schwarze
2015-01-02 14:29 ` Steffen Nurpmeso
2015-01-02 16:03 ` Ingo Schwarze [this message]
2015-01-02 18:56 ` Steffen Nurpmeso
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=20150102160333.GI32031@iris.usta.de \
--to=schwarze@usta.de \
--cc=sdaoden@yandex.com \
--cc=tech@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).