diff options
| author | Scott Rifenbark <srifenbark@gmail.com> | 2018-01-03 16:09:41 -0800 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-02-14 15:25:27 +0000 |
| commit | bc6a19d6a765dbc91c090cabddb6dd968378237d (patch) | |
| tree | 2bc9dcc8c60de05f33cba4270c50211339d1d97b | |
| parent | 9f478d13585ca0ae129ffdb71a1b68b0202a2465 (diff) | |
| download | poky-bc6a19d6a765dbc91c090cabddb6dd968378237d.tar.gz | |
overview-manual: Added new "overview" manual to YP doc set
Fixes [YOCTO #12370]
I added all the mechanics for this new "Yocto Project Overview Manual".
For now, the manual builds and publishes into the 2.5 area. I used
"overview-manual" for the folder name. Makefile properly builds the
new manual. The mega-manual.sed file processes links for the new manual.
The mega-manual.xml file includes the new manual. The poky.ent file
includes a new ENTITY link for the overview manual. All pieces are in
place.
With this commit, just an overview chapter exists. The remaining content
needs to be developed.
(From yocto-docs rev: 632ebd4a91920585e736527e070ca8363a00f41b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
20 files changed, 1622 insertions, 2 deletions
diff --git a/documentation/Makefile b/documentation/Makefile index a747b44738..c6584af546 100644 --- a/documentation/Makefile +++ b/documentation/Makefile | |||
| @@ -84,6 +84,17 @@ | |||
| 84 | # for the 'denzil' branch. | 84 | # for the 'denzil' branch. |
| 85 | # | 85 | # |
| 86 | 86 | ||
| 87 | ifeq ($(DOC),overview-manual) | ||
| 88 | XSLTOPTS = --xinclude | ||
| 89 | ALLPREQ = html eclipse tarball | ||
| 90 | TARFILES = overview-style.css overview-manual.html figures/overview-title.png \ | ||
| 91 | eclipse | ||
| 92 | MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse | ||
| 93 | FIGURES = figures | ||
| 94 | STYLESHEET = $(DOC)/*.css | ||
| 95 | |||
| 96 | endif | ||
| 97 | |||
| 87 | ifeq ($(DOC),bsp-guide) | 98 | ifeq ($(DOC),bsp-guide) |
| 88 | XSLTOPTS = --xinclude | 99 | XSLTOPTS = --xinclude |
| 89 | ALLPREQ = html eclipse tarball | 100 | ALLPREQ = html eclipse tarball |
| @@ -249,7 +260,8 @@ TARFILES = mega-manual.html mega-style.css \ | |||
| 249 | figures/sdk-environment.png figures/sdk-installed-standard-sdk-directory.png \ | 260 | figures/sdk-environment.png figures/sdk-installed-standard-sdk-directory.png \ |
| 250 | figures/sdk-devtool-add-flow.png figures/sdk-installed-extensible-sdk-directory.png \ | 261 | figures/sdk-devtool-add-flow.png figures/sdk-installed-extensible-sdk-directory.png \ |
| 251 | figures/sdk-devtool-modify-flow.png figures/sdk-eclipse-dev-flow.png \ | 262 | figures/sdk-devtool-modify-flow.png figures/sdk-eclipse-dev-flow.png \ |
| 252 | figures/sdk-devtool-upgrade-flow.png figures/bitbake-build-flow.png figures/ypqs-title.png | 263 | figures/sdk-devtool-upgrade-flow.png figures/bitbake-build-flow.png figures/ypqs-title.png \ |
| 264 | figures/overview-title.png | ||
| 253 | endif | 265 | endif |
| 254 | 266 | ||
| 255 | MANUALS = $(DOC)/$(DOC).html | 267 | MANUALS = $(DOC)/$(DOC).html |
| @@ -406,10 +418,11 @@ eclipse: eclipse-generate eclipse-resolve-links | |||
| 406 | .PHONY : eclipse-generate eclipse-resolve-links | 418 | .PHONY : eclipse-generate eclipse-resolve-links |
| 407 | 419 | ||
| 408 | eclipse-generate: | 420 | eclipse-generate: |
| 409 | ifeq ($(filter $(DOC), sdk-manual bsp-guide dev-manual kernel-dev profile-manual ref-manual yocto-project-qs),) | 421 | ifeq ($(filter $(DOC), overview-manual sdk-manual bsp-guide dev-manual kernel-dev profile-manual ref-manual yocto-project-qs),) |
| 410 | @echo " " | 422 | @echo " " |
| 411 | @echo "ERROR: You can only create eclipse documentation" | 423 | @echo "ERROR: You can only create eclipse documentation" |
| 412 | @echo " of the following documentation parts:" | 424 | @echo " of the following documentation parts:" |
| 425 | @echo " - overview-manual" | ||
| 413 | @echo " - sdk-manual" | 426 | @echo " - sdk-manual" |
| 414 | @echo " - bsp-guide" | 427 | @echo " - bsp-guide" |
| 415 | @echo " - dev-manual" | 428 | @echo " - dev-manual" |
diff --git a/documentation/mega-manual/figures/overview-title.png b/documentation/mega-manual/figures/overview-title.png new file mode 100644 index 0000000000..c5ec87242e --- /dev/null +++ b/documentation/mega-manual/figures/overview-title.png | |||
| Binary files differ | |||
diff --git a/documentation/mega-manual/mega-manual.xml b/documentation/mega-manual/mega-manual.xml index 3557cae84b..22b3a86a4d 100644 --- a/documentation/mega-manual/mega-manual.xml +++ b/documentation/mega-manual/mega-manual.xml | |||
| @@ -129,6 +129,15 @@ | |||
| 129 | <xi:include | 129 | <xi:include |
| 130 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../yocto-project-qs/qs.xml"/> | 130 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../yocto-project-qs/qs.xml"/> |
| 131 | 131 | ||
| 132 | <!-- Includes overview-manual title image and then overview-manual chapters --> | ||
| 133 | |||
| 134 | <para> | ||
| 135 | <imagedata fileref="figures/overview-title.png" width="100%" align="left" scalefit="1" /> | ||
| 136 | </para> | ||
| 137 | |||
| 138 | <xi:include | ||
| 139 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../overview-manual/overview-manual-intro.xml"/> | ||
| 140 | |||
| 132 | <!-- Includes dev-manual title image and then dev-manual chapters --> | 141 | <!-- Includes dev-manual title image and then dev-manual chapters --> |
| 133 | 142 | ||
| 134 | <para> | 143 | <para> |
diff --git a/documentation/overview-manual/eclipse/html/overview-manual/figures/overview-title.png b/documentation/overview-manual/eclipse/html/overview-manual/figures/overview-title.png new file mode 100644 index 0000000000..c5ec87242e --- /dev/null +++ b/documentation/overview-manual/eclipse/html/overview-manual/figures/overview-title.png | |||
| Binary files differ | |||
diff --git a/documentation/overview-manual/eclipse/html/overview-manual/index.html b/documentation/overview-manual/eclipse/html/overview-manual/index.html new file mode 100644 index 0000000000..a88cde67f0 --- /dev/null +++ b/documentation/overview-manual/eclipse/html/overview-manual/index.html | |||
| @@ -0,0 +1,93 @@ | |||
| 1 | <html> | ||
| 2 | <head> | ||
| 3 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | ||
| 4 | <title>Yocto Project Overview Manual</title> | ||
| 5 | <link rel="stylesheet" type="text/css" href="../book.css"> | ||
| 6 | <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> | ||
| 7 | <link rel="home" href="index.html" title="Yocto Project Overview Manual"> | ||
| 8 | <link rel="next" href="overview-manual-intro.html" title="Chapter 1. The Yocto Project Overview Manual"> | ||
| 9 | </head> | ||
| 10 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div lang="en" class="book" title="Yocto Project Overview Manual"> | ||
| 11 | <div class="titlepage"> | ||
| 12 | <div> | ||
| 13 | <div><h1 class="title"> | ||
| 14 | <a name="overview-manual"></a> | ||
| 15 | Yocto Project Overview Manual | ||
| 16 | </h1></div> | ||
| 17 | <div><div class="authorgroup"> | ||
| 18 | <div class="author"> | ||
| 19 | <h3 class="author"> | ||
| 20 | <span class="firstname">Scott</span> <span class="surname">Rifenbark</span> | ||
| 21 | </h3> | ||
| 22 | <div class="affiliation"> | ||
| 23 | <span class="orgname">Scotty's Documentation Services, INC<br></span> | ||
| 24 | </div> | ||
| 25 | <code class="email"><<a class="email" href="mailto:srifenbark@gmail.com">srifenbark@gmail.com</a>></code> | ||
| 26 | </div> | ||
| 27 | </div></div> | ||
| 28 | <div><p class="copyright">Copyright © 2010-2018 Linux Foundation</p></div> | ||
| 29 | <div><div class="legalnotice" title="Legal Notice"> | ||
| 30 | <a name="idm46676678022160"></a> | ||
| 31 | <p> | ||
| 32 | Permission is granted to copy, distribute and/or modify this document under | ||
| 33 | the terms of the <a class="ulink" href="http://creativecommons.org/licenses/by-sa/2.0/uk/" target="_self"> | ||
| 34 | Creative Commons Attribution-Share Alike 2.0 UK: England & Wales</a> as published by | ||
| 35 | Creative Commons. | ||
| 36 | </p> | ||
| 37 | <div class="note" title="Manual Notes" style="margin-left: 0.5in; margin-right: 0.5in;"> | ||
| 38 | <h3 class="title">Manual Notes</h3> | ||
| 39 | <div class="itemizedlist"><ul class="itemizedlist" type="disc"> | ||
| 40 | <li class="listitem"><p> | ||
| 41 | This version of the | ||
| 42 | <span class="emphasis"><em>Yocto Project Overview Manual</em></span> | ||
| 43 | is for the 2.5 release of the | ||
| 44 | Yocto Project. | ||
| 45 | To be sure you have the latest version of the manual | ||
| 46 | for this release, use the manual from the | ||
| 47 | <a class="ulink" href="http://www.yoctoproject.org/documentation" target="_self">Yocto Project documentation page</a>. | ||
| 48 | </p></li> | ||
| 49 | <li class="listitem"><p> | ||
| 50 | For manuals associated with other releases of the Yocto | ||
| 51 | Project, go to the | ||
| 52 | <a class="ulink" href="http://www.yoctoproject.org/documentation" target="_self">Yocto Project documentation page</a> | ||
| 53 | and use the drop-down "Active Releases" button | ||
| 54 | and choose the manual associated with the desired | ||
| 55 | Yocto Project. | ||
| 56 | </p></li> | ||
| 57 | <li class="listitem"><p> | ||
| 58 | To report any inaccuracies or problems with this | ||
| 59 | manual, send an email to the Yocto Project | ||
| 60 | discussion group at | ||
| 61 | <code class="filename">yocto@yoctoproject.com</code> or log into | ||
| 62 | the freenode <code class="filename">#yocto</code> channel. | ||
| 63 | </p></li> | ||
| 64 | </ul></div> | ||
| 65 | </div> | ||
| 66 | </div></div> | ||
| 67 | <div><div class="revhistory"><table border="1" width="100%" summary="Revision history"> | ||
| 68 | <tr><th align="left" valign="top" colspan="2"><b>Revision History</b></th></tr> | ||
| 69 | <tr> | ||
| 70 | <td align="left">Revision 2.5</td> | ||
| 71 | <td align="left">April 2018</td> | ||
| 72 | </tr> | ||
| 73 | <tr><td align="left" colspan="2">The initial document released with the Yocto Project 2.5 Release.</td></tr> | ||
| 74 | </table></div></div> | ||
| 75 | </div> | ||
| 76 | <hr> | ||
| 77 | </div> | ||
| 78 | <div class="toc"> | ||
| 79 | <p><b>Table of Contents</b></p> | ||
| 80 | <dl> | ||
| 81 | <dt><span class="chapter"><a href="overview-manual-intro.html">1. The Yocto Project Overview Manual</a></span></dt> | ||
| 82 | <dd><dl> | ||
| 83 | <dt><span class="section"><a href="overview-welcome.html">1.1. Welcome</a></span></dt> | ||
| 84 | <dt><span class="section"><a href="overview-other-information.html">1.2. Other Information</a></span></dt> | ||
| 85 | </dl></dd> | ||
| 86 | </dl> | ||
| 87 | </div> | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | </div></body> | ||
| 93 | </html> | ||
diff --git a/documentation/overview-manual/eclipse/html/overview-manual/index.xml b/documentation/overview-manual/eclipse/html/overview-manual/index.xml new file mode 100644 index 0000000000..9edb4b92ac --- /dev/null +++ b/documentation/overview-manual/eclipse/html/overview-manual/index.xml | |||
| @@ -0,0 +1,2 @@ | |||
| 1 | <?xml version="1.0" encoding="utf-8" standalone="no"?> | ||
| 2 | <index/> | ||
diff --git a/documentation/overview-manual/eclipse/html/overview-manual/overview-manual-intro.html b/documentation/overview-manual/eclipse/html/overview-manual/overview-manual-intro.html new file mode 100644 index 0000000000..a111537108 --- /dev/null +++ b/documentation/overview-manual/eclipse/html/overview-manual/overview-manual-intro.html | |||
| @@ -0,0 +1,23 @@ | |||
| 1 | <html> | ||
| 2 | <head> | ||
| 3 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | ||
| 4 | <title>Chapter 1. The Yocto Project Overview Manual</title> | ||
| 5 | <link rel="stylesheet" type="text/css" href="../book.css"> | ||
| 6 | <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> | ||
| 7 | <link rel="home" href="index.html" title="Yocto Project Overview Manual"> | ||
| 8 | <link rel="up" href="index.html" title="Yocto Project Overview Manual"> | ||
| 9 | <link rel="prev" href="index.html" title="Yocto Project Overview Manual"> | ||
| 10 | <link rel="next" href="overview-welcome.html" title="1.1. Welcome"> | ||
| 11 | </head> | ||
| 12 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="chapter" title="Chapter 1. The Yocto Project Overview Manual"> | ||
| 13 | <div class="titlepage"><div><div><h2 class="title"> | ||
| 14 | <a name="overview-manual-intro"></a>Chapter 1. The Yocto Project Overview Manual</h2></div></div></div> | ||
| 15 | <div class="toc"> | ||
| 16 | <p><b>Table of Contents</b></p> | ||
| 17 | <dl> | ||
| 18 | <dt><span class="section"><a href="overview-welcome.html">1.1. Welcome</a></span></dt> | ||
| 19 | <dt><span class="section"><a href="overview-other-information.html">1.2. Other Information</a></span></dt> | ||
| 20 | </dl> | ||
| 21 | </div> | ||
| 22 | </div></body> | ||
| 23 | </html> | ||
diff --git a/documentation/overview-manual/eclipse/html/overview-manual/overview-other-information.html b/documentation/overview-manual/eclipse/html/overview-manual/overview-other-information.html new file mode 100644 index 0000000000..15e6490e5b --- /dev/null +++ b/documentation/overview-manual/eclipse/html/overview-manual/overview-other-information.html | |||
| @@ -0,0 +1,30 @@ | |||
| 1 | <html> | ||
| 2 | <head> | ||
| 3 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | ||
| 4 | <title>1.2. Other Information</title> | ||
| 5 | <link rel="stylesheet" type="text/css" href="../book.css"> | ||
| 6 | <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> | ||
| 7 | <link rel="home" href="index.html" title="Yocto Project Overview Manual"> | ||
| 8 | <link rel="up" href="overview-manual-intro.html" title="Chapter 1. The Yocto Project Overview Manual"> | ||
| 9 | <link rel="prev" href="overview-welcome.html" title="1.1. Welcome"> | ||
| 10 | </head> | ||
| 11 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="section" title="1.2. Other Information"> | ||
| 12 | <div class="titlepage"><div><div><h2 class="title" style="clear: both"> | ||
| 13 | <a name="overview-other-information"></a>1.2. Other Information</h2></div></div></div> | ||
| 14 | <p> | ||
| 15 | Because this manual presents information for many different | ||
| 16 | topics, supplemental information is recommended for full | ||
| 17 | comprehension. | ||
| 18 | For additional introductory information on the Yocto Project, see | ||
| 19 | the <a class="ulink" href="http://www.yoctoproject.org" target="_self">Yocto Project Website</a>. | ||
| 20 | You can find an introductory to using the Yocto Project by working | ||
| 21 | through the | ||
| 22 | <a class="link" href="../yocto-project-qs/index.html" target="_self">Yocto Project Quick Start</a>. | ||
| 23 | </p> | ||
| 24 | <p> | ||
| 25 | For a comprehensive list of links and other documentation, see the | ||
| 26 | "<a class="link" href="../ref-manual/resources-links-and-related-documentation.html" target="_self">Links and Related Documentation</a>" | ||
| 27 | section in the Yocto Project Reference Manual. | ||
| 28 | </p> | ||
| 29 | </div></body> | ||
| 30 | </html> | ||
diff --git a/documentation/overview-manual/eclipse/html/overview-manual/overview-welcome.html b/documentation/overview-manual/eclipse/html/overview-manual/overview-welcome.html new file mode 100644 index 0000000000..6901d0decf --- /dev/null +++ b/documentation/overview-manual/eclipse/html/overview-manual/overview-welcome.html | |||
| @@ -0,0 +1,85 @@ | |||
| 1 | <html> | ||
| 2 | <head> | ||
| 3 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | ||
| 4 | <title>1.1. Welcome</title> | ||
| 5 | <link rel="stylesheet" type="text/css" href="../book.css"> | ||
| 6 | <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> | ||
| 7 | <link rel="home" href="index.html" title="Yocto Project Overview Manual"> | ||
| 8 | <link rel="up" href="overview-manual-intro.html" title="Chapter 1. The Yocto Project Overview Manual"> | ||
| 9 | <link rel="prev" href="overview-manual-intro.html" title="Chapter 1. The Yocto Project Overview Manual"> | ||
| 10 | <link rel="next" href="overview-other-information.html" title="1.2. Other Information"> | ||
| 11 | </head> | ||
| 12 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="section" title="1.1. Welcome"> | ||
| 13 | <div class="titlepage"><div><div><h2 class="title" style="clear: both"> | ||
| 14 | <a name="overview-welcome"></a>1.1. Welcome</h2></div></div></div> | ||
| 15 | <p> | ||
| 16 | Welcome to the Yocto Project Overview Manual! | ||
| 17 | This manual introduces the Yocto Project by providing concepts, | ||
| 18 | software overviews, best-known-methods (BKMs), and any other | ||
| 19 | high-level introductory information suitable for a new Yocto | ||
| 20 | Project user. | ||
| 21 | </p> | ||
| 22 | <p> | ||
| 23 | The following list describes what you can get from this manual: | ||
| 24 | </p> | ||
| 25 | <div class="itemizedlist"><ul class="itemizedlist" type="disc"> | ||
| 26 | <li class="listitem"><p> | ||
| 27 | <span class="emphasis"><em>Major Topic:</em></span> | ||
| 28 | Provide a high-level description of this major topic. | ||
| 29 | </p></li> | ||
| 30 | <li class="listitem"><p> | ||
| 31 | <span class="emphasis"><em>Major Topic:</em></span> | ||
| 32 | Provide a high-level description of this major topic. | ||
| 33 | </p></li> | ||
| 34 | <li class="listitem"><p> | ||
| 35 | <span class="emphasis"><em>Major Topic:</em></span> | ||
| 36 | Provide a high-level description of this major topic. | ||
| 37 | </p></li> | ||
| 38 | <li class="listitem"><p> | ||
| 39 | <span class="emphasis"><em>Major Topic:</em></span> | ||
| 40 | Provide a high-level description of this major topic. | ||
| 41 | </p></li> | ||
| 42 | </ul></div> | ||
| 43 | <p> | ||
| 44 | </p> | ||
| 45 | <p> | ||
| 46 | This manual does not give you the following: | ||
| 47 | </p> | ||
| 48 | <div class="itemizedlist"><ul class="itemizedlist" type="disc"> | ||
| 49 | <li class="listitem"><p> | ||
| 50 | <span class="emphasis"><em>Step-by-step Instructions for Development Tasks:</em></span> | ||
| 51 | Instructional procedures reside in other manuals within | ||
| 52 | the Yocto Project documentation set. | ||
| 53 | For example, the | ||
| 54 | <a class="link" href="../dev-manual/index.html" target="_self">Yocto Project Development Tasks Manual</a> | ||
| 55 | provides examples on how to perform various development | ||
| 56 | tasks. | ||
| 57 | As another example, the | ||
| 58 | <a class="link" href="../sdk-manual/index.html" target="_self">Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</a> | ||
| 59 | manual contains detailed instructions on how to install an | ||
| 60 | SDK, which is used to develop applications for target | ||
| 61 | hardware. | ||
| 62 | </p></li> | ||
| 63 | <li class="listitem"><p> | ||
| 64 | <span class="emphasis"><em>Reference Material:</em></span> | ||
| 65 | This type of material resides in an appropriate reference | ||
| 66 | manual. | ||
| 67 | For example, system variables are documented in the | ||
| 68 | <a class="link" href="../ref-manual/index.html" target="_self">Yocto Project Reference Manual</a>. | ||
| 69 | As another example, the | ||
| 70 | <a class="link" href="../bsp-guide/index.html" target="_self">Yocto Project Board Support Package (BSP) Developer's Guide</a> | ||
| 71 | contains reference information on BSPs. | ||
| 72 | </p></li> | ||
| 73 | <li class="listitem"><p> | ||
| 74 | <span class="emphasis"><em>Detailed Public Information Not Specific to the | ||
| 75 | Yocto Project:</em></span> | ||
| 76 | For example, exhaustive information on how to use the | ||
| 77 | Source Control Manager Git is better covered with Internet | ||
| 78 | searches and official Git Documentation than through the | ||
| 79 | Yocto Project documentation. | ||
| 80 | </p></li> | ||
| 81 | </ul></div> | ||
| 82 | <p> | ||
| 83 | </p> | ||
| 84 | </div></body> | ||
| 85 | </html> | ||
diff --git a/documentation/overview-manual/eclipse/overview-manual-toc.xml b/documentation/overview-manual/eclipse/overview-manual-toc.xml new file mode 100644 index 0000000000..9dd8da8c4e --- /dev/null +++ b/documentation/overview-manual/eclipse/overview-manual-toc.xml | |||
| @@ -0,0 +1,7 @@ | |||
| 1 | <?xml version="1.0" encoding="utf-8" standalone="no"?> | ||
| 2 | <toc label="Yocto Project Overview Manual" topic="html/overview-manual/index.html"> | ||
| 3 | <topic label="The Yocto Project Overview Manual" href="html/overview-manual/overview-manual-intro.html"> | ||
| 4 | <topic label="Welcome" href="html/overview-manual/overview-welcome.html"/> | ||
| 5 | <topic label="Other Information" href="html/overview-manual/overview-other-information.html"/> | ||
| 6 | </topic> | ||
| 7 | </toc> | ||
diff --git a/documentation/overview-manual/figures/overview-title.png b/documentation/overview-manual/figures/overview-title.png new file mode 100644 index 0000000000..c5ec87242e --- /dev/null +++ b/documentation/overview-manual/figures/overview-title.png | |||
| Binary files differ | |||
diff --git a/documentation/overview-manual/overview-manual-customization.xsl b/documentation/overview-manual/overview-manual-customization.xsl new file mode 100644 index 0000000000..ccb7521259 --- /dev/null +++ b/documentation/overview-manual/overview-manual-customization.xsl | |||
| @@ -0,0 +1,27 @@ | |||
| 1 | <?xml version='1.0'?> | ||
| 2 | <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> | ||
| 3 | |||
| 4 | <xsl:import href="http://downloads.yoctoproject.org/mirror/docbook-mirror/docbook-xsl-1.76.1/xhtml/docbook.xsl" /> | ||
| 5 | |||
| 6 | <!-- | ||
| 7 | |||
| 8 | <xsl:import href="../template/1.76.1/docbook-xsl-1.76.1/xhtml/docbook.xsl" /> | ||
| 9 | |||
| 10 | <xsl:import href="http://docbook.sourceforge.net/release/xsl/1.76.1/xhtml/docbook.xsl" /> | ||
| 11 | |||
| 12 | --> | ||
| 13 | |||
| 14 | <xsl:include href="../template/permalinks.xsl"/> | ||
| 15 | <xsl:include href="../template/section.title.xsl"/> | ||
| 16 | <xsl:include href="../template/component.title.xsl"/> | ||
| 17 | <xsl:include href="../template/division.title.xsl"/> | ||
| 18 | <xsl:include href="../template/formal.object.heading.xsl"/> | ||
| 19 | |||
| 20 | <xsl:param name="html.stylesheet" select="'overview-style.css'" /> | ||
| 21 | <xsl:param name="chapter.autolabel" select="1" /> | ||
| 22 | <xsl:param name="appendix.autolabel" select="A" /> | ||
| 23 | <xsl:param name="section.autolabel" select="1" /> | ||
| 24 | <xsl:param name="section.label.includes.component.label" select="1" /> | ||
| 25 | <xsl:param name="generate.id.attributes" select="1" /> | ||
| 26 | |||
| 27 | </xsl:stylesheet> | ||
diff --git a/documentation/overview-manual/overview-manual-eclipse-customization.xsl b/documentation/overview-manual/overview-manual-eclipse-customization.xsl new file mode 100644 index 0000000000..aaf99ea1ba --- /dev/null +++ b/documentation/overview-manual/overview-manual-eclipse-customization.xsl | |||
| @@ -0,0 +1,35 @@ | |||
| 1 | <?xml version='1.0'?> | ||
| 2 | <xsl:stylesheet | ||
| 3 | xmlns:xsl="http://www.w3.org/1999/XSL/Transform" | ||
| 4 | xmlns="http://www.w3.org/1999/xhtml" | ||
| 5 | xmlns:fo="http://www.w3.org/1999/XSL/Format" | ||
| 6 | version="1.0"> | ||
| 7 | |||
| 8 | <xsl:import href="http://downloads.yoctoproject.org/mirror/docbook-mirror/docbook-xsl-1.76.1/eclipse/eclipse3.xsl" /> | ||
| 9 | |||
| 10 | <!-- | ||
| 11 | |||
| 12 | <xsl:import href="../template/1.76.1/docbook-xsl-1.76.1/eclipse/eclipse3.xsl" /> | ||
| 13 | |||
| 14 | <xsl:import | ||
| 15 | href="http://docbook.sourceforge.net/release/xsl/1.76.1/eclipse/eclipse3.xsl" /> | ||
| 16 | |||
| 17 | --> | ||
| 18 | |||
| 19 | <xsl:param name="chunker.output.indent" select="'yes'"/> | ||
| 20 | <xsl:param name="chunk.quietly" select="1"/> | ||
| 21 | <xsl:param name="chunk.first.sections" select="1"/> | ||
| 22 | <xsl:param name="chunk.section.depth" select="10"/> | ||
| 23 | <xsl:param name="use.id.as.filename" select="1"/> | ||
| 24 | <xsl:param name="ulink.target" select="'_self'" /> | ||
| 25 | <xsl:param name="base.dir" select="'html/overview-manual/'"/> | ||
| 26 | <xsl:param name="html.stylesheet" select="'../book.css'"/> | ||
| 27 | <xsl:param name="eclipse.manifest" select="0"/> | ||
| 28 | <xsl:param name="create.plugin.xml" select="0"/> | ||
| 29 | <xsl:param name="suppress.navigation" select="1"/> | ||
| 30 | <xsl:param name="generate.index" select="0"/> | ||
| 31 | <xsl:param name="chapter.autolabel" select="1" /> | ||
| 32 | <xsl:param name="appendix.autolabel" select="1" /> | ||
| 33 | <xsl:param name="section.autolabel" select="1" /> | ||
| 34 | <xsl:param name="section.label.includes.component.label" select="1" /> | ||
| 35 | </xsl:stylesheet> | ||
diff --git a/documentation/overview-manual/overview-manual-intro.xml b/documentation/overview-manual/overview-manual-intro.xml new file mode 100644 index 0000000000..51a21b6e23 --- /dev/null +++ b/documentation/overview-manual/overview-manual-intro.xml | |||
| @@ -0,0 +1,103 @@ | |||
| 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
| 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" | ||
| 3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | ||
| 4 | |||
| 5 | <chapter id='overview-manual-intro'> | ||
| 6 | |||
| 7 | <title>The Yocto Project Overview Manual</title> | ||
| 8 | <section id='overview-welcome'> | ||
| 9 | <title>Welcome</title> | ||
| 10 | |||
| 11 | <para> | ||
| 12 | Welcome to the Yocto Project Overview Manual! | ||
| 13 | This manual introduces the Yocto Project by providing concepts, | ||
| 14 | software overviews, best-known-methods (BKMs), and any other | ||
| 15 | high-level introductory information suitable for a new Yocto | ||
| 16 | Project user. | ||
| 17 | </para> | ||
| 18 | |||
| 19 | <para> | ||
| 20 | The following list describes what you can get from this manual: | ||
| 21 | <itemizedlist> | ||
| 22 | <listitem><para> | ||
| 23 | <emphasis>Major Topic:</emphasis> | ||
| 24 | Provide a high-level description of this major topic. | ||
| 25 | </para></listitem> | ||
| 26 | <listitem><para> | ||
| 27 | <emphasis>Major Topic:</emphasis> | ||
| 28 | Provide a high-level description of this major topic. | ||
| 29 | </para></listitem> | ||
| 30 | <listitem><para> | ||
| 31 | <emphasis>Major Topic:</emphasis> | ||
| 32 | Provide a high-level description of this major topic. | ||
| 33 | </para></listitem> | ||
| 34 | <listitem><para> | ||
| 35 | <emphasis>Major Topic:</emphasis> | ||
| 36 | Provide a high-level description of this major topic. | ||
| 37 | </para></listitem> | ||
| 38 | </itemizedlist> | ||
| 39 | </para> | ||
| 40 | |||
| 41 | <para> | ||
| 42 | This manual does not give you the following: | ||
| 43 | <itemizedlist> | ||
| 44 | <listitem><para> | ||
| 45 | <emphasis>Step-by-step Instructions for Development Tasks:</emphasis> | ||
| 46 | Instructional procedures reside in other manuals within | ||
| 47 | the Yocto Project documentation set. | ||
| 48 | For example, the | ||
| 49 | <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Tasks Manual</ulink> | ||
| 50 | provides examples on how to perform various development | ||
| 51 | tasks. | ||
| 52 | As another example, the | ||
| 53 | <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink> | ||
| 54 | manual contains detailed instructions on how to install an | ||
| 55 | SDK, which is used to develop applications for target | ||
| 56 | hardware. | ||
| 57 | </para></listitem> | ||
| 58 | <listitem><para> | ||
| 59 | <emphasis>Reference Material:</emphasis> | ||
| 60 | This type of material resides in an appropriate reference | ||
| 61 | manual. | ||
| 62 | For example, system variables are documented in the | ||
| 63 | <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>. | ||
| 64 | As another example, the | ||
| 65 | <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink> | ||
| 66 | contains reference information on BSPs. | ||
| 67 | </para></listitem> | ||
| 68 | <listitem><para> | ||
| 69 | <emphasis>Detailed Public Information Not Specific to the | ||
| 70 | Yocto Project:</emphasis> | ||
| 71 | For example, exhaustive information on how to use the | ||
| 72 | Source Control Manager Git is better covered with Internet | ||
| 73 | searches and official Git Documentation than through the | ||
| 74 | Yocto Project documentation. | ||
| 75 | </para></listitem> | ||
| 76 | </itemizedlist> | ||
| 77 | </para> | ||
| 78 | </section> | ||
| 79 | |||
| 80 | <section id='overview-other-information'> | ||
| 81 | <title>Other Information</title> | ||
| 82 | |||
| 83 | <para> | ||
| 84 | Because this manual presents information for many different | ||
| 85 | topics, supplemental information is recommended for full | ||
| 86 | comprehension. | ||
| 87 | For additional introductory information on the Yocto Project, see | ||
| 88 | the <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>. | ||
| 89 | You can find an introductory to using the Yocto Project by working | ||
| 90 | through the | ||
| 91 | <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. | ||
| 92 | </para> | ||
| 93 | |||
| 94 | <para> | ||
| 95 | For a comprehensive list of links and other documentation, see the | ||
| 96 | "<ulink url='&YOCTO_DOCS_REF_URL;#resources-links-and-related-documentation'>Links and Related Documentation</ulink>" | ||
| 97 | section in the Yocto Project Reference Manual. | ||
| 98 | </para> | ||
| 99 | </section> | ||
| 100 | </chapter> | ||
| 101 | <!-- | ||
| 102 | vim: expandtab tw=80 ts=4 | ||
| 103 | --> | ||
diff --git a/documentation/overview-manual/overview-manual.html b/documentation/overview-manual/overview-manual.html new file mode 100644 index 0000000000..834f184d2f --- /dev/null +++ b/documentation/overview-manual/overview-manual.html | |||
| @@ -0,0 +1,112 @@ | |||
| 1 | <?xml version="1.0" encoding="UTF-8"?> | ||
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Yocto Project Overview Manual</title><link rel="stylesheet" type="text/css" href="overview-style.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="book" title="Yocto Project Overview Manual" id="overview-manual" lang="en"><div class="titlepage"><div><div><h1 class="title"> | ||
| 3 | Yocto Project Overview Manual | ||
| 4 | </h1></div><div><div class="authorgroup"> | ||
| 5 | <div class="author"><h3 class="author"><span class="firstname">Scott</span> <span class="surname">Rifenbark</span></h3><div class="affiliation"> | ||
| 6 | <span class="orgname">Scotty's Documentation Services, INC<br /></span> | ||
| 7 | </div><code class="email"><<a class="email" href="mailto:srifenbark@gmail.com">srifenbark@gmail.com</a>></code></div> | ||
| 8 | </div></div><div><p class="copyright">Copyright © 2010-2018 Linux Foundation</p></div><div><div class="legalnotice" title="Legal Notice"><a id="idm45825624227376"></a> | ||
| 9 | <p> | ||
| 10 | Permission is granted to copy, distribute and/or modify this document under | ||
| 11 | the terms of the <a class="ulink" href="http://creativecommons.org/licenses/by-sa/2.0/uk/" target="_top"> | ||
| 12 | Creative Commons Attribution-Share Alike 2.0 UK: England & Wales</a> as published by | ||
| 13 | Creative Commons. | ||
| 14 | </p> | ||
| 15 | <div class="note" title="Manual Notes" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Manual Notes</h3> | ||
| 16 | <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p> | ||
| 17 | This version of the | ||
| 18 | <span class="emphasis"><em>Yocto Project Overview Manual</em></span> | ||
| 19 | is for the 2.5 release of the | ||
| 20 | Yocto Project. | ||
| 21 | To be sure you have the latest version of the manual | ||
| 22 | for this release, use the manual from the | ||
| 23 | <a class="ulink" href="http://www.yoctoproject.org/documentation" target="_top">Yocto Project documentation page</a>. | ||
| 24 | </p></li><li class="listitem"><p> | ||
| 25 | For manuals associated with other releases of the Yocto | ||
| 26 | Project, go to the | ||
| 27 | <a class="ulink" href="http://www.yoctoproject.org/documentation" target="_top">Yocto Project documentation page</a> | ||
| 28 | and use the drop-down "Active Releases" button | ||
| 29 | and choose the manual associated with the desired | ||
| 30 | Yocto Project. | ||
| 31 | </p></li><li class="listitem"><p> | ||
| 32 | To report any inaccuracies or problems with this | ||
| 33 | manual, send an email to the Yocto Project | ||
| 34 | discussion group at | ||
| 35 | <code class="filename">yocto@yoctoproject.com</code> or log into | ||
| 36 | the freenode <code class="filename">#yocto</code> channel. | ||
| 37 | </p></li></ul></div> | ||
| 38 | </div> | ||
| 39 | </div></div><div><div class="revhistory"><table border="1" width="100%" summary="Revision history"><tr><th align="left" valign="top" colspan="2"><strong>Revision History</strong></th></tr> | ||
| 40 | <tr><td align="left">Revision 2.5</td><td align="left">April 2018</td></tr><tr><td align="left" colspan="2">The initial document released with the Yocto Project 2.5 Release.</td></tr> | ||
| 41 | </table></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="chapter"><a href="#overview-manual-intro">1. The Yocto Project Overview Manual</a></span></dt><dd><dl><dt><span class="section"><a href="#overview-welcome">1.1. Welcome</a></span></dt><dt><span class="section"><a href="#overview-other-information">1.2. Other Information</a></span></dt></dl></dd></dl></div> | ||
| 42 | |||
| 43 | |||
| 44 | <div class="chapter" title="Chapter 1. The Yocto Project Overview Manual" id="overview-manual-intro"><div class="titlepage"><div><div><h2 class="title">Chapter 1. The Yocto Project Overview Manual<span class="permalink"><a alt="Permalink" title="Permalink" href="#overview-manual-intro">¶</a></span></h2></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#overview-welcome">1.1. Welcome</a></span></dt><dt><span class="section"><a href="#overview-other-information">1.2. Other Information</a></span></dt></dl></div><div class="section" title="1.1. Welcome"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="overview-welcome">1.1. Welcome<span class="permalink"><a alt="Permalink" title="Permalink" href="#overview-welcome">¶</a></span></h2></div></div></div><p> | ||
| 45 | Welcome to the Yocto Project Overview Manual! | ||
| 46 | This manual introduces the Yocto Project by providing concepts, | ||
| 47 | software overviews, best-known-methods (BKMs), and any other | ||
| 48 | high-level introductory information suitable for a new Yocto | ||
| 49 | Project user. | ||
| 50 | </p><p> | ||
| 51 | The following list describes what you can get from this manual: | ||
| 52 | </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p> | ||
| 53 | <span class="emphasis"><em>Major Topic:</em></span> | ||
| 54 | Provide a high-level description of this major topic. | ||
| 55 | </p></li><li class="listitem"><p> | ||
| 56 | <span class="emphasis"><em>Major Topic:</em></span> | ||
| 57 | Provide a high-level description of this major topic. | ||
| 58 | </p></li><li class="listitem"><p> | ||
| 59 | <span class="emphasis"><em>Major Topic:</em></span> | ||
| 60 | Provide a high-level description of this major topic. | ||
| 61 | </p></li><li class="listitem"><p> | ||
| 62 | <span class="emphasis"><em>Major Topic:</em></span> | ||
| 63 | Provide a high-level description of this major topic. | ||
| 64 | </p></li></ul></div><p> | ||
| 65 | </p><p> | ||
| 66 | This manual does not give you the following: | ||
| 67 | </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p> | ||
| 68 | <span class="emphasis"><em>Step-by-step Instructions for Development Tasks:</em></span> | ||
| 69 | Instructional procedures reside in other manuals within | ||
| 70 | the Yocto Project documentation set. | ||
| 71 | For example, the | ||
| 72 | <a class="ulink" href="http://www.yoctoproject.org/docs/2.5/dev-manual/dev-manual.html" target="_top">Yocto Project Development Tasks Manual</a> | ||
| 73 | provides examples on how to perform various development | ||
| 74 | tasks. | ||
| 75 | As another example, the | ||
| 76 | <a class="ulink" href="http://www.yoctoproject.org/docs/2.5/sdk-manual/sdk-manual.html" target="_top">Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</a> | ||
| 77 | manual contains detailed instructions on how to install an | ||
| 78 | SDK, which is used to develop applications for target | ||
| 79 | hardware. | ||
| 80 | </p></li><li class="listitem"><p> | ||
| 81 | <span class="emphasis"><em>Reference Material:</em></span> | ||
| 82 | This type of material resides in an appropriate reference | ||
| 83 | manual. | ||
| 84 | For example, system variables are documented in the | ||
| 85 | <a class="ulink" href="http://www.yoctoproject.org/docs/2.5/ref-manual/ref-manual.html" target="_top">Yocto Project Reference Manual</a>. | ||
| 86 | As another example, the | ||
| 87 | <a class="ulink" href="http://www.yoctoproject.org/docs/2.5/bsp-guide/bsp-guide.html" target="_top">Yocto Project Board Support Package (BSP) Developer's Guide</a> | ||
| 88 | contains reference information on BSPs. | ||
| 89 | </p></li><li class="listitem"><p> | ||
| 90 | <span class="emphasis"><em>Detailed Public Information Not Specific to the | ||
| 91 | Yocto Project:</em></span> | ||
| 92 | For example, exhaustive information on how to use the | ||
| 93 | Source Control Manager Git is better covered with Internet | ||
| 94 | searches and official Git Documentation than through the | ||
| 95 | Yocto Project documentation. | ||
| 96 | </p></li></ul></div><p> | ||
| 97 | </p></div><div class="section" title="1.2. Other Information"><div class="titlepage"><div><div><h2 class="title" style="clear: both" id="overview-other-information">1.2. Other Information<span class="permalink"><a alt="Permalink" title="Permalink" href="#overview-other-information">¶</a></span></h2></div></div></div><p> | ||
| 98 | Because this manual presents information for many different | ||
| 99 | topics, supplemental information is recommended for full | ||
| 100 | comprehension. | ||
| 101 | For additional introductory information on the Yocto Project, see | ||
| 102 | the <a class="ulink" href="http://www.yoctoproject.org" target="_top">Yocto Project Website</a>. | ||
| 103 | You can find an introductory to using the Yocto Project by working | ||
| 104 | through the | ||
| 105 | <a class="ulink" href="http://www.yoctoproject.org/docs/2.5/yocto-project-qs/yocto-project-qs.html" target="_top">Yocto Project Quick Start</a>. | ||
| 106 | </p><p> | ||
| 107 | For a comprehensive list of links and other documentation, see the | ||
| 108 | "<a class="ulink" href="http://www.yoctoproject.org/docs/2.5/ref-manual/ref-manual.html#resources-links-and-related-documentation" target="_top">Links and Related Documentation</a>" | ||
| 109 | section in the Yocto Project Reference Manual. | ||
| 110 | </p></div></div> | ||
| 111 | |||
| 112 | </div></body></html> \ No newline at end of file | ||
diff --git a/documentation/overview-manual/overview-manual.tgz b/documentation/overview-manual/overview-manual.tgz new file mode 100644 index 0000000000..9bb8c6635f --- /dev/null +++ b/documentation/overview-manual/overview-manual.tgz | |||
| Binary files differ | |||
diff --git a/documentation/overview-manual/overview-manual.xml b/documentation/overview-manual/overview-manual.xml new file mode 100644 index 0000000000..9eda19a8f7 --- /dev/null +++ b/documentation/overview-manual/overview-manual.xml | |||
| @@ -0,0 +1,90 @@ | |||
| 1 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
| 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" | ||
| 3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | ||
| 4 | |||
| 5 | <book id='overview-manual' lang='en' | ||
| 6 | xmlns:xi="http://www.w3.org/2003/XInclude" | ||
| 7 | xmlns="http://docbook.org/ns/docbook" | ||
| 8 | > | ||
| 9 | <bookinfo> | ||
| 10 | |||
| 11 | <mediaobject> | ||
| 12 | <imageobject> | ||
| 13 | <imagedata fileref='figures/overview-title.png' | ||
| 14 | format='SVG' | ||
| 15 | align='left' scalefit='1' width='100%'/> | ||
| 16 | </imageobject> | ||
| 17 | </mediaobject> | ||
| 18 | |||
| 19 | <title> | ||
| 20 | Yocto Project Overview Manual | ||
| 21 | </title> | ||
| 22 | |||
| 23 | <authorgroup> | ||
| 24 | <author> | ||
| 25 | <firstname>Scott</firstname> <surname>Rifenbark</surname> | ||
| 26 | <affiliation> | ||
| 27 | <orgname>Scotty's Documentation Services, INC</orgname> | ||
| 28 | </affiliation> | ||
| 29 | <email>srifenbark@gmail.com</email> | ||
| 30 | </author> | ||
| 31 | </authorgroup> | ||
| 32 | |||
| 33 | <revhistory> | ||
| 34 | <revision> | ||
| 35 | <revnumber>2.5</revnumber> | ||
| 36 | <date>April 2018</date> | ||
| 37 | <revremark>The initial document released with the Yocto Project 2.5 Release.</revremark> | ||
| 38 | </revision> | ||
| 39 | </revhistory> | ||
| 40 | |||
| 41 | <copyright> | ||
| 42 | <year>©RIGHT_YEAR;</year> | ||
| 43 | <holder>Linux Foundation</holder> | ||
| 44 | </copyright> | ||
| 45 | |||
| 46 | <legalnotice> | ||
| 47 | <para> | ||
| 48 | Permission is granted to copy, distribute and/or modify this document under | ||
| 49 | the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-sa/2.0/uk/"> | ||
| 50 | Creative Commons Attribution-Share Alike 2.0 UK: England & Wales</ulink> as published by | ||
| 51 | Creative Commons. | ||
| 52 | </para> | ||
| 53 | <note><title>Manual Notes</title> | ||
| 54 | <itemizedlist> | ||
| 55 | <listitem><para> | ||
| 56 | This version of the | ||
| 57 | <emphasis>Yocto Project Overview Manual</emphasis> | ||
| 58 | is for the &YOCTO_DOC_VERSION; release of the | ||
| 59 | Yocto Project. | ||
| 60 | To be sure you have the latest version of the manual | ||
| 61 | for this release, use the manual from the | ||
| 62 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink>. | ||
| 63 | </para></listitem> | ||
| 64 | <listitem><para> | ||
| 65 | For manuals associated with other releases of the Yocto | ||
| 66 | Project, go to the | ||
| 67 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> | ||
| 68 | and use the drop-down "Active Releases" button | ||
| 69 | and choose the manual associated with the desired | ||
| 70 | Yocto Project. | ||
| 71 | </para></listitem> | ||
| 72 | <listitem><para> | ||
| 73 | To report any inaccuracies or problems with this | ||
| 74 | manual, send an email to the Yocto Project | ||
| 75 | discussion group at | ||
| 76 | <filename>yocto@yoctoproject.com</filename> or log into | ||
| 77 | the freenode <filename>#yocto</filename> channel. | ||
| 78 | </para></listitem> | ||
| 79 | </itemizedlist> | ||
| 80 | </note> | ||
| 81 | </legalnotice> | ||
| 82 | |||
| 83 | </bookinfo> | ||
| 84 | |||
| 85 | <xi:include href="overview-manual-intro.xml"/> | ||
| 86 | |||
| 87 | </book> | ||
| 88 | <!-- | ||
| 89 | vim: expandtab tw=80 ts=4 | ||
| 90 | --> | ||
diff --git a/documentation/overview-manual/overview-style.css b/documentation/overview-manual/overview-style.css new file mode 100644 index 0000000000..9d7bf9e0d6 --- /dev/null +++ b/documentation/overview-manual/overview-style.css | |||
| @@ -0,0 +1,988 @@ | |||
| 1 | /* | ||
| 2 | Generic XHTML / DocBook XHTML CSS Stylesheet. | ||
| 3 | |||
| 4 | Browser wrangling and typographic design by | ||
| 5 | Oyvind Kolas / pippin@gimp.org | ||
| 6 | |||
| 7 | Customised for Poky by | ||
| 8 | Matthew Allum / mallum@o-hand.com | ||
| 9 | |||
| 10 | Thanks to: | ||
| 11 | Liam R. E. Quin | ||
| 12 | William Skaggs | ||
| 13 | Jakub Steiner | ||
| 14 | |||
| 15 | Structure | ||
| 16 | --------- | ||
| 17 | |||
| 18 | The stylesheet is divided into the following sections: | ||
| 19 | |||
| 20 | Positioning | ||
| 21 | Margins, paddings, width, font-size, clearing. | ||
| 22 | Decorations | ||
| 23 | Borders, style | ||
| 24 | Colors | ||
| 25 | Colors | ||
| 26 | Graphics | ||
| 27 | Graphical backgrounds | ||
| 28 | Nasty IE tweaks | ||
| 29 | Workarounds needed to make it work in internet explorer, | ||
| 30 | currently makes the stylesheet non validating, but up until | ||
| 31 | this point it is validating. | ||
| 32 | Mozilla extensions | ||
| 33 | Transparency for footer | ||
| 34 | Rounded corners on boxes | ||
| 35 | |||
| 36 | */ | ||
| 37 | |||
| 38 | |||
| 39 | /*************** / | ||
| 40 | / Positioning / | ||
| 41 | / ***************/ | ||
| 42 | |||
| 43 | body { | ||
| 44 | font-family: Verdana, Sans, sans-serif; | ||
| 45 | |||
| 46 | min-width: 640px; | ||
| 47 | width: 80%; | ||
| 48 | margin: 0em auto; | ||
| 49 | padding: 2em 5em 5em 5em; | ||
| 50 | color: #333; | ||
| 51 | } | ||
| 52 | |||
| 53 | h1,h2,h3,h4,h5,h6,h7 { | ||
| 54 | font-family: Arial, Sans; | ||
| 55 | color: #00557D; | ||
| 56 | clear: both; | ||
| 57 | } | ||
| 58 | |||
| 59 | h1 { | ||
| 60 | font-size: 2em; | ||
| 61 | text-align: left; | ||
| 62 | padding: 0em 0em 0em 0em; | ||
| 63 | margin: 2em 0em 0em 0em; | ||
| 64 | } | ||
| 65 | |||
| 66 | h2.subtitle { | ||
| 67 | margin: 0.10em 0em 3.0em 0em; | ||
| 68 | padding: 0em 0em 0em 0em; | ||
| 69 | font-size: 1.8em; | ||
| 70 | padding-left: 20%; | ||
| 71 | font-weight: normal; | ||
| 72 | font-style: italic; | ||
| 73 | } | ||
| 74 | |||
| 75 | h2 { | ||
| 76 | margin: 2em 0em 0.66em 0em; | ||
| 77 | padding: 0.5em 0em 0em 0em; | ||
| 78 | font-size: 1.5em; | ||
| 79 | font-weight: bold; | ||
| 80 | } | ||
| 81 | |||
| 82 | h3.subtitle { | ||
| 83 | margin: 0em 0em 1em 0em; | ||
| 84 | padding: 0em 0em 0em 0em; | ||
| 85 | font-size: 142.14%; | ||
| 86 | text-align: right; | ||
| 87 | } | ||
| 88 | |||
| 89 | h3 { | ||
| 90 | margin: 1em 0em 0.5em 0em; | ||
| 91 | padding: 1em 0em 0em 0em; | ||
| 92 | font-size: 140%; | ||
| 93 | font-weight: bold; | ||
| 94 | } | ||
| 95 | |||
| 96 | h4 { | ||
| 97 | margin: 1em 0em 0.5em 0em; | ||
| 98 | padding: 1em 0em 0em 0em; | ||
| 99 | font-size: 120%; | ||
| 100 | font-weight: bold; | ||
| 101 | } | ||
| 102 | |||
| 103 | h5 { | ||
| 104 | margin: 1em 0em 0.5em 0em; | ||
| 105 | padding: 1em 0em 0em 0em; | ||
| 106 | font-size: 110%; | ||
| 107 | font-weight: bold; | ||
| 108 | } | ||
| 109 | |||
| 110 | h6 { | ||
| 111 | margin: 1em 0em 0em 0em; | ||
| 112 | padding: 1em 0em 0em 0em; | ||
| 113 | font-size: 110%; | ||
| 114 | font-weight: bold; | ||
| 115 | } | ||
| 116 | |||
| 117 | .authorgroup { | ||
| 118 | background-color: transparent; | ||
| 119 | background-repeat: no-repeat; | ||
| 120 | padding-top: 256px; | ||
| 121 | background-image: url("figures/overview-title.png"); | ||
| 122 | background-position: left top; | ||
| 123 | margin-top: -256px; | ||
| 124 | padding-right: 50px; | ||
| 125 | margin-left: 0px; | ||
| 126 | text-align: right; | ||
| 127 | width: 740px; | ||
| 128 | } | ||
| 129 | |||
| 130 | h3.author { | ||
| 131 | margin: 0em 0me 0em 0em; | ||
| 132 | padding: 0em 0em 0em 0em; | ||
| 133 | font-weight: normal; | ||
| 134 | font-size: 100%; | ||
| 135 | color: #333; | ||
| 136 | clear: both; | ||
| 137 | } | ||
| 138 | |||
| 139 | .author tt.email { | ||
| 140 | font-size: 66%; | ||
| 141 | } | ||
| 142 | |||
| 143 | .titlepage hr { | ||
| 144 | width: 0em; | ||
| 145 | clear: both; | ||
| 146 | } | ||
| 147 | |||
| 148 | .revhistory { | ||
| 149 | padding-top: 2em; | ||
| 150 | clear: both; | ||
| 151 | } | ||
| 152 | |||
| 153 | .toc, | ||
| 154 | .list-of-tables, | ||
| 155 | .list-of-examples, | ||
| 156 | .list-of-figures { | ||
| 157 | padding: 1.33em 0em 2.5em 0em; | ||
| 158 | color: #00557D; | ||
| 159 | } | ||
| 160 | |||
| 161 | .toc p, | ||
| 162 | .list-of-tables p, | ||
| 163 | .list-of-figures p, | ||
| 164 | .list-of-examples p { | ||
| 165 | padding: 0em 0em 0em 0em; | ||
| 166 | padding: 0em 0em 0.3em; | ||
| 167 | margin: 1.5em 0em 0em 0em; | ||
| 168 | } | ||
| 169 | |||
| 170 | .toc p b, | ||
| 171 | .list-of-tables p b, | ||
| 172 | .list-of-figures p b, | ||
| 173 | .list-of-examples p b{ | ||
| 174 | font-size: 100.0%; | ||
| 175 | font-weight: bold; | ||
| 176 | } | ||
| 177 | |||
| 178 | .toc dl, | ||
| 179 | .list-of-tables dl, | ||
| 180 | .list-of-figures dl, | ||
| 181 | .list-of-examples dl { | ||
| 182 | margin: 0em 0em 0.5em 0em; | ||
| 183 | padding: 0em 0em 0em 0em; | ||
| 184 | } | ||
| 185 | |||
| 186 | .toc dt { | ||
| 187 | margin: 0em 0em 0em 0em; | ||
| 188 | padding: 0em 0em 0em 0em; | ||
| 189 | } | ||
| 190 | |||
| 191 | .toc dd { | ||
| 192 | margin: 0em 0em 0em 2.6em; | ||
| 193 | padding: 0em 0em 0em 0em; | ||
| 194 | } | ||
| 195 | |||
| 196 | div.glossary dl, | ||
| 197 | div.variablelist dl { | ||
| 198 | } | ||
| 199 | |||
| 200 | .glossary dl dt, | ||
| 201 | .variablelist dl dt, | ||
| 202 | .variablelist dl dt span.term { | ||
| 203 | font-weight: normal; | ||
| 204 | width: 20em; | ||
| 205 | text-align: right; | ||
| 206 | } | ||
| 207 | |||
| 208 | .variablelist dl dt { | ||
| 209 | margin-top: 0.5em; | ||
| 210 | } | ||
| 211 | |||
| 212 | .glossary dl dd, | ||
| 213 | .variablelist dl dd { | ||
| 214 | margin-top: -1em; | ||
| 215 | margin-left: 25.5em; | ||
| 216 | } | ||
| 217 | |||
| 218 | .glossary dd p, | ||
| 219 | .variablelist dd p { | ||
| 220 | margin-top: 0em; | ||
| 221 | margin-bottom: 1em; | ||
| 222 | } | ||
| 223 | |||
| 224 | |||
| 225 | div.calloutlist table td { | ||
| 226 | padding: 0em 0em 0em 0em; | ||
| 227 | margin: 0em 0em 0em 0em; | ||
| 228 | } | ||
| 229 | |||
| 230 | div.calloutlist table td p { | ||
| 231 | margin-top: 0em; | ||
| 232 | margin-bottom: 1em; | ||
| 233 | } | ||
| 234 | |||
| 235 | div p.copyright { | ||
| 236 | text-align: left; | ||
| 237 | } | ||
| 238 | |||
| 239 | div.legalnotice p.legalnotice-title { | ||
| 240 | margin-bottom: 0em; | ||
| 241 | } | ||
| 242 | |||
| 243 | p { | ||
| 244 | line-height: 1.5em; | ||
| 245 | margin-top: 0em; | ||
| 246 | |||
| 247 | } | ||
| 248 | |||
| 249 | dl { | ||
| 250 | padding-top: 0em; | ||
| 251 | } | ||
| 252 | |||
| 253 | hr { | ||
| 254 | border: solid 1px; | ||
| 255 | } | ||
| 256 | |||
| 257 | |||
| 258 | .mediaobject, | ||
| 259 | .mediaobjectco { | ||
| 260 | text-align: center; | ||
| 261 | } | ||
| 262 | |||
| 263 | img { | ||
| 264 | border: none; | ||
| 265 | } | ||
| 266 | |||
| 267 | ul { | ||
| 268 | padding: 0em 0em 0em 1.5em; | ||
| 269 | } | ||
| 270 | |||
| 271 | ul li { | ||
| 272 | padding: 0em 0em 0em 0em; | ||
| 273 | } | ||
| 274 | |||
| 275 | ul li p { | ||
| 276 | text-align: left; | ||
| 277 | } | ||
| 278 | |||
| 279 | table { | ||
| 280 | width :100%; | ||
| 281 | } | ||
| 282 | |||
| 283 | th { | ||
| 284 | padding: 0.25em; | ||
| 285 | text-align: left; | ||
| 286 | font-weight: normal; | ||
| 287 | vertical-align: top; | ||
| 288 | } | ||
| 289 | |||
| 290 | td { | ||
| 291 | padding: 0.25em; | ||
| 292 | vertical-align: top; | ||
| 293 | } | ||
| 294 | |||
| 295 | p a[id] { | ||
| 296 | margin: 0px; | ||
| 297 | padding: 0px; | ||
| 298 | display: inline; | ||
| 299 | background-image: none; | ||
| 300 | } | ||
| 301 | |||
| 302 | a { | ||
| 303 | text-decoration: underline; | ||
| 304 | color: #444; | ||
| 305 | } | ||
| 306 | |||
| 307 | pre { | ||
| 308 | overflow: auto; | ||
| 309 | } | ||
| 310 | |||
| 311 | a:hover { | ||
| 312 | text-decoration: underline; | ||
| 313 | /*font-weight: bold;*/ | ||
| 314 | } | ||
| 315 | |||
| 316 | /* This style defines how the permalink character | ||
| 317 | appears by itself and when hovered over with | ||
| 318 | the mouse. */ | ||
| 319 | |||
| 320 | [alt='Permalink'] { color: #eee; } | ||
| 321 | [alt='Permalink']:hover { color: black; } | ||
| 322 | |||
| 323 | |||
| 324 | div.informalfigure, | ||
| 325 | div.informalexample, | ||
| 326 | div.informaltable, | ||
| 327 | div.figure, | ||
| 328 | div.table, | ||
| 329 | div.example { | ||
| 330 | margin: 1em 0em; | ||
| 331 | padding: 1em; | ||
| 332 | page-break-inside: avoid; | ||
| 333 | } | ||
| 334 | |||
| 335 | |||
| 336 | div.informalfigure p.title b, | ||
| 337 | div.informalexample p.title b, | ||
| 338 | div.informaltable p.title b, | ||
| 339 | div.figure p.title b, | ||
| 340 | div.example p.title b, | ||
| 341 | div.table p.title b{ | ||
| 342 | padding-top: 0em; | ||
| 343 | margin-top: 0em; | ||
| 344 | font-size: 100%; | ||
| 345 | font-weight: normal; | ||
| 346 | } | ||
| 347 | |||
| 348 | .mediaobject .caption, | ||
| 349 | .mediaobject .caption p { | ||
| 350 | text-align: center; | ||
| 351 | font-size: 80%; | ||
| 352 | padding-top: 0.5em; | ||
| 353 | padding-bottom: 0.5em; | ||
| 354 | } | ||
| 355 | |||
| 356 | .epigraph { | ||
| 357 | padding-left: 55%; | ||
| 358 | margin-bottom: 1em; | ||
| 359 | } | ||
| 360 | |||
| 361 | .epigraph p { | ||
| 362 | text-align: left; | ||
| 363 | } | ||
| 364 | |||
| 365 | .epigraph .quote { | ||
| 366 | font-style: italic; | ||
| 367 | } | ||
| 368 | .epigraph .attribution { | ||
| 369 | font-style: normal; | ||
| 370 | text-align: right; | ||
| 371 | } | ||
| 372 | |||
| 373 | span.application { | ||
| 374 | font-style: italic; | ||
| 375 | } | ||
| 376 | |||
| 377 | .programlisting { | ||
| 378 | font-family: monospace; | ||
| 379 | font-size: 80%; | ||
| 380 | white-space: pre; | ||
| 381 | margin: 1.33em 0em; | ||
| 382 | padding: 1.33em; | ||
| 383 | } | ||
| 384 | |||
| 385 | .tip, | ||
| 386 | .warning, | ||
| 387 | .caution, | ||
| 388 | .note { | ||
| 389 | margin-top: 1em; | ||
| 390 | margin-bottom: 1em; | ||
| 391 | |||
| 392 | } | ||
| 393 | |||
| 394 | /* force full width of table within div */ | ||
| 395 | .tip table, | ||
| 396 | .warning table, | ||
| 397 | .caution table, | ||
| 398 | .note table { | ||
| 399 | border: none; | ||
| 400 | width: 100%; | ||
| 401 | } | ||
| 402 | |||
| 403 | |||
| 404 | .tip table th, | ||
| 405 | .warning table th, | ||
| 406 | .caution table th, | ||
| 407 | .note table th { | ||
| 408 | padding: 0.8em 0.0em 0.0em 0.0em; | ||
| 409 | margin : 0em 0em 0em 0em; | ||
| 410 | } | ||
| 411 | |||
| 412 | .tip p, | ||
| 413 | .warning p, | ||
| 414 | .caution p, | ||
| 415 | .note p { | ||
| 416 | margin-top: 0.5em; | ||
| 417 | margin-bottom: 0.5em; | ||
| 418 | padding-right: 1em; | ||
| 419 | text-align: left; | ||
| 420 | } | ||
| 421 | |||
| 422 | .acronym { | ||
| 423 | text-transform: uppercase; | ||
| 424 | } | ||
| 425 | |||
| 426 | b.keycap, | ||
| 427 | .keycap { | ||
| 428 | padding: 0.09em 0.3em; | ||
| 429 | margin: 0em; | ||
| 430 | } | ||
| 431 | |||
| 432 | .itemizedlist li { | ||
| 433 | clear: none; | ||
| 434 | } | ||
| 435 | |||
| 436 | .filename { | ||
| 437 | font-size: medium; | ||
| 438 | font-family: Courier, monospace; | ||
| 439 | } | ||
| 440 | |||
| 441 | |||
| 442 | div.navheader, div.heading{ | ||
| 443 | position: absolute; | ||
| 444 | left: 0em; | ||
| 445 | top: 0em; | ||
| 446 | width: 100%; | ||
| 447 | background-color: #cdf; | ||
| 448 | width: 100%; | ||
| 449 | } | ||
| 450 | |||
| 451 | div.navfooter, div.footing{ | ||
| 452 | position: fixed; | ||
| 453 | left: 0em; | ||
| 454 | bottom: 0em; | ||
| 455 | background-color: #eee; | ||
| 456 | width: 100%; | ||
| 457 | } | ||
| 458 | |||
| 459 | |||
| 460 | div.navheader td, | ||
| 461 | div.navfooter td { | ||
| 462 | font-size: 66%; | ||
| 463 | } | ||
| 464 | |||
| 465 | div.navheader table th { | ||
| 466 | /*font-family: Georgia, Times, serif;*/ | ||
| 467 | /*font-size: x-large;*/ | ||
| 468 | font-size: 80%; | ||
| 469 | } | ||
| 470 | |||
| 471 | div.navheader table { | ||
| 472 | border-left: 0em; | ||
| 473 | border-right: 0em; | ||
| 474 | border-top: 0em; | ||
| 475 | width: 100%; | ||
| 476 | } | ||
| 477 | |||
| 478 | div.navfooter table { | ||
| 479 | border-left: 0em; | ||
| 480 | border-right: 0em; | ||
| 481 | border-bottom: 0em; | ||
| 482 | width: 100%; | ||
| 483 | } | ||
| 484 | |||
| 485 | div.navheader table td a, | ||
| 486 | div.navfooter table td a { | ||
| 487 | color: #777; | ||
| 488 | text-decoration: none; | ||
| 489 | } | ||
| 490 | |||
| 491 | /* normal text in the footer */ | ||
| 492 | div.navfooter table td { | ||
| 493 | color: black; | ||
| 494 | } | ||
| 495 | |||
| 496 | div.navheader table td a:visited, | ||
| 497 | div.navfooter table td a:visited { | ||
| 498 | color: #444; | ||
| 499 | } | ||
| 500 | |||
| 501 | |||
| 502 | /* links in header and footer */ | ||
| 503 | div.navheader table td a:hover, | ||
| 504 | div.navfooter table td a:hover { | ||
| 505 | text-decoration: underline; | ||
| 506 | background-color: transparent; | ||
| 507 | color: #33a; | ||
| 508 | } | ||
| 509 | |||
| 510 | div.navheader hr, | ||
| 511 | div.navfooter hr { | ||
| 512 | display: none; | ||
| 513 | } | ||
| 514 | |||
| 515 | |||
| 516 | .qandaset tr.question td p { | ||
| 517 | margin: 0em 0em 1em 0em; | ||
| 518 | padding: 0em 0em 0em 0em; | ||
| 519 | } | ||
| 520 | |||
| 521 | .qandaset tr.answer td p { | ||
| 522 | margin: 0em 0em 1em 0em; | ||
| 523 | padding: 0em 0em 0em 0em; | ||
| 524 | } | ||
| 525 | .answer td { | ||
| 526 | padding-bottom: 1.5em; | ||
| 527 | } | ||
| 528 | |||
| 529 | .emphasis { | ||
| 530 | font-weight: bold; | ||
| 531 | } | ||
| 532 | |||
| 533 | |||
| 534 | /************* / | ||
| 535 | / decorations / | ||
| 536 | / *************/ | ||
| 537 | |||
| 538 | .titlepage { | ||
| 539 | } | ||
| 540 | |||
| 541 | .part .title { | ||
| 542 | } | ||
| 543 | |||
| 544 | .subtitle { | ||
| 545 | border: none; | ||
| 546 | } | ||
| 547 | |||
| 548 | /* | ||
| 549 | h1 { | ||
| 550 | border: none; | ||
| 551 | } | ||
| 552 | |||
| 553 | h2 { | ||
| 554 | border-top: solid 0.2em; | ||
| 555 | border-bottom: solid 0.06em; | ||
| 556 | } | ||
| 557 | |||
| 558 | h3 { | ||
| 559 | border-top: 0em; | ||
| 560 | border-bottom: solid 0.06em; | ||
| 561 | } | ||
| 562 | |||
| 563 | h4 { | ||
| 564 | border: 0em; | ||
| 565 | border-bottom: solid 0.06em; | ||
| 566 | } | ||
| 567 | |||
| 568 | h5 { | ||
| 569 | border: 0em; | ||
| 570 | } | ||
| 571 | */ | ||
| 572 | |||
| 573 | .programlisting { | ||
| 574 | border: solid 1px; | ||
| 575 | } | ||
| 576 | |||
| 577 | div.figure, | ||
| 578 | div.table, | ||
| 579 | div.informalfigure, | ||
| 580 | div.informaltable, | ||
| 581 | div.informalexample, | ||
| 582 | div.example { | ||
| 583 | border: 1px solid; | ||
| 584 | } | ||
| 585 | |||
| 586 | |||
| 587 | |||
| 588 | .tip, | ||
| 589 | .warning, | ||
| 590 | .caution, | ||
| 591 | .note { | ||
| 592 | border: 1px solid; | ||
| 593 | } | ||
| 594 | |||
| 595 | .tip table th, | ||
| 596 | .warning table th, | ||
| 597 | .caution table th, | ||
| 598 | .note table th { | ||
| 599 | border-bottom: 1px solid; | ||
| 600 | } | ||
| 601 | |||
| 602 | .question td { | ||
| 603 | border-top: 1px solid black; | ||
| 604 | } | ||
| 605 | |||
| 606 | .answer { | ||
| 607 | } | ||
| 608 | |||
| 609 | |||
| 610 | b.keycap, | ||
| 611 | .keycap { | ||
| 612 | border: 1px solid; | ||
| 613 | } | ||
| 614 | |||
| 615 | |||
| 616 | div.navheader, div.heading{ | ||
| 617 | border-bottom: 1px solid; | ||
| 618 | } | ||
| 619 | |||
| 620 | |||
| 621 | div.navfooter, div.footing{ | ||
| 622 | border-top: 1px solid; | ||
| 623 | } | ||
| 624 | |||
| 625 | /********* / | ||
| 626 | / colors / | ||
| 627 | / *********/ | ||
| 628 | |||
| 629 | body { | ||
| 630 | color: #333; | ||
| 631 | background: white; | ||
| 632 | } | ||
| 633 | |||
| 634 | a { | ||
| 635 | background: transparent; | ||
| 636 | } | ||
| 637 | |||
| 638 | a:hover { | ||
| 639 | background-color: #dedede; | ||
| 640 | } | ||
| 641 | |||
| 642 | |||
| 643 | h1, | ||
| 644 | h2, | ||
| 645 | h3, | ||
| 646 | h4, | ||
| 647 | h5, | ||
| 648 | h6, | ||
| 649 | h7, | ||
| 650 | h8 { | ||
| 651 | background-color: transparent; | ||
| 652 | } | ||
| 653 | |||
| 654 | hr { | ||
| 655 | border-color: #aaa; | ||
| 656 | } | ||
| 657 | |||
| 658 | |||
| 659 | .tip, .warning, .caution, .note { | ||
| 660 | border-color: #fff; | ||
| 661 | } | ||
| 662 | |||
| 663 | |||
| 664 | .tip table th, | ||
| 665 | .warning table th, | ||
| 666 | .caution table th, | ||
| 667 | .note table th { | ||
| 668 | border-bottom-color: #fff; | ||
| 669 | } | ||
| 670 | |||
| 671 | |||
| 672 | .warning { | ||
| 673 | background-color: #f0f0f2; | ||
| 674 | } | ||
| 675 | |||
| 676 | .caution { | ||
| 677 | background-color: #f0f0f2; | ||
| 678 | } | ||
| 679 | |||
| 680 | .tip { | ||
| 681 | background-color: #f0f0f2; | ||
| 682 | } | ||
| 683 | |||
| 684 | .note { | ||
| 685 | background-color: #f0f0f2; | ||
| 686 | } | ||
| 687 | |||
| 688 | .glossary dl dt, | ||
| 689 | .variablelist dl dt, | ||
| 690 | .variablelist dl dt span.term { | ||
| 691 | color: #044; | ||
| 692 | } | ||
| 693 | |||
| 694 | div.figure, | ||
| 695 | div.table, | ||
| 696 | div.example, | ||
| 697 | div.informalfigure, | ||
| 698 | div.informaltable, | ||
| 699 | div.informalexample { | ||
| 700 | border-color: #aaa; | ||
| 701 | } | ||
| 702 | |||
| 703 | pre.programlisting { | ||
| 704 | color: black; | ||
| 705 | background-color: #fff; | ||
| 706 | border-color: #aaa; | ||
| 707 | border-width: 2px; | ||
| 708 | } | ||
| 709 | |||
| 710 | .guimenu, | ||
| 711 | .guilabel, | ||
| 712 | .guimenuitem { | ||
| 713 | background-color: #eee; | ||
| 714 | } | ||
| 715 | |||
| 716 | |||
| 717 | b.keycap, | ||
| 718 | .keycap { | ||
| 719 | background-color: #eee; | ||
| 720 | border-color: #999; | ||
| 721 | } | ||
| 722 | |||
| 723 | |||
| 724 | div.navheader { | ||
| 725 | border-color: black; | ||
| 726 | } | ||
| 727 | |||
| 728 | |||
| 729 | div.navfooter { | ||
| 730 | border-color: black; | ||
| 731 | } | ||
| 732 | |||
| 733 | .writernotes { | ||
| 734 | color: red; | ||
| 735 | } | ||
| 736 | |||
| 737 | |||
| 738 | /*********** / | ||
| 739 | / graphics / | ||
| 740 | / ***********/ | ||
| 741 | |||
| 742 | /* | ||
| 743 | body { | ||
| 744 | background-image: url("images/body_bg.jpg"); | ||
| 745 | background-attachment: fixed; | ||
| 746 | } | ||
| 747 | |||
| 748 | .navheader, | ||
| 749 | .note, | ||
| 750 | .tip { | ||
| 751 | background-image: url("images/note_bg.jpg"); | ||
| 752 | background-attachment: fixed; | ||
| 753 | } | ||
| 754 | |||
| 755 | .warning, | ||
| 756 | .caution { | ||
| 757 | background-image: url("images/warning_bg.jpg"); | ||
| 758 | background-attachment: fixed; | ||
| 759 | } | ||
| 760 | |||
| 761 | .figure, | ||
| 762 | .informalfigure, | ||
| 763 | .example, | ||
| 764 | .informalexample, | ||
| 765 | .table, | ||
| 766 | .informaltable { | ||
| 767 | background-image: url("images/figure_bg.jpg"); | ||
| 768 | background-attachment: fixed; | ||
| 769 | } | ||
| 770 | |||
| 771 | */ | ||
| 772 | h1, | ||
| 773 | h2, | ||
| 774 | h3, | ||
| 775 | h4, | ||
| 776 | h5, | ||
| 777 | h6, | ||
| 778 | h7{ | ||
| 779 | } | ||
| 780 | |||
| 781 | /* | ||
| 782 | Example of how to stick an image as part of the title. | ||
| 783 | |||
| 784 | div.article .titlepage .title | ||
| 785 | { | ||
| 786 | background-image: url("figures/white-on-black.png"); | ||
| 787 | background-position: center; | ||
| 788 | background-repeat: repeat-x; | ||
| 789 | } | ||
| 790 | */ | ||
| 791 | |||
| 792 | div.preface .titlepage .title, | ||
| 793 | div.colophon .title, | ||
| 794 | div.chapter .titlepage .title, | ||
| 795 | div.article .titlepage .title | ||
| 796 | { | ||
| 797 | } | ||
| 798 | |||
| 799 | div.section div.section .titlepage .title, | ||
| 800 | div.sect2 .titlepage .title { | ||
| 801 | background: none; | ||
| 802 | } | ||
| 803 | |||
| 804 | |||
| 805 | h1.title { | ||
| 806 | background-color: transparent; | ||
| 807 | background-repeat: no-repeat; | ||
| 808 | height: 256px; | ||
| 809 | text-indent: -9000px; | ||
| 810 | overflow:hidden; | ||
| 811 | } | ||
| 812 | |||
| 813 | h2.subtitle { | ||
| 814 | background-color: transparent; | ||
| 815 | text-indent: -9000px; | ||
| 816 | overflow:hidden; | ||
| 817 | width: 0px; | ||
| 818 | display: none; | ||
| 819 | } | ||
| 820 | |||
| 821 | /*************************************** / | ||
| 822 | / pippin.gimp.org specific alterations / | ||
| 823 | / ***************************************/ | ||
| 824 | |||
| 825 | /* | ||
| 826 | div.heading, div.navheader { | ||
| 827 | color: #777; | ||
| 828 | font-size: 80%; | ||
| 829 | padding: 0; | ||
| 830 | margin: 0; | ||
| 831 | text-align: left; | ||
| 832 | position: absolute; | ||
| 833 | top: 0px; | ||
| 834 | left: 0px; | ||
| 835 | width: 100%; | ||
| 836 | height: 50px; | ||
| 837 | background: url('/gfx/heading_bg.png') transparent; | ||
| 838 | background-repeat: repeat-x; | ||
| 839 | background-attachment: fixed; | ||
| 840 | border: none; | ||
| 841 | } | ||
| 842 | |||
| 843 | div.heading a { | ||
| 844 | color: #444; | ||
| 845 | } | ||
| 846 | |||
| 847 | div.footing, div.navfooter { | ||
| 848 | border: none; | ||
| 849 | color: #ddd; | ||
| 850 | font-size: 80%; | ||
| 851 | text-align:right; | ||
| 852 | |||
| 853 | width: 100%; | ||
| 854 | padding-top: 10px; | ||
| 855 | position: absolute; | ||
| 856 | bottom: 0px; | ||
| 857 | left: 0px; | ||
| 858 | |||
| 859 | background: url('/gfx/footing_bg.png') transparent; | ||
| 860 | } | ||
| 861 | */ | ||
| 862 | |||
| 863 | |||
| 864 | |||
| 865 | /****************** / | ||
| 866 | / nasty ie tweaks / | ||
| 867 | / ******************/ | ||
| 868 | |||
| 869 | /* | ||
| 870 | div.heading, div.navheader { | ||
| 871 | width:expression(document.body.clientWidth + "px"); | ||
| 872 | } | ||
| 873 | |||
| 874 | div.footing, div.navfooter { | ||
| 875 | width:expression(document.body.clientWidth + "px"); | ||
| 876 | margin-left:expression("-5em"); | ||
| 877 | } | ||
| 878 | body { | ||
| 879 | padding:expression("4em 5em 0em 5em"); | ||
| 880 | } | ||
| 881 | */ | ||
| 882 | |||
| 883 | /**************************************** / | ||
| 884 | / mozilla vendor specific css extensions / | ||
| 885 | / ****************************************/ | ||
| 886 | /* | ||
| 887 | div.navfooter, div.footing{ | ||
| 888 | -moz-opacity: 0.8em; | ||
| 889 | } | ||
| 890 | |||
| 891 | div.figure, | ||
| 892 | div.table, | ||
| 893 | div.informalfigure, | ||
| 894 | div.informaltable, | ||
| 895 | div.informalexample, | ||
| 896 | div.example, | ||
| 897 | .tip, | ||
| 898 | .warning, | ||
| 899 | .caution, | ||
| 900 | .note { | ||
| 901 | -moz-border-radius: 0.5em; | ||
| 902 | } | ||
| 903 | |||
| 904 | b.keycap, | ||
| 905 | .keycap { | ||
| 906 | -moz-border-radius: 0.3em; | ||
| 907 | } | ||
| 908 | */ | ||
| 909 | |||
| 910 | table tr td table tr td { | ||
| 911 | display: none; | ||
| 912 | } | ||
| 913 | |||
| 914 | |||
| 915 | hr { | ||
| 916 | display: none; | ||
| 917 | } | ||
| 918 | |||
| 919 | table { | ||
| 920 | border: 0em; | ||
| 921 | } | ||
| 922 | |||
| 923 | .photo { | ||
| 924 | float: right; | ||
| 925 | margin-left: 1.5em; | ||
| 926 | margin-bottom: 1.5em; | ||
| 927 | margin-top: 0em; | ||
| 928 | max-width: 17em; | ||
| 929 | border: 1px solid gray; | ||
| 930 | padding: 3px; | ||
| 931 | background: white; | ||
| 932 | } | ||
| 933 | .seperator { | ||
| 934 | padding-top: 2em; | ||
| 935 | clear: both; | ||
| 936 | } | ||
| 937 | |||
| 938 | #validators { | ||
| 939 | margin-top: 5em; | ||
| 940 | text-align: right; | ||
| 941 | color: #777; | ||
| 942 | } | ||
| 943 | @media print { | ||
| 944 | body { | ||
| 945 | font-size: 8pt; | ||
| 946 | } | ||
| 947 | .noprint { | ||
| 948 | display: none; | ||
| 949 | } | ||
| 950 | } | ||
| 951 | |||
| 952 | |||
| 953 | .tip, | ||
| 954 | .note { | ||
| 955 | background: #f0f0f2; | ||
| 956 | color: #333; | ||
| 957 | padding: 20px; | ||
| 958 | margin: 20px; | ||
| 959 | } | ||
| 960 | |||
| 961 | .tip h3, | ||
| 962 | .note h3 { | ||
| 963 | padding: 0em; | ||
| 964 | margin: 0em; | ||
| 965 | font-size: 2em; | ||
| 966 | font-weight: bold; | ||
| 967 | color: #333; | ||
| 968 | } | ||
| 969 | |||
| 970 | .tip a, | ||
| 971 | .note a { | ||
| 972 | color: #333; | ||
| 973 | text-decoration: underline; | ||
| 974 | } | ||
| 975 | |||
| 976 | .footnote { | ||
| 977 | font-size: small; | ||
| 978 | color: #333; | ||
| 979 | } | ||
| 980 | |||
| 981 | /* Changes the announcement text */ | ||
| 982 | .tip h3, | ||
| 983 | .warning h3, | ||
| 984 | .caution h3, | ||
| 985 | .note h3 { | ||
| 986 | font-size:large; | ||
| 987 | color: #00557D; | ||
| 988 | } | ||
diff --git a/documentation/poky.ent b/documentation/poky.ent index bbef07bb5e..1be7be8e85 100644 --- a/documentation/poky.ent +++ b/documentation/poky.ent | |||
| @@ -59,6 +59,7 @@ | |||
| 59 | <!ENTITY YOCTO_DOCS_BB_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/bitbake-user-manual/bitbake-user-manual.html"> | 59 | <!ENTITY YOCTO_DOCS_BB_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/bitbake-user-manual/bitbake-user-manual.html"> |
| 60 | <!ENTITY YOCTO_DOCS_TOAST_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/toaster-manual/toaster-manual.html"> | 60 | <!ENTITY YOCTO_DOCS_TOAST_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/toaster-manual/toaster-manual.html"> |
| 61 | <!ENTITY YOCTO_DOCS_SDK_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/sdk-manual/sdk-manual.html"> | 61 | <!ENTITY YOCTO_DOCS_SDK_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/sdk-manual/sdk-manual.html"> |
| 62 | <!ENTITY YOCTO_DOCS_OVERVIEW_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/overview-manual/overview-manual.html"> | ||
| 62 | <!ENTITY YOCTO_ADTPATH_DIR "/opt/poky/&DISTRO;"> | 63 | <!ENTITY YOCTO_ADTPATH_DIR "/opt/poky/&DISTRO;"> |
| 63 | <!ENTITY YOCTO_POKY_TARBALL "&YOCTO_POKY;.tar.bz2"> | 64 | <!ENTITY YOCTO_POKY_TARBALL "&YOCTO_POKY;.tar.bz2"> |
| 64 | <!ENTITY OE_INIT_PATH "&YOCTO_POKY;/oe-init-build-env"> | 65 | <!ENTITY OE_INIT_PATH "&YOCTO_POKY;/oe-init-build-env"> |
diff --git a/documentation/tools/mega-manual.sed b/documentation/tools/mega-manual.sed index 4d4f34ba35..8ea92e6598 100644 --- a/documentation/tools/mega-manual.sed +++ b/documentation/tools/mega-manual.sed | |||
| @@ -16,6 +16,7 @@ s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/poky-ref-manual\/po | |||
| 16 | s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/sdk-manual\/sdk-manual.html#/\"link\" href=\"#/g | 16 | s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/sdk-manual\/sdk-manual.html#/\"link\" href=\"#/g |
| 17 | s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/bsp-guide\/bsp-guide.html#/\"link\" href=\"#/g | 17 | s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/bsp-guide\/bsp-guide.html#/\"link\" href=\"#/g |
| 18 | s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/dev-manual\/dev-manual.html#/\"link\" href=\"#/g | 18 | s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/dev-manual\/dev-manual.html#/\"link\" href=\"#/g |
| 19 | s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/overview-manual\/overview-manual.html#/\"link\" href=\"#/g | ||
| 19 | s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/kernel-dev\/kernel-dev.html#/\"link\" href=\"#/g | 20 | s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/kernel-dev\/kernel-dev.html#/\"link\" href=\"#/g |
| 20 | s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/profile-manual\/profile-manual.html#/\"link\" href=\"#/g | 21 | s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/profile-manual\/profile-manual.html#/\"link\" href=\"#/g |
| 21 | s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/ref-manual\/ref-manual.html#/\"link\" href=\"#/g | 22 | s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/ref-manual\/ref-manual.html#/\"link\" href=\"#/g |
| @@ -25,6 +26,7 @@ s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/yocto-project-qs\/y | |||
| 25 | # Process cases where just an external manual is referenced without an id anchor | 26 | # Process cases where just an external manual is referenced without an id anchor |
| 26 | s/<a class=\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/yocto-project-qs\/yocto-project-qs.html\" target=\"_top\">Yocto Project Quick Start<\/a>/Yocto Project Quick Start/g | 27 | s/<a class=\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/yocto-project-qs\/yocto-project-qs.html\" target=\"_top\">Yocto Project Quick Start<\/a>/Yocto Project Quick Start/g |
| 27 | s/<a class=\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/dev-manual\/dev-manual.html\" target=\"_top\">Yocto Project Development Tasks Manual<\/a>/Yocto Project Development Tasks Manual/g | 28 | s/<a class=\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/dev-manual\/dev-manual.html\" target=\"_top\">Yocto Project Development Tasks Manual<\/a>/Yocto Project Development Tasks Manual/g |
| 29 | s/<a class=\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/overview-manual\/overview-manual.html\" target=\"_top\">Yocto Project Overview Manual<\/a>/Yocto Project Overview Manual/g | ||
| 28 | s/<a class=\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/sdk-manual\/sdk-manual.html\" target=\"_top\">Yocto Project Software Development Kit (SDK) Developer's Guide<\/a>/Yocto Project Software Development Kit (SDK) Developer's Guide/g | 30 | s/<a class=\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/sdk-manual\/sdk-manual.html\" target=\"_top\">Yocto Project Software Development Kit (SDK) Developer's Guide<\/a>/Yocto Project Software Development Kit (SDK) Developer's Guide/g |
| 29 | s/<a class=\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/bsp-guide\/bsp-guide.html\" target=\"_top\">Yocto Project Board Support Package (BSP) Developer's Guide<\/a>/Yocto Project Board Support Package (BSP) Developer's Guide/g | 31 | s/<a class=\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/bsp-guide\/bsp-guide.html\" target=\"_top\">Yocto Project Board Support Package (BSP) Developer's Guide<\/a>/Yocto Project Board Support Package (BSP) Developer's Guide/g |
| 30 | s/<a class=\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/profile-manual\/profile-manual.html\" target=\"_top\">Yocto Project Profiling and Tracing Manual<\/a>/Yocto Project Profiling and Tracing Manual/g | 32 | s/<a class=\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/2.5\/profile-manual\/profile-manual.html\" target=\"_top\">Yocto Project Profiling and Tracing Manual<\/a>/Yocto Project Profiling and Tracing Manual/g |
