YP Quick Start PDF generation
cover YP Quick Start PDF generation
From: Scott Rifenbark <[email protected]>
These commits accomplish PDF generation for the Yocto Project Quick Start. Prior to this release this manual was generated as an HTML document only. Release 1.0 of YP saw the need for a PDF version as well. To accomplish this several new files had to be introduced and the make structure altered.
Pull URL: git://git.pokylinux.org/poky-contrib.git
Branch: srifenbark/qs-work
Browse: http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=srifenbark/qs-work
Thanks,
Scott Rifenbark <[email protected]>
---
Scott Rifenbark (8):
documentation/yocto-project-qs/yocto-project-qs.xml: cleaned out
another "YP"
documentation/yocto-project-qs/yocto-project-qs.xml: Edits plus Matt
Madison note regarding older host systems
documentation/yocto-project-qs/Makefile: Updated to create a PDF documentation/yocto-project-qs/figures/ypqs-title.png: New title
image
documentation/yocto-project-qs/ypqs.xml: New high-level file for PDF documentation/yocto-project-qs/style.css: Updates for PDF generation documentation/yocto-project-qs/yocto-project-qs-customization.xsl:
Updated for PDF creation
documentation/yocto-project-qs/yocto-project-qs.xml: Updates for PDF
creation
documentation/yocto-project-qs/Makefile | 25 ++++--- .../yocto-project-qs/figures/ypqs-title.png | Bin 0 -> 11324 bytes documentation/yocto-project-qs/style.css | 10 ++-- .../yocto-project-qs-customization.xsl | 2 - .../yocto-project-qs/yocto-project-qs.xml | 39 ++++++++--- documentation/yocto-project-qs/ypqs.xml | 67 ++++++++++++++++++++ 6 files changed, 114 insertions(+), 29 deletions(-) create mode 100644 documentation/yocto-project-qs/figures/ypqs-title.png create mode 100644 documentation/yocto-project-qs/ypqs.xml
PATCH 1/8 documentation/yocto-project-qs/yocto-project-qs.xml: cleaned out another "YP"
From: Scott Rifenbark <[email protected]>
Removed "YP" from another spot in the manual.
--- .../yocto-project-qs/yocto-project-qs.xml | 3 ++- 1 files changed, 2 insertions(+), 1 deletions(-)
documentation/yocto-project-qs/yocto-project-qs.xml +2 -1
@@ -15,7 +15,8 @@ Welcome to the Yocto Project! The Yocto Project is an open-source collaboration project focused on embedded Linux developers. - Amongst other things, YP uses the Poky build tool to construct complete Linux images. + Amongst other things, the Yocto Project uses the Poky build tool to + construct complete Linux images. </para> <para> This short document will give you some basic information about the environment as well
Signature · 1 line
1.7.0.4
PATCH 2/8 documentation/yocto-project-qs/yocto-project-qs.xml: Edits plus Matt Madison note regarding older host systems
In reply to Scott RifenbarkFrom: Scott Rifenbark <[email protected]>
I made a few small edits and I added a reference to the
wiki page 'https://wiki.yoctoproject.org/wiki/BuildingOnRHEL4' that has entries for older development hosts. Right now all that is there is the RHEL4 notes but the wiki page can be expanded as needed.
--- .../yocto-project-qs/yocto-project-qs.xml | 17 +++++++++++------ 1 files changed, 11 insertions(+), 6 deletions(-)
documentation/yocto-project-qs/yocto-project-qs.xml +11 -6
@@ -91,11 +91,11 @@ </itemizedlist> <para> - Yocto Project can generate images for many kinds of devices. + The Yocto Project can generate images for many kinds of devices. However, the standard example machines target QEMU full system emulation for x86, ARM, MIPS, - and PPC based architectures as well as specific hardware such as the Intel Desktop Board + and PPC-based architectures as well as specific hardware such as the Intel Desktop Board DH55TC. - Because an image developed with Yocto Project can boot inside a QEMU emulator, the + Because an image developed with the Yocto Project can boot inside a QEMU emulator, the development environment works nicely as a test platform for developing embedded software. </para>
@@ -103,7 +103,7 @@ Another important Yocto Project feature is the Sato reference User Interface. This optional GNOME mobile-based UI, which is intended for devices with resolution but restricted size screens, sits neatly on top of a device using the - GNOME Mobile Stack providing a well defined user experience. + GNOME Mobile Stack providing a well-defined user experience. Implemented in its own layer, it makes it clear to developers how they can implement their own UIs on top of Yocto Linux. </para>
@@ -119,7 +119,12 @@ <itemizedlist> <listitem> <para>A host system running a supported Linux distribution (i.e. recent releases of - Fedora, OpenSUSE, Debian, and Ubuntu).</para> + Fedora, OpenSUSE, Debian, and Ubuntu). + <note> + For notes about using the Yocto Project on development systems that use + older Linux distributions see + <ulink url='https://wiki.yoctoproject.org/wiki/BuildingOnRHEL4'></ulink> + </note></para> </listitem> <listitem> <para>The right packages.</para>
@@ -260,7 +265,7 @@ Adding this statement deletes the work directory used for building a package once the package is built. <literallayout class='monospaced'> - INHERIT += "rm_work" + INHERIT += rm_work </literallayout> </para></tip>
Signature · 1 line
1.7.0.4
PATCH 3/8 documentation/yocto-project-qs/Makefile: Updated to create a PDF
In reply to Scott RifenbarkFrom: Scott Rifenbark <[email protected]>
Release 1.0 all of a sudden saw the need for a PDF version of the Quick Start. Prior to this I was just generating an HTML version of this manual to keep the front matter minimal and clean. Now, however, the QS has joined the ranks of the other Yocto Project docs.
Several changes were made inside this makefile to accomplish the
goal: introduction of a title PNG file, a high-level file to contain the title page information (ypqs.xml), and some changes to the tarball line and output line.
--- documentation/yocto-project-qs/Makefile | 25 ++++++++++++++----------- 1 files changed, 14 insertions(+), 11 deletions(-)
documentation/yocto-project-qs/Makefile +14 -11
@@ -1,28 +1,31 @@ XSLTOPTS = --stringparam html.stylesheet style.css \ - --xinclude + --stringparam chapter.autolabel 1 \ + --stringparam section.autolabel 1 \ + --stringparam section.label.includes.component.label 1 \ + --xinclude +## +# These URI should be rewritten by your distribution's xml catalog to +# match your localy installed XSL stylesheets. XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl -all: html tarball +all: html pdf tarball -## -# These URI should be rewritten by your distribution's xml catalog to -# match your localy installed XSL stylesheets. +pdf: + ../tools/poky-docbook-to-pdf ypqs.xml ../template html: # See http://www.sagehill.net/docbookxsl/HtmlOutput.html - -# xsltproc $(XSLTOPTS) -o yocto-project-qs.html $(XSL_XHTML_URI) yocto-project-qs.xml - xsltproc $(XSLTOPTS) -o yocto-project-qs.html yocto-project-qs-customization.xsl yocto-project-qs.xml + xsltproc $(XSLTOPTS) -o yocto-project-qs.html yocto-project-qs-customization.xsl ypqs.xml tarball: html - tar -cvzf yocto-project-qs.tgz yocto-project-qs.html style.css figures/yocto-environment.png figures/building-an-image.png figures/using-a-pre-built-image.png figures/yocto-project-transp.png + tar -cvzf yocto-project-qs.tgz yocto-project-qs.html ypqs.pdf style.css figures/yocto-environment.png figures/building-an-image.png figures/using-a-pre-built-image.png figures/ypqs-title.png validate: - xmllint --postvalid --xinclude --noout yocto-project-qs.xml + xmllint --postvalid --xinclude --noout ypqs.xml -OUTPUTS = yocto-project-qs.tgz yocto-project-qs.html +OUTPUTS = yocto-project-qs.tgz yocto-project-qs.html ypqs.pdf SOURCES = *.png *.xml *.css publish:
Signature · 1 line
1.7.0.4
PATCH 4/8 documentation/yocto-project-qs/figures/ypqs-title.png: New title image
In reply to Scott RifenbarkFrom: Scott Rifenbark <[email protected]>
Part of the PDF scheme is a PNG file that contains the title of the manual and the transparent version of the Yocto Project logo. I had to introduce this new figure to the Yocto Project QS with the requirement of a PDF manual.
--- .../yocto-project-qs/figures/ypqs-title.png | Bin 0 -> 11324 bytes 1 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 documentation/yocto-project-qs/figures/ypqs-title.png
documentation/yocto-project-qs/figures/ypqs-title.png new file binary +0 -0
Signature · 1 line
1.7.0.4
PATCH 5/8 documentation/yocto-project-qs/ypqs.xml: New high-level file for PDF
In reply to Scott RifenbarkFrom: Scott Rifenbark <[email protected]>
With the need for a PDF version of the Yocto Project Quick Start I had to introduce the high-level file used to contain the structure of the manual (title page, rev-history, chapters, etc.). This file is new.
--- documentation/yocto-project-qs/ypqs.xml | 67 +++++++++++++++++++++++++++++++ 1 files changed, 67 insertions(+), 0 deletions(-) create mode 100644 documentation/yocto-project-qs/ypqs.xml
documentation/yocto-project-qs/ypqs.xml new file +67 -0
@@ -0,0 +1,67 @@ +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + +<book id='ypqs' lang='en' + xmlns:xi="http://www.w3.org/2003/XInclude" + xmlns="http://docbook.org/ns/docbook" + > + <bookinfo> + + <mediaobject> + <imageobject> + <imagedata fileref='figures/ypqs-title.png' + format='SVG' + align='center' scalefit='1' width='100%'/> + </imageobject> + </mediaobject> + + <title></title> + + <authorgroup> + <author> + <firstname>Scott</firstname> <surname>Rifenbark</surname> + <affiliation> + <orgname>Intel Corporation</orgname> + </affiliation> + <email>[email protected]</email> + </author> + </authorgroup> + + <revhistory> + <revision> + <revnumber>0.9</revnumber> + <date>27 October 2010</date> + <revremark>Initial Document released with Yocto Project 0.9 on 27 October 2010.</revremark> + </revision> + <revision> + <revnumber>1.0</revnumber> + <date>6 April 2011</date> + <revremark>This manual revision corresponds to the Yocto Project 1.0 Release.</revremark> + </revision> + </revhistory> + + <copyright> + <year>2010-2011</year> + <holder>Linux Foundation</holder> + </copyright> + + <legalnotice> + <para> + Permission is granted to copy, distribute and/or modify this document under + the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-sa/2.0/uk/">Creative Commons Attribution-Share Alike 2.0 UK: England & Wales</ulink> as published by Creative Commons. + </para> + </legalnotice> + + </bookinfo> + + <xi:include href="yocto-project-qs.xml"/> + +<!-- <index id='index'> + <title>Index</title> + </index> +--> + +</book> +<!-- +vim: expandtab tw=80 ts=4 +-->
Signature · 1 line
1.7.0.4
PATCH 6/8 documentation/yocto-project-qs/style.css: Updates for PDF generation
In reply to Scott RifenbarkFrom: Scott Rifenbark <[email protected]>
The .authorgroup style needed to be updated to use the new title image PNG file.
--- documentation/yocto-project-qs/style.css | 10 +++++----- 1 files changed, 5 insertions(+), 5 deletions(-)
documentation/yocto-project-qs/style.css +5 -5
@@ -122,13 +122,13 @@ h6 { background-color: transparent; background-repeat: no-repeat; padding-top: 256px; - background-image: url("../figures/yocto-project-bw.png"); - background-position: top; + background-image: url("figures/ypqs-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 {
Signature · 1 line
1.7.0.4
PATCH 7/8 documentation/yocto-project-qs/yocto-project-qs-customization.xsl: Updated for PDF creation
In reply to Scott RifenbarkFrom: Scott Rifenbark <[email protected]>
I had to remove the line that suppresses all the TOC generation stuff to bring the Quick Start into line with the other Yocto Manuals.
--- .../yocto-project-qs-customization.xsl | 2 -- 1 files changed, 0 insertions(+), 2 deletions(-)
documentation/yocto-project-qs/yocto-project-qs-customization.xsl +0 -2
@@ -3,6 +3,4 @@ <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" /> - <xsl:param name="generate.toc" select="'article nop'"></xsl:param> - </xsl:stylesheet>
Signature · 1 line
1.7.0.4
PATCH 8/8 documentation/yocto-project-qs/yocto-project-qs.xml: Updates for PDF creation
In reply to Scott RifenbarkFrom: Scott Rifenbark <[email protected]>
I had to make edits to eliminate the stand-alone logo and insert the commands to include the title-page PNG for PDF creation.
--- .../yocto-project-qs/yocto-project-qs.xml | 19 +++++++++++++++---- 1 files changed, 15 insertions(+), 4 deletions(-)
documentation/yocto-project-qs/yocto-project-qs.xml +15 -4
@@ -1,14 +1,23 @@ <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> -<article id='intro'> - <imagedata fileref="figures/yocto-project-transp.png" width="6in" depth="1in" align="right" scale="25" /> +<chapter id='intro'> +<!-- <imagedata fileref="figures/yocto-project-transp.png" width="6in" depth="1in" align="right" scale="25" /> +--> + + <title>Yocto Project Quick Start</title> -<section id='fake-title'> +<!-- <section id='fake-title'> <title>Yocto Project Quick Start</title> <para>Copyright © 2010-2011 Linux Foundation</para> </section> + + <para> + This is some intro text. + </para> +--> + <section id='welcome'> <title>Welcome!</title> <para>
@@ -299,10 +308,12 @@ <ulink url='http://www.yoctoproject.org/docs/poky-ref-manual/poky-ref-manual.html'> Poky Reference Manual</ulink>. </para></note> + <para> The final command runs the image: <literallayout class='monospaced'> $ poky-qemu qemux86 </literallayout> + </para> <note><para> Depending on the number of processors and cores, the amount or RAM, the speed of your Internet connection and other factors, the build process could take several hours the first
@@ -519,7 +530,7 @@ </section> </section> -</article> +</chapter> <!-- vim: expandtab tw=80 ts=4 -->
Signature · 1 line
1.7.0.4
This pull request can be ignored. Do not merge it with master.
Thanks,
Scott
-----Original Message-----
From: [email protected] [mailto:[email protected]] On Behalf Of Scott Rifenbark
Sent: Thursday, March 31, 2011 11:31 AM
To: [email protected]
Subject: [poky] [PATCH 0/8] [DOCS] YP Quick Start PDF generation
From: Scott Rifenbark <[email protected]>
These commits accomplish PDF generation for the Yocto Project Quick Start. Prior to this release this manual was generated as an HTML document only. Release 1.0 of YP saw the need for a PDF version as well. To accomplish this several new files had to be introduced and the make structure altered.
Pull URL: git://git.pokylinux.org/poky-contrib.git
Branch: srifenbark/qs-work
Browse: http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=srifenbark/qs-work
Thanks,
Scott Rifenbark <[email protected]>
---
Scott Rifenbark (8):
documentation/yocto-project-qs/yocto-project-qs.xml: cleaned out
another "YP"
documentation/yocto-project-qs/yocto-project-qs.xml: Edits plus Matt
Madison note regarding older host systems
documentation/yocto-project-qs/Makefile: Updated to create a PDF documentation/yocto-project-qs/figures/ypqs-title.png: New title
image
documentation/yocto-project-qs/ypqs.xml: New high-level file for PDF documentation/yocto-project-qs/style.css: Updates for PDF generation documentation/yocto-project-qs/yocto-project-qs-customization.xsl:
Updated for PDF creation
documentation/yocto-project-qs/yocto-project-qs.xml: Updates for PDF
creation
documentation/yocto-project-qs/Makefile | 25 ++++--- .../yocto-project-qs/figures/ypqs-title.png | Bin 0 -> 11324 bytes documentation/yocto-project-qs/style.css | 10 ++-- .../yocto-project-qs-customization.xsl | 2 - .../yocto-project-qs/yocto-project-qs.xml | 39 ++++++++--- documentation/yocto-project-qs/ypqs.xml | 67 ++++++++++++++++++++ 6 files changed, 114 insertions(+), 29 deletions(-) create mode 100644 documentation/yocto-project-qs/figures/ypqs-title.png create mode 100644 documentation/yocto-project-qs/ypqs.xml
_______________________________________________
poky mailing list
[email protected]
https://lists.yoctoproject.org/listinfo/poky