[kde-doc-english] [gcompris/devel] doc: add admin manual converted from http://gcompris.net/wiki/Manual to docbook
Burkhard Lück
lueck at hube-lueck.de
Sat Mar 21 10:33:15 UTC 2015
Git commit f07eca6e46c3c603dd0d6541db6bb1f2f1a063a3 by Burkhard Lück.
Committed on 21/03/2015 at 10:30.
Pushed by lueck into branch 'devel'.
add admin manual converted from http://gcompris.net/wiki/Manual to docbook
REVIEW:122965
A +- -- doc/32px-About.png
A +- -- doc/32px-Button-exit.png
A +- -- doc/32px-Button-ok.png
A +- -- doc/32px-Config.png
A +- -- doc/32px-Help.png
A +- -- doc/32px-Home.png
A +- -- doc/32px-Level1.png
A +- -- doc/32px-Repeat.png
A +- -- doc/32px-difficulty_star1.png
A +- -- doc/32px-difficulty_star4.png
A +4 -0 doc/CMakeLists.txt
A +- -- doc/Stock_preferences_24.png
A +- -- doc/admin-activity.png
A +- -- doc/admin-class.png
A +- -- doc/admin-difficulty-filter.png
A +- -- doc/admin-group.png
A +- -- doc/admin-profil-edit.png
A +- -- doc/admin-report.png
A +- -- doc/gcompris-main-menu.png
A +774 -0 doc/index.docbook
A +- -- doc/login-list.png
A +- -- doc/login-text.png
A +- -- doc/missing-letter.png
A +- -- doc/reading-activity.png
http://commits.kde.org/gcompris/f07eca6e46c3c603dd0d6541db6bb1f2f1a063a3
diff --git a/doc/32px-About.png b/doc/32px-About.png
new file mode 100644
index 0000000..6c4811c
Binary files /dev/null and b/doc/32px-About.png differ
diff --git a/doc/32px-Button-exit.png b/doc/32px-Button-exit.png
new file mode 100644
index 0000000..4feea57
Binary files /dev/null and b/doc/32px-Button-exit.png differ
diff --git a/doc/32px-Button-ok.png b/doc/32px-Button-ok.png
new file mode 100644
index 0000000..e911eae
Binary files /dev/null and b/doc/32px-Button-ok.png differ
diff --git a/doc/32px-Config.png b/doc/32px-Config.png
new file mode 100644
index 0000000..7e67c65
Binary files /dev/null and b/doc/32px-Config.png differ
diff --git a/doc/32px-Help.png b/doc/32px-Help.png
new file mode 100644
index 0000000..3b6e29e
Binary files /dev/null and b/doc/32px-Help.png differ
diff --git a/doc/32px-Home.png b/doc/32px-Home.png
new file mode 100644
index 0000000..39c2295
Binary files /dev/null and b/doc/32px-Home.png differ
diff --git a/doc/32px-Level1.png b/doc/32px-Level1.png
new file mode 100644
index 0000000..4117e33
Binary files /dev/null and b/doc/32px-Level1.png differ
diff --git a/doc/32px-Repeat.png b/doc/32px-Repeat.png
new file mode 100644
index 0000000..dba6dd3
Binary files /dev/null and b/doc/32px-Repeat.png differ
diff --git a/doc/32px-difficulty_star1.png b/doc/32px-difficulty_star1.png
new file mode 100644
index 0000000..94ffa51
Binary files /dev/null and b/doc/32px-difficulty_star1.png differ
diff --git a/doc/32px-difficulty_star4.png b/doc/32px-difficulty_star4.png
new file mode 100644
index 0000000..7915b53
Binary files /dev/null and b/doc/32px-difficulty_star4.png differ
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
new file mode 100644
index 0000000..a941336
--- /dev/null
+++ b/doc/CMakeLists.txt
@@ -0,0 +1,4 @@
+########### install files ###############
+#
+#
+kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR gcompris-qt)
diff --git a/doc/Stock_preferences_24.png b/doc/Stock_preferences_24.png
new file mode 100644
index 0000000..0daad3c
Binary files /dev/null and b/doc/Stock_preferences_24.png differ
diff --git a/doc/admin-activity.png b/doc/admin-activity.png
new file mode 100644
index 0000000..556c707
Binary files /dev/null and b/doc/admin-activity.png differ
diff --git a/doc/admin-class.png b/doc/admin-class.png
new file mode 100644
index 0000000..7d2c281
Binary files /dev/null and b/doc/admin-class.png differ
diff --git a/doc/admin-difficulty-filter.png b/doc/admin-difficulty-filter.png
new file mode 100644
index 0000000..4ae773b
Binary files /dev/null and b/doc/admin-difficulty-filter.png differ
diff --git a/doc/admin-group.png b/doc/admin-group.png
new file mode 100644
index 0000000..6ca9e14
Binary files /dev/null and b/doc/admin-group.png differ
diff --git a/doc/admin-profil-edit.png b/doc/admin-profil-edit.png
new file mode 100644
index 0000000..042094b
Binary files /dev/null and b/doc/admin-profil-edit.png differ
diff --git a/doc/admin-report.png b/doc/admin-report.png
new file mode 100644
index 0000000..e218956
Binary files /dev/null and b/doc/admin-report.png differ
diff --git a/doc/gcompris-main-menu.png b/doc/gcompris-main-menu.png
new file mode 100644
index 0000000..d6aa091
Binary files /dev/null and b/doc/gcompris-main-menu.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
new file mode 100644
index 0000000..112fa43
--- /dev/null
+++ b/doc/index.docbook
@@ -0,0 +1,774 @@
+<?xml version="1.0" ?>
+<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
+ <!-- Define an entity for your application if it is not part of KDE
+ Git -->
+ <!ENTITY gcompris "<application>GCompris</application>">
+ <!ENTITY kappname "&gcompris;"><!-- replace kmyapplication here
+ do *not* replace kappname-->
+ <!ENTITY % addindex "IGNORE">
+ <!ENTITY % English "INCLUDE"> <!-- ONLY If you are writing non-English
+ original documentation, change
+ the language here -->
+
+ <!-- Do not define any other entities; instead, use the entities
+ from entities/general.entities and en/user.entities. -->
+]>
+<book id="gcompris" lang="&language;">
+
+<bookinfo>
+<title>The &gcompris; Administration Handbook</title>
+
+<authorgroup>
+<author>
+<personname>
+<firstname>This documentation was converted from the
+<ulink url="http://gcompris.net/wiki/Manual">&gcompris; Manual</ulink>
+page.</firstname>
+<surname></surname>
+</personname>
+</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<legalnotice>&FDLNotice;</legalnotice>
+
+<!-- Date of the documentation
+Don't forget to include this last date.
+Please respect the format of the date (YYYY-MM-DD),it is used by scripts.
+-->
+<date>2015-03-14</date>
+
+<!--version information of the application and kde this documentation is valid for.
+for example 'xx.yy.zz'
+-->
+<releaseinfo>0.30</releaseinfo>
+
+<!-- Abstract about this handbook -->
+
+<abstract>
+<para>
+&gcompris; is a multi-activity educational software.
+</para>
+</abstract>
+
+<keywordset>
+<keyword>KDE</keyword>
+<keyword>education</keyword>
+<keyword>children</keyword>
+<keyword>games</keyword>
+</keywordset>
+
+</bookinfo>
+
+<chapter id="administration-handbook">
+<title>Administration Handbook</title>
+
+<sect1 id="introduction">
+<title>Introduction</title>
+<para>&gcompris; is a completely free educational software suite which contains a wide range of activities.</para>
+<para>It offers various activities aimed at covering a variety of fields such as the functioning of the computer,
+using the mouse and keyboard, general learning, reading, writing, foreign languages, algebra, as well as various
+activities such as memory and logic games, scientific experiments &etc;.</para>
+<para>In &gcompris; you will find many individual software packages which together make up the complete &gcompris;
+suite of activities. Unfortunately, it is difficult to follow and maintain them as each one offers different
+graphic interfaces which vary widely in quality.</para>
+<para>The purpose of &gcompris; is to provide a development platform for educational activities.</para>
+<para>&gcompris; is part of &GNU; project and is placed under the <ulink url="http://www.gnu.org/licenses/gpl.html">GPL license</ulink>.</para>
+</sect1>
+
+<sect1 id="minimal-configuration">
+<title>Minimal configuration</title>
+<itemizedlist>
+<listitem><para>Processor : Pentium 3 500Mhz</para></listitem>
+<listitem><para>Memory (RAM) : 512 Mega Bytes</para></listitem>
+<listitem><para>Disk : 400 Mega Bytes</para></listitem>
+<listitem><para>Operating system : &GNU;/&Linux;, &BSD;, MacOSX, &Windows;</para></listitem>
+<listitem><para>Video : A 3D card is <emphasis>not</emphasis> required. 32 bits color depth mandatory</para></listitem>
+</itemizedlist>
+</sect1>
+
+<sect1 id="installation">
+<title>Installation</title>
+<para>The software is delivered under several forms. Follow the process according to your case. </para>
+<itemizedlist>
+<listitem><para>&GNU;/&Linux; : Use the packages delivered by your &GNU;/&Linux; distribution. You may have to install
+the package gcompris-sound-en to have the english voices. If &gcompris; is not packaged in your &Linux; distribution,
+please contact them to ask for the inclusion of &gcompris; in your &Linux; distribution.</para></listitem>
+<listitem><para>&Windows; : Delivered under a classic installer for &Windows;. This version requires an activation code. </para></listitem>
+<listitem><para>MacOSX : Delivered under a classic installer. This version requires an activation code.</para></listitem>
+</itemizedlist>
+</sect1>
+
+<sect1 id="user-interface">
+<title>The User Interface</title>
+<para>The interface is designed for easy use by small children. &gcompris; is controlled with a mouse,
+it cannot be used without a mouse or a pointing system.</para>
+
+<sect2 id="main-window">
+<title>Main window</title>
+<para>When you start the program, &gcompris; shows a graphic interface which presents the list of activities
+with a control bar at the bottom.</para>
+<screenshot>
+<screeninfo>Here's a screenshot of &gcompris; Main Window</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="gcompris-main-menu.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>&gcompris; Main Window</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+
+<para>Each icon represents an activity. When the mouse is set on it, the activity is highlighted and the name,
+description and author of the activity are displayed in the description area.</para>
+<para>Around each one, you can find small icons which give additional information about the activity.
+A simple click on the icon will lead you to an activity or a menu of activities.</para>
+<para>An icon indicates if a functioning sound system is required for an activity:</para>
+<itemizedlist>
+<listitem><para>Soundspeaker : The audio files are included for this activity.</para></listitem>
+<listitem><para>Soundspeaker with a red cross : The audio files are not installed in the present language.</para></listitem>
+</itemizedlist>
+<para>The stars indicates the age group for which each game is designed:</para>
+<itemizedlist>
+<listitem><para><inlinemediaobject><imageobject><imagedata fileref="32px-difficulty_star1.png" format="PNG"/></imageobject>
+</inlinemediaobject>1, 2 or 3 stars - for 2 to 6 years old.</para></listitem>
+<listitem><para><inlinemediaobject><imageobject><imagedata fileref="32px-difficulty_star4.png" format="PNG"/></imageobject>
+</inlinemediaobject>1, 2 or 3 complex stars - greater than 6 years old.</para></listitem>
+</itemizedlist>
+
+<para>At the bottom of the screen there is a control bar for &gcompris;. The following icons are described below from
+the right to the left (the icons are only displayed if they are available in the activity):</para>
+<itemizedlist>
+<listitem><para><inlinemediaobject><imageobject><imagedata fileref="32px-Home.png" format="PNG"/></imageobject>
+</inlinemediaobject> Home - Leaves the current activity, returns to the previous menu.</para></listitem>
+<listitem><para><inlinemediaobject><imageobject><imagedata fileref="32px-Button-ok.png" format="PNG"/></imageobject>
+</inlinemediaobject> Thumb - Validate, confirm your answer. Some activities do not detect automatically whether or
+not the child has completed the task. In this case, you have to click on this icon. You can also use the &Enter;
+key on your keyboard.</para></listitem>
+<listitem><para><inlinemediaobject><imageobject><imagedata fileref="32px-Level1.png" format="PNG"/></imageobject>
+</inlinemediaobject> Die - The present level is displayed. Click on the die to select another level.
+Generally, the activities offer several levels whose numbers depend on the activity.
+In &gcompris;, it is possible to go to the next level without having completed the current level.</para></listitem>
+<listitem><para><inlinemediaobject><imageobject><imagedata fileref="32px-Repeat.png" format="PNG"/></imageobject>
+</inlinemediaobject> Lips - Ask &gcompris; to repeat the question.</para></listitem>
+<listitem><para><inlinemediaobject><imageobject><imagedata fileref="32px-Help.png" format="PNG"/></imageobject>
+</inlinemediaobject> Question mark - Display the help dialog box. Sometimes, an activity can be too complex
+to be described easily in the description area. In this case, this function gives access to additional information.</para></listitem>
+<listitem><para><inlinemediaobject><imageobject><imagedata fileref="32px-Config.png" format="PNG"/></imageobject>
+</inlinemediaobject> Tool box - Configuration menu. The configuration is saved in the user repository(Folder)
+under the name <filename>.config/gcompris/gcompris.conf</filename>. This is a text file which can be edited manually.</para></listitem>
+<listitem><para><inlinemediaobject><imageobject><imagedata fileref="32px-About.png" format="PNG"/></imageobject>
+</inlinemediaobject> Tux and his plane - Information box on &gcompris;, presents the main contributors and the version of the software.</para></listitem>
+<listitem><para><inlinemediaobject><imageobject><imagedata fileref="32px-Button-exit.png" format="PNG"/></imageobject>
+</inlinemediaobject> Night - Quit &gcompris;. You can also use the short cut on your keyboard
+<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></para></listitem>
+</itemizedlist>
+</sect2>
+
+<sect2 id="kiosk-mode">
+<title>Kiosk Mode</title>
+<para>When you use &gcompris; with small children or on a self-service kiosk, you can disable a certain number of options:</para>
+<itemizedlist>
+<listitem><para><userinput><command>gcompris --disable-quit</command></userinput> : disable the <guiicon>Quit</guiicon> button.</para></listitem>
+<listitem><para><userinput><command>gcompris --disable-config</command></userinput> : disable the <guiicon>Configuration</guiicon> button</para></listitem>
+<listitem><para><userinput><command>gcompris --disable-level</command></userinput> : disable the <guiicon>Level</guiicon> button</para></listitem>
+</itemizedlist>
+<para>These options can of course be combined.</para>
+</sect2>
+
+<sect2 id="keyboard-shortcuts">
+<title>Keyboard Shortcuts</title>
+<informaltable>
+<tgroup cols="2">
+<tbody>
+<row>
+<entry>Shortcut</entry>
+<entry>Action</entry>
+</row>
+<row>
+<entry>&Esc; or <keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo></entry>
+<entry>Quit the current activity or dialog then return to the main menu</entry>
+</row>
+<row>
+<entry><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></entry>
+<entry>Quit &gcompris; without further notice</entry>
+</row>
+<row>
+<entry><keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo></entry>
+<entry>Toggle fullscreen mode</entry>
+</row>
+<row>
+<entry><keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo></entry>
+<entry>Toggle sound mute</entry>
+</row>
+<row>
+<entry><keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo></entry>
+<entry>Display or Hide the control bar</entry>
+</row>
+</tbody>
+</tgroup>
+</informaltable>
+</sect2>
+
+</sect1>
+
+<sect1 id="internationalization">
+<title>Notes on Internationalization</title>
+<para>&gcompris; is internationalized and is available in more than 50 languages. If you want
+to check if your language is available, you can start &gcompris; and select your language in
+the option of configuration.</para>
+<para>Be careful, your operating system must support your language so that &gcompris; can use it.
+If you find a red cross while selecting a language in &gcompris;, this means that your system does not
+support it, even if a translation is available in &gcompris;.</para>
+<para>On &GNU;/&Linux;, if your language is not available, select another language support on your
+distribution to add it. In most cases, you have to install an additional package 'locale-xx' or
+'language-pack-xx' - xx is a language code such as 'En' for English. </para>
+<para>If your language is not supported, you can contribute to the software and add the
+translation of your language. If you are interested, you can contact the
+<ulink url="http://l10n.kde.org/teams">translation team</ulink> of
+the &kde; project for your language. You can check the level of translation for your language on
+the <ulink url="http://l10n.kde.org/">&kde; translation web site</ulink>.</para>
+</sect1>
+
+<sect1 id="learning-language">
+<title>Language learning</title>
+<para>You can use &gcompris; in a foreign language that you are learning. Select a foreign language
+in the configuration menu. Do not forget to install the optional audio modules for this language in
+your &GNU;/&Linux; distribution.</para>
+<para>&Windows; version is provided with all audio support that are available. Whilst using &gcompris;
+in another language it is possible to configure some activities more precisely using the audio set
+through the administration module.</para>
+</sect1>
+
+<sect1 id="customizing-activities">
+<title>Customizing activities</title>
+<para>Control Panels allow you to enrich the lexical content of activities to make them fit your needs.
+In the activities of reading or math, you can add your own lists of words or numbers, and thus adapt
+the content of the activity to your curriculum.</para>
+<screenshot>
+<screeninfo>Missing Letter</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="missing-letter.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Missing Letter</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+<para>Configuration table of the activity of vertical reading:</para>
+<screenshot>
+<screeninfo>Vertical Reading</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="reading-activity.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Vertical Reading</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+<itemizedlist>
+<listitem><para>Default: Indicates the default language of the activity that can be changed.</para></listitem>
+<listitem><para>Language: selects the language of the word list.</para></listitem>
+<listitem><para>Level: indicates the level of difficulty and allows the display of lists that
+you can complete and / or modify.</para></listitem>
+</itemizedlist>
+</sect1>
+
+<sect1 id="administering-gcompris">
+<title>Administering &gcompris;</title>
+<para>&gcompris; contains a very powerful administration module to assist in simplifying its use in schools.
+This module was designed to satisfy the many different ways of using &gcompris; in as simple a way as possible.</para>
+
+<sect2 id="activity-selection">
+<title>Activity selection</title>
+<para>&gcompris; currently offers nearly a hundred different activities. It is not always sensible to offer
+all of the activities to children at once. One approach could be the introduction of the activities little
+by little as the children develop their skills. This will keep their curiosity alive and will avoid them
+loosing time doing activities which may be too complex for them.</para>
+
+<para>There are two different ways of selecting the activities:</para>
+
+<itemizedlist>
+<listitem>
+<screenshot>
+<screeninfo>Select an Activity by Level</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="admin-difficulty-filter.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Select an Activity by Level</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+<para>By levels or intervals of levels. In this case, you use &gcompris;'levels (1 to 6 stars),
+You can choose a specific level such as 1 star, or an interval of levels - from 2 to 4 stars -.</para></listitem>
+<listitem>
+<screenshot>
+<screeninfo>Select Activities</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="admin-activity.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Select Activities</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+<para>By activity. In this mode, you can tick or tick out each activity or all the activities
+of a same section.</para></listitem>
+</itemizedlist>
+</sect2>
+
+<sect2 id="profile-creation">
+<title>Profile Creation</title>
+<para>A profile permits the creation of a behavior model of &gcompris; under a unique name. It is possible
+to create profiles without any links to users, groups or class.</para>
+<screenshot>
+<screeninfo>Select Activities</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="admin-profil-edit.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Select Activities</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+<para>If you want to use &gcompris; with children of different age groups, you can create a profile for each one.
+For each profile, you will be able to associate a set of activities.</para>
+<para>For instance, it is possible to create a profile 'grade 1' or a profile 'grade 2'.
+To launch the administration module, find the start menu on your desktop or on a command line with
+<userinput><command>gcompris -a</command></userinput>.</para>
+
+<sect3 id="using-profile">
+<title>Using a Profile</title>
+<para>Start &gcompris; with the option --profile 'my profile':</para>
+<para><userinput><command>gcompris --profile <replaceable>cycle 1</replaceable></command></userinput> </para>
+<para>To get the list of existing profiles:</para>
+<para><userinput><command>gcompris --profile-list</command></userinput> </para>
+<para>Of course to simplify the start of &gcompris; in a particular profile, the easiest is to create a new launcher
+for your desktop and to associate it to a command that include the correct options.</para>
+</sect3>
+
+</sect2>
+
+<sect2 id="activity-configuration">
+<title>Activity Configuration</title>
+<para>The profiles exist mainly to specify a list of activities but you can also personalize the behavior
+of each one whenever it is possible within the activity.</para>
+<para>The activities marked with an icon <inlinemediaobject><imageobject>
+<imagedata fileref="Stock_preferences_24.png" format="PNG"/></imageobject>
+</inlinemediaobject> can be directly configured in the administration module.
+For example, You can configure some activities to function in English.</para>
+</sect2>
+
+<sect2 id="user-class-creation">
+<title>User and Class Creation</title>
+<para>If you want to set up a personalized recording system, you can create a user profile for each pupil.</para>
+<screenshot>
+<screeninfo>Classes and Users</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="admin-class.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Classes and Users</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+<para>This option will permit them to enter their 'user name' when they start &gcompris;. &gcompris; will then
+record a list of activities the pupil has attempted and show whether or not the pupil has completed it.
+&gcompris; is very flexible, you can group all the pupils in the default class if you don't use &gcompris;
+in several classes. You can also create classes without mentioning pupils. It will give you the possibility
+to define profiles for your classes.</para>
+</sect2>
+
+<sect2 id="groups-creation">
+<title>Groups Creation</title>
+<para>A group is a number of pupils from different classes. It is an optional function, you can use &gcompris;,
+create users and define profiles without creating any groups.</para>
+<screenshot>
+<screeninfo>Creating Groups</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="admin-group.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Creating Groups</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+<para>The creation of groups will help you if your functioning mode is based on user groups which are composed of
+small groups of classes but also of groups of children from the same class or even of children who have not
+been associated to a class.</para>
+</sect2>
+
+<sect2 id="reporting">
+<title>Reporting</title>
+<para>Each activity lets appear a bonus image when the child has accomplished it or not. &gcompris; keeps
+in its internal base all the results for each child or for the default user.</para>
+<screenshot>
+<screeninfo>Trace Usage</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="admin-report.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Trace Usage</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+<para>You can display the results for all the pupils or for one in particular. A button allows you to erase
+all the records.</para>
+</sect2>
+
+<sect2 id="identification">
+<title>Identification</title>
+<para>If you have created user profiles in &gcompris;, and you start &gcompris; with a profile, a 'Log-in'
+screen will appear.</para>
+<para>There are two identification modes: a 'list' mode where you have to find your name from a list of names.</para>
+<screenshot>
+<screeninfo>Children recognize their name and click on it</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="login-list.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Children recognize their name and click on it</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+<para>This mode can encourage the child read his name.</para>
+<para>The second mode asks the child to enter his name.</para>
+<screenshot>
+<screeninfo>Children enter their login name</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="login-text.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Children enter their login name</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+<para>It can help the child learn how to use the keyboard.</para>
+</sect2>
+
+<sect2 id="networking-ultiple-sers">
+<title>Networking / Multiple Users</title>
+<para>If you administer a school network, you can overwrite the configuration options of your users with
+your own configuration. The instructions bellows apply to a single system on which you want to share the
+configuration between several users or for different users on multiple computers. In the last case, you
+need to put the configuration files on a networked partition.</para>
+<para>&gcompris; uses 2 distinct files for its configuration:</para>
+<itemizedlist>
+<listitem><para>The file <filename>gcompris.conf</filename> (configuration) contains
+end user specific choices like sound and screen preference.</para></listitem>
+<listitem><para>The file <filename>gcompris.db</filename> (database) contains:
+<itemizedlist>
+<listitem><para>The list of all the activities and their menu position.</para></listitem>
+<listitem><para>The user log, what activity was played, at what time and was it successful.</para></listitem>
+<listitem><para>The users, classes, groups and profiles.</para></listitem>
+<listitem><para>The configuration of each activity.</para></listitem>
+</itemizedlist>
+</para></listitem>
+</itemizedlist>
+<para>To edit a configuration file, the easiest way is to create one from &gcompris;. Simply configure &gcompris;
+as you wish, quit it and copy the created configuration file into the system one. From it, you can then
+remove the options that you don't want to be compulsory.</para>
+<para>Configuration file example:</para>
+<screen>music=1
+fx=1
+screensize=1
+fullscreen=1
+timer=1
+key="default"</screen>
+
+<sect3 id="gnu-linux">
+<title>&GNU; / &Linux;</title>
+<para>On &GNU;/&Linux;, the configuration file is in the user directory under <filename class="directory">~/.config/gcompris/gcompris.conf</filename> </para>
+<para>To make the configuration global to all the users:</para>
+<itemizedlist>
+<listitem><para>You can copy your configuration file to <filename class="directory">/etc/gcompris.conf</filename></para></listitem>
+<listitem><para>You can run &gcompris; with the <userinput><option>--config</option></userinput> option
+passing it a fully qualified path to a file</para></listitem>
+</itemizedlist>
+<para>To make all users using the same database, run &gcompris; with <userinput><option>--database</option></userinput>
+option passing it a file on a local directory or a networked folder. The users must have read and write access to this file.</para>
+<para>You can create a desktop launcher for the children and pass in it the options you need
+(<userinput><option>--config</option></userinput> and/or <userinput><option>--database</option></userinput>).</para>
+<para>
+You can create another desktop launcher for the teacher. It must include the <userinput><option>--administration</option></userinput>
+option and the <userinput><option>--database</option></userinput> option that points to your database.</para>
+</sect3>
+
+<sect3 id="windows-xp-2000">
+<title>&Windows; XP / 2000</title>
+<para>On &Windows; XP, the configuration file is in <filename class="directory">C:\Documents and Settings\YOUR USER\.config\gcompris\gcompris.conf</filename> </para>
+<para>To make the configuration global to all the users:</para>
+<itemizedlist>
+<listitem><para>You can copy your configuration file to <filename class="directory">C:\Program Files\gcompris</filename> directory</para></listitem>
+<listitem><para>You can run &gcompris; with the <userinput><option>--config</option></userinput> option passing it a fully qualified path to a file</para></listitem>
+</itemizedlist>
+<para>To make all users using the same database, run &gcompris; with <userinput><option>--database</option></userinput>
+option passing it a file on a local directory or a networked folder. The users must have read and write access to this file.</para>
+<para>You can create a desktop launcher for the children and pass in it the options you need
+(<userinput><option>--config</option></userinput> and/or <userinput><option>--database</option></userinput>).
+Here's an example:</para>
+<para><userinput><command>"C:\Program Files\Gcompris\gcompris.exe" -b C:\Documents and Settings\All Users\gcconfig\gc.db</command></userinput></para>
+<para>You can create another desktop launcher for the teacher. It must include the <userinput><option>--administration</option></userinput> option and
+the <userinput><option>--database</option></userinput> that points to your database. Here's an example:</para>
+<para><userinput><command>"C:\Program Files\Gcompris\gcompris.exe" -a -b C:\Documents and Settings\All Users\gcconfig\gc.db </command></userinput></para>
+<note><para>Due to a bug in XP, there is a possibility that users with limited access will not be able
+to write to the database. If this is happening to you, you will need to make those users to have administrator access.</para></note>
+</sect3>
+
+<sect3 id="windows-vista-7">
+<title>&Windows; Vista / 7</title>
+<para>On &Windows; Vista & 7, the configuration file is in <filename class="directory">C:\User\YOUR USER\.config\gcompris\gcompris.conf</filename>,</para>
+<para>To make the configuration global to all the users:</para>
+<itemizedlist>
+<listitem><para>You can copy your configuration file to <filename class="directory">C:\Program Files\gcompris</filename>
+directory or <filename class="directory">C:\Program Files (x86)\Gcompris</filename>.
+</para></listitem>
+<listitem><para>
+You can run &gcompris; with the <userinput><option>--config</option></userinput> option passing it a fully qualified path to a file</para></listitem>
+</itemizedlist>
+<para>To make all users using the same database, run &gcompris; with <userinput><option>--database</option></userinput> option passing it a file on a
+local directory or a networked folder. The users must have read and write access to this file.</para>
+<para>You can create a desktop launcher for the children and pass in it the options you need (<userinput><option>--config</option></userinput>
+and/or <userinput><option>--database</option></userinput>). Here's an example:</para>
+<para><userinput><command>"C:\Program Files\Gcompris\gcompris.exe" -b C:\Users\Public\gcconfig\gc.db</command></userinput></para>
+<para>You can create another desktop launcher for the teacher. It must include the <userinput><option>--administration</option></userinput> option and
+the <userinput><option>--database</option></userinput> option that points to your database. Here's an example:</para>
+<para><userinput><command>"C:\Program Files\Gcompris\gcompris.exe" -a -b C:\Users\Public\gcconfig\gc.db</command></userinput></para>
+</sect3>
+
+<sect3 id="activation-key">
+<title>Activation Key</title>
+<para>On &Windows;, it makes sense to put at least the line <userinput>key="your 6 digit key"</userinput> in a shared configuration
+file. This way, all users on this PC won't have to activate &gcompris;.</para>
+<para>On school networks, you can simply copy this file using your deployment system.</para>
+<para>Finally, the last step is to move the <guiicon>Gcompris Admin</guiicon> desktop icon from the
+<filename class="directory">All Users</filename> or <filename class="directory">Public</filename> desktop
+folder to the user's desktop folder that will be administering Gcompris. Make sure this user has &Windows; admin rights.</para>
+</sect3>
+
+</sect2>
+
+<sect2 id="portable-gcompris">
+<title>Portable &gcompris;</title>
+<para><ulink url="http://en.wikipedia.org/wiki/Portable_apps">Portable software</ulink> is a class of software that is suitable for use on portable drives such as a
+USB (thumb) drive or iPod, although any external hard drive could theoretically be used.
+The concept of carrying one's favored applications, utilities, and files on a portable drive for
+use on any computer is one which has evolved considerably in recent years.</para>
+<para>&gcompris; can be made portable very easily by installing it on the target thumb drive and adding
+in its directory a <filename>gcompris.conf</filename> configuration file which includes a local user and configuration
+directory. The directory are specified as relative to the gcompris.exe binary. </para>
+<para>Configuration file example:</para>
+<screen>
+user_dir="../My &gcompris;"
+config_dir="../&gcompris;_config"
+key="your 6 digit key if you have it"</screen>
+</sect2>
+
+</sect1>
+
+<sect1 id="console-switches">
+<title>Console Switches</title>
+<para>Running &gcompris; from a command console with the --help option will display all the parameters it accepts:</para>
+<informaltable>
+<tgroup cols="2">
+<tbody>
+<row>
+<entry>-f, --fullscreen</entry>
+<entry>Run &gcompris; in fullscreen mode</entry>
+</row>
+<row>
+<entry>-w, --window</entry>
+<entry>Run &gcompris; in window mode</entry>
+</row>
+<row>
+<entry>-s, --sound</entry>
+<entry>Run &gcompris; with sound enabled</entry>
+</row>
+<row>
+<entry>-m, --mute</entry>
+<entry>Run &gcompris; without sound</entry>
+</row>
+<row>
+<entry>-c, --cursor</entry>
+<entry>Run &gcompris; with the default system cursor</entry>
+</row>
+<row>
+<entry>-C, --nocursor</entry>
+<entry>Run &gcompris; without cursor (touch screen mode)</entry>
+</row>
+<row>
+<entry>--d, --difficulty</entry>
+<entry>Display only activities with this difficulty level</entry>
+</row>
+<row>
+<entry> -D, --debug</entry>
+<entry>Display debug information on the console</entry>
+</row>
+<row>
+<entry>-v, --version</entry>
+<entry>Print the version of &gcompris;</entry>
+</row>
+<row>
+<entry>-l, --root-menu</entry>
+<entry>Run &gcompris; with local menu (e.g -l /reading will let you play only activities in the reading directory,
+-l /strategy/connect4 only the connect4 activity). Use '-l list' to list all the available activities and their descriptions</entry>
+</row>
+<row>
+<entry>-A, --package_data_dir</entry>
+<entry>&gcompris; will find the data dir in this directory</entry>
+</row>
+<row>
+<entry>-S, --package_skin_dir</entry>
+<entry>&gcompris; will find the skins in this directory</entry>
+</row>
+<row>
+<entry>-L, --plugin_dir</entry>
+<entry>&gcompris; will find the activity plugins in this directory</entry>
+</row>
+<row>
+<entry>-P, --python_plugin_dir</entry>
+<entry>&gcompris; will find the python activity in this directory</entry>
+</row>
+<row>
+<entry>--locale_dir</entry>
+<entry>&gcompris; will find the locale file (.mo translation) in this directory</entry>
+</row>
+<row>
+<entry>-M, --menu_dir</entry>
+<entry>&gcompris; will find the activities menu in this directory</entry>
+</row>
+<row>
+<entry>-a, --administration</entry>
+<entry>Run &gcompris; in administration and user-management mode</entry>
+</row>
+<row>
+<entry>-b, --database</entry>
+<entry>Use alternate database for profiles [<filename class="directory"><envar>$HOME</envar>/.config/gcompris/gcompris_sqlite.db</filename>]</entry>
+</row>
+<row>
+<entry>--create-db</entry>
+<entry>Create the alternate database for profiles</entry>
+</row>
+<row>
+<entry>--reread-menu</entry>
+<entry>Re-read &XML; Menus and store them in the database</entry>
+</row>
+<row>
+<entry>-p, --profile</entry>
+<entry>Set the profile to use. Use <userinput><command>gcompris -a</command></userinput> to create profiles</entry>
+</row>
+<row>
+<entry>--profile-list</entry>
+<entry>List all available profiles. Use <userinput><command>gcompris -a</command></userinput> to create profiles</entry>
+</row>
+<row>
+<entry>--config-dir</entry>
+<entry>Config directory location: [<filename class="directory"><envar>$HOME</envar>/.config/gcompris</filename>].
+Alternate is to set <envar>$XDG_CONFIG_HOME</envar></entry>
+</row>
+<row>
+<entry>--user-dir</entry>
+<entry>The location of user directories: [<filename class="directory"><envar>$HOME</envar>/My gcompris</filename>]</entry>
+</row>
+<row>
+<entry>--experimental</entry>
+<entry>Run the experimental activities</entry>
+</row>
+<row>
+<entry>--disable-quit</entry>
+<entry>Disable the quit button</entry>
+</row>
+<row>
+<entry>--disable-config</entry>
+<entry>Disable the config button</entry>
+</row>
+<row>
+<entry>-g, --drag-mode</entry>
+<entry>Global drag and drop mode: normal, 2clicks, both. Default mode is normal</entry>
+</row>
+<row>
+<entry>--nolockcheck</entry>
+<entry>Do not avoid the execution of multiple instances of &gcompris;</entry>
+</row>
+<row>
+<entry>--no-zoom</entry>
+<entry>Disable maximization zoom</entry>
+</row>
+<row>
+<entry>--timing-base</entry>
+<entry>Increase activities timeout delays; useful values < 1.0; 1.0 to not change hardcoded value</entry>
+</row>
+<row>
+<entry>--timing-mult</entry>
+<entry>How activities timeout delays are growing for several actors; useful values < 1.0; 1.0 to not change hardcoded value</entry>
+</row>
+</tbody>
+</tgroup>
+</informaltable>
+
+<sect2 id="windows-example">
+<title>&Windows; Example</title>
+<para>You can add these switches in the desktop icon properties. Here is an example that runs &gcompris; in kiosk mode in full screen given a specific database:</para>
+<para><userinput><command>"C:\Program Files\Gcompris\gcompris.exe" -b C:\Users\Public\gcconfig\gc.db --disable-quit --disable-config -f</command></userinput></para>
+</sect2>
+
+<sect2 id="gnu-linux-example">
+<title>&GNU;/&Linux; Example</title>
+<para>Create an application launcher and configure the command line parameters. Here is an example that runs &gcompris; in kiosk mode in full screen given a specific database:</para>
+<para><userinput><command>gcompris -b /etc/gcompris/gc.db --disable-quit --disable-config -f</command></userinput></para>
+</sect2>
+
+</sect1>
+
+</chapter>
+<chapter id="credits">
+
+<title>Credits and License</title>
+
+<para>
+&gcompris;
+</para>
+<para>
+Program copyright 2000-2015 Bruno Coudoin and others
+</para>
+
+<para>
+Documentation Copyright see the
+<ulink url="http://gcompris.net/mediawiki-1.22.0/index.php?title=Manual&action=history">Manual page history</ulink>
+</para>
+
+<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
+
+&underFDL; <!-- FDL: do not remove -->
+
+&underGPL; <!-- GPL License -->
+
+</chapter>
+
+&documentation.index;
+</book>
+
+<!--
+Local Variables:
+mode: xml
+sgml-minimize-attributes:nil
+sgml-general-insert-case:lower
+sgml-indent-step:0
+sgml-indent-data:nil
+End:
+
+vim:tabstop=2:shiftwidth=2:expandtab
+kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;
+-->
diff --git a/doc/login-list.png b/doc/login-list.png
new file mode 100644
index 0000000..4761e41
Binary files /dev/null and b/doc/login-list.png differ
diff --git a/doc/login-text.png b/doc/login-text.png
new file mode 100644
index 0000000..0896361
Binary files /dev/null and b/doc/login-text.png differ
diff --git a/doc/missing-letter.png b/doc/missing-letter.png
new file mode 100644
index 0000000..5e7e412
Binary files /dev/null and b/doc/missing-letter.png differ
diff --git a/doc/reading-activity.png b/doc/reading-activity.png
new file mode 100644
index 0000000..749baee
Binary files /dev/null and b/doc/reading-activity.png differ
More information about the kde-doc-english
mailing list