diff --git a/doc/help/configuration.rst b/doc/help/configuration.rst index f760fb1..58ba845 100644 --- a/doc/help/configuration.rst +++ b/doc/help/configuration.rst @@ -1,2 +1,53 @@ +.. _configuration: + Game Configuration -================== +****************** + +To configure **Tanglet**, open the **Settings** menu. You see the following +entries: + +**Show Maximum Score** – you can choose between three options for the status +line at the bottom of the window: + +* *Never* – You see word lengths and the count of words found for each length. + +* *End Of Game* – At the end of the game, you see the contained words per word + length and the count of words found by you. + +* *Always*: The behavior described for *End Of Game* is always visible. + +The visibility of the word count status bar can be toggled with +**Show Word Counts**. + +**Show Missed Words** – In addition to the list of found words on the left, an +extra tab named **Missed** will de displayed. This tab is inactive until the +game ends. + +**Board Language** – You can change the board language by clicking on the +drop-down list and choose from the available languages. Besides that, you have +some extra options: + +.. figure:: ./figures/tanglet_board_language.png + +You can change the file paths to *Dice*, *Word List* and *Dictionary* by +entering the file paths manually or click on the respective **Choose…** buttons +to open a file chooser dialog. To set all entries back to the defaults, click +on **Defaults** in the bottom left corner of the window. As usual, you can stop +editing the preferences with the **Cancel** button, and apply the changes with +**OK**. Your changes will be applied after the next start of **Tanglet**. + +Under **Application Language**, you can change the language of the user +interface. The settings window opens with the button ****. +Click on it to change the desired language from the drop-down menu. Again, your +changes will be applied after the next start of **Tanglet**. + +.. note:: + Maybe the following command is known to you for opening an application + with different language settings: + + .. code-block:: + + export LC_ALL=C && tanglet + + This doesn't work correctly in **Tanglet**. To change the user interface + language, we recommend to use the configuration option described above. diff --git a/doc/help/credits.rst b/doc/help/credits.rst index 8e8e9c5..0ae8512 100644 --- a/doc/help/credits.rst +++ b/doc/help/credits.rst @@ -1,5 +1,5 @@ Credits and License -=================== +******************* Program copyright 2009-2021 Graeme Gott diff --git a/doc/help/figures/tanglet_board_language.png b/doc/help/figures/tanglet_board_language.png new file mode 100644 index 0000000..c3dae12 Binary files /dev/null and b/doc/help/figures/tanglet_board_language.png differ diff --git a/doc/help/figures/tanglet_change_modes.png b/doc/help/figures/tanglet_change_modes.png new file mode 100644 index 0000000..e5377e2 Binary files /dev/null and b/doc/help/figures/tanglet_change_modes.png differ diff --git a/doc/help/howtoplay.rst b/doc/help/howtoplay.rst index 218a82d..d5a5de2 100644 --- a/doc/help/howtoplay.rst +++ b/doc/help/howtoplay.rst @@ -1,6 +1,9 @@ +.. _howtoplay: + How to Play -=========== +*********** +--------------- Using the Mouse --------------- @@ -12,6 +15,8 @@ Using the Mouse **Clear the word:** Click twice on the first selected letter. + +------------------ Using the Keyboard ------------------ @@ -20,3 +25,26 @@ Using the Keyboard **Make a guess:** Press Enter. **Clear the word:** Press Ctrl+Backspace. + +Once you found an acceptable word, it will be displayed in the list left to the +board. In case you find the word *again*, it will be highlighted in this list. +If the word can be extended with one or more letters, click on it to display it +again on the board, and you can add more letters to create a new word. + +When you hover the mouse pointer over one of the accepted words in the list, +a popup displays the word in eventually different spellings and how many points +you have earned for this word. + +.. I remember, there was such an icon in previous versions... + + When you hover the mouse pointer over one of the accepted words in the list, + a clickable book icon will be displayed, which leads you to the appropriate + entry in Wiktionary. + +The wordlist has a tab **Missed**, which is inactive during the game play. +When the game is over, you can click on it to see the words which you haven't +found. + +.. note:: + When closing the game without it has ended, the same game at the same + score will be opened when **Tanglet** starts next time. diff --git a/doc/help/index.rst b/doc/help/index.rst index 32206c6..a32cd20 100644 --- a/doc/help/index.rst +++ b/doc/help/index.rst @@ -1,9 +1,9 @@ Tanglet User Manual -=================== +******************* Tanglet |release| -Copyright © 2009-2021 Graeme Gott +Copyright © 2009-2026 Graeme Gott Abstract -------- diff --git a/doc/help/introduction.rst b/doc/help/introduction.rst index c516b33..1132007 100644 --- a/doc/help/introduction.rst +++ b/doc/help/introduction.rst @@ -1,2 +1,127 @@ +.. _introduction: + Introduction -============ +************ + +Tanglet is a single player word finding game based on +`Boggle `__. The object of the game is to +list as many words as you can before the time runs out. There are several timer +modes that determine how much time you start with, and if you get extra time +when you find a word. + +You can join letters horizontally, vertically, or diagonally in any direction +to make a word, so as long as the letters are next to each other on the board. +However, you can not reuse the same letter cells in a single word. Also, each +word must be at least three letters on a normal board, and four letters on a +large board. + +----------------- +Starting the game +----------------- + +You can start the game using the application menu of your desktop environment. +Open the application menu and choose **Games** ➡ **Tanglet** or open a +quick start prompt using **Alt** ➡ **F2** and start typing *tanglet*, then +click on the application name found. + +When **Tanglet** starts, two board sizes are available, 4x4 and 5x5. Click on +one of them to apply. In the drop-down list right to **Amount Of Words**, you +can choose between more or less words contained in the board. Try out how it +results in the created word counts in the board, in many cases, with a 5x5 +board, you get more than 1000 contained words. The other drop-down list +**Minimum Word Length** lets you choose between acceptable character counts. +The minimally configurable word length depends on the board let's say 5, then +words with 4 letters, which actually exists, won't be accepted by **Tanglet**. + + +Finally you can choose between different game modes: + +.. figure:: ./figures/tanglet_change_modes.png + +The following modes are available: + +* *Allotment* – Game ends after 30 guesses. + +* *Classic* – Counts fown from 3 minutes. + +* *Discipline* – Counts down from 30 seconds and increases on correct guesses. + +* *Refill* – Counts down from 30 seconds and refills on correct guesses. + +* *Stamina* – Counts down from 45 seconds and pauses on correct guesses. + +* *Strikeout* – Game ends after 3 incorrect guesses. + +* *Tanglet* – Counts down from 30 seconds and increases or decreases on guesses. + +* *Unlimited* – Game ends when all words are found. + +----------------- +Menu bar overview +----------------- + +*Game* menu +----------- + +* *New Game* – Starts a new game. If a previous game is still running, + you will asked for confirmation to stop that game. + +* *New Roll* – Starts a new game in the same mode as the currently running + one. Again, you will asked for confirmation to stop that game. + +* *Choose…* – Lets you start a game which has been saved previously. A file + chooser dialog will be opened where you can search for the desired game + file. + +* *Share* – Lets you save the game in a file. A file chooser dialog will be + opened where you can choose for a file name and directory. Although it is + possible, keep the **File type** entry unchanged. We don't recommend to + save files with another extension than *.tanglet*. + +* *End* – End the game. You will asked for confirmation to stop the game. + +* *Pause* – Pause the game. Probably you need this for time-limited games. When + pausing a game, the whole window content disappears. After clicking anywhere + in the window, the pause ends and the content comes back. Note, also when the + window losts the focus, the window content disappears. + +* *Details* – Shows details about the running game, such as the board size, the + word density and length, the game type and a short description of that game. + +* *High Scores* – Shows the High Scores. The initial view shows the High Scores + for the type of the currently running game. To view the High Scores for the + other game types, click on the vertical tab bar on the left. + +* *Quit* – Quits the game and the application. + + +*Settings* menu +--------------- + +See :ref:`configuration` about how to use the entries of the *Settings* menu. + + + +*Help* menu +----------- + +* *Controls* – Shows a brief summary of the usage. In fact, the same as + described in :ref:`howtoplay`. + +.. For the upcoming user manual + +* *User manual* – Opens this user manual in your configured standard browser. + The opened browser is out of the scope of **Tanglet**; if you like to use a + different browser or HTML viewer, you need to configure this in the settings + of your desktop environment. + +* *About* – Shows a brief summary, including the version number of **Tanglet**. + +* *About Qt* – Shows a description of Qt, which is the code base of + **Tanglet**. + +*Search* bar +------------ + +Open the search bar by clicking on it and type anything to find corresponding +menu bar entries. diff --git a/doc/help/locales/de/LC_MESSAGES/configuration.po b/doc/help/locales/de/LC_MESSAGES/configuration.po index bbffec9..5069810 100644 --- a/doc/help/locales/de/LC_MESSAGES/configuration.po +++ b/doc/help/locales/de/LC_MESSAGES/configuration.po @@ -1,23 +1,25 @@ -# SOME DESCRIPTIVE TITLE. +# German translation of the Tanglet user manual # Copyright (C) 2021 Graeme Gott # This file is distributed under the same license as the Tanglet package. -# FIRST AUTHOR , 2021. # -#, fuzzy +# Mario Blättermann , 2021. msgid "" msgstr "" "Project-Id-Version: Tanglet 1.6\n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2021-04-26 15:30-0400\n" -"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" -"Last-Translator: FULL NAME \n" -"Language-Team: LANGUAGE \n" +"PO-Revision-Date: 2021-04-27 19:27+0200\n" +"Last-Translator: Mario Blättermann \n" +"Language-Team: German \n" "MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=utf-8\n" +"Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" "Generated-By: Babel 2.9.0\n" +"Language: de\n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" +"X-Generator: Lokalize 21.04.0\n" #: ../configuration.rst:2 msgid "Game Configuration" -msgstr "" +msgstr "Einstellungen des Spiels" diff --git a/doc/help/locales/de/LC_MESSAGES/credits.po b/doc/help/locales/de/LC_MESSAGES/credits.po index 8034771..e47eb4a 100644 --- a/doc/help/locales/de/LC_MESSAGES/credits.po +++ b/doc/help/locales/de/LC_MESSAGES/credits.po @@ -1,33 +1,37 @@ -# SOME DESCRIPTIVE TITLE. +# German translation of the Tanglet user manual # Copyright (C) 2021 Graeme Gott # This file is distributed under the same license as the Tanglet package. -# FIRST AUTHOR , 2021. # -#, fuzzy +# Mario Blättermann , 2021. msgid "" msgstr "" "Project-Id-Version: Tanglet \n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2021-04-26 15:00-0400\n" -"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" -"Last-Translator: FULL NAME \n" -"Language-Team: LANGUAGE \n" +"PO-Revision-Date: 2021-04-27 19:31+0200\n" +"Last-Translator: Mario Blättermann \n" +"Language-Team: German \n" "MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=utf-8\n" +"Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" "Generated-By: Babel 2.9.0\n" +"Language: de\n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" +"X-Generator: Lokalize 21.04.0\n" #: ../credits.rst:2 msgid "Credits and License" -msgstr "" +msgstr "Danksagungen und Lizenz" #: ../credits.rst:4 msgid "Program copyright 2009-2021 Graeme Gott " -msgstr "" +msgstr "Copyright des Programms 2009-2021 Graeme Gott " #: ../credits.rst:6 msgid "" "This program is licensed under the terms of the `GNU General Public " "License `_." msgstr "" +"Dieses Programm wird unter den Bedingungen der `GNU General Public " +"License `_ veröffentlicht." diff --git a/doc/help/locales/de/LC_MESSAGES/howtoplay.po b/doc/help/locales/de/LC_MESSAGES/howtoplay.po index ecc05dd..2b0b47b 100644 --- a/doc/help/locales/de/LC_MESSAGES/howtoplay.po +++ b/doc/help/locales/de/LC_MESSAGES/howtoplay.po @@ -1,29 +1,31 @@ -# SOME DESCRIPTIVE TITLE. +# German translation of the Tanglet user manual # Copyright (C) 2021 Graeme Gott # This file is distributed under the same license as the Tanglet package. -# FIRST AUTHOR , 2021. # -#, fuzzy +# Mario Blättermann , 2021. msgid "" msgstr "" "Project-Id-Version: Tanglet \n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2021-04-24 10:07-0400\n" -"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" -"Last-Translator: FULL NAME \n" -"Language-Team: LANGUAGE \n" +"PO-Revision-Date: 2021-04-27 19:30+0200\n" +"Last-Translator: Mario Blättermann \n" +"Language-Team: German \n" "MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=utf-8\n" +"Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" "Generated-By: Babel 2.9.0\n" +"Language: de\n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" +"X-Generator: Lokalize 21.04.0\n" #: ../howtoplay.rst:2 msgid "How to Play" -msgstr "" +msgstr "Spielweise" #: ../howtoplay.rst:5 msgid "Using the Mouse" -msgstr "" +msgstr "Mit der Maus" #: ../howtoplay.rst:7 msgid "**Select a word:** Click on the letters of a word." @@ -31,19 +33,22 @@ msgstr "**Wort auswählen:** Auf die Buchstaben eines Worts klicken." #: ../howtoplay.rst:9 msgid "**Make a guess:** Click on the last selected letter." -msgstr "**Einen Versuch machen:** Auf den zuletzt ausgewählten Buchstaben klicken." +msgstr "" +"**Einen Versuch machen:** Auf den zuletzt ausgewählten Buchstaben klicken." #: ../howtoplay.rst:11 msgid "**Erase letters:** Click on an earlier selected letter." -msgstr "**Buchstaben entfernen:** Auf einen vorher ausgewählten Buchstaben klicken." +msgstr "" +"**Buchstaben entfernen:** Auf einen vorher ausgewählten Buchstaben klicken." #: ../howtoplay.rst:13 msgid "**Clear the word:** Click twice on the first selected letter." -msgstr "**Wort löschen:** Zweimal auf den ersten ausgewählten Buchstaben klicken." +msgstr "" +"**Wort löschen:** Zweimal auf den ersten ausgewählten Buchstaben klicken." #: ../howtoplay.rst:16 msgid "Using the Keyboard" -msgstr "" +msgstr "Mit der Tastatur" #: ../howtoplay.rst:18 msgid "**Select a word:** Type the letters of a word." diff --git a/doc/help/locales/de/LC_MESSAGES/index.po b/doc/help/locales/de/LC_MESSAGES/index.po index 2ab4466..d996e08 100644 --- a/doc/help/locales/de/LC_MESSAGES/index.po +++ b/doc/help/locales/de/LC_MESSAGES/index.po @@ -1,39 +1,41 @@ -# SOME DESCRIPTIVE TITLE. +# German translation of the Tanglet user manual. # Copyright (C) 2021 Graeme Gott # This file is distributed under the same license as the Tanglet package. -# FIRST AUTHOR , 2021. # -#, fuzzy +# Mario Blättermann , 2021. msgid "" msgstr "" "Project-Id-Version: Tanglet \n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2021-04-26 15:05-0400\n" -"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" -"Last-Translator: FULL NAME \n" -"Language-Team: LANGUAGE \n" +"PO-Revision-Date: 2021-04-27 19:29+0200\n" +"Last-Translator: Mario Blättermann \n" +"Language-Team: German \n" "MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=utf-8\n" +"Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" "Generated-By: Babel 2.9.0\n" +"Language: de\n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" +"X-Generator: Lokalize 21.04.0\n" #: ../index.rst:2 msgid "Tanglet User Manual" -msgstr "" +msgstr "Benutzerhandbuch für Tanglet" #: ../index.rst:4 msgid "Tanglet |release|" -msgstr "" +msgstr "Tanglet |release|" #: ../index.rst:6 msgid "Copyright © 2009-2021 Graeme Gott" -msgstr "" +msgstr "Copyright © 2009-2021 Graeme Gott" #: ../index.rst:9 msgid "Abstract" -msgstr "" +msgstr "Kurzbeschreibung" #: ../index.rst:11 msgid "A word finding game." -msgstr "" +msgstr "Ein Wortsuchspiel." diff --git a/doc/help/locales/de/LC_MESSAGES/introduction.po b/doc/help/locales/de/LC_MESSAGES/introduction.po index 2897bd5..468fd5c 100644 --- a/doc/help/locales/de/LC_MESSAGES/introduction.po +++ b/doc/help/locales/de/LC_MESSAGES/introduction.po @@ -1,23 +1,25 @@ -# SOME DESCRIPTIVE TITLE. +# German translation of the Tanglet user manual # Copyright (C) 2021 Graeme Gott # This file is distributed under the same license as the Tanglet package. -# FIRST AUTHOR , 2021. # -#, fuzzy +# Mario Blättermann , 2021. msgid "" msgstr "" "Project-Id-Version: Tanglet \n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2021-04-24 10:07-0400\n" -"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" -"Last-Translator: FULL NAME \n" -"Language-Team: LANGUAGE \n" +"PO-Revision-Date: 2021-04-27 19:28+0200\n" +"Last-Translator: Mario Blättermann \n" +"Language-Team: German \n" "MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=utf-8\n" +"Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" "Generated-By: Babel 2.9.0\n" +"Language: de\n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" +"X-Generator: Lokalize 21.04.0\n" #: ../introduction.rst:2 msgid "Introduction" -msgstr "" +msgstr "Einführung"