Add eclipse help generation to build system

PATCH Superseded [email protected] 1 participant 36 messages Oct 10, 2012

lore

Share & tools

lore

[email protected]

author

2012-10-10 09:54 UTC #0 lore raw

cover Add eclipse help generation to build system

From: Timo Mueller <[email protected]>

Hi,

this is a rework of the patches I've been submitting to include the generation of eclipse help files into the documentation build system.

From original rfc ([yocto-docs] Add eclipse help generation to build system):
<snip>
I've added the target 'eclipse' to the documentation's build system to automate the process of eclipse help generation. This can help to facilitate the process of keeping the integrated documentation in sync with the yocto documentation.
<snip>

This patch set incorporates all changes I've been making so far:

1: Remove the use if title in pdf documents 2..6: Add eclipse generation to adt-manual 7..11: Add eclipse generation to dev-manual 12..16: Add eclipse generation to bsp-guide 17..21: Add eclipse generation to kernel-manual 22..26: Add eclipse generation to poky-ref-manual 27..32: Add eclipse generation to yocto-project-qs 33..34: Handle links between documents
35: Makefile documentation update

Best regards,
Timo

Timo Mueller (35):
documentation/template/titlepage.templates.xml: Remove title info
documentation: Move adt-manual global parameters to customization
file
documentation/adt-manual/adt-manual-eclipse-customization.xsl: new
file
documentation/Makefile: Support for making Eclipse HTML adt manual documentation/adt-manual/adt-manual.xml: Added Title tag documentation/Makefile: logic to make all for adt manual and cleanup
documentation: Move dev-manual global parameters to customization
file
documentation/dev-manual/dev-manual-eclipse-customization.xsl: new
file
documentation/Makefile: Support for making Eclipse HTML dev manual documentation/dev-manual/dev-manual.xml: Added Title tag documentation/Makefile: logic to make all for dev manual and cleanup
documentation: Move bsp-guide global parameters to customization file documentation/bsp-guide/bsp-guide-eclipse-customization.xsl: new file documentation/Makefile: Support for making Eclipse HTML bsp guide documentation/bsp-guide/bsp-guide.xml: Added Title tag documentation/Makefile: logic to make all for bsp guide and cleanup
documentation: Move kernel-manual global parameters to customization
file
documentation/kernel-manual/kernel-manual-eclipse-customization.xsl:
new file
documentation/Makefile: Support for making Eclipse HTML kernel manual documentation/kernel-manual/kernel-manual.xml: Added Title tag documentation/Makefile: logic to make all for kernel-manual and
cleanup
documentation: Move poky-ref-manual global parameters to
customization file
documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl:
new file
documentation/Makefile: Support for making Eclipse HTML poky ref
manual
documentation/poky-ref-manual/poky-ref-manual.xml: Added Title tag documentation/Makefile: logic to make all for poky-ref-manual and
cleanup
documentation: Move yocto-project-qs global parameters to
customization file
documentation/yocto-project-qs: Added custom title page documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl:
new file
documentation/Makefile: Support for making Eclipse HTML yocto project
qs manual
documentation/yocto-project-qs/yocto-project-qs.xml: Convert
fake-title section into articleinfo
documentation/Makefile: logic to make all for yocto-project-qs and
cleanup
documentation/tools/eclipse-help.sed: Processes external links for
eclipse html files
documentation/Makefile: Added conversion of links to other
documentation parts.
documentation/Makefile: Clean up eclipse target and update help.

 documentation/Makefile                             |  119 +-
 .../adt-manual/adt-manual-customization.xsl        |    7 +-
 .../adt-manual-eclipse-customization.xsl           |   26 +
 documentation/adt-manual/adt-manual.xml            |    4 +-
 .../bsp-guide/bsp-guide-customization.xsl          |    4 +
 .../bsp-guide/bsp-guide-eclipse-customization.xsl  |   26 +
 documentation/bsp-guide/bsp-guide.xml              |    4 +-
 .../dev-manual/dev-manual-customization.xsl        |    6 +-
 .../dev-manual-eclipse-customization.xsl           |   26 +
 documentation/dev-manual/dev-manual.xml            |    4 +-
 .../kernel-manual/kernel-manual-customization.xsl  |    7 +-
 .../kernel-manual-eclipse-customization.xsl        |   26 +
 documentation/kernel-manual/kernel-manual.xml      |    4 +-
 .../poky-ref-manual-customization.xsl              |    5 +
 .../poky-ref-manual-eclipse-customization.xsl      |   26 +
 documentation/poky-ref-manual/poky-ref-manual.xml  |    4 +-
 documentation/template/titlepage.templates.xml     |   13 -
 documentation/tools/eclipse-help.sed               |   18 +
 .../yocto-project-qs-customization.xsl             |    3 +-
 .../yocto-project-qs-eclipse-customization.xsl     |   24 +
 .../yocto-project-qs-titlepage.xsl                 | 3820 ++++++++++++++++++++
 .../yocto-project-qs/yocto-project-qs.xml          |   20 +-
 22 files changed, 4116 insertions(+), 80 deletions(-)
 create mode 100644 documentation/adt-manual/adt-manual-eclipse-customization.xsl
 create mode 100644 documentation/bsp-guide/bsp-guide-eclipse-customization.xsl
 create mode 100644 documentation/dev-manual/dev-manual-eclipse-customization.xsl
 create mode 100644 documentation/kernel-manual/kernel-manual-eclipse-customization.xsl
 create mode 100644 documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl
 create mode 100644 documentation/tools/eclipse-help.sed
 create mode 100644 documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl
 create mode 100644 documentation/yocto-project-qs/yocto-project-qs-titlepage.xsl

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #1 lore raw

PATCH 1/35 documentation/template/titlepage.templates.xml: Remove title info

From: Timo Mueller <[email protected]>

The title of a pdf document is part of the image used on the title page. Thus the title defined (e.g. bookinfo.title) in a document should never be used when creating title pages for pdf documents. As other output formats may use the title information to create metadata the title has been removed from the template.

---
 documentation/template/titlepage.templates.xml |   13 -------------
 1 files changed, 0 insertions(+), 13 deletions(-)

documentation/template/titlepage.templates.xml +0 ~~-13~~

index ff640fa..f53f147 100644
@@ -140,14 +140,6 @@
 
       <mediaobject/>	     
 
-      <title
-	     t:named-template="division.title"
-	     param:node="ancestor-or-self::book[1]"
-	     text-align="center"
-	     font-size="&hsize5;"
-	     space-before="&hsize5space;"
-	     font-weight="bold"
-	     font-family="{$title.fontset}"/>
       <subtitle
 		text-align="center"
 		font-size="&hsize4;"

@@ -163,11 +155,6 @@
     </t:titlepage-content>
 
   <t:titlepage-content t:side="verso">
-      <title
-	     t:named-template="book.verso.title"
-	     font-size="&hsize2;"
-	     font-weight="bold"
-	     font-family="{$title.fontset}"/>
       <corpauthor/>
       <authorgroup t:named-template="verso.authorgroup"/>
       <author/>

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #2 lore raw

PATCH 2/35 documentation: Move adt-manual global parameters to customization file

From: Timo Mueller <[email protected]>

Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile.

Furthermore supporting new output formats can now be achieved by creating a new customization file containing its corresponding parameters. Parameters that are used across different stylesheets with different values will then be separated through different customization files.

Global parameters can still be set through the XSLTOPTS variable since this precedes the parameters in the customization file.

---
 documentation/Makefile                             |    7 +------
 .../adt-manual/adt-manual-customization.xsl        |    7 +++++--
 2 files changed, 6 insertions(+), 8 deletions(-)

documentation/Makefile +1 -6

index ee7089a..380193d 100644
@@ -213,12 +213,7 @@ endif
 
 
 ifeq ($(DOC),adt-manual)
-XSLTOPTS = --stringparam html.stylesheet adt-style.css \
-           --stringparam  chapter.autolabel 1 \
-           --stringparam  appendix.autolabel A \
-           --stringparam  section.autolabel 1 \
-           --stringparam  section.label.includes.component.label 1 \
-           --xinclude
+XSLTOPTS = --xinclude
 ALLPREQ = html pdf tarball
 TARFILES = adt-manual.html adt-manual.pdf adt-style.css figures/adt-title.png
 MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf

documentation/adt-manual/adt-manual-customization.xsl +5 -2

index 8eb6905..373bdb7 100644
@@ -3,6 +3,9 @@
   
   <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
 
-<!--  <xsl:param name="generate.toc" select="'article nop'"></xsl:param>  -->
-
+  <xsl:param name="html.stylesheet" select="'adt-style.css'" />
+  <xsl:param name="chapter.autolabel" select="1" />
+  <xsl:param name="appendix.autolabel" select="1" />
+  <xsl:param name="section.autolabel" select="1" />
+  <xsl:param name="section.label.includes.component.label" select="1" />
 </xsl:stylesheet>

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #3 lore raw

PATCH 3/35 documentation/adt-manual/adt-manual-eclipse-customization.xsl: new file

From: Timo Mueller <[email protected]>

This stylesheet uses the eclipse stylesheets of docbook to create eclipse help from this documentation. In addition to simple html files these stylesheets will also create xml files which are needed to integrate the documentation into eclipse (e.g. toc.xml).

Additional parameters are required so resolve links between different documentation parts inside eclipse.

---
 .../adt-manual-eclipse-customization.xsl           |   26 ++++++++++++++++++++
 1 files changed, 26 insertions(+), 0 deletions(-)
 create mode 100644 documentation/adt-manual/adt-manual-eclipse-customization.xsl

documentation/adt-manual/adt-manual-eclipse-customization.xsl new file +26 -0

new file mode 100644
index 0000000..ff1464e
@@ -0,0 +1,26 @@
+<?xml version='1.0'?>
+<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">
+
+  <xsl:import
+	  href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl" />
+
+  <xsl:param name="chunker.output.indent" select="'yes'"/>
+  <xsl:param name="chunk.first.sections" select="1"/>
+  <xsl:param name="chunk.section.depth" select="10"/>
+  <xsl:param name="use.id.as.filename" select="1"/>
+  <xsl:param name="ulink.target" select="'_self'" />
+  <xsl:param name="base.dir" select="'html/adt-manual/'"/>
+  <xsl:param name="html.stylesheet" select="'../book.css'"/>
+  <xsl:param name="eclipse.manifest" select="0"/>
+  <xsl:param name="create.plugin.xml" select="0"/>
+  <xsl:param name="suppress.navigation" select="1"/>
+  <xsl:param name="generate.index" select="0"/>
+  <xsl:param name="chapter.autolabel" select="1" />
+  <xsl:param name="appendix.autolabel" select="1" />
+  <xsl:param name="section.autolabel" select="1" />
+  <xsl:param name="section.label.includes.component.label" select="1" />
+</xsl:stylesheet>

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #4 lore raw

PATCH 4/35 documentation/Makefile: Support for making Eclipse HTML adt manual

From: Timo Mueller <[email protected]>

This target will generate eclipse help for the adt-manual using the adt-manual-eclipse-customization.xsl stylesheet.

The output will be generated to a separate directory which can be used for integrating the documentation into eclipse.

---
 documentation/Makefile |   23 +++++++++++++++++++++++
 1 files changed, 23 insertions(+), 0 deletions(-)

documentation/Makefile +23 -0

index 380193d..66eecaa 100644
@@ -284,6 +284,29 @@ else
 endif
 
 
+eclipse: BASE_DIR = html/$(DOC)/
+
+eclipse:
+ifneq ($(DOC),adt-manual)
+	@echo " "
+	@echo "ERROR: You can only create eclipse documentation of the"
+	@echo "       Yocto Project Application Development Toolkit (ADT)"
+	@echo "       User's Guide"
+	@echo " "
+else
+	@echo " "
+	@echo "******** Building eclipse help of "$(DOC)
+	@echo " "
+	cd $(DOC) && \
+		xsltproc $(XSLTOPTS) \
+				--stringparam base.dir '$(BASE_DIR)' \
+				-o eclipse/$(DOC).html \
+				$(DOC)-eclipse-customization.xsl $(DOC).xml && \
+		mv eclipse/toc.xml eclipse/$(DOC)-toc.xml && \
+		cp -rf $(FIGURES) eclipse/$(BASE_DIR)/$(FIGURES) && \
+		cd ..
+endif
+
 tarball: html
 	@echo " "
 	@echo "******** Creating Tarball of document files"

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #5 lore raw

PATCH 5/35 documentation/adt-manual/adt-manual.xml: Added Title tag

From: Timo Mueller <[email protected]>

The title of the document used to create metadata for output formats such as eclipse help.

---
 documentation/adt-manual/adt-manual.xml |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

documentation/adt-manual/adt-manual.xml +3 -1

index e34dc1c..930bbde 100644
@@ -16,7 +16,9 @@
             </imageobject>    
         </mediaobject>
 
-        <title></title>
+        <title>
+            The Yocto Project Application Developer's Guide
+        </title>
 
         <authorgroup>
             <author>

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #6 lore raw

PATCH 6/35 documentation/Makefile: logic to make all for adt manual and cleanup

From: Timo Mueller <[email protected]>

Eclipse help documents are now created when calling the 'make all' target on the adt-manual. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted.

---
 documentation/Makefile |    9 +++++----
 1 files changed, 5 insertions(+), 4 deletions(-)

documentation/Makefile +5 -4

index 66eecaa..bb8ca37 100644
@@ -214,9 +214,10 @@ endif
 
 ifeq ($(DOC),adt-manual)
 XSLTOPTS = --xinclude
-ALLPREQ = html pdf tarball
-TARFILES = adt-manual.html adt-manual.pdf adt-style.css figures/adt-title.png
-MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
+ALLPREQ = html pdf eclipse tarball
+TARFILES = adt-manual.html adt-manual.pdf adt-style.css figures/adt-title.png \
+			eclipse
+MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
 FIGURES = figures
 STYLESHEET = $(DOC)/*.css
 endif

@@ -332,4 +333,4 @@ publish:
 	fi
 
 clean:
-	rm -f $(MANUALS)
+	rm -rf $(MANUALS)

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #7 lore raw

PATCH 7/35 documentation: Move dev-manual global parameters to customization file

From: Timo Mueller <[email protected]>

Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile.

---
 documentation/Makefile                             |    6 +-----
 .../dev-manual/dev-manual-customization.xsl        |    6 ++++--
 2 files changed, 5 insertions(+), 7 deletions(-)

documentation/Makefile +1 -5

index bb8ca37..dd5dd50 100644
@@ -84,11 +84,7 @@ STYLESHEET = $(DOC)/*.css
 endif
 
 ifeq ($(DOC),dev-manual)
-XSLTOPTS = --stringparam html.stylesheet dev-style.css \
-           --stringparam  chapter.autolabel 1 \
-           --stringparam  section.autolabel 1 \
-           --stringparam  section.label.includes.component.label 1 \
-           --xinclude
+XSLTOPTS = --xinclude
 ALLPREQ = html pdf tarball
 #
 # Note that the tarfile might produce the "Cannot stat: No such file or directory" error

documentation/dev-manual/dev-manual-customization.xsl +4 -2

index 8eb6905..8969605 100644
@@ -3,6 +3,8 @@
   
   <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
 
-<!--  <xsl:param name="generate.toc" select="'article nop'"></xsl:param>  -->
-
+  <xsl:param name="html.stylesheet" select="'dev-style.css'" />
+  <xsl:param name="chapter.autolabel" select="1" />
+  <xsl:param name="section.autolabel" select="1" />
+  <xsl:param name="section.label.includes.component.label" select="1" />
 </xsl:stylesheet>

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #8 lore raw

PATCH 8/35 documentation/dev-manual/dev-manual-eclipse-customization.xsl: new file

From: Timo Mueller <[email protected]>

---
 .../dev-manual-eclipse-customization.xsl           |   26 ++++++++++++++++++++
 1 files changed, 26 insertions(+), 0 deletions(-)
 create mode 100644 documentation/dev-manual/dev-manual-eclipse-customization.xsl

documentation/dev-manual/dev-manual-eclipse-customization.xsl new file +26 -0

new file mode 100644
index 0000000..ff1de89
@@ -0,0 +1,26 @@
+<?xml version='1.0'?>
+<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">
+
+  <xsl:import
+	  href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl" />
+
+  <xsl:param name="chunker.output.indent" select="'yes'"/>
+  <xsl:param name="chunk.first.sections" select="1"/>
+  <xsl:param name="chunk.section.depth" select="10"/>
+  <xsl:param name="use.id.as.filename" select="1"/>
+  <xsl:param name="ulink.target" select="'_self'" />
+  <xsl:param name="base.dir" select="'html/dev-manual/'"/>
+  <xsl:param name="html.stylesheet" select="'../book.css'"/>
+  <xsl:param name="eclipse.manifest" select="0"/>
+  <xsl:param name="create.plugin.xml" select="0"/>
+  <xsl:param name="suppress.navigation" select="1"/>
+  <xsl:param name="generate.index" select="0"/>
+  <xsl:param name="chapter.autolabel" select="1" />
+  <xsl:param name="appendix.autolabel" select="1" />
+  <xsl:param name="section.autolabel" select="1" />
+  <xsl:param name="section.label.includes.component.label" select="1" />
+</xsl:stylesheet>

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #9 lore raw

PATCH 9/35 documentation/Makefile: Support for making Eclipse HTML dev manual

From: Timo Mueller <[email protected]>

This target will generate eclipse help for the dev-manual using the dev-manual-eclipse-customization.xsl stylesheet.

The output will be generated to a separate directory which can be used for integrating the documentation into eclipse.

---
 documentation/Makefile |   10 ++++++----
 1 files changed, 6 insertions(+), 4 deletions(-)

documentation/Makefile +6 -4

index dd5dd50..8d70deb 100644
@@ -284,11 +284,13 @@ endif
 eclipse: BASE_DIR = html/$(DOC)/
 
 eclipse:
-ifneq ($(DOC),adt-manual)
+ifeq ($(filter $(DOC), adt-manual dev-manual),)
 	@echo " "
-	@echo "ERROR: You can only create eclipse documentation of the"
-	@echo "       Yocto Project Application Development Toolkit (ADT)"
-	@echo "       User's Guide"
+	@echo "ERROR: You can only create eclipse documentation"
+	@echo "       of the following documentation parts:"
+	@echo " "
+	@echo "       - The Yocto Project Application Developer's Guide (adt-manual)"
+	@echo "       - The Yocto Project Development Manual (dev-manual)"
 	@echo " "
 else
 	@echo " "

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #10 lore raw

PATCH 10/35 documentation/dev-manual/dev-manual.xml: Added Title tag

From: Timo Mueller <[email protected]>

The title of the document used to create metadata for output formats such as eclipse help.

---
 documentation/dev-manual/dev-manual.xml |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

documentation/dev-manual/dev-manual.xml +3 -1

index a5856e0..7c8f58d 100644
@@ -16,7 +16,9 @@
             </imageobject> 
         </mediaobject>
 
-        <title></title> 
+        <title>
+            The Yocto Project Development Manual
+        </title>
 
         <authorgroup>
             <author>

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #11 lore raw

PATCH 11/35 documentation/Makefile: logic to make all for dev manual and cleanup

From: Timo Mueller <[email protected]>

Eclipse help documents are now created when calling the 'make all' target on the dev-manual. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted.

---
 documentation/Makefile |    7 ++++---
 1 files changed, 4 insertions(+), 3 deletions(-)

documentation/Makefile +4 -3

index 8d70deb..3a3a2c3 100644
@@ -85,7 +85,7 @@ endif
 
 ifeq ($(DOC),dev-manual)
 XSLTOPTS = --xinclude
-ALLPREQ = html pdf tarball
+ALLPREQ = html pdf eclipse tarball
 #
 # Note that the tarfile might produce the "Cannot stat: No such file or directory" error
 # message for .PNG files that are not present when building a particular branch.  The

@@ -119,10 +119,11 @@ TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
            figures/kernel-overview-1.png figures/kernel-overview-2.png \
            figures/kernel-overview-3-denzil.png \
            figures/source-repos.png figures/yp-download.png \
-           figures/wip.png
+           figures/wip.png \
+           eclipse
 	endif
 
-MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
+MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
 FIGURES = figures
 STYLESHEET = $(DOC)/*.css

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #12 lore raw

PATCH 12/35 documentation: Move bsp-guide global parameters to customization file

From: Timo Mueller <[email protected]>

Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile.

---
 documentation/Makefile                             |    6 +-----
 .../bsp-guide/bsp-guide-customization.xsl          |    4 ++++
 2 files changed, 5 insertions(+), 5 deletions(-)

documentation/Makefile +1 -5

index 3a3a2c3..86fb598 100644
@@ -70,11 +70,7 @@
 #
 
 ifeq ($(DOC),bsp-guide)
-XSLTOPTS = --stringparam html.stylesheet bsp-style.css \
-           --stringparam  chapter.autolabel 1 \
-           --stringparam  section.autolabel 1 \
-           --stringparam  section.label.includes.component.label 1 \
-           --xinclude
+XSLTOPTS = --xinclude
 ALLPREQ = html pdf tarball
 TARFILES = bsp-style.css bsp-guide.html bsp-guide.pdf figures/bsp-title.png
 MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf

documentation/bsp-guide/bsp-guide-customization.xsl +4 -0

index 362ebed..5560289 100644
@@ -3,4 +3,8 @@
   
   <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
 
+  <xsl:param name="html.stylesheet" select="'bsp-style.css'" />
+  <xsl:param name="chapter.autolabel" select="1" />
+  <xsl:param name="section.autolabel" select="1" />
+  <xsl:param name="section.label.includes.component.label" select="1" />
 </xsl:stylesheet>

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #13 lore raw

PATCH 13/35 documentation/bsp-guide/bsp-guide-eclipse-customization.xsl: new file

From: Timo Mueller <[email protected]>

---
 .../bsp-guide/bsp-guide-eclipse-customization.xsl  |   26 ++++++++++++++++++++
 1 files changed, 26 insertions(+), 0 deletions(-)
 create mode 100644 documentation/bsp-guide/bsp-guide-eclipse-customization.xsl

documentation/bsp-guide/bsp-guide-eclipse-customization.xsl new file +26 -0

new file mode 100644
index 0000000..b9aceb2
@@ -0,0 +1,26 @@
+<?xml version='1.0'?>
+<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">
+
+  <xsl:import
+	  href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl" />
+
+  <xsl:param name="chunker.output.indent" select="'yes'"/>
+  <xsl:param name="chunk.first.sections" select="1"/>
+  <xsl:param name="chunk.section.depth" select="10"/>
+  <xsl:param name="use.id.as.filename" select="1"/>
+  <xsl:param name="ulink.target" select="'_self'" />
+  <xsl:param name="base.dir" select="'html/bsp-guide/'"/>
+  <xsl:param name="html.stylesheet" select="'../book.css'"/>
+  <xsl:param name="eclipse.manifest" select="0"/>
+  <xsl:param name="create.plugin.xml" select="0"/>
+  <xsl:param name="suppress.navigation" select="1"/>
+  <xsl:param name="generate.index" select="0"/>
+  <xsl:param name="chapter.autolabel" select="1" />
+  <xsl:param name="appendix.autolabel" select="1" />
+  <xsl:param name="section.autolabel" select="1" />
+  <xsl:param name="section.label.includes.component.label" select="1" />
+</xsl:stylesheet>

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #14 lore raw

PATCH 14/35 documentation/Makefile: Support for making Eclipse HTML bsp guide

From: Timo Mueller <[email protected]>

This target will generate eclipse help for the bsp-guide using the bsp-guide-eclipse-customization.xsl stylesheet.

The output will be generated to a separate directory which can be used for integrating the documentation into eclipse.

---
 documentation/Makefile |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

documentation/Makefile +3 -1

index 86fb598..7420dec 100644
@@ -281,12 +281,14 @@ endif
 eclipse: BASE_DIR = html/$(DOC)/
 
 eclipse:
-ifeq ($(filter $(DOC), adt-manual dev-manual),)
+ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual),)
 	@echo " "
 	@echo "ERROR: You can only create eclipse documentation"
 	@echo "       of the following documentation parts:"
 	@echo " "
 	@echo "       - The Yocto Project Application Developer's Guide (adt-manual)"
+	@echo "       - The Yocto Project Board Support Package"
+	@echo "                           Developer's Guide (bsp-guide)"
 	@echo "       - The Yocto Project Development Manual (dev-manual)"
 	@echo " "
 else

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #15 lore raw

PATCH 15/35 documentation/bsp-guide/bsp-guide.xml: Added Title tag

From: Timo Mueller <[email protected]>

The title of the document used to create metadata for output formats such as eclipse help.

---
 documentation/bsp-guide/bsp-guide.xml |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

documentation/bsp-guide/bsp-guide.xml +3 -1

index 3b7ab6a..8ea48d6 100644
@@ -16,7 +16,9 @@
             </imageobject>    
         </mediaobject>
 
-        <title></title> 
+        <title>
+            The Yocto Project Board Support Package Developer's Guide
+        </title>
 
         <authorgroup>
             <author>

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #16 lore raw

PATCH 16/35 documentation/Makefile: logic to make all for bsp guide and cleanup

From: Timo Mueller <[email protected]>

Eclipse help documents are now created when calling the 'make all' target on the bsp-guide. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted.

---
 documentation/Makefile |    7 ++++---
 1 files changed, 4 insertions(+), 3 deletions(-)

documentation/Makefile +4 -3

index 7420dec..9774932 100644
@@ -71,9 +71,10 @@
 
 ifeq ($(DOC),bsp-guide)
 XSLTOPTS = --xinclude
-ALLPREQ = html pdf tarball
-TARFILES = bsp-style.css bsp-guide.html bsp-guide.pdf figures/bsp-title.png
-MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
+ALLPREQ = html pdf eclipse tarball
+TARFILES = bsp-style.css bsp-guide.html bsp-guide.pdf figures/bsp-title.png \
+           eclipse
+MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
 FIGURES = figures
 STYLESHEET = $(DOC)/*.css

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #17 lore raw

PATCH 17/35 documentation: Move kernel-manual global parameters to customization file

From: Timo Mueller <[email protected]>

Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile.

---
 documentation/Makefile                             |    7 +------
 .../kernel-manual/kernel-manual-customization.xsl  |    7 +++++--
 2 files changed, 6 insertions(+), 8 deletions(-)

documentation/Makefile +1 -6

index 9774932..d86868a 100644
@@ -217,12 +217,7 @@ STYLESHEET = $(DOC)/*.css
 endif
 
 ifeq ($(DOC),kernel-manual)
-XSLTOPTS = --stringparam html.stylesheet kernel-style.css \
-           --stringparam  chapter.autolabel 1 \
-           --stringparam  appendix.autolabel A \
-           --stringparam  section.autolabel 1 \
-           --stringparam  section.label.includes.component.label 1 \
-           --xinclude
+XSLTOPTS = --xinclude
 ALLPREQ = html pdf tarball
 TARFILES = kernel-manual.html kernel-manual.pdf kernel-style.css figures/kernel-title.png figures/kernel-architecture-overview.png
 MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf

documentation/kernel-manual/kernel-manual-customization.xsl +5 -2

index 8eb6905..6f46df2 100644
@@ -3,6 +3,9 @@
   
   <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
 
-<!--  <xsl:param name="generate.toc" select="'article nop'"></xsl:param>  -->
-
+  <xsl:param name="html.stylesheet" select="'kernel-style.css'" />
+  <xsl:param name="chapter.autolabel" select="1" />
+  <xsl:param name="appendix.autolabel" select="A" />
+  <xsl:param name="section.autolabel" select="1" />
+  <xsl:param name="section.label.includes.component.label" select="1" />
 </xsl:stylesheet>

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #18 lore raw

PATCH 18/35 documentation/kernel-manual/kernel-manual-eclipse-customization.xsl: new file

From: Timo Mueller <[email protected]>

---
 .../kernel-manual-eclipse-customization.xsl        |   26 ++++++++++++++++++++
 1 files changed, 26 insertions(+), 0 deletions(-)
 create mode 100644 documentation/kernel-manual/kernel-manual-eclipse-customization.xsl

documentation/kernel-manual/kernel-manual-eclipse-customization.xsl new file +26 -0

new file mode 100644
index 0000000..70a1e19
@@ -0,0 +1,26 @@
+<?xml version='1.0'?>
+<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">
+
+  <xsl:import
+	  href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl" />
+
+  <xsl:param name="chunker.output.indent" select="'yes'"/>
+  <xsl:param name="chunk.first.sections" select="1"/>
+  <xsl:param name="chunk.section.depth" select="10"/>
+  <xsl:param name="use.id.as.filename" select="1"/>
+  <xsl:param name="ulink.target" select="'_self'" />
+  <xsl:param name="base.dir" select="'html/kernel-manual/'"/>
+  <xsl:param name="html.stylesheet" select="'../book.css'"/>
+  <xsl:param name="eclipse.manifest" select="0"/>
+  <xsl:param name="create.plugin.xml" select="0"/>
+  <xsl:param name="suppress.navigation" select="1"/>
+  <xsl:param name="generate.index" select="0"/>
+  <xsl:param name="chapter.autolabel" select="1" />
+  <xsl:param name="appendix.autolabel" select="A" />
+  <xsl:param name="section.autolabel" select="1" />
+  <xsl:param name="section.label.includes.component.label" select="1" />
+</xsl:stylesheet>

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #19 lore raw

PATCH 19/35 documentation/Makefile: Support for making Eclipse HTML kernel manual

From: Timo Mueller <[email protected]>

This target will generate eclipse help for the kernel-manual using the kernel-manual-eclipse-customization.xsl stylesheet.

The output will be generated to a separate directory which can be used for integrating the documentation into eclipse.

---
 documentation/Makefile |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

documentation/Makefile +3 -1

index d86868a..4cb7a00 100644
@@ -277,7 +277,7 @@ endif
 eclipse: BASE_DIR = html/$(DOC)/
 
 eclipse:
-ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual),)
+ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual kernel-manual),)
 	@echo " "
 	@echo "ERROR: You can only create eclipse documentation"
 	@echo "       of the following documentation parts:"

@@ -286,6 +286,8 @@ ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual),)
 	@echo "       - The Yocto Project Board Support Package"
 	@echo "                           Developer's Guide (bsp-guide)"
 	@echo "       - The Yocto Project Development Manual (dev-manual)"
+	@echo "       - The Yocto Project Kernel Architecture and"
+	@echo "                           Use Manual (kernel-manual)"
 	@echo " "
 else
 	@echo " "

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #20 lore raw

PATCH 20/35 documentation/kernel-manual/kernel-manual.xml: Added Title tag

From: Timo Mueller <[email protected]>

The title of the document used to create metadata for output formats such as eclipse help.

---
 documentation/kernel-manual/kernel-manual.xml |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

documentation/kernel-manual/kernel-manual.xml +3 -1

index 174663a..df52f4e 100644
@@ -16,7 +16,9 @@
             </imageobject>    
         </mediaobject>
 
-        <title></title> 
+        <title>
+            The Yocto Project Kernel Architecture and Use Manual
+        </title>
 
         <authorgroup>
             <author>

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #21 lore raw

PATCH 21/35 documentation/Makefile: logic to make all for kernel-manual and cleanup

From: Timo Mueller <[email protected]>

Eclipse help documents are now created when calling the 'make all' target on the kernel-manual. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted.

---
 documentation/Makefile |    8 +++++---
 1 files changed, 5 insertions(+), 3 deletions(-)

documentation/Makefile +5 -3

index 4cb7a00..79732f8 100644
@@ -218,9 +218,11 @@ endif
 
 ifeq ($(DOC),kernel-manual)
 XSLTOPTS = --xinclude
-ALLPREQ = html pdf tarball
-TARFILES = kernel-manual.html kernel-manual.pdf kernel-style.css figures/kernel-title.png figures/kernel-architecture-overview.png
-MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
+ALLPREQ = html pdf eclipse tarball
+TARFILES = kernel-manual.html kernel-manual.pdf kernel-style.css \
+           figures/kernel-title.png figures/kernel-architecture-overview.png \
+           eclipse
+MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
 FIGURES = figures
 STYLESHEET = $(DOC)/*.css
 endif

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #22 lore raw

PATCH 22/35 documentation: Move poky-ref-manual global parameters to customization file

From: Timo Mueller <[email protected]>

Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile.

---
 documentation/Makefile                             |    7 +------
 .../poky-ref-manual-customization.xsl              |    5 +++++
 2 files changed, 6 insertions(+), 6 deletions(-)

documentation/Makefile +1 -6

index 79732f8..e2bd4a9 100644
@@ -192,12 +192,7 @@ STYLESHEET = $(DOC)/*.css
 endif
 
 ifeq ($(DOC),poky-ref-manual)
-XSLTOPTS = --stringparam html.stylesheet ref-style.css \
-           --stringparam  chapter.autolabel 1 \
-           --stringparam  appendix.autolabel A \
-           --stringparam  section.autolabel 1 \
-           --stringparam  section.label.includes.component.label 1 \
-           --xinclude
+XSLTOPTS = --xinclude
 ALLPREQ = html pdf tarball
 TARFILES = poky-ref-manual.html ref-style.css figures/poky-title.png
 MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf

documentation/poky-ref-manual/poky-ref-manual-customization.xsl +5 -0

index 362ebed..3ad3a31 100644
@@ -3,4 +3,9 @@
   
   <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
 
+  <xsl:param name="html.stylesheet" select="'ref-style.css'" />
+  <xsl:param name="chapter.autolabel" select="1" />
+  <xsl:param name="appendix.autolabel" select="A" />
+  <xsl:param name="section.autolabel" select="1" />
+  <xsl:param name="section.label.includes.component.label" select="1" />
 </xsl:stylesheet>

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #23 lore raw

PATCH 23/35 documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl: new file

From: Timo Mueller <[email protected]>

---
 .../poky-ref-manual-eclipse-customization.xsl      |   26 ++++++++++++++++++++
 1 files changed, 26 insertions(+), 0 deletions(-)
 create mode 100644 documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl

documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl new file +26 -0

new file mode 100644
index 0000000..4e31193
@@ -0,0 +1,26 @@
+<?xml version='1.0'?>
+<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">
+
+  <xsl:import
+	  href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl" />
+
+  <xsl:param name="chunker.output.indent" select="'yes'"/>
+  <xsl:param name="chunk.first.sections" select="1"/>
+  <xsl:param name="chunk.section.depth" select="10"/>
+  <xsl:param name="use.id.as.filename" select="1"/>
+  <xsl:param name="ulink.target" select="'_self'" />
+  <xsl:param name="base.dir" select="'html/poky-ref-manual/'"/>
+  <xsl:param name="html.stylesheet" select="'../book.css'"/>
+  <xsl:param name="eclipse.manifest" select="0"/>
+  <xsl:param name="create.plugin.xml" select="0"/>
+  <xsl:param name="suppress.navigation" select="1"/>
+  <xsl:param name="generate.index" select="0"/>
+  <xsl:param name="chapter.autolabel" select="1" />
+  <xsl:param name="appendix.autolabel" select="A" />
+  <xsl:param name="section.autolabel" select="1" />
+  <xsl:param name="section.label.includes.component.label" select="1" />
+</xsl:stylesheet>

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #24 lore raw

PATCH 24/35 documentation/Makefile: Support for making Eclipse HTML poky ref manual

From: Timo Mueller <[email protected]>

This target will generate eclipse help for the poky-ref-manual using the poky-ref-manual-eclipse-customization.xsl stylesheet.

The output will be generated to a separate directory which can be used for integrating the documentation into eclipse.

---
 documentation/Makefile |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

documentation/Makefile +2 -1

index e2bd4a9..58e406e 100644
@@ -274,7 +274,7 @@ endif
 eclipse: BASE_DIR = html/$(DOC)/
 
 eclipse:
-ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual kernel-manual),)
+ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual kernel-manual poky-ref-manual),)
 	@echo " "
 	@echo "ERROR: You can only create eclipse documentation"
 	@echo "       of the following documentation parts:"

@@ -285,6 +285,7 @@ ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual kernel-manual),)
 	@echo "       - The Yocto Project Development Manual (dev-manual)"
 	@echo "       - The Yocto Project Kernel Architecture and"
 	@echo "                           Use Manual (kernel-manual)"
+	@echo "		  - The Yocto Project Reference Manual (poky-ref-manual)"
 	@echo " "
 else
 	@echo " "

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #25 lore raw

PATCH 25/35 documentation/poky-ref-manual/poky-ref-manual.xml: Added Title tag

From: Timo Mueller <[email protected]>

The title of the document used to create metadata for output formats such as eclipse help.

---
 documentation/poky-ref-manual/poky-ref-manual.xml |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

documentation/poky-ref-manual/poky-ref-manual.xml +3 -1

index e405375..9f647ab 100644
@@ -16,7 +16,9 @@
             </imageobject>    
         </mediaobject>
 
-        <title></title>
+        <title>
+            The Yocto Project Reference Manual
+        </title>
 
         <authorgroup>
             <author>

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #26 lore raw

PATCH 26/35 documentation/Makefile: logic to make all for poky-ref-manual and cleanup

From: Timo Mueller <[email protected]>

Eclipse help documents are now created when calling the 'make all' target on the poky-ref-manual. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted.

---
 documentation/Makefile |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)

documentation/Makefile +3 -3

index 58e406e..bf4c14c 100644
@@ -193,9 +193,9 @@ endif
 
 ifeq ($(DOC),poky-ref-manual)
 XSLTOPTS = --xinclude
-ALLPREQ = html pdf tarball
-TARFILES = poky-ref-manual.html ref-style.css figures/poky-title.png
-MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
+ALLPREQ = html pdf eclipse tarball
+TARFILES = poky-ref-manual.html ref-style.css figures/poky-title.png eclipse
+MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
 FIGURES = figures
 STYLESHEET = $(DOC)/*.css
 endif

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #27 lore raw

PATCH 27/35 documentation: Move yocto-project-qs global parameters to customization file

From: Timo Mueller <[email protected]>

Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile.

---
 documentation/Makefile                             |    3 +--
 .../yocto-project-qs-customization.xsl             |    2 +-
 2 files changed, 2 insertions(+), 3 deletions(-)

documentation/Makefile +1 -2

index bf4c14c..85b0e39 100644
@@ -127,8 +127,7 @@ STYLESHEET = $(DOC)/*.css
 endif
 
 ifeq ($(DOC),yocto-project-qs)
-XSLTOPTS = --stringparam html.stylesheet qs-style.css \
-           --xinclude
+XSLTOPTS = --xinclude
 ALLPREQ = html 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
 MANUALS = $(DOC)/$(DOC).html

documentation/yocto-project-qs/yocto-project-qs-customization.xsl +1 -1

index 8e6ea34..904289a 100644
@@ -4,5 +4,5 @@
   <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
 
   <xsl:param name="generate.toc" select="'article nop'"></xsl:param>
-
+  <xsl:param name="html.stylesheet" select="'qs-style.css'" />
 </xsl:stylesheet>

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #28 lore raw

PATCH 28/35 documentation/yocto-project-qs: Added custom title page

From: Timo Mueller <[email protected]>

The quick start guide is currently not using a title information to set the title of the document (e.g. article.title or article.articleinfo.title).
As other output formats may use the title information to create metadata this information has to be added to the document. To preserve current style of the document a custom title page has to be used. With this for instance 'article.title' can be used instead of the fake-title section currently used, leaving the style intact.

---
 .../yocto-project-qs-customization.xsl             |    1 +
 .../yocto-project-qs-titlepage.xsl                 | 3820 ++++++++++++++++++++
 2 files changed, 3821 insertions(+), 0 deletions(-)
 create mode 100644 documentation/yocto-project-qs/yocto-project-qs-titlepage.xsl

documentation/yocto-project-qs/yocto-project-qs-customization.xsl +1 -0

index 904289a..bd53ecb 100644
@@ -2,6 +2,7 @@
 <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">
   
   <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
+  <xsl:import href="yocto-project-qs-titlepage.xsl"/>
 
   <xsl:param name="generate.toc" select="'article nop'"></xsl:param>
   <xsl:param name="html.stylesheet" select="'qs-style.css'" />

documentation/yocto-project-qs/yocto-project-qs-titlepage.xsl new file +3820 -0

2,993 lines not on this page · raw message

The rest of this diff is not shown. View the raw message.

Signature · 1 line

1.7.7.6

Part of the diff is not shown here. View the raw message.

[email protected]

author

2012-10-10 09:54 UTC #29 lore raw

PATCH 29/35 documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl: new file

From: Timo Mueller <[email protected]>

---
 .../yocto-project-qs-eclipse-customization.xsl     |   24 ++++++++++++++++++++
 1 files changed, 24 insertions(+), 0 deletions(-)
 create mode 100644 documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl

documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl new file +24 -0

new file mode 100644
index 0000000..468508b
@@ -0,0 +1,24 @@
+<?xml version='1.0'?>
+<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">
+
+  <xsl:import
+	  href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl" />
+  <xsl:import href="yocto-project-qs-titlepage.xsl"/>
+
+  <xsl:param name="chunker.output.indent" select="'yes'"/>
+  <xsl:param name="use.id.as.filename" select="1"/>
+  <xsl:param name="ulink.target" select="'_self'" />
+  <xsl:param name="base.dir" select="'html/yocto-project-qs/'"/>
+  <xsl:param name="chunk.section.depth" select="0"/>
+  <xsl:param name="html.stylesheet" select="'../book.css'"/>
+  <xsl:param name="eclipse.manifest" select="0"/>
+  <xsl:param name="create.plugin.xml" select="0"/>
+  <xsl:param name="suppress.navigation" select="1"/>
+  <xsl:param name="generate.index" select="0"/>
+  <xsl:param name="generate.toc" select="'article nop'"></xsl:param>
+  <xsl:param name="html.stylesheet" select="'style.css'" />
+</xsl:stylesheet>

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #30 lore raw

PATCH 30/35 documentation/Makefile: Support for making Eclipse HTML yocto project qs manual

From: Timo Mueller <[email protected]>

This target will generate eclipse help for the yocto-project-qs using the yocto-project-qs-eclipse-customization.xsl stylesheet.

The output will be generated to a separate directory which can be used for integrating the documentation into eclipse.

---
 documentation/Makefile |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

documentation/Makefile +2 -1

index 85b0e39..a435bbf 100644
@@ -273,7 +273,7 @@ endif
 eclipse: BASE_DIR = html/$(DOC)/
 
 eclipse:
-ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual kernel-manual poky-ref-manual),)
+ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual kernel-manual poky-ref-manual yocto-project-qs),)
 	@echo " "
 	@echo "ERROR: You can only create eclipse documentation"
 	@echo "       of the following documentation parts:"

@@ -285,6 +285,7 @@ ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual kernel-manual poky-ref-ma
 	@echo "       - The Yocto Project Kernel Architecture and"
 	@echo "                           Use Manual (kernel-manual)"
 	@echo "		  - The Yocto Project Reference Manual (poky-ref-manual)"
+	@echo "       - The Yocto Project Quick Start (yocto-project-qs)"
 	@echo " "
 else
 	@echo " "

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #31 lore raw

PATCH 31/35 documentation/yocto-project-qs/yocto-project-qs.xml: Convert fake-title section into articleinfo

From: Timo Mueller <[email protected]>

The fake title section is converted into a docbook article.articleinfo. If used with a custom title page this will lead to the excapt same output. But I will enable the creation of metadata from this title information.

---
 .../yocto-project-qs/yocto-project-qs.xml          |   20 ++++++++++++++------
 1 files changed, 14 insertions(+), 6 deletions(-)

documentation/yocto-project-qs/yocto-project-qs.xml +14 -6

index ca6f65b..390c24c 100644
@@ -3,12 +3,20 @@
 [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
 
 <article id='intro'>
-   <imagedata fileref="figures/yocto-project-transp.png" width="6in" depth="1in" align="right" scale="25" />
-
-<section id='fake-title'>
-    <title>The Yocto Project Quick Start</title>
-    <para>Copyright &copy; &COPYRIGHT_YEAR; Linux Foundation</para>
-</section>
+    <articleinfo>
+        <title>The Yocto Project Quick Start</title>
+
+        <copyright>
+            <year>&COPYRIGHT_YEAR;</year>
+            <holder>Linux Foundation</holder>
+        </copyright>
+
+        <abstract>
+            <imagedata fileref="figures/yocto-project-transp.png"
+                        width="6in" depth="1in"
+                        align="right" scale="25" />
+        </abstract>
+    </articleinfo>
 
 <section id='welcome'>
     <title>Welcome!</title>

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #32 lore raw

PATCH 32/35 documentation/Makefile: logic to make all for yocto-project-qs and cleanup

From: Timo Mueller <[email protected]>

Eclipse help documents are now created when calling the 'make all' target on the yocto-project-qs. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted.

---
 documentation/Makefile |    9 ++++++---
 1 files changed, 6 insertions(+), 3 deletions(-)

documentation/Makefile +6 -3

index a435bbf..d38d204 100644
@@ -128,9 +128,12 @@ endif
 
 ifeq ($(DOC),yocto-project-qs)
 XSLTOPTS = --xinclude
-ALLPREQ = html 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
-MANUALS = $(DOC)/$(DOC).html
+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 \
+           eclipse
+MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse
 FIGURES = figures
 STYLESHEET = $(DOC)/*.css
 endif

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #33 lore raw

PATCH 33/35 documentation/tools/eclipse-help.sed: Processes external links for eclipse html files

From: Timo Mueller <[email protected]>

The file is used when creating eclipse help html files. It processes all html files and converts links so that the user can navigate between different docuementation parts without leaving the eclipse help center.

---
 documentation/tools/eclipse-help.sed |   18 ++++++++++++++++++
 1 files changed, 18 insertions(+), 0 deletions(-)
 create mode 100644 documentation/tools/eclipse-help.sed

documentation/tools/eclipse-help.sed new file +18 -0

new file mode 100644
index 0000000..71d3395
@@ -0,0 +1,18 @@
+# Processes poky-ref-manual and yocto-project-qs manual (<word>-<word>-<word> style)
+# For example:
+#   "ulink" href="http://www.yoctoproject.org/docs/1.3/poky-ref-manual/poky-ref-manual.html#faq" 
+#   -> "link" href="../poky-ref-manual/faq.html"
+s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/[^\/]*\/\([a-z]*-[a-z]*-[a-z]*\)\/[a-z]*-[a-z]*-[a-z]*.html#\([^\"]*\)\"/\"link\" href=\"\.\.\/\1\/\2.html\"/g
+
+# Processes all other manuals (<word>-<word> style)
+# For example:
+#   "ulink" href="http://www.yoctoproject.org/docs/1.3/kernel-manual/kernel-manual.html#faq" 
+#   -> "link" href="../kernel-manual/faq.html"
+s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/[^\/]*\/\([a-z]*-[a-z]*\)\/[a-z]*-[a-z]*.html#\([^\"]*\)\"/\"link\" href=\"\.\.\/\1\/\2.html\"/g
+
+# Process cases where just an external manual is referenced without an id anchor
+# For example:
+#   "ulink" href="http://www.yoctoproject.org/docs/1.3/kernel-manual/kernel-manual.html
+#   -> "link" href="../kernel-manual/index.html"
+s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/[^\/]*\/\([a-z]*-[a-z]*-[a-z]*\)\/[a-z]*-[a-z]*-[a-z]*.html\"/\"link\" href=\"\.\.\/\1\/index.html\"/g
+s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/[^\/]*\/\([a-z]*-[a-z]*\)\/[a-z]*-[a-z]*.html\"/\"link\" href=\"\.\.\/\1\/index.html\"/g

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #34 lore raw

PATCH 34/35 documentation/Makefile: Added conversion of links to other documentation parts.

From: Timo Mueller <[email protected]>

The script tools/eclipse-help.sed is used to convert links that point to other documentation parts. This avoids having to leave the eclipse help center when clicking these links.

---
 documentation/Makefile |   18 ++++++++++++++++--
 1 files changed, 16 insertions(+), 2 deletions(-)

documentation/Makefile +16 -2

index d38d204..3abfb3e 100644
@@ -275,7 +275,11 @@ endif
 
 eclipse: BASE_DIR = html/$(DOC)/
 
-eclipse:
+eclipse: eclipse-generate eclipse-resolve-links
+
+.PHONY : eclipse-generate eclipse-resolve-links
+
+eclipse-generate:
 ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual kernel-manual poky-ref-manual yocto-project-qs),)
 	@echo " "
 	@echo "ERROR: You can only create eclipse documentation"

@@ -301,9 +305,19 @@ else
 				$(DOC)-eclipse-customization.xsl $(DOC).xml && \
 		mv eclipse/toc.xml eclipse/$(DOC)-toc.xml && \
 		cp -rf $(FIGURES) eclipse/$(BASE_DIR)/$(FIGURES) && \
-		cd ..
+		cd ..;
+
+	$(call modify-eclipse)
 endif
 
+eclipse-resolve-links:
+	@echo " "
+	@echo "******** Using eclipse-help.sed to process external links"
+	@echo " "
+	$(foreach FILE, \
+		$(wildcard $(DOC)/eclipse/html/$(DOC)/*.html), \
+		$(shell sed -i -f tools/eclipse-help.sed $(FILE)))
+
 tarball: html
 	@echo " "
 	@echo "******** Creating Tarball of document files"

Signature · 1 line

1.7.7.6

[email protected]

author

2012-10-10 09:54 UTC #35 lore raw

PATCH 35/35 documentation/Makefile: Clean up eclipse target and update help.

From: Timo Mueller <[email protected]>

---
 documentation/Makefile |   16 ++++------------
 1 files changed, 4 insertions(+), 12 deletions(-)

documentation/Makefile +4 ~~-12~~

index 3abfb3e..957f5e5 100644
@@ -11,6 +11,8 @@
 #              or the mega-manual (single, large HTML file comprised of all 
 #              Yocto Project manuals).
 #    html:     generates an HTML version of a manual.
+#    eclipse:  generates an HTML version of a manual that can be used as
+#              eclipse help (including necessary metadata files).
 #    tarball:  creates a tarball for the doc files.
 #    validate: validates 
 #    publish:  pushes generated files to the Yocto Project website

@@ -280,19 +282,9 @@ eclipse: eclipse-generate eclipse-resolve-links
 .PHONY : eclipse-generate eclipse-resolve-links
 
 eclipse-generate:
-ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual kernel-manual poky-ref-manual yocto-project-qs),)
-	@echo " "
-	@echo "ERROR: You can only create eclipse documentation"
-	@echo "       of the following documentation parts:"
+ifeq ($(DOC),mega-manual)
 	@echo " "
-	@echo "       - The Yocto Project Application Developer's Guide (adt-manual)"
-	@echo "       - The Yocto Project Board Support Package"
-	@echo "                           Developer's Guide (bsp-guide)"
-	@echo "       - The Yocto Project Development Manual (dev-manual)"
-	@echo "       - The Yocto Project Kernel Architecture and"
-	@echo "                           Use Manual (kernel-manual)"
-	@echo "		  - The Yocto Project Reference Manual (poky-ref-manual)"
-	@echo "       - The Yocto Project Quick Start (yocto-project-qs)"
+	@echo "ERROR: You cannot generate eclipse documentation for the mega-manual"
 	@echo " "
 else
 	@echo " "

Signature · 1 line

1.7.7.6