diff --git a/doc/help/conf.py b/doc/help/conf.py index f2c17a7..04177ec 100644 --- a/doc/help/conf.py +++ b/doc/help/conf.py @@ -19,7 +19,7 @@ # General information about the project. project = 'Tanglet' -copyright = ' 2021 Graeme Gott' +copyright = ' 2026 Graeme Gott' author = 'Graeme Gott' # The version info for the project you're documenting, acts as replacement for @@ -27,9 +27,9 @@ # built documents. # # The short X.Y version. -version = '1.6' +version = '3.0' # The full version, including alpha/beta/rc tags. -release = '1.6.0' +release = '3.0.3' # -- General configuration --------------------------------------------------- @@ -37,7 +37,7 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [] +extensions = [ 'sphinxcontrib.email' ] # Add any paths that contain templates here, relative to this directory. templates_path = [] @@ -70,7 +70,7 @@ # The name for this set of Sphinx documents. # " v documentation" by default. -html_title = 'Tanglet' +html_title = 'Tetzle' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -98,3 +98,6 @@ # If true, Sphinx will add “permalinks” for each heading and description environment. html_permalinks = False + +# Setting to display email adresses as obfuscated mailto links, needs sphinxcontrib-email +email_automode = True diff --git a/doc/help/configuration.rst b/doc/help/configuration.rst index f760fb1..2cd9713 100644 --- a/doc/help/configuration.rst +++ b/doc/help/configuration.rst @@ -1,2 +1,57 @@ +.. _configuration: + Game Configuration -================== +****************** + +To configure :program:`Tanglet`, open the :menuselection:`Settings` menu. You see the +following entries: + +:menuselection:`Show &Maximum Score` – you can choose between three options for +the status line at the bottom of the window: + +* :menuselection:`&Never` – You see word lengths and the count of words found + for each length. + +* :menuselection:`&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. + +* :menuselection:`&Always`: The behavior described for + :menuselection:`&End Of Game` is always visible. + +The visibility of the word count status bar can be toggled with +:menuselection:`Show Word &Counts`. + +:menuselection:`Show Missed &Words` – In addition to the list of found words +on the left, an extra tab named :guilabel:`Missed` will de displayed. This tab +is inactive until the game ends. + +:menuselection:`&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 :guilabel:`Dice`, :guilabel:`Word List` and +:guilabel:`Dictionary` by entering the file paths manually or click on the +respective :guilabel:`Choose…` buttons to open a file chooser dialog. To set +all entries back to the defaults, click on :guilabel:`Defaults` in the bottom +left corner of the window. As usual, you can stop editing the preferences with +the :guilabel:`Cancel` button, and apply the changes with :guilabel:`OK`. Your +changes will be applied after the next start of :program:`Tanglet`. + +Under :menuselection:`Application &Language`, you can change the language of +the user interface. The settings window opens with the button +:guilabel:``. Click on it to change the desired language from +the drop-down menu. Again, your changes will be applied after the next start of +:program:`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 :program:`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..9a9a216 100644 --- a/doc/help/credits.rst +++ b/doc/help/credits.rst @@ -1,6 +1,10 @@ Credits and License -=================== +******************* -Program copyright 2009-2021 Graeme Gott +Program copyright 2009-2026 :email:`Graeme Gott ` -This program is licensed under the terms of the `GNU General Public License `_. +User manual written by :email:`Graeme Gott ` and +:email:`Mario Blättermann ` + +This program is licensed under the terms of the +`GNU General Public License `_. 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..b9d3926 100644 --- a/doc/help/howtoplay.rst +++ b/doc/help/howtoplay.rst @@ -1,22 +1,40 @@ -How to Play -=========== - -Using the Mouse ---------------- - -**Select a word:** Click on the letters of a word. - -**Make a guess:** Click on the last selected letter. - -**Erase letters:** Click on an earlier selected letter. +.. _howtoplay: -**Clear the word:** Click twice on the first selected letter. - -Using the Keyboard ------------------- - -**Select a word:** Type the letters of a word. - -**Make a guess:** Press Enter. - -**Clear the word:** Press Ctrl+Backspace. +How to Play +*********** + ++----------------+-------------------------------------------+------------------------------+ +| Action | Using the mouse | Using the keyboard | ++================+===========================================+==============================+ +| Select a word | Click on the letters of a word. | Type the letters of a word. | ++----------------+-------------------------------------------+------------------------------+ +| Make a guess | Click on the last selected letter. | Press :kbd:`Enter`. | ++----------------+-------------------------------------------+------------------------------+ +| Erase letters | Click on an earlier selected letter. | Press :kbd:`Backspace`. | ++----------------+-------------------------------------------+------------------------------+ +| Clear the word | Click twice on the first selected letter. | Press :kbd:`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 :guilabel:`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..dd9e2a4 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 :email:`Graeme Gott ` Abstract -------- diff --git a/doc/help/introduction.rst b/doc/help/introduction.rst index c516b33..64011f9 100644 --- a/doc/help/introduction.rst +++ b/doc/help/introduction.rst @@ -1,2 +1,132 @@ +.. _introduction: + Introduction -============ +************ + +:program:`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 :menuselection:`Games --> Tanglet` or open +a quick start prompt using :kbd:`Alt-F2` and start typing *tanglet*, then click +on the application name found. + +When :program:`Tanglet` starts, two board sizes are available, 4x4 and 5x5. +Click on one of them to apply. In the drop-down list right to +:guilabel:`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 :guilabel:`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 :program:`Tanglet`. + + +Finally you can choose between different game modes: + +.. figure:: ./figures/tanglet_change_modes.png + +The following modes are available: + +* :guilabel:`Allotment` – Game ends after 30 guesses. + +* :guilabel:`Classic` – Counts fown from 3 minutes. + +* :guilabel:`Discipline` – Counts down from 30 seconds and increases on correct + guesses. + +* :guilabel:`Refill` – Counts down from 30 seconds and refills on correct + guesses. + +* :guilabel:`Stamina` – Counts down from 45 seconds and pauses on correct + guesses. + +* :guilabel:`Strikeout` – Game ends after 3 incorrect guesses. + +* :guilabel:`Tanglet` – Counts down from 30 seconds and increases or decreases + on guesses. + +* :guilabel:`Unlimited` – Game ends when all words are found. + +----------------- +Menu bar overview +----------------- + +*Game* menu +----------- + +* :menuselection:`New &Game` – Starts a new game. If a previous game is still + running, you will asked for confirmation to stop that game. + +* :menuselection:`&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. + +* :menuselection:`&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. + +* :menuselection:`&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 :guilabel:`File type` entry unchanged. We + don't recommend to save files with another extension than :file:`.tanglet`. + +* :menuselection:`&End` – End the game. You will asked for confirmation to stop + the game. + +* :menuselection:`&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. + +* :menuselection:`&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. + +* :menuselection:`&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. + +* :menuselection:`&Quit` – Quits the game and the application. + + +*Settings* menu +--------------- + +See :ref:`configuration` about how to use the entries of the +:menuselection:`&Settings` menu. + + + +*Help* menu +----------- + +* :menuselection:`&Controls` – Shows a brief summary of the usage. In fact, + the same as described in :ref:`howtoplay`. + +.. For the upcoming user manual; mnemonic needs to be added later + +* :menuselection:`User &manual` – Opens this user manual in your configured + standard browser. The opened application is out of the scope of + :program:`Tanglet`; if you like to use a different browser or HTML viewer, + you need to configure this in the settings of your desktop environment. + +* :menuselection:`&About` – Shows a brief summary, including the version number + of :program:`Tanglet`. + +* :menuselection:`About &Qt` – Shows a description of + `Qt `__, which is the code base of :program:`Tanglet`. 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" diff --git a/doc/help/mallard/configuration.page b/doc/help/mallard/configuration.page new file mode 100644 index 0000000..f45cc26 --- /dev/null +++ b/doc/help/mallard/configuration.page @@ -0,0 +1,115 @@ + + + + + + + Configuration + Configuration + + + How to configure the game. + + + Graeme Gott + graeme@gottcode.org + + + Mario Blättermann + mario.blaettermann@gmail.com + + +

Creative Commons Share Alike 4.0

+ + + + 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:

+ + +
+ Listed maximum scores + + +
+ + + + +

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.

+ + +
+ Word count status + + +
+ + +

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:

+ + +
+ Language settings + +

Language settings

+ +
+ + +

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 System + language. 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.

+ + + +

Not all translated captions come from Tanglet itself. Because + some of them are provided by the underlying Qt libraries, it + might happen that some captions are still displayed in the system + language. Maybe the following command is known to you for opening an + application with different language settings:

+ + + $ export LC_ALL=C && tanglet + +

This helps in such cases to switch completely to the desired language.

+ + diff --git a/doc/help/mallard/contributing.page b/doc/help/mallard/contributing.page new file mode 100644 index 0000000..06eb5f2 --- /dev/null +++ b/doc/help/mallard/contributing.page @@ -0,0 +1,67 @@ + + + + + + + Contributing + Contributing + + + Contributing to the development of Tanglet. + + + Graeme Gott + graeme@gottcode.org + + + Mario Blättermann + mario.blaettermann@gmail.com + + +

Creative Commons Share Alike 4.0

+ + + + Contributing +

The Tanglet development is maintained in a + Github repository. +

+
+ Contributing with code +

If you have a Github account, feel free to fork the project, apply and + commit your changes and open a Pull Request. This is the preferred way.

+
+
+ Issue tickets +

You found a bug, like to request a new feature or have any other + suggestion? Please got to + our issue tracker + and open a new one by clicking on New issue in the top + right corner of the page. This also applies for the documentation, if + parts are confusing or missing, or for wrong translations. Regarding + incomplete translations: Don't treat it as a bug worth to be filed. Our + translators don't always have as much time as needed, so translations may + be incomplete.

+
+
+ Translations +

Tanglet is available in various languages. The appropriate + .ts and .po files are maintained at + Transifex. + If you like to contribute to translations, register or sign in there, + join a translation team or create a new one for your desired language, + if needed.

+

For the translations itself, Transifex offers a web-based editor. If + you prefer to work on the files directly, you can also download and edit + them locally in your preferred tool.

+

Although Tanglet is not part of any integrated desktop + environment, please always try to follow the basic rules of well-known + translation teams for your language, for example, those of the + KDE or + GNOME teams.

+
+ diff --git a/doc/help/mallard/credits.page b/doc/help/mallard/credits.page new file mode 100644 index 0000000..47ab23e --- /dev/null +++ b/doc/help/mallard/credits.page @@ -0,0 +1,47 @@ + + + + + + + Credits + Credits + + + Credits and licensing conditions of Tanglet. + + + Graeme Gott + graeme@gottcode.org + + + Mario Blättermann + mario.blaettermann@gmail.com + + +

Creative Commons Share Alike 4.0

+ + + + Credits and License + +

Program copyright 2009-2026 + Graeme Gott

+ +

User manual written by Graeme + Gott and Mario + Blättermann

+ +

For a list of contributors, see + here.

+ +

This program is licensed under the terms of the + GNU General Public License.

+ +

This manual is licensed under the terms of the + Creative Commons Share Alike 4.0.

+ + diff --git a/doc/help/mallard/figures/tanglet_board.png b/doc/help/mallard/figures/tanglet_board.png new file mode 100644 index 0000000..a0ade5c Binary files /dev/null and b/doc/help/mallard/figures/tanglet_board.png differ diff --git a/doc/help/mallard/figures/tanglet_board_language.png b/doc/help/mallard/figures/tanglet_board_language.png new file mode 100644 index 0000000..b2ef32d Binary files /dev/null and b/doc/help/mallard/figures/tanglet_board_language.png differ diff --git a/doc/help/mallard/figures/tanglet_change_modes.png b/doc/help/mallard/figures/tanglet_change_modes.png new file mode 100644 index 0000000..9dc3918 Binary files /dev/null and b/doc/help/mallard/figures/tanglet_change_modes.png differ diff --git a/doc/help/mallard/figures/tanglet_toggle_maximum_score_display.png b/doc/help/mallard/figures/tanglet_toggle_maximum_score_display.png new file mode 100644 index 0000000..2e856d1 Binary files /dev/null and b/doc/help/mallard/figures/tanglet_toggle_maximum_score_display.png differ diff --git a/doc/help/mallard/figures/tanglet_word_counts.png b/doc/help/mallard/figures/tanglet_word_counts.png new file mode 100644 index 0000000..10bb8b2 Binary files /dev/null and b/doc/help/mallard/figures/tanglet_word_counts.png differ diff --git a/doc/help/mallard/files.page b/doc/help/mallard/files.page new file mode 100644 index 0000000..4581b60 --- /dev/null +++ b/doc/help/mallard/files.page @@ -0,0 +1,74 @@ + + + + + + + Files + Files used by <app>Tanglet</app>. + + + Information about configuration files and exported games. + + + Graeme Gott + graeme@gottcode.org + + + Mario Blättermann + mario.blaettermann@gmail.com + + +

Creative Commons Share Alike 4.0

+ + + + Files + +

The files used by Tanglet are not intended for manual + editing. Do not do so unless you know exactly what you are doing.

+ +
+ User configuration file +

The user configuration is located in the + ~/.config/Gottcode/Tanglet.conf file. The folder + ~/.config/Gottcode/ is shared with other + Gottcode games, therefore, + make sure you don't mix anything up. As mentioned above, the file is + not intended to be edited manually. However, if you actually want to + edit it, your game scores could be lost. Be aware of this.

+
+
+ Saved Games +

A game you save using GameSave… + is a text file, compressed with gzip. If you are curious + enough, you can unpack such a file using the following command:

+ + $ rename tanglet gz savedgame.tanglet && gunzip savedgame.gz + +
+ File structure +

The first four lines after [Game] mirror the settings of the board language.

+

Seven more lines follow:

+ +

Letters – The letters shown in the board. +

+ +

Locale – The configured Locale for the board. +

+

Minimum – Minimum word length.

 +

Size – Size of the board.

 +

TimerMode – Timer mode, depending on the + initially chosen game.

 + +

Version – TBD.

 +

Words – The used wordlist

 + +

We don't recommend to change anything here. It can easily happen + that the file becomes unusable.

+
+
+ diff --git a/doc/help/mallard/howtoplay.page b/doc/help/mallard/howtoplay.page new file mode 100644 index 0000000..c49a2e2 --- /dev/null +++ b/doc/help/mallard/howtoplay.page @@ -0,0 +1,140 @@ + + + + + + + How to Play + How to Play + + + How to play Tanglet. + + + Graeme Gott + graeme@gottcode.org + + + Mario Blättermann + mario.blaettermann@gmail.com + + +

Creative Commons Share Alike 4.0

+ + + + How to Play +
+ Mouse and Keyboard Controls + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Action

Using the mouse

Using the keyboard

Select a word

Click on the letters of a word.

Type the letters of a word.

Make a guess

Click on the last selected letter.

Press Enter.

Erase letters

Click on an earlier selected letter.

Press Backspace.

Clear the word

Click twice on the first selected letter.

Press CtrlBackspace.

+
+
+ Activating a Word + +

If you found a word, click on te first letter. Now you will see around + this field the letters you can choose from to continue the word; all other + fields are grayed out.

+

While entering the letters, the word will be displayed above the word + list on the left.

+ + + +
+ The board with an activated word + + + +
+ + +

Once you found a word you think it's valid, double-click on the last + activated letter or press Return. If Tanglet accepts + it, it will be displayed in the list tab Found left to the + board.

+

In case you find the word again (also in a different letter + sequence on the board), it will be highlighted in this list.

+

If the word can be extended with one or more letters to form a new one, + click on it to display it again on the board, and you can click on the + white fields to add more letters to create a new word. Note, you earn + points for the whole new word, not only for the newly added + letters!

+

If you activate letters using the keyboard or you accidentally press a + key with a letter which is not reachable from the current word end, or + even doesn't exist on the board, the whole board will be grayed out and + the field above the word list will be displayed with a red + background.

+ + +

When the game ends and if you have achieved a place among the top ten in + the chosen game mode, the High Scores list appears. Under + Name, your name (taken from your user account) is already + entered, but highlighted. If you like to use a different name, or anyone + else has played the game, you can change the name directly, or leave it + as-is. In either case, finally click on Close.

+

You can close the game at any time. When closing the game without it has + ended, the same game at the same score will be opened when + Tanglet starts next time.

+
+ +
+ Show missed words +

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.

+
+
+ Show high scores +

Choose GameShow High Scores to + open the High Scores list. To switch between the various game modes, use + the vertical tab bar on the left.

+
+
+ Export or import a game +

To export a game, choose + GameShare…. A file saver dialog + opens where you can type a file name and specify a location where the + file will be saved. Note, the saved file contains only the game + properties itself, not your found words or earned points. See also + the explanation of the file structure. +

+

Vice versa, you can choose + GameChoose…. A file chooser + dialog opens where you can navigate to the desired file and + open it.

+
+ diff --git a/doc/help/mallard/index.page b/doc/help/mallard/index.page new file mode 100644 index 0000000..292869a --- /dev/null +++ b/doc/help/mallard/index.page @@ -0,0 +1,101 @@ + + + + + + + Tanglet + Tanglet + + + Graeme Gott + graeme@gottcode.org + + + Mario Blättermann + mario.blaettermann@gmail.com + + +

Creative Commons Share Alike 4.0

+ + + + Tanglet user manual +
+

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 + AltF2 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:

+ + +
+ Game modes + +

Change game modes.

+ +
+ + +

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.

 + +
+ +
+ How to Play +
+ +
+ Configuration +
+ +
+ References +
+ + diff --git a/doc/help/mallard/menubar.page b/doc/help/mallard/menubar.page new file mode 100644 index 0000000..2918b34 --- /dev/null +++ b/doc/help/mallard/menubar.page @@ -0,0 +1,92 @@ + + + + + + + Menu Bar Overview + Menu Bar Overview + + + How to use the menu bar entries. + + + Graeme Gott + graeme@gottcode.org + + + Mario Blättermann + mario.blaettermann@gmail.com + + +

Creative Commons Share Alike 4.0

+ + + + Menu Bar Overview + +
+ <gui>Game</gui> 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.

 + +
+ +
+ <gui>Settings</gui> menu + +

See about how to use the entries of the + Settings menu.

+
+ +
+ <gui>Help</gui> menu + +

Controls – Shows a brief summary of the usage. In + fact, the same as described in the + page.

 +

User manual – Opens this user manual in your + configured standard browser. The opened application 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.

 + +
+