* any plans on more carefully distinguishing docbook markup in yocto docs?
@ 2014-06-17 12:51 Robert P. J. Day
2014-06-17 13:50 ` Rifenbark, Scott M
0 siblings, 1 reply; 3+ messages in thread
From: Robert P. J. Day @ 2014-06-17 12:51 UTC (permalink / raw)
To: Yocto discussion list
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?
rday
--
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: any plans on more carefully distinguishing docbook markup in yocto docs?
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
0 siblings, 1 reply; 3+ messages in thread
From: Rifenbark, Scott M @ 2014-06-17 13:50 UTC (permalink / raw)
To: Robert P. J. Day, Yocto discussion list
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?
>
>rday
>
>--
>
>===========================================================
>=============
>Robert P. J. Day Ottawa, Ontario, CANADA
> http://crashcourse.ca
>
>Twitter: http://twitter.com/rpjday
>LinkedIn: http://ca.linkedin.com/in/rpjday
>===========================================================
>=============
>--
>_______________________________________________
>yocto mailing list
>yocto@yoctoproject.org
>https://lists.yoctoproject.org/listinfo/yocto
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: any plans on more carefully distinguishing docbook markup in yocto docs?
2014-06-17 13:50 ` Rifenbark, Scott M
@ 2014-06-18 11:49 ` Robert P. J. Day
0 siblings, 0 replies; 3+ messages in thread
From: Robert P. J. Day @ 2014-06-18 11:49 UTC (permalink / raw)
To: Rifenbark, Scott M; +Cc: Yocto discussion list
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
========================================================================
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2014-06-18 11:53 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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 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.