Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/Customization Guide/en-US/Customization.xml
blob: a57785fadfb00691d32a681a2cd1dc57b950afad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
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/system_config_keyboard/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>