aboutsummaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-12-15 09:31:59 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-12-19 22:36:14 +0000
commitc57655603373f72b6c6ca10cd488b85a2c188ca2 (patch)
treef361712c26e8b68756dcb3030f62a8826bb1a088 /documentation
parent6ee3207ec757dacc462c95dac05841b78b9df735 (diff)
downloadopenembedded-core-contrib-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/Makefile4
-rw-r--r--documentation/mega-manual/figures/yocto-project-qs-title.pngbin0 -> 10156 bytes
-rwxr-xr-xdocumentation/mega-manual/figures/yocto-project-transp.pngbin8626 -> 0 bytes
-rw-r--r--documentation/mega-manual/mega-manual.xml2
-rw-r--r--documentation/yocto-project-qs/figures/yocto-project-qs-title.pngbin0 -> 10156 bytes
-rwxr-xr-xdocumentation/yocto-project-qs/figures/yocto-project-transp.pngbin8626 -> 0 bytes
-rw-r--r--documentation/yocto-project-qs/qs-style.css9
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml42
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
ALLPREQ = html eclipse tarball
TARFILES = yocto-project-qs.html qs-style.css figures/yocto-environment.png \
figures/building-an-image.png figures/using-a-pre-built-image.png \
- figures/yocto-project-transp.png \
+ figures/yocto-project-qs-title.png \
eclipse
MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse
FIGURES = figures
@@ -201,7 +201,7 @@ TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures
figures/package-feeds.png figures/layer-input.png figures/images.png figures/sdk.png \
figures/source-fetching.png figures/patching.png figures/configuration-compile-autoreconf.png \
figures/analysis-for-package-splitting.png figures/image-generation.png \
- figures/sdk-generation.png figures/recipe-workflow.png
+ figures/sdk-generation.png figures/recipe-workflow.png figures/yocto-project-qs-title.png
endif
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 @@
xmlns="http://docbook.org/ns/docbook"
>
+<para><imagedata fileref="figures/yocto-project-qs-title.png" width="100%" align="left" scalefit="1" /></para>
+
<xi:include
xmlns:xi="http://www.w3.org/2003/XInclude" href="../yocto-project-qs/yocto-project-qs.xml"/>
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 {
background-color: transparent;
background-repeat: no-repeat;
padding-top: 256px;
- background-position: top;
+ background-image: url("figures/yocto-project-qs-title.png");
+ background-position: left top;
margin-top: -256px;
padding-right: 50px;
- margin-left: 50px;
- text-align: center;
- width: 600px;
+ margin-left: 0px;
+ text-align: right;
+ width: 740px;
}
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 @@
-<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
-<article id='intro'>
- <articleinfo>
- <title>Yocto Project Quick Start</title>
+<book id='intro' lang='en'
+ xmlns:xi="http://www.w3.org/2003/XInclude"
+ xmlns="http://docbook.org/ns/docbook"
+ >
+ <bookinfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref='figures/yocto-project-qs-title.png'
+ format='SVG'
+ align='left' scalefit='1' width='100%'/>
+ </imageobject>
+ </mediaobject>
+
+ <title>
+ Yocto Project Quick Start
+ </title>
+
+ <authorgroup>
+ <author>
+ <firstname>Scott</firstname> <surname>Rifenbark</surname>
+ <affiliation>
+ <orgname>Intel Corporation</orgname>
+ </affiliation>
+ <email>scott.m.rifenbark@intel.com</email>
+ </author>
+ </authorgroup>
<copyright>
<year>&COPYRIGHT_YEAR;</year>
@@ -23,14 +46,7 @@
from the Yocto Project website.
</note>
</legalnotice>
-
-
- <abstract>
- <imagedata fileref="figures/yocto-project-transp.png"
- width="6in" depth="1in"
- align="right" scale="25" />
- </abstract>
- </articleinfo>
+ </bookinfo>
<section id='welcome'>
<title>Welcome!</title>
@@ -962,7 +978,7 @@
</section>
</section>
-</article>
+</book>
<!--
vim: expandtab tw=80 ts=4
-->