Updated the ref-qa-checks.xml chapter so that each QA warning
or error message would generate a permalink that is suitable
for searching from the poky codebase. To implement this, I
had to embed an id marker in the <para> tag that precedes each
<code></code> tag pair. The 'xxx' string of the id is the leaf
portion of the permalink.
This creates the following tag construct:
<para id='xxx'>
<code>
some-warning-or-error-message
</code>
</para>
The permalink is generated with the help of the new
qa-code-permalinks.xsl file, which triggers on the
<para><code></code></para> construct. This new file resides
in documentation/template.
Right now, this construct
is unique to the ref-manual's chapter on the QA error and warnings
chapter only. However, if for some reason that construct is
used in any other part of the ref-manual, a generically numbered
permalink would also be generated.
The ref-manual-customization.xsl file was also altered to include
the new documentation/template/qa-code-permalinks.xsl file.
Reported-by: Paul Eggleton <paul.eggleton@linux.intel.com>
(From yocto-docs rev: aec27a9f8337575d31bfe0066563da99259046e0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5772]
With this template, all that is necessary to trigger permalink
generation for variable entries in a manual's glossary is to
update the customization layer to include the gloss-permalinks.xsl
file.
(From yocto-docs rev: aebe1a727be7921fe9bc26101b670d5fdc1670e4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The prefix is used for DocBook 5 Schema. We are using the
4.2 Schema. Having this prefix disabled the permalink titles
XSL template (section.title.xsl) produced permalinks with no
titles. Because I removed it in the section.title.xls file,
I also removed it here for completeness. Note that I don't
think the template is used at this point but I made the change
just in case for the future.
(From yocto-docs rev: 8eca4299d0408c1095bfa8aa7b9f04e246db0c0d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5772]
These five style sheets support creation of permalinks in the
HTML formatted output.
(From yocto-docs rev: 7467ad6518c0fc0eb829b9432dc113bd0cdb6807)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #3728
The poky-db-pdf.xsl file has code that controls the font color
for the headers, footers, and separating lines for each when
the PDF version of a manual is made. I changed the values
from #cccccc to #999999 to darken these up so they can be
seen a little better.
(From yocto-docs rev: c9c83028a5f13dc672414b6ca395290f05019f8e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The title of a pdf document is part of the image used on the title
page. Thus the title defined (e.g. bookinfo.title) in a document
should never be used when creating title pages for pdf documents. As
other output formats may use the title information to create metadata
the title has been removed from the template.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark
Timo Mueller
Richard Purdie