tech@mandoc.bsd.lv
 help / color / mirror / Atom feed
From: "Anthony J. Bentley" <anthony@cathet.us>
To: Ingo Schwarze <schwarze@usta.de>
Cc: kristaps@bsd.lv, tech@mdocml.bsd.lv, Guy Harris <guy@alum.mit.edu>
Subject: Re: Is there any reason not to use <EM> for items emphasized with .Em?
Date: Tue, 12 Aug 2014 20:06:38 -0600	[thread overview]
Message-ID: <3063.1407895598@cathet.us> (raw)
In-Reply-To: <20140813011505.GA24152@iris.usta.de>

Hi Ingo,

Ingo Schwarze writes:
> i think this is an improvement but feel like knowing too little
> about HTML to just go ahead and commit.  Can either of you (or
> somebody else who feels at home with HTML) provide an OK?

I thought this would be a dead simple decision, but my email draft keeps
getting more and more complicated!

There are three HTML elements that could conceivably make sense here:
<i>, <em>, and <strong>.

mdoc(7):
"Denotes text that should be emphasised.  Note that this is a presentation
term and should not be used for stylistically decorating technical terms.
Depending on the output device, this is usually represented using an
italic font or underlined characters."

Based on this description, <i> would make the most sense. (Essentially,
I read it as being a straight equivalent to man(7)'s I macro.)

http://www.w3.org/html/wg/drafts/html/master/text-level-semantics.html#the-i-element

mdoc(7):
Examples:
      .Em Warnings!
      .Em Remarks:

Based on these examples, <strong> would make the most sense.

http://www.w3.org/html/wg/drafts/html/master/text-level-semantics.html#the-strong-element

Note that in the HTML world, <strong> is considered to be a semantic
element (unlike <i>). In practice, browsers display <strong> in boldface
but the standard would allow italics here because it is considered a
semantic element.

(As an aside, there are many uses of Sy in OpenBSD manpages like "Note:"
and "Important:". Based on mdoc(7) that seems to be misuse of
presentational macros.)

The third possible element is <em> itself. <em>'s raison d'être is
emphasis, such as most situations where you would use italics in prose
(although one exception would be "raison d'être" itself, which as a
foreign language idiom would be marked up with <i>...).

http://www.w3.org/html/wg/drafts/html/master/text-level-semantics.html#the-em-element

Honestly? I think this is just hair-splitting and we should use <em>
for Em. But if we do that, mdoc(7) probably should be revised for clarity.

-- 
Anthony J. Bentley

--
 To unsubscribe send an email to tech+unsubscribe@mdocml.bsd.lv

  reply	other threads:[~2014-08-13  2:06 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-08-12 22:44 Guy Harris
2014-08-13  1:15 ` Ingo Schwarze
2014-08-13  2:06   ` Anthony J. Bentley [this message]
2014-08-13 14:51     ` Ingo Schwarze
2014-08-13 15:17       ` Anthony J. Bentley
2014-08-13 17:49         ` Ingo Schwarze
2014-08-13  1:44 ` Joerg Sonnenberger
2014-08-13 15:30   ` Ingo Schwarze
2014-08-13 17:20 ` Ingo Schwarze
2014-08-13 18:53   ` Guy Harris
2014-08-13 23:24   ` Kristaps Dzonsons
2014-08-14  0:46     ` Ingo Schwarze
  -- strict thread matches above, loose matches on Subject: below --
2012-12-21  0:30 Guy Harris

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=3063.1407895598@cathet.us \
    --to=anthony@cathet.us \
    --cc=guy@alum.mit.edu \
    --cc=kristaps@bsd.lv \
    --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).