[yocto] having yocto-docs take advantage of more docbook tags

Robert P. J. Day rpjday at crashcourse.ca
Fri Jan 2 02:16:51 PST 2015


  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
========================================================================



More information about the yocto mailing list