discuss@mandoc.bsd.lv
 help / color / mirror / Atom feed
From: Ingo Schwarze <schwarze@usta.de>
To: discuss@mdocml.bsd.lv
Subject: Re: Raw UTF-8?
Date: Wed, 7 Jul 2010 22:13:14 +0200	[thread overview]
Message-ID: <20100707201314.GB19725@iris.usta.de> (raw)
In-Reply-To: <4c349192.071f960a.7247.2ccd@mx.google.com>

Hi Anthony,

Anthony J. Bentley wrote on Wed, Jul 07, 2010 at 08:39:09AM -0600:

> mandoc_char(7) isn't much help either, as it's several pages long and
> doesn't display the actual character in the terminal,

See the problem?
In the manual you write, \(/o won't be displayed either,
no matter how you try to input it.

The output is the problem here, not the input.

I think we should reorganize mandoc_char(7) in the following way.

 1) First the sane escape sequences that render well everywhere
    and serve a real purpose.

    Examples: \~ \  \& \(ba \(em \(en \(hy \e \-

    The number of sane sequences is relatively small,
    which will also solve the problem you are pointing
    out above:  mandoc_char(7) is unreasonably long.
    A typesetting system like TeX needs long character
    tables, and it needs the ability to print obscure
    characters.  A manual page does not.

 2) Then a sentence explaining that what follows is rarely
    needed, because mandoc(1) is not really intended for
    general purpose typesetting, and much less typesetting
    of mathematical formulas, but just for writing manuals,
    encouraging people to express their intention using text,
    not symbols.  Still, all escape sequences in this
    section are guaranteed to render well and may be useful
    in uncommon situations.

    Examples: \(co \(rg \(-> \(rA \(+- \(<= \*(Pi

 3) Then a sentence explaining that what follows is rarely
    needed, because mdoc(7) has alternative concepts handling
    the typical use case better.  Note that writing new man(7)
    code is discouraged anyway.
    Still, all escape sequences in this section are guaranteed
    to render well and may be useful in very uncommon situations.

    Examples: \0  -- use .Dl or .Bd -literal
              \bu -- use .Bl -bullet
              \lq -- use .Qq or .Qo
              \lB -- use .Bq or .Bc

 4) Then a sentence mildly discouraging the use of what follows,
    listing obsolete sequences that render well, but are not
    needed at all because equivalent recommended escape sequences
    exist.

    Examples: \^ \% \| \(at \(mi \(eq \*(Ba

 5) Then a sentence strongly discouraging any use of the rest,
    listing those escape sequences that render badly.

    Examples: \(r! \(sr \(ss \('e \(`u \(~n \(:a \(^o \(,c \(oa \(eu

    Obviously, this is by far the largest group.

Yours,
  Ingo
--
 To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv

  reply	other threads:[~2010-07-07 20:13 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-07-07  3:13 Anthony J. Bentley
2010-07-07  9:33 ` Kristaps Dzonsons
2010-07-07 14:39   ` Anthony J. Bentley
2010-07-07 20:13     ` Ingo Schwarze [this message]
2010-07-07 18:58 ` Ingo Schwarze
2010-07-07 19:18   ` Joerg Sonnenberger
2010-07-07 21:12     ` Ingo Schwarze
2010-07-07 21:17       ` Joerg Sonnenberger
2010-07-09 21:05         ` Ulrich Spörlein
2010-07-10 18:11           ` J.C. Roberts
2010-07-11 22:17             ` Ingo Schwarze
2010-07-11 22:38           ` Kristaps Dzonsons
2010-07-13 19:23             ` Ulrich Spörlein
2010-07-13 23:25               ` Kristaps Dzonsons

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=20100707201314.GB19725@iris.usta.de \
    --to=schwarze@usta.de \
    --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).