All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Robert P. J. Day" <rpjday@crashcourse.ca>
To: "Rifenbark, Scott M" <scott.m.rifenbark@intel.com>
Cc: Yocto discussion list <yocto@yoctoproject.org>
Subject: Re: any plans on more carefully distinguishing docbook markup in yocto docs?
Date: Wed, 18 Jun 2014 07:49:49 -0400 (EDT)	[thread overview]
Message-ID: <alpine.LFD.2.11.1406180748290.6593@localhost> (raw)
In-Reply-To: <41DEA4B02DBDEF40A0F3B6D0DDB1237983FA8BC2@ORSMSX101.amr.corp.intel.com>

On Tue, 17 Jun 2014, Rifenbark, Scott M wrote:

> I could look at this... low on the priority list right now though
> but good point.
>
> Thanks,
> Scott
>
> >-----Original Message-----
> >From: yocto-bounces@yoctoproject.org [mailto:yocto-
> >bounces@yoctoproject.org] On Behalf Of Robert P. J. Day
> >Sent: Tuesday, June 17, 2014 5:51 AM
> >To: Yocto discussion list
> >Subject: [yocto] any plans on more carefully distinguishing docbook markup in
> >yocto docs?
> >
> >
> >  i'm sure i asked this once before, but is there any long-term plan for more
> >carefully marking up the yocto docs semantically? as in, most things that
> >represent filenames or variables or commands or code are simply tagged as
> ><filename>, even when this is not really appropriate.
> >
> >  to be semantically precise, one should be more carefully selecting among
> >tags such as <filename>, <varname>, <command>, <code> and so on.
> >for now, i suspect the rendering toolchain wouldn't change what's eventually
> >produced, but in the future, i think more careful markup would allow the
> >generation of much prettier docs.
> >
> >  thoughts?

  oh, i totally agree that it's low priority -- it would make sense to
decide on proper semantic markup and do one massive change, say, after
the next major release. i'd be willing to help with that.

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:[~2014-06-18 11:53 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-06-17 12:51 any plans on more carefully distinguishing docbook markup in yocto docs? Robert P. J. Day
2014-06-17 13:50 ` Rifenbark, Scott M
2014-06-18 11:49   ` Robert P. J. Day [this message]

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.1406180748290.6593@localhost \
    --to=rpjday@crashcourse.ca \
    --cc=scott.m.rifenbark@intel.com \
    --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.