Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Dziallas <sebastian@when.com>2010-03-28 16:41:57 (GMT)
committer Sebastian Dziallas <sebastian@when.com>2010-03-28 16:41:57 (GMT)
commitbab7570b4cd72521e00f920b92219b03bbb8d5de (patch)
tree18243ac296f4110a3bdfe334a4fc555395b805b5
parentb5184ac40b66f6cddaf29b2d9e5b029d1d48fe56 (diff)
add customization guide and ready for first release
-rw-r--r--Customization Guide/en-US/Author_Group.xml14
-rw-r--r--Customization Guide/en-US/Author_Group.xml~15
-rw-r--r--Customization Guide/en-US/Book_Info.xml37
-rw-r--r--Customization Guide/en-US/Book_Info.xml~37
-rw-r--r--Customization Guide/en-US/Building.xml42
-rw-r--r--Customization Guide/en-US/Building.xml~41
-rw-r--r--Customization Guide/en-US/Chapter.xml~98
-rw-r--r--Customization Guide/en-US/Customization.xml89
-rw-r--r--Customization Guide/en-US/Customization.xml~87
-rw-r--r--Customization Guide/en-US/Customization_Guide.ent4
-rw-r--r--Customization Guide/en-US/Customization_Guide.ent~4
-rw-r--r--Customization Guide/en-US/Customization_Guide.xml12
-rw-r--r--Customization Guide/en-US/Customization_Guide.xml~13
-rw-r--r--Customization Guide/en-US/Feedback.xml9
-rw-r--r--Customization Guide/en-US/Legal_Notice.xml9
-rw-r--r--Customization Guide/en-US/Legal_Notice.xml~9
-rw-r--r--Customization Guide/en-US/Overview.xml~0
-rw-r--r--Customization Guide/en-US/Preface.xml18
-rw-r--r--Customization Guide/en-US/Preface.xml~18
-rw-r--r--Customization Guide/en-US/Preparation.xml80
-rw-r--r--Customization Guide/en-US/Preparation.xml~80
-rw-r--r--Customization Guide/en-US/Revision_History.xml39
-rw-r--r--Customization Guide/en-US/Revision_History.xml~25
-rw-r--r--Customization Guide/en-US/images/soas-blueberry.pngbin0 -> 148537 bytes
-rw-r--r--Customization Guide/en-US/images/sugar-thumbnail.pngbin0 -> 868 bytes
-rw-r--r--Customization Guide/publican.cfg7
26 files changed, 787 insertions, 0 deletions
diff --git a/Customization Guide/en-US/Author_Group.xml b/Customization Guide/en-US/Author_Group.xml
new file mode 100644
index 0000000..5043218
--- /dev/null
+++ b/Customization Guide/en-US/Author_Group.xml
@@ -0,0 +1,14 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<authorgroup>
+ <author>
+ <firstname>Sebastian</firstname>
+ <surname>Dziallas</surname>
+ <affiliation>
+ <orgname>Sugar Labs</orgname>
+ <orgdiv></orgdiv>
+ </affiliation>
+ <email>sdz@sugarlabs.org</email>
+ </author>
+</authorgroup>
diff --git a/Customization Guide/en-US/Author_Group.xml~ b/Customization Guide/en-US/Author_Group.xml~
new file mode 100644
index 0000000..d2bd016
--- /dev/null
+++ b/Customization Guide/en-US/Author_Group.xml~
@@ -0,0 +1,15 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<authorgroup>
+ <author>
+ <firstname>Dude</firstname>
+ <surname>McPants</surname>
+ <affiliation>
+ <orgname>Somewhere</orgname>
+ <orgdiv>Someone</orgdiv>
+ </affiliation>
+ <email>Dude.McPants@example.com</email>
+ </author>
+</authorgroup>
+
diff --git a/Customization Guide/en-US/Book_Info.xml b/Customization Guide/en-US/Book_Info.xml
new file mode 100644
index 0000000..c4b4778
--- /dev/null
+++ b/Customization Guide/en-US/Book_Info.xml
@@ -0,0 +1,37 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<bookinfo id="book-Customization_Guide-Customization_Guide">
+ <title>Customization Guide</title>
+ <subtitle>A simple guide on how to customize SoaS</subtitle>
+ <productname>Sugar on a Stick</productname>
+ <productnumber>3</productnumber>
+ <edition>1</edition>
+ <pubsnumber>0</pubsnumber>
+ <abstract>
+ <para>
+This guide will effectively show you how to customize and adjust
+your copy of Sugar on a Stick, so that it fits your needs directly
+and enables you to do more the open source way.
+</para>
+ </abstract>
+ <keywordset>
+ <keyword>soas</keyword>
+ <keyword>sugar</keyword>
+ <keyword>documentation</keyword>
+ </keywordset>
+ <subjectset scheme="libraryofcongress">
+ <subject>
+ <subjectterm>Open source software</subjectterm>
+ </subject>
+ </subjectset>
+ <corpauthor>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/soas-blueberry.png" format="PNG" />
+ </imageobject>
+ </inlinemediaobject>
+ </corpauthor>
+ <xi:include href="Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</bookinfo>
diff --git a/Customization Guide/en-US/Book_Info.xml~ b/Customization Guide/en-US/Book_Info.xml~
new file mode 100644
index 0000000..4e8471f
--- /dev/null
+++ b/Customization Guide/en-US/Book_Info.xml~
@@ -0,0 +1,37 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<bookinfo id="book-Customization_Guide-Customization_Guide">
+ <title>Customization Guide</title>
+ <subtitle>A simple guide on how to customize SoaS</subtitle>
+ <productname>Sugar on a Stick</productname>
+ <productnumber>0.1</productnumber>
+ <edition>0</edition>
+ <pubsnumber>0</pubsnumber>
+ <abstract>
+ <para>
+This guide will effectively show you how to customize and adjust
+your copy of Sugar on a Stick, so that it fits your needs directly
+and enables you to do more the open source way.
+</para>
+ </abstract>
+ <keywordset>
+ <keyword>soas</keyword>
+ <keyword>sugar</keyword>
+ <keyword>documentation</keyword>
+ </keywordset>
+ <subjectset scheme="libraryofcongress">
+ <subject>
+ <subjectterm>Open source software</subjectterm>
+ </subject>
+ </subjectset>
+ <corpauthor>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/soas-blueberry.png" format="PNG" />
+ </imageobject>
+ </inlinemediaobject>
+ </corpauthor>
+ <xi:include href="Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</bookinfo>
diff --git a/Customization Guide/en-US/Building.xml b/Customization Guide/en-US/Building.xml
new file mode 100644
index 0000000..b13008a
--- /dev/null
+++ b/Customization Guide/en-US/Building.xml
@@ -0,0 +1,42 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<chapter id="chap-Customization_Guide-Building">
+ <title>Building</title>
+ <para>
+ At the end of the customization process, you will run your own build, resulting in a new image file. This chapter describes how to do so and mentions aspects to pay attention to.
+ </para>
+ <para>
+ To run the build process, Sugar on a Stick makes of the <firstterm>livecd-creator</firstterm> from Fedora's livecd-tools. The process, which may take depending on your machine up to an hour, requires to be executed as root.
+ </para>
+ <warning>
+ <para>
+ The build process is hardware-intensive and will demand both your internet connection and your computer itself in general. Make sure proceed only if you are aware of this.
+ </para>
+ </warning>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Make sure you comply with the system requirements as listed in the first chapter, especially concerning the amount of free hard disk space.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Turn SELinux <footnote><para>http://fedoraproject.org/wiki/SELinux</para></footnote> temporarily into a permissive mode by executing: <command>/usr/sbin/setenforce 0</command>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Start the build process by executing the following command from the directory where you placed both kickstart files: <command>livecd-creator --config=fedora-livecd-soas.ks</command>
+ <note>
+ <para>
+ You may also specify a <firstterm>file system label</firstterm>, influencing the name of the resulting image, as well as a <firstterm>cache directory</firstterm>, preventing livecd-creator from redownloading the required packages again, unless updates have occurred. For more information, execute: <command>livecd-creator --help</command>
+ </para>
+ </note>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ Congratulations! You have just taken the final step towards customizing Sugar on a Stick for your needs. If you ran into any issues or have comments, suggestions, or feedback in general, feel free to contact us on the Sugar on a Stick <ulink url="http://lists.sugarlabs.org/listinfo/soas">mailing list</ulink>.
+ </para>
+</chapter>
diff --git a/Customization Guide/en-US/Building.xml~ b/Customization Guide/en-US/Building.xml~
new file mode 100644
index 0000000..d942805
--- /dev/null
+++ b/Customization Guide/en-US/Building.xml~
@@ -0,0 +1,41 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<chapter id="chap-Customization_Guide-Building">
+ <title>Building</title>
+ <para>
+ At the end of the customization process, you will run your own build, resulting in a new image file. This chapter describes how to do so and mentions aspects to pay attention to.
+ </para>
+ <para>
+ To run the build process, Sugar on a Stick makes of the <firstterm>livecd-creator</firstterm> from Fedora's livecd-tools. The process, which may take depending on your machine up to an hour, requires to be executed as root.
+ </para>
+ <warning>
+ <para>
+ The build process is hardware-intensive and will demand both your internet connection and your computer itself in general. Make sure proceed only if you are aware of this.
+ </para>
+ </warning>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Make sure you comply with the system requirements as listed in the first chapter, especially concerning the amount of free hard disk space.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Turn SELinux <footnote><para>http://fedoraproject.org/wiki/SELinux</para></footnote> temporarily into a permissive mode by executing: <command>/usr/sbin/setenforce 0</command>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Start the build process by executing the following command from the directory where you placed both kickstart files: <command>livecd-creator --config=fedora-livecd-soas.ks</command>
+ <note>
+ <para>
+ You may also specify a <firstterm>file system label</firstterm>, influencing the name of the resulting image, as well as a <firstterm>cache directory</firstterm>, preventing livecd-creator from redownloading the required packages again, unless updates have occurred. For more information, execute: <command>livecd-creator --help</command>
+ </para>
+ </note>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ Congratulations! You have just taken the final step towards customizing Sugar on a Stick for your needs. If you ran into any issues or have comments, suggestions, or feedback in general, feel free to contact us on the Sugar on a Stick <ulink url="http://lists.sugarlabs.org/listinfo/soas">mailing list</ulink>.
+</chapter>
diff --git a/Customization Guide/en-US/Chapter.xml~ b/Customization Guide/en-US/Chapter.xml~
new file mode 100644
index 0000000..2910d48
--- /dev/null
+++ b/Customization Guide/en-US/Chapter.xml~
@@ -0,0 +1,98 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<chapter id="chap-Customization_Guide-Preparation">
+ <title>Preparation</title>
+ <para>
+ This chapter will demonstrate the stages required to customize Sugar on a Stick in different ways and will guide you through them step by step. Please pay close attention to the instructions to make sure no loss of data occurs.
+ </para>
+
+ <section id="sect-Creation_Kit-Preparation-System_Requirements">
+ <title>System Requirements</title>
+ <table id="tabl-Creation_Kit-Preparation-System_Requirements-Platforms">
+ <title>Platforms</title>
+ <tgroup cols="3">
+ <colspec colname="Platform" colnum="1" colwidth="2*"></colspec>
+ <colspec colname="Requirements" colnum="2" colwidth="4*"></colspec>
+ <colspec colname="Notes" colnum="3" colwidth="4*"></colspec>
+ <thead>
+ <row>
+ <entry> Platform </entry>
+ <entry> Requirements </entry>
+ <entry> Notes </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry> <simplelist> <member> Linux </member> </simplelist> </entry>
+ <entry>
+ <simplelist>
+ <member> Fedora 12 or higher </member>
+ <member> at least 5 GB of free hard disk space </member>
+ <member> a decently fast internet connection </member>
+ </simplelist>
+ </entry>
+ <entry> <simplelist>
+ <member> root access is required </member>
+ <member> older versions may be unsupported </member>
+ </simplelist>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ <section id="sect-Creation_Kit-Preparation-Getting_Started">
+ <title>Getting Started</title>
+ <para>
+ When remixing Sugar on a Stick, you will note a lot of references to Fedora and related projects. This is mainly, because Sugar on a Stick is a Fedora Spin and thus based on this distribution. Hence, we are also assuming that you are starting with a current Fedora installation, as defined in the system requirements.
+ </para>
+ <para>
+ As a first step, you will need to install a number of packages that allow you to build your own Sugar on a Stick. For the build process, we are relying on Fedora's livecd-tools. <footnote><para>http://fedoraproject.org/wiki/FedoraLiveCD</para></footnote> Therefore, you will need to install these, along with a couple of other packages.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Execute as root: <command>yum install <replaceable>git livecd-tools</replaceable></command>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ The production of Sugar on a Stick usually takes place by providing the build tool with a kind of configuration file. This file is called <firstterm>kickstart</firstterm> file. We are going to start from the currently existing files, which are available in Fedora's GIT repositories, since the upcoming Sugar on a Stick version as a spin will be part of Fedora's engineering process.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Grab the configuration files by running: <command>git clone <replaceable>git://git.fedorahosted.org/spin-kickstarts.git</replaceable></command>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ You have taken the first step! You have downloaded all the required components and are now ready to learn how to customize Sugar on a Stick for your own purposes in the next chapter
+ </para>
+ </section>
+</chapter>
+
+<chapter id="chap-Customization_Guide-Customization">
+ <title>Customization</title>
+ <para>
+ This chapter will introduce you to the exact steps on how to customize Sugar on a Stick by editing the appropriate files and running a complete build process thereafter.
+ </para>
+
+ <section id="sect-Creation_Kit-Customization-Overview">
+ <title>Overview</title>
+ <para>There are namely two kickstart files to look at:</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <filename>fedora-live-mini.ks</filename> - this file is shared with a number of other Fedora Mini <footnote><para>http://fedoraproject.org/wiki/SIGs/FedoraMini</para></footnote> projects and contains the package set for the base operating system, as well as other configurations for such purposes.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <filename>fedora-livecd-soas.ks</filename> - this file contains all the changes required to actually make Sugar on a Stick, such as the unique package set and a number of other modifications to fit the special design.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+</chapter>
diff --git a/Customization Guide/en-US/Customization.xml b/Customization Guide/en-US/Customization.xml
new file mode 100644
index 0000000..97f17f1
--- /dev/null
+++ b/Customization Guide/en-US/Customization.xml
@@ -0,0 +1,89 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<chapter id="chap-Customization_Guide-Customization">
+ <title>Customization</title>
+ <para>
+ This chapter will introduce you to the exact steps on how to customize Sugar on a Stick by editing the appropriate files and running a complete build process thereafter.
+ </para>
+
+ <section id="sect-Creation_Kit-Customization-Overview">
+ <title>Overview</title>
+ <para>There are namely two kickstart files to look at:</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <filename>fedora-live-mini.ks</filename> - this file is shared with a number of other Fedora Mini <footnote><para>http://fedoraproject.org/wiki/SIGs/FedoraMini</para></footnote> projects and contains the package set for the base operating system, as well as other configurations for such purposes.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <filename>fedora-livecd-soas.ks</filename> - this file contains all the changes required to actually make Sugar on a Stick, such as the unique package set and a number of other modifications to fit the special design.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ In the following sections, we will walk through the different parameters and enable you to customize them.
+ </para>
+ </section>
+ <section id="sect-Creation_Kit-Customization-Locales">
+ <title>Locales</title>
+ <para>
+ One of the most requested changes to Sugar on a Stick is understandably the modification of the locals and keyboard settings. Sugar is a well localized learning environment and users of Sugar on a Stick should be able to take advantage of this fact.
+ </para>
+ <para>
+ Language customizations take place in the <filename>fedora-live-mini.ks</filename> file. At the top of this file, you will find the following three lines:
+ </para>
+<programlisting>
+lang en_US.UTF-8
+keyboard us
+timezone US/Eastern
+</programlisting>
+ <para>
+ These lines impact the default language, keyboard setting and timezone configuration of Sugar on a Stick. You can modify them to fit your needs by following the given scheme as explained in the Kickstart Options <footnote><para>http://fedoraproject.org/wiki/Anaconda/Kickstart#Chapter_2._Kickstart_Options</para></footnote>.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ A list of the valid language codes for the lang parameter is availible in the first column of each line in the following file. Execute: <command>less /usr/share/system-config-language/locale-list</command>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A list of valid keyboard settings is available in the following file. Execute: <command>less /usr/lib/python2.6/site-packages/rhpl/keyboard_models.py</command>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="sect-Creation_Kit-Customization-Packages">
+ <title>Packages</title>
+ <para>
+ Another inevitable request we received concerns the selection of activities. For the upcoming Sugar on a Stick releases, we decided to include a number of core activities, allowing users to add more themselves from the <ulink url="http://activities.sugarlabs.org/">Activity Portal</ulink>. However, deployments and experienced users might want to customize the base set of activities as described in this section.
+ </para>
+ <para>
+ Package set customizations take place in the <filename>fedora-livecd-soas.ks</filename> file, in which you will find a line listing a number of activities. This is the place to add new activities.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ To get an overview what activities are available, run: <command>yum list "sugar-*"</command>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ You will be presented a list of available activities following the <command>sugar-<replaceable>name</replaceable></command> naming scheme.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Add your preferred activities to the list in the kickstart file.
+ <important>
+ <para>
+ Pay attention to not introduce any typos at this point, as the build process will otherwise fail later on.
+ </para>
+ </important>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+</chapter>
diff --git a/Customization Guide/en-US/Customization.xml~ b/Customization Guide/en-US/Customization.xml~
new file mode 100644
index 0000000..338c4ab
--- /dev/null
+++ b/Customization Guide/en-US/Customization.xml~
@@ -0,0 +1,87 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<chapter id="chap-Customization_Guide-Customization">
+ <title>Customization</title>
+ <para>
+ This chapter will introduce you to the exact steps on how to customize Sugar on a Stick by editing the appropriate files and running a complete build process thereafter.
+ </para>
+
+ <section id="sect-Creation_Kit-Customization-Overview">
+ <title>Overview</title>
+ <para>There are namely two kickstart files to look at:</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <filename>fedora-live-mini.ks</filename> - this file is shared with a number of other Fedora Mini <footnote><para>http://fedoraproject.org/wiki/SIGs/FedoraMini</para></footnote> projects and contains the package set for the base operating system, as well as other configurations for such purposes.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <filename>fedora-livecd-soas.ks</filename> - this file contains all the changes required to actually make Sugar on a Stick, such as the unique package set and a number of other modifications to fit the special design.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ In the following sections, we will walk through the different parameters and enable you to customize them.
+ </para>
+ </section>
+ <section id="sect-Creation_Kit-Customization-Locales">
+ <title>Locales</title>
+ <para>
+ One of the most requested changes to Sugar on a Stick is understandably the modification of the locals and keyboard settings. Sugar is a well localized learning environment and users of Sugar on a Stick should be able to take advantage of this fact.
+ </para>
+ <para>
+ Language customizations take place in the <filename>fedora-live-mini.ks</filename> file. At the top of this file, you will find the following three lines:
+ </para>
+<programlisting>
+lang en_US.UTF-8
+keyboard us
+timezone US/Eastern
+</programlisting>
+ <para>
+ These lines impact the default language, keyboard setting and timezone configuration of Sugar on a Stick. You can modify them to fit your needs by following the given scheme as explained in the Kickstart Options <footnote><para>http://fedoraproject.org/wiki/Anaconda/Kickstart#Chapter_2._Kickstart_Options</para></footnote>.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ A list of the valid language codes for the lang parameter is availible in the first column of each line in the following file. Execute: <command>less /usr/share/system-config-language/locale-list</command>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A list of valid keyboard settings is available in the following file. Execute: <command>less /usr/lib/python2.6/site-packages/rhpl/keyboard_models.py</command>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="sect-Creation_Kit-Customization-Packages">
+ <title>Packages</title>
+ <para>
+ Another inevitable request we received concerns the selection of activities. For the upcoming Sugar on a Stick releases, we decided to include a number of core activities, allowing users to add more themselves from the <ulink url="http://activities.sugarlabs.org/">Activity Portal</ulink>. However, deployments and experienced users might want to customize the base set of activities as described in this section.
+ </para>
+ <para>
+ Package set customizations take place in the <filename>fedora-livecd-soas.ks</filename> file, in which you will find a line listing a number of activities. This is the place to add new activities.
+ </para>
+ <important>
+ <para>
+ Pay attention to not introduce any typos at this point, as the build process will otherwise fail later on.
+ </para>
+ </important>
+ <itemizedlist>
+ <listitem>
+ <para>
+ To get an overview what activities are available, run: <command>yum list "sugar-*"</command>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ You will be presented a list of available activities following the <command>sugar-<replaceable>name</replaceable></command> naming scheme.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Add your preferred activities to the list in the kickstart file.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+</chapter>
diff --git a/Customization Guide/en-US/Customization_Guide.ent b/Customization Guide/en-US/Customization_Guide.ent
new file mode 100644
index 0000000..8a21e56
--- /dev/null
+++ b/Customization Guide/en-US/Customization_Guide.ent
@@ -0,0 +1,4 @@
+<!ENTITY PRODUCT "Sugar on a Stick">
+<!ENTITY BOOKID "Customization Guide">
+<!ENTITY YEAR "2010">
+<!ENTITY HOLDER "| Sebastian Dziallas |">
diff --git a/Customization Guide/en-US/Customization_Guide.ent~ b/Customization Guide/en-US/Customization_Guide.ent~
new file mode 100644
index 0000000..f2e9e1d
--- /dev/null
+++ b/Customization Guide/en-US/Customization_Guide.ent~
@@ -0,0 +1,4 @@
+<!ENTITY PRODUCT "Sugar_on_a_Stick">
+<!ENTITY BOOKID "Customization_Guide">
+<!ENTITY YEAR "2010">
+<!ENTITY HOLDER "| You need to change the HOLDER entity in the en-US/Customization_Guide.ent file |">
diff --git a/Customization Guide/en-US/Customization_Guide.xml b/Customization Guide/en-US/Customization_Guide.xml
new file mode 100644
index 0000000..678ac7e
--- /dev/null
+++ b/Customization Guide/en-US/Customization_Guide.xml
@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<book>
+ <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Preparation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Customization.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Building.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</book>
+
diff --git a/Customization Guide/en-US/Customization_Guide.xml~ b/Customization Guide/en-US/Customization_Guide.xml~
new file mode 100644
index 0000000..bf368dc
--- /dev/null
+++ b/Customization Guide/en-US/Customization_Guide.xml~
@@ -0,0 +1,13 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<book>
+ <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Preparation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Customization.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Building.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <index />
+</book>
+
diff --git a/Customization Guide/en-US/Feedback.xml b/Customization Guide/en-US/Feedback.xml
new file mode 100644
index 0000000..bda2224
--- /dev/null
+++ b/Customization Guide/en-US/Feedback.xml
@@ -0,0 +1,9 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<section>
+ <title>We Need Feedback!</title>
+ <para>
+ Please share your feedback with us; it will help us to improve Sugar in subsequent versions of SoaS. Send an e-mail to the <firstterm>Sugar on a Stick</firstterm> <ulink url="http://lists.sugarlabs.org/listinfo/soas">mailing list</ulink> or join the <firstterm>It is an Education Project</firstterm> <ulink url="http://lists.sugarlabs.org/listinfo/iaep">mailing list</ulink>. If you encounter any hardware-related issues besides the ones listed below, please consider joining our hardware effort. Submitting the specifications of your hardware helps us to work together with upstream to resolve any issues. Finally, you might also consider submitting bug reports at our <ulink url="http://bugs.sugarlabs.org">bug tracker</ulink>.
+ </para>
+</section>
diff --git a/Customization Guide/en-US/Legal_Notice.xml b/Customization Guide/en-US/Legal_Notice.xml
new file mode 100644
index 0000000..167cc63
--- /dev/null
+++ b/Customization Guide/en-US/Legal_Notice.xml
@@ -0,0 +1,9 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<legalnotice>
+ <para>
+ Copyright <trademark class="copyright"></trademark> &YEAR; &HOLDER; This material may only be distributed subject to the terms and conditions set forth in the Creative Commons Attribution-Share Alike 3.0 Unported License (CC-BY-SA), available at <ulink url="http://creativecommons.org/licenses/by-sa/3.0/">http://creativecommons.org/licenses/by-sa/3.0/</ulink>. Be also aware that Sugar on a Stick policies do not permit you to distribute any modified or customized versions of the original product using the Sugar on a Stick name. You may create and distribute a <firstterm>Sugar on a Stick Remix</firstterm>, as long as you make clear that your product is neither officially related with nor implies any endorsement or support by the Sugar on a Stick project. Sugar Labs trademark policies apply.
+ </para>
+</legalnotice>
+
diff --git a/Customization Guide/en-US/Legal_Notice.xml~ b/Customization Guide/en-US/Legal_Notice.xml~
new file mode 100644
index 0000000..f090589
--- /dev/null
+++ b/Customization Guide/en-US/Legal_Notice.xml~
@@ -0,0 +1,9 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<legalnotice>
+ <para>
+ Copyright <trademark class="copyright"></trademark> &YEAR; &HOLDER; This material may only be distributed subject to the terms and conditions set forth in the Creative Commons Attribution-Share Alike 3.0 Unported License (CC-BY-SA), available at <ulink url="http://creativecommons.org/licenses/by-sa/3.0/">http://creativecommons.org/licenses/by-sa/3.0/</ulink>. Be also aware that Sugar on a Stick policies do not permit you to distribute any modified or customized versions of the original product using the Sugar on a Stick name. You may create and distribute a <firstterm>Sugar on a Stick Remix</firstterm>, as long as you make clear that your product does not is neither officially related with nor implies any endorsement or support by the Sugar on a Stick project. Sugar Labs trademark policies apply.
+ </para>
+</legalnotice>
+
diff --git a/Customization Guide/en-US/Overview.xml~ b/Customization Guide/en-US/Overview.xml~
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/Customization Guide/en-US/Overview.xml~
diff --git a/Customization Guide/en-US/Preface.xml b/Customization Guide/en-US/Preface.xml
new file mode 100644
index 0000000..cb6455b
--- /dev/null
+++ b/Customization Guide/en-US/Preface.xml
@@ -0,0 +1,18 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<preface id="pref-Customization_Guide-Preface">
+ <title>Preface</title>
+ <para>
+ To whom it may concern,
+ </para>
+ <para>
+ you might have already explored your own Sugar on a Stick which you either received preloaded or downloaded yourself from our website. No matter which way you chose, you have come across the different possibilities Sugar on a Stick bears. You might have created content for your students, downloaded and tested additional activities or simply changed the language. Now you ask how to incorporate these changes easily? — That is why weare here today. Sugar on a Stick comes with a number of methods to customize it. You can apply all those said changes and create your proper image of Sugar on a Stick. And that is also the reason why we do this: We want to enable you — as a newcomer, early grade teacher, college professor or large deployment — to get the best possible Sugar on a Stick experience.
+ </para>
+ <para>Sebastian Dziallas</para>
+ <para>Sugar on a Stick Release Manager</para>
+ <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </xi:fallback>
+ </xi:include>
+</preface>
+
diff --git a/Customization Guide/en-US/Preface.xml~ b/Customization Guide/en-US/Preface.xml~
new file mode 100644
index 0000000..061dbbb
--- /dev/null
+++ b/Customization Guide/en-US/Preface.xml~
@@ -0,0 +1,18 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<preface id="pref-Customization_Guide-Preface">
+ <title>Preface</title>
+ <para>
+ To whom it may concern,
+ </para>
+ <para>
+ you might have already explored your own Sugar on a Stick which you either received preloaded or downloaded yourself from our website. No matter which way you chose, you have come across the different possibilities Sugar on a Stick bears. You might have created content for your students, downloaded and tested additional activities or simply changed the language. Now you ask how to incorporate these changes easily? — That is why weare here today. Sugar on a Stick comes with a number of methods to customize it. You can apply all those said changes and create your proper image of Sugar on a Stick. And that is also the reason why we do this: We want to enable you — as a newcomer, early grade teacher, professor or large deployment — to get the best possible Sugar on a Stick experience.
+ </para>
+ <para>Sebastian Dziallas</para>
+ <para>Sugar on a Stick Release Manager</para>
+ <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </xi:fallback>
+ </xi:include>
+</preface>
+
diff --git a/Customization Guide/en-US/Preparation.xml b/Customization Guide/en-US/Preparation.xml
new file mode 100644
index 0000000..61864b3
--- /dev/null
+++ b/Customization Guide/en-US/Preparation.xml
@@ -0,0 +1,80 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<chapter id="chap-Customization_Guide-Preparation">
+ <title>Preparation</title>
+ <para>
+ This chapter will demonstrate the stages required to customize Sugar on a Stick in different ways and will guide you through them step by step. Please pay close attention to the instructions to make sure no loss of data occurs.
+ </para>
+
+ <section id="sect-Creation_Kit-Preparation-System_Requirements">
+ <title>System Requirements</title>
+ <table id="tabl-Creation_Kit-Preparation-System_Requirements-Platforms">
+ <title>Platforms</title>
+ <tgroup cols="3">
+ <colspec colname="Platform" colnum="1" colwidth="2*"></colspec>
+ <colspec colname="Requirements" colnum="2" colwidth="4*"></colspec>
+ <colspec colname="Notes" colnum="3" colwidth="4*"></colspec>
+ <thead>
+ <row>
+ <entry> Platform </entry>
+ <entry> Requirements </entry>
+ <entry> Notes </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry> <simplelist> <member> Linux </member> </simplelist> </entry>
+ <entry>
+ <simplelist>
+ <member> Fedora 12 or higher </member>
+ <member> at least 5 GB of free hard disk space </member>
+ <member> a decently fast internet connection </member>
+ </simplelist>
+ </entry>
+ <entry> <simplelist>
+ <member> root access is required </member>
+ <member> older versions may be unsupported </member>
+ </simplelist>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ <section id="sect-Creation_Kit-Preparation-Getting_Started">
+ <title>Getting Started</title>
+ <para>
+ When remixing Sugar on a Stick, you will note a lot of references to Fedora and related projects. This is mainly, because Sugar on a Stick is a Fedora Spin and thus based on this distribution. Hence, we are also assuming that you are starting with a current Fedora installation, as defined in the system requirements.
+ </para>
+ <para>
+ As a first step, you will need to install a number of packages that allow you to build your own Sugar on a Stick. For the build process, we are relying on Fedora's livecd-tools. <footnote><para>http://fedoraproject.org/wiki/FedoraLiveCD</para></footnote> Therefore, you will need to install these, along with a couple of other packages.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Execute as root: <command>yum install <replaceable>git livecd-tools rhpl system-config-language</replaceable></command>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ The production of Sugar on a Stick usually takes place by providing the build tool with a kind of configuration file. This file is called <firstterm>kickstart</firstterm> file. We are going to start from the currently existing files, which are available in Fedora's GIT repositories, since the upcoming Sugar on a Stick version as a spin will be part of Fedora's engineering process.
+ </para>
+ <note>
+ <title>Note</title>
+ <para>
+ Make sure to pull the appropriate branch from GIT if you want to build against one of the upcoming stable releases. Otherwise, you will checkout the latest moving contents from the repository.
+ </para>
+ </note>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Grab the configuration files by running: <command>git clone <replaceable>git://git.fedorahosted.org/spin-kickstarts.git</replaceable></command>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ You have taken the first step! You have downloaded all the required components and are now ready to learn how to customize Sugar on a Stick for your own purposes in the next chapter.
+ </para>
+ </section>
+</chapter>
diff --git a/Customization Guide/en-US/Preparation.xml~ b/Customization Guide/en-US/Preparation.xml~
new file mode 100644
index 0000000..13a11f9
--- /dev/null
+++ b/Customization Guide/en-US/Preparation.xml~
@@ -0,0 +1,80 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<chapter id="chap-Customization_Guide-Preparation">
+ <title>Preparation</title>
+ <para>
+ This chapter will demonstrate the stages required to customize Sugar on a Stick in different ways and will guide you through them step by step. Please pay close attention to the instructions to make sure no loss of data occurs.
+ </para>
+
+ <section id="sect-Creation_Kit-Preparation-System_Requirements">
+ <title>System Requirements</title>
+ <table id="tabl-Creation_Kit-Preparation-System_Requirements-Platforms">
+ <title>Platforms</title>
+ <tgroup cols="3">
+ <colspec colname="Platform" colnum="1" colwidth="2*"></colspec>
+ <colspec colname="Requirements" colnum="2" colwidth="4*"></colspec>
+ <colspec colname="Notes" colnum="3" colwidth="4*"></colspec>
+ <thead>
+ <row>
+ <entry> Platform </entry>
+ <entry> Requirements </entry>
+ <entry> Notes </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry> <simplelist> <member> Linux </member> </simplelist> </entry>
+ <entry>
+ <simplelist>
+ <member> Fedora 12 or higher </member>
+ <member> at least 5 GB of free hard disk space </member>
+ <member> a decently fast internet connection </member>
+ </simplelist>
+ </entry>
+ <entry> <simplelist>
+ <member> root access is required </member>
+ <member> older versions may be unsupported </member>
+ </simplelist>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ <section id="sect-Creation_Kit-Preparation-Getting_Started">
+ <title>Getting Started</title>
+ <para>
+ When remixing Sugar on a Stick, you will note a lot of references to Fedora and related projects. This is mainly, because Sugar on a Stick is a Fedora Spin and thus based on this distribution. Hence, we are also assuming that you are starting with a current Fedora installation, as defined in the system requirements.
+ </para>
+ <para>
+ As a first step, you will need to install a number of packages that allow you to build your own Sugar on a Stick. For the build process, we are relying on Fedora's livecd-tools. <footnote><para>http://fedoraproject.org/wiki/FedoraLiveCD</para></footnote> Therefore, you will need to install these, along with a couple of other packages.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Execute as root: <command>yum install <replaceable>git livecd-tools rhpl system-config-language</replaceable></command>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ The production of Sugar on a Stick usually takes place by providing the build tool with a kind of configuration file. This file is called <firstterm>kickstart</firstterm> file. We are going to start from the currently existing files, which are available in Fedora's GIT repositories, since the upcoming Sugar on a Stick version as a spin will be part of Fedora's engineering process.
+ </para>
+ <note>
+ <title>Note</title>
+ <para>
+ Make sure to pull the appropriate branch from GIT if you want to build against one of the upcoming stable releases. Otherwise, you will checkout the latest moving contents from the repository.
+ </para>
+ </note>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Grab the configuration files by running: <command>git clone <replaceable>git://git.fedorahosted.org/spin-kickstarts.git</replaceable></command>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ You have taken the first step! You have downloaded all the required components and are now ready to learn how to customize Sugar on a Stick for your own purposes in the next chapter
+ </para>
+ </section>
+</chapter>
diff --git a/Customization Guide/en-US/Revision_History.xml b/Customization Guide/en-US/Revision_History.xml
new file mode 100644
index 0000000..2a97e68
--- /dev/null
+++ b/Customization Guide/en-US/Revision_History.xml
@@ -0,0 +1,39 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<appendix id="appe-Customization_Guide-Revision_History">
+ <title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>1</revnumber>
+ <date>Sun Mar 28 2010</date>
+ <author>
+ <firstname>Sebastian</firstname>
+ <surname>Dziallas</surname>
+ <email>sdz@sugarlabs.org</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Added more content for customizing locales and packages</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>0</revnumber>
+ <date>Sat Mar 20 2010</date>
+ <author>
+ <firstname>Sebastian</firstname>
+ <surname>Dziallas</surname>
+ <email>sdz@sugarlabs.org</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Initial creation of book by Publican</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ </revhistory>
+ </simpara>
+</appendix>
+
diff --git a/Customization Guide/en-US/Revision_History.xml~ b/Customization Guide/en-US/Revision_History.xml~
new file mode 100644
index 0000000..de70bc2
--- /dev/null
+++ b/Customization Guide/en-US/Revision_History.xml~
@@ -0,0 +1,25 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<appendix id="appe-Customization_Guide-Revision_History">
+ <title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>0</revnumber>
+ <date>Sat Mar 20 2010</date>
+ <author>
+ <firstname>Sebastian</firstname>
+ <surname>Dziallas</surname>
+ <email>sdz@sugarlabs.org</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Initial creation of book by Publican</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ </revhistory>
+ </simpara>
+</appendix>
+
diff --git a/Customization Guide/en-US/images/soas-blueberry.png b/Customization Guide/en-US/images/soas-blueberry.png
new file mode 100644
index 0000000..1a0f21f
--- /dev/null
+++ b/Customization Guide/en-US/images/soas-blueberry.png
Binary files differ
diff --git a/Customization Guide/en-US/images/sugar-thumbnail.png b/Customization Guide/en-US/images/sugar-thumbnail.png
new file mode 100644
index 0000000..4f684de
--- /dev/null
+++ b/Customization Guide/en-US/images/sugar-thumbnail.png
Binary files differ
diff --git a/Customization Guide/publican.cfg b/Customization Guide/publican.cfg
new file mode 100644
index 0000000..7c45529
--- /dev/null
+++ b/Customization Guide/publican.cfg
@@ -0,0 +1,7 @@
+# Config::Simple 4.59
+# Sat Mar 20 19:45:57 2010
+
+xml_lang: en-US
+type: Book
+brand: common
+