linux/poky.git/documentation/template, branch 4.2_M3

manuals: start of documentation standards document

2021-11-07T10:44:52+00:00

This first version specifies how to create consistent SGV graphics (From yocto-docs rev: 370b9e34e9092c9eed22df2e8b2d0bb979487e5c) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

sphinx: remove DocBook files

2020-10-06T12:56:17+00:00

The Yocto Project documentation was migrated to Sphinx. Let's remove the deprecated DocBook files. (From yocto-docs rev: 28fb0e63b2fbfd6426b00498bf2682bb53fdd862) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

toaster-manual: Draft of Manual.

2015-04-01T11:59:10+00:00

Fixes [YOCTO #6901] (From yocto-docs rev: 258b46b0f3e23045b5fb8c97d03dceb69db5ce20) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie

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

2014-10-10T15:44:34+00:00

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 tag that precedes each tag pair. The 'xxx' string of the id is the leaf portion of the permalink. This creates the following tag construct:


            some-warning-or-error-message

The permalink is generated with the help of the new qa-code-permalinks.xsl file, which triggers on the 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 (From yocto-docs rev: aec27a9f8337575d31bfe0066563da99259046e0) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie

template: Added new line at end of file so vi does not throw error.

2014-07-03T12:57:12+00:00

(From yocto-docs rev: 2b8cd1b912ea4a1725b9060be712828b6c3d2a36) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie

templates: Added new line to avoid vi save warning.

2014-07-03T12:57:11+00:00

(From yocto-docs rev: dd24fa4e254a9ee4f76c78e2cc525a752195bbdb) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie

template: Added an XSL template to support glossary variable permalinks

2014-07-03T12:57:09+00:00

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 Signed-off-by: Richard Purdie

template: Removed the "d:" character namespace prefix.

2014-06-18T09:30:47+00:00

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 Signed-off-by: Richard Purdie

template: Added XSL stylesheets to support permalinks.

2014-06-18T09:30:46+00:00

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 Signed-off-by: Richard Purdie

template: Changed the font color for footers and headers

2013-02-14T17:25:45+00:00

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 Signed-off-by: Richard Purdie