From: "Robert P. J. Day" <rpjday@crashcourse.ca>
To: Yocto discussion list <yocto@yoctoproject.org>
Subject: having yocto-docs take advantage of more docbook tags
Date: Fri, 2 Jan 2015 05:16:51 -0500 (EST) [thread overview]
Message-ID: <alpine.LFD.2.11.1501020510460.8468@localhost> (raw)
i mentioned this once upon a time but i figure it's worth bringing
up again ... i think it would be useful to drag at least a few more
relevant docbook tags into the yocto-docs documents.
case in point: the most common way right now to render something in
monospaced font is to just tag it as a <filename>, but that really
shouldn't be used for things that aren't filenames, such as, you know,
variables. for variables like, say, SRC_URI, there is the <varname>
tag, which for HTML renders the variable name not just in monospaced
but slightly smaller font size, which i think looks *way* nicer.
one other tag that i like using in other places is <firstterm>,
which is used to emphasize that this is the first time a term/phrase
is being used. and while that is typically rendered just in italics,
it's still useful semantic markup for the purpose of building indices.
anyway, apologies if all this is already underway.
rday
--
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================
reply other threads:[~2015-01-02 10:17 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=alpine.LFD.2.11.1501020510460.8468@localhost \
--to=rpjday@crashcourse.ca \
--cc=yocto@yoctoproject.org \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.