diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-12-15 09:31:59 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-12-19 22:36:14 +0000 |
commit | c57655603373f72b6c6ca10cd488b85a2c188ca2 (patch) | |
tree | f361712c26e8b68756dcb3030f62a8826bb1a088 /documentation | |
parent | 6ee3207ec757dacc462c95dac05841b78b9df735 (diff) | |
download | poky-c57655603373f72b6c6ca10cd488b85a2c188ca2.tar.gz |
yocto-project-qs, mega-manual: Conformed to YP book set
I discovered some artifacts and inconsistencies with how the YP
Quick Start was made. I made the following changes:
1. Changed the structure of the QS from "article" to "book"
as it is a separate book. This change doesn't fix anything
but it does bring the XML file closer to passing validation.
2. Removed the <abstract></abstract> tag. This tag was in place
simply to display the PNG file for the Yocto logo in the upper
right part of the first page. After turning the QS into a
book from an article, the title could be displayed as a PNG
file similar to the other books. This change solved two issues:
1) removed the empty "abstract" element from being displayed in
both the mega-manual and the PDF version, and 2), brought the
author and look of the first page into line with other YP
manuals.
3. Removed the old PNG file used to display the Yocto logo at
the top of the QS. This file was removed from both the
yocto-project-qs and mega-manual "figures" directories.
4. Added a new "yocto-project-qs-title.png" file to both the
yocto-project-qs and mega-manual "figures" directories.
5. Updated the "qs-style.css" file's .authorgroup element to
match and behave like the other YP manuals. This effectively
correctly displays the title PNG file for the QS.
6. Updated the Makefile area where the TAR files are made for
both the yocto-project-qs and the mega-manual. I had to
substitute in the new PNG file for the QS one and had to
add the title PNG to the mega-manual part.
(From yocto-docs rev: 914c482bd89071ab34b3381e3bd8065f871cc047)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/Makefile | 4 | ||||
-rw-r--r-- | documentation/mega-manual/figures/yocto-project-qs-title.png | bin | 0 -> 10156 bytes | |||
-rwxr-xr-x | documentation/mega-manual/figures/yocto-project-transp.png | bin | 8626 -> 0 bytes | |||
-rw-r--r-- | documentation/mega-manual/mega-manual.xml | 2 | ||||
-rw-r--r-- | documentation/yocto-project-qs/figures/yocto-project-qs-title.png | bin | 0 -> 10156 bytes | |||
-rwxr-xr-x | documentation/yocto-project-qs/figures/yocto-project-transp.png | bin | 8626 -> 0 bytes | |||
-rw-r--r-- | documentation/yocto-project-qs/qs-style.css | 9 | ||||
-rw-r--r-- | documentation/yocto-project-qs/yocto-project-qs.xml | 42 |
8 files changed, 38 insertions, 19 deletions
diff --git a/documentation/Makefile b/documentation/Makefile index 3bc9a213ee..7ffe649035 100644 --- a/documentation/Makefile +++ b/documentation/Makefile | |||
@@ -130,7 +130,7 @@ XSLTOPTS = --xinclude | |||
130 | ALLPREQ = html eclipse tarball | 130 | ALLPREQ = html eclipse tarball |
131 | TARFILES = yocto-project-qs.html qs-style.css figures/yocto-environment.png \ | 131 | TARFILES = yocto-project-qs.html qs-style.css figures/yocto-environment.png \ |
132 | figures/building-an-image.png figures/using-a-pre-built-image.png \ | 132 | figures/building-an-image.png figures/using-a-pre-built-image.png \ |
133 | figures/yocto-project-transp.png \ | 133 | figures/yocto-project-qs-title.png \ |
134 | eclipse | 134 | eclipse |
135 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse | 135 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse |
136 | FIGURES = figures | 136 | FIGURES = figures |
@@ -201,7 +201,7 @@ TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures | |||
201 | figures/package-feeds.png figures/layer-input.png figures/images.png figures/sdk.png \ | 201 | figures/package-feeds.png figures/layer-input.png figures/images.png figures/sdk.png \ |
202 | figures/source-fetching.png figures/patching.png figures/configuration-compile-autoreconf.png \ | 202 | figures/source-fetching.png figures/patching.png figures/configuration-compile-autoreconf.png \ |
203 | figures/analysis-for-package-splitting.png figures/image-generation.png \ | 203 | figures/analysis-for-package-splitting.png figures/image-generation.png \ |
204 | figures/sdk-generation.png figures/recipe-workflow.png | 204 | figures/sdk-generation.png figures/recipe-workflow.png figures/yocto-project-qs-title.png |
205 | endif | 205 | endif |
206 | 206 | ||
207 | MANUALS = $(DOC)/$(DOC).html | 207 | MANUALS = $(DOC)/$(DOC).html |
diff --git a/documentation/mega-manual/figures/yocto-project-qs-title.png b/documentation/mega-manual/figures/yocto-project-qs-title.png new file mode 100644 index 0000000000..a410a0d5e8 --- /dev/null +++ b/documentation/mega-manual/figures/yocto-project-qs-title.png | |||
Binary files differ | |||
diff --git a/documentation/mega-manual/figures/yocto-project-transp.png b/documentation/mega-manual/figures/yocto-project-transp.png deleted file mode 100755 index 31d2b147fd..0000000000 --- a/documentation/mega-manual/figures/yocto-project-transp.png +++ /dev/null | |||
Binary files differ | |||
diff --git a/documentation/mega-manual/mega-manual.xml b/documentation/mega-manual/mega-manual.xml index 01af789aed..a2ec256445 100644 --- a/documentation/mega-manual/mega-manual.xml +++ b/documentation/mega-manual/mega-manual.xml | |||
@@ -8,6 +8,8 @@ | |||
8 | xmlns="http://docbook.org/ns/docbook" | 8 | xmlns="http://docbook.org/ns/docbook" |
9 | > | 9 | > |
10 | 10 | ||
11 | <para><imagedata fileref="figures/yocto-project-qs-title.png" width="100%" align="left" scalefit="1" /></para> | ||
12 | |||
11 | <xi:include | 13 | <xi:include |
12 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../yocto-project-qs/yocto-project-qs.xml"/> | 14 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../yocto-project-qs/yocto-project-qs.xml"/> |
13 | 15 | ||
diff --git a/documentation/yocto-project-qs/figures/yocto-project-qs-title.png b/documentation/yocto-project-qs/figures/yocto-project-qs-title.png new file mode 100644 index 0000000000..a410a0d5e8 --- /dev/null +++ b/documentation/yocto-project-qs/figures/yocto-project-qs-title.png | |||
Binary files differ | |||
diff --git a/documentation/yocto-project-qs/figures/yocto-project-transp.png b/documentation/yocto-project-qs/figures/yocto-project-transp.png deleted file mode 100755 index 31d2b147fd..0000000000 --- a/documentation/yocto-project-qs/figures/yocto-project-transp.png +++ /dev/null | |||
Binary files differ | |||
diff --git a/documentation/yocto-project-qs/qs-style.css b/documentation/yocto-project-qs/qs-style.css index 235c85a1ba..a324a4a51d 100644 --- a/documentation/yocto-project-qs/qs-style.css +++ b/documentation/yocto-project-qs/qs-style.css | |||
@@ -118,12 +118,13 @@ h6 { | |||
118 | background-color: transparent; | 118 | background-color: transparent; |
119 | background-repeat: no-repeat; | 119 | background-repeat: no-repeat; |
120 | padding-top: 256px; | 120 | padding-top: 256px; |
121 | background-position: top; | 121 | background-image: url("figures/yocto-project-qs-title.png"); |
122 | background-position: left top; | ||
122 | margin-top: -256px; | 123 | margin-top: -256px; |
123 | padding-right: 50px; | 124 | padding-right: 50px; |
124 | margin-left: 50px; | 125 | margin-left: 0px; |
125 | text-align: center; | 126 | text-align: right; |
126 | width: 600px; | 127 | width: 740px; |
127 | } | 128 | } |
128 | 129 | ||
129 | h3.author { | 130 | h3.author { |
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index 9f1a4fbb36..1e2f3670f4 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml | |||
@@ -1,10 +1,33 @@ | |||
1 | <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 1 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" | 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" |
3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | 3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > |
4 | 4 | ||
5 | <article id='intro'> | 5 | <book id='intro' lang='en' |
6 | <articleinfo> | 6 | xmlns:xi="http://www.w3.org/2003/XInclude" |
7 | <title>Yocto Project Quick Start</title> | 7 | xmlns="http://docbook.org/ns/docbook" |
8 | > | ||
9 | <bookinfo> | ||
10 | <mediaobject> | ||
11 | <imageobject> | ||
12 | <imagedata fileref='figures/yocto-project-qs-title.png' | ||
13 | format='SVG' | ||
14 | align='left' scalefit='1' width='100%'/> | ||
15 | </imageobject> | ||
16 | </mediaobject> | ||
17 | |||
18 | <title> | ||
19 | Yocto Project Quick Start | ||
20 | </title> | ||
21 | |||
22 | <authorgroup> | ||
23 | <author> | ||
24 | <firstname>Scott</firstname> <surname>Rifenbark</surname> | ||
25 | <affiliation> | ||
26 | <orgname>Intel Corporation</orgname> | ||
27 | </affiliation> | ||
28 | <email>scott.m.rifenbark@intel.com</email> | ||
29 | </author> | ||
30 | </authorgroup> | ||
8 | 31 | ||
9 | <copyright> | 32 | <copyright> |
10 | <year>©RIGHT_YEAR;</year> | 33 | <year>©RIGHT_YEAR;</year> |
@@ -23,14 +46,7 @@ | |||
23 | from the Yocto Project website. | 46 | from the Yocto Project website. |
24 | </note> | 47 | </note> |
25 | </legalnotice> | 48 | </legalnotice> |
26 | 49 | </bookinfo> | |
27 | |||
28 | <abstract> | ||
29 | <imagedata fileref="figures/yocto-project-transp.png" | ||
30 | width="6in" depth="1in" | ||
31 | align="right" scale="25" /> | ||
32 | </abstract> | ||
33 | </articleinfo> | ||
34 | 50 | ||
35 | <section id='welcome'> | 51 | <section id='welcome'> |
36 | <title>Welcome!</title> | 52 | <title>Welcome!</title> |
@@ -962,7 +978,7 @@ | |||
962 | </section> | 978 | </section> |
963 | </section> | 979 | </section> |
964 | 980 | ||
965 | </article> | 981 | </book> |
966 | <!-- | 982 | <!-- |
967 | vim: expandtab tw=80 ts=4 | 983 | vim: expandtab tw=80 ts=4 |
968 | --> | 984 | --> |