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
Signature · 7 lines
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================I could look at this... low on the priority list right now though but good point.
Thanks,
Scott
Quoted 40 lines
-----Original Message-----
From: [email protected] [mailto:yocto- [email protected]] 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.caTwitter: http://twitter.com/rpjday LinkedIn: http://ca.linkedin.com/in/rpjday===========================================================
=============
--
_______________________________________________
yocto mailing list
[email protected]
https://lists.yoctoproject.org/listinfo/yocto
Quoted 27 lines · Scott M
I could look at this... low on the priority list right now though but good point.
Thanks,
ScottQuoted 21 lines
-----Original Message-----
From: [email protected] [mailto:yocto- [email protected]] 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
Signature · 7 lines
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================