discuss@mandoc.bsd.lv
 help / color / mirror / Atom feed
From: Ingo Schwarze <schwarze@usta.de>
To: Jan Stary <hans@stare.cz>
Cc: discuss@mdocml.bsd.lv
Subject: Re: Links into HTML page would be great
Date: Tue, 14 Mar 2017 18:17:14 +0100	[thread overview]
Message-ID: <20170314171714.GA19750@athene.usta.de> (raw)
In-Reply-To: <20170314093912.GA15549@www.stare.cz>

Hi Jan,

Jan Stary wrote on Tue, Mar 14, 2017 at 10:39:12AM +0100:

> in e.g.
> http://man.openbsd.org/vmctl.8#create
> the mouseover is "Cm", and it's "Fl" for the options,
> and similarly for "Sx", "Xr" and the others.
> 
>   <dt class="It-tag" style="margin-left: -6.60ex;"><a class="selflink"
>   href="#create"><b class="Cm" title="Cm" id="create">create</b></a>
> 
> That seems a bit odd to display.

What is odd about that?

> Is that intended?

Yes.

> I get why it's the class, but why is it the title?

Because semantic markup is the whole point of the mdoc(7) language,
and not communicating the semantics to the user is a shame and a waste?

For example, in a section 3 manual, italic font might mean a function
type, a variable type, a function argument, a variable name, a path
name, stress emphasis and so on...  Anywhere, typewriter font might
mean a preprocessor constant, an error constant, an environment
variable...  It is obviously useful to be able to distinguish these
possibilities without guessing, or isn't it?

Besides, you can search for these macros keys with apropos(1),
so getting familiar with them over time is very useful.

Besides, OpenBSD is a developer-oriented system.  We enncourage
users to improve the system and send patches.  Some become developers,
and there is no other way of becoming a developer.  Getting familiar
with the macros is not just useful to better understand the content,
and to use search facilities efficiently, but also to lower the
barrier for sending patches.

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

  reply	other threads:[~2017-03-14 17:17 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-02-28 14:33 Thomas Güttler
2017-03-12 18:08 ` Ingo Schwarze
2017-03-12 19:39   ` Ingo Schwarze
2017-03-13  9:42     ` Thomas Güttler
2017-03-13  9:56       ` Jan Stary
2017-03-14  1:49         ` Ingo Schwarze
2017-03-14  9:39         ` Jan Stary
2017-03-14 17:17           ` Ingo Schwarze [this message]
2017-03-13  9:59       ` Thomas Güttler
2017-03-13 15:32         ` Ingo Schwarze
2017-03-13 21:35       ` 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=20170314171714.GA19750@athene.usta.de \
    --to=schwarze@usta.de \
    --cc=discuss@mdocml.bsd.lv \
    --cc=hans@stare.cz \
    --subject='Re: Links into HTML page would be great' \
    /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

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).