Git commit b07918a92c27ce49901cc2dacdcbb2928d84f442 by Johnny Jazeix. Committed on 29/08/2020 at 19:18. Pushed by jjazeix into branch 'master'.
docs, update docbook A +- -- docs/docbook/activity-config.png A +133 -0 docs/docbook/bar_activity_config.svg A +109 -0 docs/docbook/bar_hint.svg A +105 -0 docs/docbook/bar_reload.svg A +- -- docs/docbook/dataset.png M +- -- docs/docbook/gcompris-main-menu.png M +72 -69 docs/docbook/index.docbook D +- -- docs/docbook/traffic-select-mode.png M +19 -17 docs/manual-general https://invent.kde.org/education/gcompris/commit/b07918a92c27ce49901cc2dacdcbb2928d84f442 diff --git a/docs/docbook/activity-config.png b/docs/docbook/activity-config.png new file mode 100644 index 000000000..3c0786012 Binary files /dev/null and b/docs/docbook/activity-config.png differ diff --git a/docs/docbook/bar_activity_config.svg b/docs/docbook/bar_activity_config.svg new file mode 100644 index 000000000..4796ae054 --- /dev/null +++ b/docs/docbook/bar_activity_config.svg @@ -0,0 +1,133 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> + +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/"; + xmlns:cc="http://creativecommons.org/ns#"; + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"; + xmlns:svg="http://www.w3.org/2000/svg"; + xmlns="http://www.w3.org/2000/svg"; + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"; + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"; + sodipodi:docname="bar_activity_config.svg" + inkscape:version="0.92.4 (5da689c313, 2019-01-14)" + version="1.1" + id="svg4211" + height="66" + width="66"> + <defs + id="defs4213" /> + <sodipodi:namedview + id="base" + pagecolor="#9b9b9b" + bordercolor="#666666" + borderopacity="1.0" + inkscape:pageopacity="0" + inkscape:pageshadow="2" + inkscape:zoom="3.959798" + inkscape:cx="-14.333882" + inkscape:cy="33.253216" + inkscape:document-units="px" + inkscape:current-layer="layer1" + showgrid="true" + fit-margin-top="0" + fit-margin-left="0" + fit-margin-right="0" + fit-margin-bottom="0" + inkscape:window-width="1884" + inkscape:window-height="1051" + inkscape:window-x="0" + inkscape:window-y="0" + inkscape:window-maximized="1"> + <inkscape:grid + id="grid815" + type="xygrid" + empspacing="6" /> + </sodipodi:namedview> + <metadata + id="metadata4216"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage"; /> + <dc:title></dc:title> + <dc:date>2019</dc:date> + <dc:creator> + <cc:Agent> + <dc:title>Timothée Giet</dc:title> + </cc:Agent> + </dc:creator> + <cc:license + rdf:resource="http://creativecommons.org/licenses/by-sa/4.0/"; /> + </cc:Work> + <cc:License + rdf:about="http://creativecommons.org/licenses/by-sa/4.0/";> + <cc:permits + rdf:resource="http://creativecommons.org/ns#Reproduction"; /> + <cc:permits + rdf:resource="http://creativecommons.org/ns#Distribution"; /> + <cc:requires + rdf:resource="http://creativecommons.org/ns#Notice"; /> + <cc:requires + rdf:resource="http://creativecommons.org/ns#Attribution"; /> + <cc:permits + rdf:resource="http://creativecommons.org/ns#DerivativeWorks"; /> + <cc:requires + rdf:resource="http://creativecommons.org/ns#ShareAlike"; /> + </cc:License> + </rdf:RDF> + </metadata> + <g + inkscape:label="Calque 1" + inkscape:groupmode="layer" + id="layer1" + transform="translate(-541.69224,-591.06935)"> + <path + sodipodi:nodetypes="sssss" + inkscape:connector-curvature="0" + style="fill:#8b66b2;fill-opacity:1;stroke:#ffffff;stroke-width:2;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 574.69959,592.0743 c -17.664,0 -32,14.33603 -32,32 0,17.66398 14.3361,32.00001 32,32 17.664,0 32,-14.33601 32,-32 0,-17.66398 -14.336,-32 -32,-32 z" + id="path5756" /> + <rect + style="opacity:1;vector-effect:none;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:10;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect1264" + width="30" + height="6" + x="565.69226" + y="633.06934" /> + <rect + style="opacity:1;vector-effect:none;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:10;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect1266" + width="30" + height="6" + x="565.69226" + y="621.06934" /> + <rect + style="opacity:1;vector-effect:none;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:10;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect1268" + width="30" + height="6" + x="565.69226" + y="609.06934" /> + <circle + style="opacity:1;vector-effect:none;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:10;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="path1270" + cx="556.69226" + cy="612.06934" + r="3" /> + <circle + style="opacity:1;vector-effect:none;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:10;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="path1272" + cx="556.69226" + cy="624.06934" + r="3" /> + <circle + style="opacity:1;vector-effect:none;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:10;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="path1274" + cx="556.69226" + cy="636.06934" + r="3" /> + </g> +</svg> diff --git a/docs/docbook/bar_hint.svg b/docs/docbook/bar_hint.svg new file mode 100644 index 000000000..ffff9da33 --- /dev/null +++ b/docs/docbook/bar_hint.svg @@ -0,0 +1,109 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> + +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/"; + xmlns:cc="http://creativecommons.org/ns#"; + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"; + xmlns:svg="http://www.w3.org/2000/svg"; + xmlns="http://www.w3.org/2000/svg"; + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"; + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"; + width="66" + height="66" + id="svg4211" + version="1.1" + inkscape:version="0.91 r13725" + sodipodi:docname="bar_hint.svg"> + <defs + id="defs4213" /> + <sodipodi:namedview + id="base" + pagecolor="#8d8d8d" + bordercolor="#666666" + borderopacity="1.0" + inkscape:pageopacity="0" + inkscape:pageshadow="2" + inkscape:zoom="5.4601902" + inkscape:cx="-15.514148" + inkscape:cy="32.983886" + inkscape:document-units="px" + inkscape:current-layer="layer1" + showgrid="false" + fit-margin-top="0" + fit-margin-left="0" + fit-margin-right="0" + fit-margin-bottom="0" + inkscape:window-width="1600" + inkscape:window-height="840" + inkscape:window-x="0" + inkscape:window-y="31" + inkscape:window-maximized="1" + showguides="false" /> + <metadata + id="metadata4216"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage"; /> + <dc:title></dc:title> + <dc:date>2015</dc:date> + <dc:creator> + <cc:Agent> + <dc:title>Timothée Giet</dc:title> + </cc:Agent> + </dc:creator> + <cc:license + rdf:resource="http://creativecommons.org/licenses/by-sa/4.0/"; /> + </cc:Work> + <cc:License + rdf:about="http://creativecommons.org/licenses/by-sa/4.0/";> + <cc:permits + rdf:resource="http://creativecommons.org/ns#Reproduction"; /> + <cc:permits + rdf:resource="http://creativecommons.org/ns#Distribution"; /> + <cc:requires + rdf:resource="http://creativecommons.org/ns#Notice"; /> + <cc:requires + rdf:resource="http://creativecommons.org/ns#Attribution"; /> + <cc:permits + rdf:resource="http://creativecommons.org/ns#DerivativeWorks"; /> + <cc:requires + rdf:resource="http://creativecommons.org/ns#ShareAlike"; /> + </cc:License> + </rdf:RDF> + </metadata> + <g + inkscape:label="Calque 1" + inkscape:groupmode="layer" + id="layer1" + transform="translate(-341.9925,-499.36546)"> + <path + sodipodi:nodetypes="sssss" + inkscape:connector-curvature="0" + style="fill:#ff9e00;fill-opacity:1;stroke:#ffffff;stroke-width:2;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 374.99695,500.36211 c -17.6638,0 -31.997,14.33934 -31.997,32.00314 0,17.66381 14.3332,31.997 31.997,31.99701 17.6638,0 32.0031,-14.3332 32.0031,-31.99701 0,-17.6638 -14.3393,-32.00314 -32.0031,-32.00314 z" + id="path3726" /> + <g + id="g4324" + transform="matrix(0.27694924,0,0,0.27694924,324.02061,82.42059)"> + <circle + r="52.684975" + cy="1599.2439" + cx="185.24718" + id="path4326" + style="fill:#ffffff;fill-rule:evenodd" + transform="translate(0,0.36218)" /> + <rect + id="rect4328" + style="fill:#ffffff;fill-rule:evenodd" + ry="25.917999" + height="103.67" + width="51.834999" + y="1596.2" + x="159.33" /> + </g> + </g> +</svg> diff --git a/docs/docbook/bar_reload.svg b/docs/docbook/bar_reload.svg new file mode 100644 index 000000000..377422d44 --- /dev/null +++ b/docs/docbook/bar_reload.svg @@ -0,0 +1,105 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> + +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/"; + xmlns:cc="http://creativecommons.org/ns#"; + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"; + xmlns:svg="http://www.w3.org/2000/svg"; + xmlns="http://www.w3.org/2000/svg"; + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"; + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"; + width="66" + height="66" + id="svg4211" + version="1.1" + inkscape:version="0.91 r13725" + sodipodi:docname="bar_reload.svg"> + <defs + id="defs4213" /> + <sodipodi:namedview + id="base" + pagecolor="#8b8b8b" + bordercolor="#666666" + borderopacity="1.0" + inkscape:pageopacity="0" + inkscape:pageshadow="2" + inkscape:zoom="7.919596" + inkscape:cx="18.813066" + inkscape:cy="26.991488" + inkscape:document-units="px" + inkscape:current-layer="layer1" + showgrid="false" + fit-margin-top="0" + fit-margin-left="0" + fit-margin-right="0" + fit-margin-bottom="0" + inkscape:window-width="1880" + inkscape:window-height="1060" + inkscape:window-x="-2" + inkscape:window-y="-3" + inkscape:window-maximized="1" /> + <metadata + id="metadata4216"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage"; /> + <dc:title></dc:title> + <dc:date>2015</dc:date> + <dc:creator> + <cc:Agent> + <dc:title>Timothée Giet</dc:title> + </cc:Agent> + </dc:creator> + <cc:license + rdf:resource="http://creativecommons.org/licenses/by-sa/4.0/"; /> + </cc:Work> + <cc:License + rdf:about="http://creativecommons.org/licenses/by-sa/4.0/";> + <cc:permits + rdf:resource="http://creativecommons.org/ns#Reproduction"; /> + <cc:permits + rdf:resource="http://creativecommons.org/ns#Distribution"; /> + <cc:requires + rdf:resource="http://creativecommons.org/ns#Notice"; /> + <cc:requires + rdf:resource="http://creativecommons.org/ns#Attribution"; /> + <cc:permits + rdf:resource="http://creativecommons.org/ns#DerivativeWorks"; /> + <cc:requires + rdf:resource="http://creativecommons.org/ns#ShareAlike"; /> + </cc:License> + </rdf:RDF> + </metadata> + <g + inkscape:label="Calque 1" + inkscape:groupmode="layer" + id="layer1" + transform="translate(-547.09986,-391.3451)"> + <g + style="stroke-width:2;stroke-miterlimit:4;stroke-dasharray:none;display:inline;stroke:#ffffff;stroke-opacity:1;fill:#7696a6;fill-opacity:1" + id="REPEAT" + transform="translate(18.474864,40.563846)"> + <path + id="path5480" + d="m 561.63735,351.78614 c -17.6638,0 -32.0031,14.33935 -32.0031,32.00314 0,17.66381 14.3393,31.99701 32.0031,31.99701 17.6638,0 31.997,-14.3332 31.997,-31.99701 0,-17.66379 -14.3332,-32.00314 -31.997,-32.00314 z" + style="fill:#7696a6;fill-opacity:1;stroke:#ffffff;stroke-width:2;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + inkscape:connector-curvature="0" + sodipodi:nodetypes="sssss" /> + </g> + <g + style="display:inline;stroke-width:2;stroke-miterlimit:4;stroke-dasharray:none" + id="REPEAT-3" + transform="translate(-61.525136,40.563846)"> + <path + id="path5480-6" + d="m 641.91985,362.13865 c 1.959,0.017 3.8518,0.30499 5.649,0.8228 -0.3469,0.1521 -0.6683,0.32655 -0.9578,0.5342 -1.3849,0.99329 -2.1146,2.66024 -2.2228,4.12626 l -0.2825,3.84997 c -0.8558,-0.15185 -1.736,-0.2215 -2.628,-0.20262 -6.8903,0.14576 -12.365,5.8631 -12.2192,12.75336 0.0147,0.69632 0.0909,1.37593 0.2149,2.03857 0.4826,-2.34031 2.545,-4.00003 4.8693,-3.80085 2.518,0.21585 4.3534,2.51954 4.1262,5.17013 l -0.9824,11.48847 c -0.007,0.0808 -0.014,0.15996 -0.0246,0.23947 -10e-5,0.002 2e-4,0.004 0,0.006 -0.0199,0.2674 -0.0637,0.54239 -0.1351,0.81052 -0.3439,1.29285 -1.2287,2.2908 -2.3701,2.84909 -0.004,0.002 -0.008,0.004 -0.0123,0.006 -0.0634,0.0308 -0.1254,0.0641 -0.1903,0.0921 -0.004,0.002 -0.008,0.004 -0.0123,0.006 -0.0155,0.007 -0.0335,0.0119 -0.0491,0.0184 -0.6087,0.27065 -1.2775,0.40613 -1.9772,0.37456 -0.0597,-0.003 -0.118,-10e-4 -0.1781,-0.006 -0.0187,-0.002 -0.0365,-0.0104 -0.0552,-0.0123 -0.0123,-8.5e-4 -0.0246,9.2e-4 -0.0369,0 -0.3061,-0.0234 -0.6182,-0.0774 -0.9272,-0.15965 l -11.1384,-2.95961 c -2.0889,-0.55577 -3.5028,-2.32103 -3.6105,-4.27364 -0.0249,-0.45061 0.0194,-0.91134 0.1412,-1.36928 0.5413,-2.03458 2.4348,-3.35759 4.5377,-3.34646 -0.8006,-2.18102 -1.256,-4.52913 -1.3079,-6.9815 -0.2523,-11.92545 9.2155,-21.81586 21.141,-22.06818 0.2128,-0.004 0.4273,-0.008 0.6386,-0.006 z m 8.3753,1.52279 c 0.0865,-0.001 0.1766,0.002 0.2641,0.006 0.0596,0.003 0.118,10e-4 0.178,0.006 0.0188,0.002 0.0366,0.004 0.0553,0.006 0.0123,8.1e-4 0.0245,0.005 0.0368,0.006 0.3062,0.0234 0.6183,0.0713 0.9272,0.1535 l 11.1323,2.95964 c 2.0889,0.55573 3.5028,2.32715 3.6105,4.27976 0.0249,0.45061 -0.0194,0.91134 -0.1412,1.3693 -0.5655,2.12524 -2.6063,3.47113 -4.8201,3.33416 0.943,2.349 1.4906,4.90419 1.5473,7.58325 0.2523,11.92546 -9.2216,21.81587 -21.1471,22.06817 -2.4266,0.0513 -4.7564,-0.31427 -6.9385,-1.01929 0.5371,-0.17624 1.0309,-0.41014 1.4552,-0.70613 1.3978,-0.97501 2.1445,-2.63109 2.2719,-4.09557 l 0.307,-3.51838 c 0.8821,0.16144 1.793,0.23439 2.714,0.21491 6.8903,-0.14578 12.3588,-5.8631 12.2131,-12.75337 -0.0163,-0.76765 -0.1033,-1.51506 -0.2518,-2.24119 -0.6179,2.13469 -2.5822,3.596 -4.7771,3.40785 -2.5181,-0.21584 -4.3596,-2.51952 -4.1324,-5.17012 l 0.9824,-11.48233 c 0.007,-0.0808 0.014,-0.16609 0.0246,-0.24561 10e-5,-0.002 -2e-4,-0.004 0,-0.006 0.0199,-0.26734 0.0637,-0.53623 0.1351,-0.80436 0.3439,-1.29286 1.2348,-2.29696 2.3763,-2.85524 0.004,-0.002 0.008,-0.004 0.0122,-0.006 0.0634,-0.0308 0.1255,-0.0641 0.1904,-0.0921 0.004,-0.002 0.008,-0.004 0.0123,-0.006 0.0155,-0.007 0.0335,-0.006 0.0491,-0.0123 0.5326,-0.23681 1.1081,-0.37217 1.7131,-0.3807 z" + style="fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:2;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:none" + inkscape:connector-curvature="0" + sodipodi:nodetypes="ccccccccccccccccccccccccccccscccccccccccccscccccsccscccccccccccc" /> + </g> + </g> +</svg> diff --git a/docs/docbook/dataset.png b/docs/docbook/dataset.png new file mode 100644 index 000000000..807801bb2 Binary files /dev/null and b/docs/docbook/dataset.png differ diff --git a/docs/docbook/gcompris-main-menu.png b/docs/docbook/gcompris-main-menu.png index 68a4ba0c4..6e1e716ef 100644 Binary files a/docs/docbook/gcompris-main-menu.png and b/docs/docbook/gcompris-main-menu.png differ diff --git a/docs/docbook/index.docbook b/docs/docbook/index.docbook index 42b407468..d28cd35d5 100644 --- a/docs/docbook/index.docbook +++ b/docs/docbook/index.docbook @@ -21,12 +21,16 @@ <authorgroup> <author> <personname> -<firstname>This documentation was converted from the -<ulink url="https://gcompris.net/wiki/Manual";>&gcompris; Manual</ulink> -page.</firstname> +<firstname>Johnny Jazeix</firstname> <surname></surname> </personname> </author> + +<othercredit role="developer"> +<othername>The &gcompris; Team</othername> +<contrib>Developers</contrib> +</othercredit> + <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> @@ -36,12 +40,12 @@ page.</firstname> Don't forget to include this last date. Please respect the format of the date (YYYY-MM-DD),it is used by scripts. --> -<date>2016-01-24</date> +<date>2020-08-30</date> <!--version information of the application and kde this documentation is valid for. for example 'xx.yy.zz' --> -<releaseinfo>0.52</releaseinfo> +<releaseinfo>0.97</releaseinfo> <!-- Abstract about this handbook --> @@ -65,44 +69,31 @@ for example 'xx.yy.zz' <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 &kde; project and is placed under the <ulink url="https://www.gnu.org/licenses/gpl.html";>GPL license</ulink>.</para> -</sect1> - -<sect1 id="minimal-configuration"> -<title>Minimal configuration</title> -<itemizedlist> -<listitem><para>Processor : 1.6GHz Atom CPU</para></listitem> -<listitem><para>Memory (RAM) : 1 Giga Byte</para></listitem> -<listitem><para>Disk : 300 Mega Bytes</para></listitem> -<listitem><para>Operating system : &GNU;/&Linux;, &BSD;, MacOSX, &Windows;, Android, SailfishOS</para></listitem> -<listitem><para>Video : A 3D card with support of <emphasis>OpenGL 2.1</emphasis> or higher is required. 32 bits color depth mandatory</para></listitem> -</itemizedlist> +<para>&gcompris; is a rich educational software suite which contains a wide range of activities.</para> +<para>It offers various activities aimed at covering a variety of fields. The topics include reading and typing, arithmetics, geography, sciences, and other topics. It is meant to be used both at home and at school.</para> +<para>The purpose of &gcompris; is to provide playful activities but always educational.</para> +<para>&gcompris; is part of &kde; project and is placed under the <ulink url="https://www.gnu.org/licenses/gpl.html";>GPLv3 license</ulink>.</para> +<para>&gcompris; is available on the following operating systems: &GNU;/&Linux;, &BSD;, MacOSX, &Windows;, Android. +It requires a 3D card with support of <emphasis>OpenGL 2.1</emphasis> or higher is required. 32 bits color depth mandatory</para> </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, +<listitem><para>&GNU;/&Linux;: Use the packages delivered by your &GNU;/&Linux; distribution. +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> +<listitem><para>&Windows;: Delivered under a classic installer for &Windows; or via the Microsoft Store.</para></listitem> +<listitem><para>MacOSX: Delivered under a classic installer.</para></listitem> +<listitem><para>Android: Distributed by the F-Droid store or Google Play Store. Apk file is also available.</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> +<para>The interface is designed for easy use by small children. &gcompris; is controlled with a mouse. +Keyboard navigation is also available on most of the activities.</para> <sect2 id="main-window"> <title>Main window</title> @@ -123,8 +114,9 @@ with a control bar at the bottom.</para> <para>Each icon represents an activity. 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. There are 8 sections (categories) of activities, which placed on the top or on the left (only if your orientation is portrait). For example, -there is section "Board games", which includes board games, like chess, tic tac toe or align four</para> -<para>The stars indicates the age group for which each game is designed:</para> +there is section "Board games", which includes board games, like chess, tic tac toe or align four.</para> +<para>Some categories have subcategories to better filter the activities. For math activities,we have three subcategories: numeration, arithmetic and measures.</para> +<para>The stars indicate the age group for which each game is designed:</para> <itemizedlist> <listitem><para><inlinemediaobject><imageobject><imagedata fileref="difficulty1.svg" format="SVG"/></imageobject> </inlinemediaobject>1, 2 or 3 yellow stars - for 2 to 6 years old.</para></listitem> @@ -132,8 +124,7 @@ there is section "Board games", which includes board games, like chess, tic tac </inlinemediaobject>1, 2 or 3 red 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> +<para>At the bottom of the screen there is a control bar for &gcompris;. The possible icons are: (the icons are only displayed if they are available in the activity):</para> <itemizedlist> <listitem><para><inlinemediaobject><imageobject><imagedata fileref="bar_home.svg" format="SVG"/></imageobject> </inlinemediaobject> Home - Leaves the current activity, returns to the previous menu.</para></listitem> @@ -141,6 +132,8 @@ the right to the left (the icons are only displayed if they are available in the </inlinemediaobject> "OK" - 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="bar_hint.svg" format="SVG"/></imageobject> +</inlinemediaobject> Light - Display a hint for the activity. We can help the children on some activities to guide them to find the answers. </para></listitem> <listitem><para><inlinemediaobject><imageobject><imagedata fileref="bar_previous.svg" format="SVG"/></imageobject></inlinemediaobject> <inlinemediaobject><imageobject><imagedata fileref="bar_next.svg" format="SVG"/></imageobject></inlinemediaobject> Arrows - The present level is displayed. Click on one of the arrows to select another level. @@ -154,10 +147,12 @@ to be described easily in the description area. In this case, this function give <listitem><para><inlinemediaobject><imageobject><imagedata fileref="bar_config.svg" format="SVG"/></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="bar_activity_config.svg" format="SVG"/></imageobject> +</inlinemediaobject> List item - Display the activity settings menu. There are two possible information here. We can choose the levels of the activities depending on several objectives and we can update the configuration of the activity if available. </para></listitem> <listitem><para><inlinemediaobject><imageobject><imagedata fileref="bar_about.svg" format="SVG"/></imageobject> </inlinemediaobject> Capital "G" - Information box on &gcompris;, presents the main contributors and the version of the software.</para></listitem> <listitem><para><inlinemediaobject><imageobject><imagedata fileref="bar_exit.svg" format="SVG"/></imageobject> -</inlinemediaobject> Power - Quit &gcompris;. You can also use the short cut on your keyboard +</inlinemediaobject> Power - Quit &gcompris;. You can also use the shortcut on your keyboard <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></para></listitem> </itemizedlist> </sect2> @@ -166,7 +161,8 @@ under the name <filename>.config/gcompris/gcompris.conf</filename>. This is a te <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 --enable-kioskmode</command></userinput> : disable the <guiicon>Quit</guiicon> and <guiicon>Configuration</guiicon> buttons.</para></listitem> +<listitem><para><userinput><command>gcompris --diable-kioskmode</command></userinput> : enable the <guiicon>Quit</guiicon> and <guiicon>Configuration</guiicon> buttons.</para></listitem> <listitem><para><userinput><command>gcompris -f</command></userinput> : run &gcompris; in fullscreen mode</para></listitem> <listitem><para><userinput><command>gcompris -C</command></userinput> : disable the cursor (touch screen mode)</para></listitem> </itemizedlist> @@ -211,15 +207,10 @@ under the name <filename>.config/gcompris/gcompris.conf</filename>. This is a te <sect1 id="internationalization"> <title>Notes on Internationalization</title> -<para>&gcompris; is internationalized and is available in more than 50 languages. If you want +<para>&gcompris; is internationalized and is available in more than 35 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>Be careful, some languages need specific fonts to be displayed correctly. </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="https://l10n.kde.org/teams";>translation team</ulink> of @@ -230,26 +221,35 @@ the <ulink url="https://l10n.kde.org/";>&kde; translation web site</ulink>.</para <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> +in the configuration menu. Do not forget to download the optional audio modules for this language.</para> </sect1> <sect1 id="customizing-activities"> <title>Customizing activities</title> -<para>You can customize some activities using tool button in them. For example, you can set lang in -some text activities (like wordsgame), or make it show real car images instead of filled rectangles -(traffic)</para> +<para>For multiple activities, you can choose several datasets in the configuration. Each one has a specific objective which is described.</para> +<screenshot> +<screeninfo>Dataset of activity "Count the items"</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="dataset.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Dataset of activity "Count the items"</phrase> + </textobject> + </mediaobject> +</screenshot> + +<para>You can customize some activities using the configuration button in them. +For example, you can set the locale in some text activities (like wordsgame), +or make it show real car images instead of filled rectangles (traffic)</para> <screenshot> -<screeninfo>Select mode of activity "Traffic"</screeninfo> +<screeninfo>Select mode of activity "Count the items"</screeninfo> <mediaobject> <imageobject> - <imagedata fileref="traffic-select-mode.png" format="PNG"/> + <imagedata fileref="activity-config.png" format="PNG"/> </imageobject> <textobject> - <phrase>Select mode of activity "Traffic"</phrase> + <phrase>Select mode of activity "Count the items"</phrase> </textobject> </mediaobject> </screenshot> @@ -294,12 +294,20 @@ some text activities (like wordsgame), or make it show real car images instead o <entry>Export activities as SQL</entry> </row> <row> -<entry>--enable-config</entry> -<entry>Enable the config button (default)</entry> +<entry>--enable-kioskmode</entry> +<entry>Enable the kiosk mode (hides Quit and Configuration buttons)</entry> +</row> +<row> +<entry>--disable-kioskmode</entry> +<entry>Disable the kiosk mode (default)</entry> </row> <row> -<entry>--disable-config</entry> -<entry>Disable the config button</entry> +<entry>--software-renderer</entry> +<entry>Use software renderer instead of openGL (should work with any graphical card)</entry> +</row> +<row> +<entry>--opengl-renderer</entry> +<entry>Use openGL renderer instead of software (faster and more graphical effects but can crash with some graphical cards)</entry> </row> </tbody> </tgroup> @@ -307,14 +315,14 @@ some text activities (like wordsgame), or make it show real car images instead o <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, without config button and cursor:</para> -<para><userinput><command>"C:\Program Files\Gcompris\gcompris-qt.exe" --disable-config -f -C</command></userinput></para> +<para>You can add these switches in the desktop icon properties. Here is an example that runs &gcompris; in kiosk mode in full screen, without Configuration button and cursor:</para> +<para><userinput><command>"C:\Program Files\Gcompris\gcompris-qt.exe" --disable-kiosk -f -C</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, without config button and cursor:</para> -<para><userinput><command>gcompris-qt --disable-config -f -C</command></userinput></para> +<para>Create an application launcher and configure the command line parameters. Here is an example that runs &gcompris; in kiosk mode in full screen, without Config button and cursor:</para> +<para><userinput><command>gcompris-qt --disable-kiosk -f -C</command></userinput></para> </sect2> </sect1> @@ -328,12 +336,7 @@ some text activities (like wordsgame), or make it show real car images instead o &gcompris; </para> <para> -Program copyright 2000-2018 Bruno Coudoin and others -</para> - -<para> -Documentation Copyright see the -<ulink url="https://gcompris.net/mediawiki-1.31.0/index.php?title=Manual&action=history";>Manual page history</ulink> +Program copyright 2000-2020 Timothée Giet and others </para> <!-- TRANS:CREDIT_FOR_TRANSLATORS --> diff --git a/docs/docbook/traffic-select-mode.png b/docs/docbook/traffic-select-mode.png deleted file mode 100644 index 9bba9dd0e..000000000 Binary files a/docs/docbook/traffic-select-mode.png and /dev/null differ diff --git a/docs/manual-general b/docs/manual-general index ed403171e..4ed61817d 100644 --- a/docs/manual-general +++ b/docs/manual-general @@ -21,36 +21,35 @@ In GCompris all the activities follow the same core values: ***Distribution -The source code of GCompris is under GNU GPLv3, it is free software. It runs best on Free-Software operating systems like GNU/Linux, where it is of course available for free. +The source code of GCompris is under GNU GPLv3, it is free software. It runs best on Free-Software operating systems like GNU/Linux. -We also support proprietary operating systems, but there we sell the full version. For Windows you can buy an activation code on our website to unlock the full version. For Android, the software must be purchased from the play store. -However for schools, you should contact us directly to get a lower price ([email protected]). +We also support proprietary operating systems, OSX, Windows and Android. For Android, you can get it either from the F-Droid store or the Google Play Store. -Note that the latest version of GCompris for OSX and iOS are not available yet, we are looking at bringing them back soon. +Note that the latest version of GCompris for iOS is not available. **Quick start tour -On first launch, we ask to download the pack of voices depending on selected language if it is not already done, as well as the additional image set. +On first launch, we ask to download the pack of voices depending on selected language if it is not already done, as well as the additional image set and background music. On the main menu page, the activities are listed by categories, with the different animals and their attributes at the top. +Some categories have subcategories too to better filter activities. - The cat is for computer activities, where children can learn to use a keyboard and a mouse or touchpad. - - The penguin (Tux, the mascot of Linux) is for discovery activities, to initiate and discover lot of different topics. - - The pig is for experience activities, mostly related to science topics. + - The penguin (Tux, the mascot of Linux) is for discovery activities, to initiate and discover lot of different topics, like logic, fine arts and music. + - The pig is for sciences activities, experimentation, history and geography topics. - The dragon (Konqi, the mascot of KDE), is for fun activities, which are more relaxing and... fun. - - The sheep is for math activities, to learn numbers and operations. + - The sheep is for math activities, to learn numeration, arithmetic and measures. - The panda is for puzzle activities, with all kinds of puzzle games to learn logic. - The cow is for reading activities, to learn letters and words. - The frog is for strategy activities, with some classical strategy games including checkers and chess. - On the left, the Sun is meant to access your favorite set of activities. To add an activity to favorites, click the little sun icon on it to activate it. + On the left, the Sun is meant to access your favorite set of activities. To add an activity to favorites, click the little Sun icon on it to activate it. On the right, there is a search category where you can find activities by keywords. The activities also have some difficulty indications, with the little stars on the top-left corner of their icons. It goes from 1 yellow star for the easiest to 3 red stars for the hardest. - On the bottom, there is the menu-bar, which different controls depending on the activity running. In the main menu page, this bar contains: @@ -58,21 +57,26 @@ In the main menu page, this bar contains: - The G button to access infos about GCompris - The question mark to access the help page - The Settings button to access the global settings page. +- The multiple dataset button to choose the levels of the activities depending on several objectives. + - **Main options In the global settings page, you find several options to configure the software to your needs. -- first, a line checking if you have the full version. If not, this is where you can enter the activation code. - - Enable audio voices: to turn off/on the voices - Enable audio effects: to turn off/on the sound effects +- Audio effects volume: to increase/decrease the sound effects volume +- Download background music: to download the background music +- Enable background music: to turn off/on the background music +- Background music: if background music is enabled, displays the current music information +- Background music volume: to increase/decrease the background music volume + - Fullscreen: start in fullscreen or window mode - virtual keyboard: to add a virtual keyboard on the screen -- Enable automatic downloads: if you disable it, GCompris will never automatically download any additional content. -- Download full word image set: if you have not already the additional image set, you can disable this option to never ask for it. +- Enable automatic downloads/updates of sound files: if you disable it, GCompris will never automatically download any additional content. +- Download full word image set: to download the full word image set used in all vocabulary activities (if not installed, GCompris uses a shipped subset of images). - The activity section menu is visible: with this option you can restrict the user to the current section selected. So if you add some favorites, when starting with this option it will only show those. @@ -97,5 +101,3 @@ It is a fast and simple way to adapt the content to the user level. mailing list: [email protected] email: [email protected] - -commercial: [email protected]
