Commit 42fe73a5 authored by Antoni Bella Pérez's avatar Antoni Bella Pérez 🚵🏻
Browse files

Documentation updates

* Update date and version numbers
* Suitable tags and add some icon names
* Fix bottom/top toolbar references, status bar does not exist
* Reorder the items and some fixes (without menus)
* Use Debian entity
parent 2edb2e16
......@@ -31,8 +31,8 @@
<legalnotice>&FDLNotice;</legalnotice>
<date>2016-04-25</date>
<releaseinfo>3.0 (Applications 16.04)</releaseinfo>
<date>2020-12-22</date>
<releaseinfo>Applications 20.12</releaseinfo>
<abstract>
<para>
......@@ -115,8 +115,8 @@ languages without changing your keyboard layout.</para>
adjectives, &etc;).</para></important>
<para>If you need help guessing the word, you can click on the <inlinemediaobject><imageobject> <imagedata
fileref="help-hint.png" format="PNG"/></imageobject></inlinemediaobject> icon in the
toolbar and a hint will be displayed to give you some clue about the word.
fileref="help-hint.png" format="PNG"/></imageobject></inlinemediaobject> <guiicon>Display the hint</guiicon>
icon in the bottom toolbar and a hint will be displayed to give you some clue about the word.
Clicking this icon again will hide the hint.
</para>
......@@ -125,7 +125,7 @@ Clicking this icon again will hide the hint.
<para> Usually, it is not important whether you type in lowercase or uppercase.
The program converts all input into an uppercase letter. The program does that
automatically. </para>
automatically.</para>
<para>
The current category, wins and losses are displayed in the window.
......@@ -159,8 +159,9 @@ adults.
-->
<para>After a word is guessed (or the hangman is completed), you are
congratulated and the next word is presented.
To quit the game click the <inlinemediaobject><imageobject><imagedata
fileref="quit.png" format="PNG"/></imageobject></inlinemediaobject> icon in the top toolbar.
To quit the game click the <inlinemediaobject><imageobject><imagedata
fileref="quit.png" format="PNG"/></imageobject></inlinemediaobject>
<guiicon>Quit</guiicon> icon in the top toolbar.
</para>
<para>You type the letter you want to try on the keyboard or select it
......@@ -174,7 +175,7 @@ tries and after that you lose and the correct word is displayed.
<inlinemediaobject><imageobject><imagedata fileref="go-next.png" format="PNG"/></imageobject></inlinemediaobject>
on the bottom toolbar. You can also change the category of words clicking the current category.</para>
<para>The look can easily be changed with theme button on the bottom toolbar.</para>
<para>The look can easily be changed with theme button on the top toolbar.</para>
<!--Not in kf5?
<para>You can also play the game with a local file installed on your machine
......@@ -200,7 +201,7 @@ By default, after the first installation of &khangman;, only English and your
&kde; language if it is one of the above and if you have the corresponding
kde-i18n package will be installed. For example if you are a Danish user and if
you have &kde; in Danish, in Language you will see two
items: English and Danish and Danish will be the default. </para>
items: English and Danish and Danish will be the default.</para>
<para>
You can still play &khangman; in other languages. It is very easy to add new
......@@ -226,11 +227,11 @@ installed, a green tick is displayed in front of the language name and the
<guibutton>Install</guibutton> turns to <guibutton>Uninstall</guibutton>. The
data is immediately installed and available in &khangman;. You click on the
<guibutton>Close</guibutton> button to close the Get New Words dialog (if you
want another data file, you can repeat these steps). </para>
want another data file, you can repeat these steps).</para>
<para>
You can then easily change the language by clicking the language button
and choose the new language. </para>
and choose the new language.</para>
<para>
Please note that the special characters in a language are displayed on the keyboard.
......@@ -246,7 +247,7 @@ special characters correctly in some languages. Provided you have those fonts
installed, &khangman; will automatically use them. If you see small squares
instead of letters, then you may not have one of these fonts installed. Type
<command>fonts:/</command> into the &konqueror; address bar to check which fonts
you have installed. </para></important> -->
you have installed.</para></important> -->
</sect1>
<sect1 id="few-tips">
......@@ -264,7 +265,7 @@ l, t, r, n, s.
&atilde; for this letter to be displayed.
</para>
<para> Did you know? In English, the most common letter is e (12.7%), followed
by t (9.1%) then a (8.2%), i (7.0%) and n (6.7%). </para>
by t (9.1%) then a (8.2%), i (7.0%) and n (6.7%).</para>
</sect1>
</chapter>
......@@ -298,6 +299,8 @@ category <quote>Animaux</quote>. The special characters for French are shown her
<inlinemediaobject><imageobject><imagedata fileref="pause.png" format="PNG"/></imageobject></inlinemediaobject>
Start or stop a game
</member>
<member>A button to change the theme
</member>
<member><inlinemediaobject><imageobject><imagedata fileref="settings_icon.png" format="PNG"/></imageobject></inlinemediaobject>
Open the settings dialog
</member>
......@@ -322,19 +325,18 @@ Quit &khangman;
<simplelist>
<member><inlinemediaobject><imageobject><imagedata fileref="help-hint.png" format="PNG"/></imageobject></inlinemediaobject>
- Display a hint about the word to guess
Display a hint about the word to guess
</member>
<member>A button to change the category</member>
<member>Language selection</member>
<member>Theme selection</member>
<member>Reveal the word to guess</member>
<member>A <guibutton>Reveal Word</guibutton> button for reveal the word to guess</member>
<member><inlinemediaobject><imageobject><imagedata fileref="go-next.png" format="PNG"/></imageobject></inlinemediaobject>
Load the next word and start a new game
</member>
</simplelist>
<para> All words are nouns. No verbs, no adjectives. The chosen category
is then displayed on the statusbar.</para>
is then displayed on the bottom toolbar.</para>
<para>Only letters are allowed to be typed in the text box.</para>
</sect1>
......@@ -519,12 +521,12 @@ game.</emphasis></para>
<sect1 id="internal">
<title>What is stored by &khangman; and where</title>
<para>
When you get a new language via <menuchoice><guimenu>Game</guimenu>
<guimenuitem>Get Words in New Language...</guimenuitem></menuchoice>, the new
language data is stored in <filename
class="directory">$XDG_DATA_HOME/share/apps/kvtml/</filename> in the language code
folder. The available language dir names are also stored in the &khangman;
config file in <filename>$XDG_DATA_HOME/share/config/khangmanrc</filename>.
When you get a new language via the <inlinemediaobject><imageobject><imagedata
fileref="get-hot-new-stuff.png" format="PNG"/></imageobject></inlinemediaobject>
<guiicon>Download new language files</guiicon> icon, the new language data is stored
in <filename class="directory">$XDG_DATA_HOME/share/apps/kvtml/</filename> in the
language code folder. The available language dir names are also stored in the
&khangman; config file in <filename>$XDG_DATA_HOME/share/config/khangmanrc</filename>.
</para>
<para>
The provider name (i.e. the address of the website where to download the new
......
......@@ -5,11 +5,11 @@
<refentry lang="&language;">
<refentryinfo>
<title>KHangman User's Manual</title>
<title>&khangman; User's Manual</title>
<author><firstname>Ben</firstname><surname>Burton</surname> <contrib>&khangman; man page.</contrib>
<email>bab@debian.org</email></author>
<date>2016-04-25</date>
<productname>KDE Applications</productname>
<date>2020-12-22</date>
<productname>Applications 20.12</productname>
</refentryinfo>
<refmeta>
......@@ -24,12 +24,12 @@
<refsect1>
<title>Description</title>
<para>&khangman; is a game based on the well known hangman game. It is
aimed for children 6 and above. It has several word categories like Animals,
<para>&khangman; is a game based on the well known hangman game. It is
aimed for children 6 and above. It has several word categories like Animals,
Clothing, Computers, Currencies and more.</para><para>A word is picked at
random and the letters are hidden. You must guess the word by trying one
letter after another. Each time you guess a wrong letter, part of a picture
of a hangman is drawn. You must guess the word before getting hanged! You
letter after another. Each time you guess a wrong letter, part of a picture
of a hangman is drawn. You must guess the word before getting hanged! You
have 10 tries.</para><para>This application is part of the &kde; Edutainment
module.</para>
</refsect1>
......@@ -37,9 +37,8 @@ module.</para>
<refsect1>
<title>See Also</title>
<para>More detailed user documentation is available from <ulink
url="help:/khangman">help:/khangman</ulink>
(either enter this <acronym>URL</acronym> into &konqueror;, or run
<userinput><command>khelpcenter</command>
url="help:/khangman">help:/khangman</ulink> (either enter this &URL; into
&konqueror;, or run <userinput><command>khelpcenter</command>
<parameter>help:/khangman</parameter></userinput>).</para>
<para>There is also further information available at the <ulink url="https://edu.kde.org/khangman/">&kde; Edutainment web site</ulink>.</para>
......@@ -48,7 +47,7 @@ url="help:/khangman">help:/khangman</ulink>
<refsect1>
<title>Authors</title>
<para>&khangman; was written by <personname><firstname>Primoz</firstname><surname>Anzur</surname></personname> and &Anne-Marie.Mahfouf; &Anne-Marie.Mahfouf.mail;</para>
<para>This manual page based on the one prepared by <personname><firstname>Ben</firstname><surname>Burton</surname></personname> for the Debian project.</para>
<para>This manual page based on the one prepared by <personname><firstname>Ben</firstname><surname>Burton</surname></personname> for the &Debian; project.</para>
</refsect1>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment