tech@mandoc.bsd.lv
 help / color / mirror / Atom feed
From: Steffen Nurpmeso <sdaoden@yandex.com>
To: Ingo Schwarze <schwarze@usta.de>
Cc: tech@mdocml.bsd.lv
Subject: Re: mdocml's .Ql doesn't map to original and GNU mdoc(7)
Date: Mon, 29 Dec 2014 21:20:24 +0100	[thread overview]
Message-ID: <20141229202024.niCQvsnl%sdaoden@yandex.com> (raw)
In-Reply-To: <20141229193631.GE17408@iris.usta.de>

Hallo Ingo,

Ingo Schwarze <schwarze@usta.de> wrote:
 |Steffen Nurpmeso wrote on Mon, Dec 29, 2014 at 01:17:46PM +0100:
 |> mdocml's mdoc.7 says
 |> 
 |>   Ql  single-quoted literal text: `text'
 |> 
 |> but that is not what .Ql is about:
 |> 
 |>   .Ql   The quoted literal macro behaves differently in troff
 |>         and nroff mode.[.]

 |> The behaviour is already device-dependent in "old -mdoc", before
 |> 1991-03-07.
 |
 |The .Ql macro is physical markup, so it is rarely used in modern
 |mdoc(7) documents.  Actually, i wouldn't know what purpose to
 |recommend it for, at all.
 |
 |For terminal output, precise output compatibility with groff
 |matters.  For other output modes, not so much.  For a rather

Yes.., but.., please consider the following.
The problem i (actually) have (had) with this is (that) mdocml's
mdoc.7 is installed in place of the "upstream" version (in fact
even overwriting it if you don't be careful) and can be expected
to increasingly become _the_ source of information on mdoc(7),
except maybe in some hardcore GNU places.  As such it spreads
false information, which will bite the unaware: i maybe was only
the first in a long long line of misleaded persons.

 |obscure legacy macro such as .Ql, even less.  So i'd rather
 |keep output consistent across devices instead of emulating
 |historical behaviour.  Besides, PostScript and PDF output have
 |much worse formatting issues than this.  Even for HTML output,
 |there are more interesting things to do.
 |
 |> (Without history i'm guessing, but maybe mdocml was
 |> ment for TTY only at first glance,
 |
 |Not quite, the original motivation for mdoc*ML* was HTML output,
 |and for the first three months of development, HTML was the
 |only output mode.  Kristaps only started coding terminal output
 |on February 20, 2009.

Ah.  I didn't know that.  (I only once have seen Kristaps'
i guess initial announcement of mdocml in the groff list
archives.)

 |> in which case the above is absolutely correct, but it lost that
 |> property once more output formats where added?)
 |
 |No, that's not what happened.

Well, wild guess leading to nowhere.

How about something as simple as the following, giving some
indication that there may be portability issues?

diff --git a/mdoc.7 b/mdoc.7
index c2ac5aa..cdc92a3 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -528,7 +528,7 @@ in the alphabetical
 .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 \&Ql Ta format 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
@@ -2201,7 +2201,10 @@ See also
 Close quoted context opened by
 .Sx \&Qo .
 .Ss \&Ql
-Format a single-quoted literal.
+Format a quoted literal.
+In
+.Xr mandoc 1
+the arguments are always enclosed in single-quotes.
 See also
 .Sx \&Qq
 and
--
 To unsubscribe send an email to tech+unsubscribe@mdocml.bsd.lv

  reply	other threads:[~2014-12-29 20:20 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 [this message]
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
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=20141229202024.niCQvsnl%sdaoden@yandex.com \
    --to=sdaoden@yandex.com \
    --cc=schwarze@usta.de \
    --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).