mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-30 00:20:08 +00:00
Code Issues Projects Releases Wiki Activity

ref-manual, template: Permalinks for QA errors and warnings

Browse Source 
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>
This commit is contained in:
Scott Rifenbark
2014-10-06 12:46:00 -07:00
committed by Richard Purdie
parent 6f32f3c757
commit 3e991ee685
3 changed files with 67 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/template/qa-code-permalinks.xsl
+23
View File
@@ -0,0 +1,23 @@
<!--
This XSL sheet enables creation of permalinks for <para><code>
constructs. Right now, this construct occurs only in the ref-manual
book's qa issues and warnings chapter. However, if the construct
were to appear anywhere in that ref-manual, a permalink would be
generated. I don't foresee any <para><code> constructs being used
in the future but if they are then a permalink with a generically
numbered permalink would be generated.
-->
<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:d="http://docbook.org/ns/docbook"
xmlns="http://www.w3.org/1999/xhtml">
<xsl:template match="para/code">
<xsl:apply-imports/>
<xsl:if test="$generate.permalink != 0">
<xsl:call-template name="permalink">
<xsl:with-param name="node" select=".."/>
</xsl:call-template>
</xsl:if>
</xsl:template>
</xsl:stylesheet>