Git commit a0d28ab3024d17e1cc3a20d88eb7041bde590706 by Emir SARI. Committed on 05/02/2025 at 13:23. Pushed by esari into branch 'esari/work/docbook-prettify'.
Prettify docbook - Use typographic and Unicode signs - Use more macros - Get rid of unnecessary spaces M +39 -42 docs/docbook/index.docbook https://invent.kde.org/education/gcompris/-/commit/a0d28ab3024d17e1cc3a20d88eb7041bde590706 diff --git a/docs/docbook/index.docbook b/docs/docbook/index.docbook index 6a73adf6f..628299d55 100644 --- a/docs/docbook/index.docbook +++ b/docs/docbook/index.docbook @@ -79,20 +79,18 @@ for example 'xx.yy.zz' <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/agpl-3.0.html";>AGPLv3 license</ulink>. All the code, except the engine for analog electricity activity is under <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. 32 bits color depth mandatory.</para> +<para>&gcompris; is available on the following operating systems: &GNU;/&Linux;, &BSD;, &macOS;, &Windows;, Android. +It requires a 3D card with support of <emphasis>OpenGL 2.1</emphasis> or higher. 32 bits color depth is 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> +<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. -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>&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;.</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> +<listitem><para>&macOS;: 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> @@ -103,10 +101,9 @@ Keyboard navigation is also available on most of the activities.</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> +<para>When you start the program, &gcompris; shows a graphical 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> +<screeninfo>Here's a screenshot of &gcompris; main window</screeninfo> <mediaobject> <imageobject> <imagedata fileref="gcompris-main-menu.png" format="PNG"/> @@ -120,45 +117,45 @@ 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 are 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> +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> +</inlinemediaobject>1, 2 or 3 yellow stars — for 2 to 6 years old.</para></listitem> <listitem><para><inlinemediaobject><imageobject><imagedata fileref="difficulty4.svg" format="SVG"/></imageobject> -</inlinemediaobject>1, 2 or 3 red stars - greater than 6 years old.</para></listitem> +</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 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> +</inlinemediaobject> Home — Leaves the current activity, returns to the previous menu.</para></listitem> <listitem><para><inlinemediaobject><imageobject><imagedata fileref="bar_ok.svg" format="SVG"/></imageobject> -</inlinemediaobject> "OK" - Validate, confirm your answer. Some activities do not detect automatically whether or +</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> +</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. +Arrows — The present level is displayed. Click on one of the arrows 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="bar_repeat.svg" format="SVG"/></imageobject> -</inlinemediaobject> Lips - Ask &gcompris; to repeat the question.</para></listitem> +</inlinemediaobject> Lips — Ask &gcompris; to repeat the question.</para></listitem> <listitem><para><inlinemediaobject><imageobject><imagedata fileref="bar_help.svg" format="SVG"/></imageobject> -</inlinemediaobject> Question mark - Display the help dialog box. Sometimes, an activity can be too complex +</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="bar_config.svg" format="SVG"/></imageobject> -</inlinemediaobject> Tool box - Configuration menu. The configuration is saved in the user repository (folder) +</inlinemediaobject> Tool box — Configuration menu. The configuration is saved in the user repository (folder) under the name <filename>.config/gcompris/gcompris-qt.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 tabs here. First one, "Dataset", allows to choose the levels of the activities depending on several objectives and the second one, "Options", allows to update the configuration of the activity if available. </para></listitem> +</inlinemediaobject> List item — Display the activity settings menu. There are two possible tabs here. First one, “Dataset”, allows to choose the levels of the activities depending on several objectives and the second one, “Options”, allows to 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> +</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 shortcut 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> @@ -167,10 +164,10 @@ under the name <filename>.config/gcompris/gcompris-qt.conf</filename>. This is a <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 --enable-kioskmode</command></userinput> : disable the <guiicon>Quit</guiicon> and <guiicon>Configuration</guiicon> buttons.</para></listitem> -<listitem><para><userinput><command>gcompris --disable-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> +<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 --disable-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> <para>These options can of course be combined.</para> </sect2> @@ -238,34 +235,34 @@ 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> +<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> + <phrase>Dataset of activity “Count the items”</phrase> </textobject> </mediaobject> </screenshot> <para>You can choose the options for this activity.</para> <screenshot> -<screeninfo>Select mode of activity "Count the items"</screeninfo> +<screeninfo>Select mode of activity “Count the items”</screeninfo> <mediaobject> <imageobject> <imagedata fileref="activity-config.png" format="PNG"/> </imageobject> <textobject> - <phrase>Select mode of activity "Count the items"</phrase> + <phrase>Select mode of activity “Count the items”</phrase> </textobject> </mediaobject> </screenshot> </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> +<title>Console Parameters</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> @@ -303,15 +300,15 @@ or make it show real car images instead of filled rectangles (traffic).</para> </row> <row> <entry>--launch activity</entry> -<entry>Specify the activity when starting GCompris.</entry> +<entry>Specify the activity when starting &gcompris;.</entry> </row> <row> <entry>--start-level level</entry> -<entry>Specify the level on which to start the activity specified by --launch option when starting GCompris. Ignored if no --launch option, or if level specified is invalid.</entry> +<entry>Specify the level on which to start the activity specified by “--launch” option when starting &gcompris;. Ignored if no “--launch” option, or if level specified is invalid.</entry> </row> <row> <entry>--difficulty {value|min-max}</entry> -<entry>For the session, force GCompris activities difficulty to be either at value or between min and max values. The values must be between 1 and 6, and if the format is min-max, the min value must be lower than the max value. If it is not the case GCompris will not start.</entry> +<entry>For the session, force &gcompris; activities difficulty to be either at value or between min and max values. The values must be between 1 and 6, and if the format is min-max, the min value must be lower than the max value. If it is not the case &gcompris; will not start.</entry> </row> <row> <entry>--export-activities-as-sql</entry> @@ -327,15 +324,15 @@ or make it show real car images instead of filled rectangles (traffic).</para> </row> <row> <entry>--renderer={renderer}</entry> -<entry>Specify which graphical renderer to use. On all platforms, opengl and software are available. On Windows, you can use direct3d11 or direct3d12 (if it was compiled with Qt>=6.6). On MacOS, you can use metal.</entry> +<entry>Specify which graphical renderer to use. On all platforms, OpenGL and software are available. On Windows, you can use Direct3D 11 or Direct3D 12 (if it was compiled with Qt ≥ 6.6). On &macOS;, you can use Metal.</entry> </row> <row> <entry>--software-renderer</entry> -<entry>Use software renderer instead of openGL (should work with any graphical card). Deprecated, use --renderer=software instead.</entry> +<entry>Use software renderer instead of OpenGL (should work with any graphical card). Deprecated, use “--renderer=software” instead.</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). Deprecated, use --renderer=opengl instead.</entry> +<entry>Use OpenGL renderer instead of software (faster and more graphical effects but can crash with some graphical cards). Deprecated, use “--renderer=opengl” instead.</entry> </row> </tbody> </tgroup> @@ -349,7 +346,7 @@ or make it show real car images instead of filled rectangles (traffic).</para> <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>Create an application launcher and configure the command line parameters. Here is an example that runs &gcompris; in kiosk mode in full screen, without Configuration button and cursor:</para> <para><userinput><command>gcompris-qt --enable-kioskmode -f -C</command></userinput></para> </sect2> @@ -364,7 +361,7 @@ or make it show real car images instead of filled rectangles (traffic).</para> &gcompris; </para> <para> -Program copyright 2000-2025 Timothée Giet and others +Program copyright © 2000–2025 Timothée Giet and others </para> <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
