diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-10-06 12:46:00 -0700 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-10-10 16:44:34 +0100 |
| commit | 3e991ee6851d9396e99aab37b8706426ff5185f1 (patch) | |
| tree | 42bf45f38c7688a0743f5d84c7051de580527c9b /documentation/ref-manual/ref-manual-customization.xsl | |
| parent | 6f32f3c757209df6d5d8b1eb0dfb2e831acd948a (diff) | |
| download | poky-3e991ee6851d9396e99aab37b8706426ff5185f1.tar.gz | |
ref-manual, template: Permalinks for QA errors and warnings
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>
Diffstat (limited to 'documentation/ref-manual/ref-manual-customization.xsl')
| -rw-r--r-- | documentation/ref-manual/ref-manual-customization.xsl | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-manual-customization.xsl b/documentation/ref-manual/ref-manual-customization.xsl index 05c9b979b1..b58b1dcaf9 100644 --- a/documentation/ref-manual/ref-manual-customization.xsl +++ b/documentation/ref-manual/ref-manual-customization.xsl | |||
| @@ -9,6 +9,7 @@ | |||
| 9 | <xsl:include href="../template/division.title.xsl"/> | 9 | <xsl:include href="../template/division.title.xsl"/> |
| 10 | <xsl:include href="../template/formal.object.heading.xsl"/> | 10 | <xsl:include href="../template/formal.object.heading.xsl"/> |
| 11 | <xsl:include href="../template/gloss-permalinks.xsl"/> | 11 | <xsl:include href="../template/gloss-permalinks.xsl"/> |
| 12 | <xsl:include href="../template/qa-code-permalinks.xsl"/> | ||
| 12 | 13 | ||
| 13 | <xsl:param name="html.stylesheet" select="'ref-style.css'" /> | 14 | <xsl:param name="html.stylesheet" select="'ref-style.css'" /> |
| 14 | <xsl:param name="chapter.autolabel" select="1" /> | 15 | <xsl:param name="chapter.autolabel" select="1" /> |