kanagram/doc/index.docbook

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003  <!ENTITY kanagram "<application>Kanagram</application>">
0004  <!ENTITY % addindex "IGNORE">
0005  <!ENTITY % English "INCLUDE"><!-- change language only here -->
0006 ]>
0007
0008 <book id="kanagram" lang="&language;">
0009
0010 <bookinfo>
0011 <title>The &kanagram; Handbook</title>
0012
0013 <authorgroup>
0014 <author>
0015 <firstname>Danny</firstname>
0016 <surname>Allen</surname>
0017 <affiliation>
0018 <address>&Danny.Allen.mail;</address>
0019 </affiliation>
0020 </author>
0021 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0022 </authorgroup>
0023
0024 <copyright>
0025 <year>2005</year>
0026 <holder>&Danny.Allen;</holder>
0027 </copyright>
0028
0029 <legalnotice>&FDLNotice;</legalnotice>
0030
0031 <date>2020-12-21</date>
0032 <releaseinfo>Applications 20.12</releaseinfo>
0033
0034 <abstract>
0035 <para>
0036 &kanagram; brings fun anagram puzzles to &kde;.
0037 </para>
0038 </abstract>
0039
0040 <keywordset>
0041 <keyword>KDE</keyword>
0042 <keyword>kdeedu</keyword>
0043 <keyword>Kanagram</keyword>
0044 <keyword>game</keyword>
0045 <keyword>child</keyword>
0046 <keyword>anagram</keyword>
0047 <keyword>words</keyword>
0048 <keyword>jumble</keyword>
0049 </keywordset>
0050
0051 </bookinfo>
0052
0053 <chapter id="introduction">
0054 <title>Introduction</title>
0055
0056 <para>
0057 &kanagram; is a game based on anagrams of words: the puzzle is solved when the letters of the scrambled word are put back in the correct order. There is no limit on either time taken, or the number of attempts to solve the word. Included with &kanagram; are several vocabularies ready to play, with many more available from the Internet.
0058 </para>
0059
0060 </chapter>
0061
0062
0063 <chapter id="using-kanagram">
0064 <title>Using &kanagram;</title>
0065
0066 <para>
0067 Here is the screen that is presented on startup of &kanagram;, showing the main interface to the application. Much of the window is taken up by the <interface>blackboard</interface>, where the puzzles are written, with the <interface>filing cabinet</interface> on the right containing application controls.
0068 </para>
0069
0070 <screenshot>
0071 <screeninfo>Here is the screen that is presented on startup of &kanagram;</screeninfo>
0072 <mediaobject>
0073 <imageobject>
0074 <imagedata fileref="kanagram.png" format="PNG"/>
0075 </imageobject>
0076 <textobject>
0077 <phrase>&kanagram; screenshot</phrase>
0078 </textobject>
0079 </mediaobject>
0080 </screenshot>
0081
0082 <orderedlist>
0083 <listitem>
0084 <para>
0085 The <interface>Vocabulary Switcher</interface> (&PgUp; / &PgDn;) allows the user to quickly <action>change the active vocabulary</action> by clicking with the &LMB; on the arrows to <action>advance to the next vocabulary</action> or to <action>return to the previously-played vocabulary</action>.
0086 </para>
0087 </listitem>
0088 <listitem>
0089 <para>
0090 In the center of the <interface>blackboard</interface> is the anagram puzzle to be solved.
0091 </para>
0092 </listitem>
0093 <listitem>
0094 <para>
0095 This is the <guiicon>Start Timer</guiicon> (<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>) button, and allows you to <action>start or stop the scoring timer</action>.
0096 </para>
0097 </listitem>
0098 <listitem>
0099 <para>
0100 When the <guibutton>Hint</guibutton> (<keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo>) button is clicked, a short sentence will appear, <action>describing the current word puzzle</action>.
0101 </para>
0102 </listitem>
0103 <listitem>
0104 <para>
0105 The <guibutton>Reveal Word</guibutton> (<keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo>) button <action>solves the current word puzzle</action>.
0106 </para>
0107 </listitem>
0108 <listitem>
0109 <para>
0110 The <interface>Entry Box</interface> allows you to <action>input your attempts</action> to solve the current word puzzle.
0111 </para>
0112 </listitem>
0113 <listitem>
0114 <para>
0115 The <interface>Next Anagram</interface> (<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>) button lets you switch to the next guess.
0116 </para>
0117 </listitem>
0118 <listitem>
0119 <para>
0120 This is the <guiicon>Configure</guiicon> button, which <action>opens the <guilabel>Configure</guilabel> &kanagram; dialog</action>.
0121 </para>
0122 </listitem>
0123 <listitem>
0124 <para>
0125 The <guiicon>Help</guiicon> button is special, in that it <action>reveals 3 sub-buttons</action>. These buttons are shown when the <guiicon>Help</guiicon> button is hovered over, and provide access to the <guilabel>&kanagram; Handbook</guilabel> (this document), and the <guilabel>About &kanagram;</guilabel> and <guilabel>About &kde;</guilabel> dialogs:
0126
0127 <screenshot>
0128 <screeninfo>The 3 different states of the <guiicon>Help</guiicon> button</screeninfo>
0129 <mediaobject>
0130 <imageobject>
0131 <imagedata fileref="helpstates.png" format="PNG"/>
0132 </imageobject>
0133 <textobject>
0134 <phrase>&kanagram; screenshot</phrase>
0135 </textobject>
0136 </mediaobject>
0137 </screenshot>
0138 </para>
0139 </listitem>
0140 <listitem>
0141 <para>
0142 Use the <guiicon>Change mode</guiicon> button to switch between 1 and 2 player mode.
0143 </para>
0144 </listitem>
0145 <listitem>
0146 <para>
0147 The <guiicon>Quit</guiicon> button <action>closes the application</action>.
0148 </para>
0149 </listitem>
0150 </orderedlist>
0151
0152 <sect1 id="playing-game">
0153 <title>Playing a game</title>
0154
0155 <para>
0156 Now that you are familiar with the user interface of &kanagram;, lets play a game!
0157 </para>
0158
0159 <procedure>
0160 <step>
0161 <para>
0162 Using the <interface>Vocabulary Switcher</interface>, <action>select the vocabulary theme</action> that you would like to attempt. A word from this vocabulary will then be presented in the middle of the <interface>blackboard</interface>. Now, try and guess what word the jumble of letters represents.
0163 <tip>
0164 <para>
0165 If you cannot guess what the word is, press the <guibutton>Hint</guibutton> button to get some friendly advice from your friend in the <interface>filing cabinet</interface>:
0166 </para>
0167 <screenshot>
0168 <screeninfo>&kanagram; hint</screeninfo>
0169 <mediaobject>
0170 <imageobject>
0171 <imagedata fileref="kanagram-hint.png" format="PNG"/>
0172 </imageobject>
0173 <textobject>
0174 <phrase>&kanagram; hint</phrase>
0175 </textobject>
0176 </mediaobject>
0177 </screenshot>
0178 </tip>
0179 </para>
0180 </step>
0181
0182 <step>
0183 <para>
0184 Once you think you know the correct answer, type the letters into the <interface>Entry Box</interface> below the <interface>blackboard</interface>, or click them with the &LMB; and the letters will move down to the entry box. If you are correct, the next anagram appears, otherwise all the letters jump back onto the blackboard.
0185 </para>
0186 </step>
0187 </procedure>
0188
0189 </sect1>
0190
0191 </chapter>
0192
0193
0194 <chapter id="configuring">
0195 <title>Configuring &kanagram;</title>
0196
0197 <para>
0198 The <guilabel>Configure</guilabel> dialog is opened by clicking on the <guiicon>Configure</guiicon> button:
0199 </para>
0200
0201 <screenshot>
0202 <screeninfo>&kanagram; general settings</screeninfo>
0203 <mediaobject>
0204 <imageobject>
0205 <imagedata fileref="general-settings.png" format="PNG"/>
0206 </imageobject>
0207 <textobject>
0208 <phrase>&kanagram; general settings</phrase>
0209 </textobject>
0210 </mediaobject>
0211 </screenshot>
0212
0213 <itemizedlist>
0214
0215 <listitem>
0216 <para>
0217 The <guilabel>Auto-hide hints after:</guilabel> drop down box allows you to specify how hints are presented to you. Here, you can set the hint box to disappear after a certain amount of seconds (&eg; 5 seconds), or you can leave it as default (<quote>Do Not Auto-Hide Hints</quote>).
0218 </para>
0219 </listitem>
0220
0221 <listitem>
0222 <para>
0223 Use the <guilabel>Time for resolving the anagram:</guilabel> drop down box to specify the time you have to resolve each puzzle. By default there is <quote>No time limit</quote>.
0224 </para>
0225 </listitem>
0226
0227 <listitem>
0228 <para>
0229 The <guilabel>Play Using:</guilabel> drop down box allows you to play &kanagram; using vocabularies of a different language. For this feature to work, you must have vocabularies of a separate language installed.
0230 </para>
0231 </listitem>
0232
0233 <listitem>
0234 <para>
0235 The <guilabel>Set timer for scoring purpose:</guilabel> drop down box allows you to set in seconds the time interval of the scoring timer.
0236 </para>
0237 </listitem>
0238
0239 <listitem>
0240 <para>
0241 The <guilabel>Score Point Settings</guilabel> checkbox can be used to reveal or hide options to configure scoring of answers.
0242 </para>
0243 </listitem>
0244
0245 <listitem>
0246 <para>
0247 The <guilabel>Use sounds</guilabel> check box allows you to either allow or suppress sound effects.
0248 </para>
0249 </listitem>
0250
0251 <listitem>
0252 <para>
0253 The <guilabel>Only uppercase letters</guilabel> check box allows you to switch &kanagram; to the uppercase only mode for words on the blackboard.
0254 </para>
0255 </listitem>
0256
0257 <listitem>
0258 <para>
0259 The <guilabel>Say correct words</guilabel> check box allows you to turn pronunciations on or off. The audio files of the pronunciations should be included in the vocabulary being played, or else you should install and configure &jovie; for this option to work.
0260 </para>
0261 </listitem>
0262 </itemizedlist>
0263
0264 <sect1 id="vocabularies-config">
0265 <title>Vocabularies</title>
0266
0267 <para>
0268 The <guilabel>Vocabularies</guilabel> configuration page allows you to manage your installed vocabularies. Using this dialog, you can <action>edit</action> and <action>remove</action> downloaded vocabularies, as well as <action>create</action> your very own:
0269 </para>
0270
0271 <screenshot>
0272 <screeninfo>&kanagram; vocabulary settings</screeninfo>
0273 <mediaobject>
0274 <imageobject>
0275 <imagedata fileref="vocab-settings.png" format="PNG"/>
0276 </imageobject>
0277 <textobject>
0278 <phrase>&kanagram; vocabulary settings</phrase>
0279 </textobject>
0280 </mediaobject>
0281 </screenshot>
0282
0283 <itemizedlist>
0284 <listitem>
0285 <para>
0286 The <guibutton>Create New</guibutton> button <action>opens the <link
0287 linkend="vocab-editor"><guilabel>Vocabulary Editor</guilabel></link> dialog</action> so that you can author your own vocabularies which you can then play with.
0288 </para>
0289 </listitem>
0290 <listitem>
0291 <para>
0292 The <guibutton>Edit</guibutton> button allows you to <action>make changes to vocabularies that you have either created or downloaded off the Internet</action>.
0293 </para>
0294 </listitem>
0295 <!-- not in 4.5 listitem>
0296 <para>
0297 The <guibutton>Delete</guibutton> button allows you to <action>delete vocabularies that you have created or downloaded</action>.
0298 </para>
0299 </listitem-->
0300 <listitem>
0301 <para>
0302 You can select which vocabulary you would like to apply these actions to by using the <interface>list of vocabularies</interface>.
0303 </para>
0304 </listitem>
0305 </itemizedlist>
0306
0307 <sect2 id="vocab-editor">
0308 <title>Vocabulary Editor</title>
0309
0310 <para>
0311 The Vocabulary Editor allows you to create your own vocabularies, which &kanagram; can then test you with:
0312 </para>
0313
0314 <screenshot>
0315 <screeninfo>&kanagram; <guilabel>Vocabulary Editor</guilabel></screeninfo>
0316 <mediaobject>
0317 <imageobject>
0318 <imagedata fileref="vocab-editor.png" format="PNG"/>
0319 </imageobject>
0320 <textobject>
0321 <phrase>&kanagram; <guilabel>Vocabulary Editor</guilabel></phrase>
0322 </textobject>
0323 </mediaobject>
0324 </screenshot>
0325
0326 <itemizedlist>
0327 <listitem>
0328 <para>
0329 The <guilabel>Vocabulary Name:</guilabel> field lets you <action>name your vocabulary</action>.
0330 </para>
0331 </listitem>
0332 <listitem>
0333 <para>
0334 The <guilabel>Description:</guilabel> field enables you to <action>expand your vocabulary name</action>, providing the user with more details of the content of your vocabulary.
0335 </para>
0336 <note>
0337 <para>
0338 Try to keep both the name and description fields as short as possible. Effective vocabularies cover a narrow, focused set of words for a single subject. Try to write at least 20 words for your vocabulary, so that it will not be finished too quickly.
0339 </para>
0340 </note>
0341 </listitem>
0342 <listitem>
0343 <para>
0344 The <guibutton>Remove Word</guibutton> button lets you <action>remove words from your vocabulary</action>.
0345 </para>
0346 </listitem>
0347 <listitem>
0348 <para>
0349 The <guibutton>New Word</guibutton> button <action>creates a new word entry in your vocabulary</action>, ready for you to expand.
0350 </para>
0351 </listitem>
0352 <listitem>
0353 <para>
0354 The <guilabel>Word:</guilabel> field lets you <action>write word values into your vocabulary</action>.
0355 </para>
0356 </listitem>
0357 <listitem>
0358 <para>
0359 The <guilabel>Hint</guilabel> field allows you to <action>write hints to accompany your words</action>.
0360 </para>
0361 <note>
0362 <para>
0363 Good hints clearly yet subtly describe the word, while also increasing the knowledge of the user. Also ensure that your hints are fairly short (under 40 characters in length).
0364 </para>
0365 </note>
0366 </listitem>
0367 <listitem>
0368 <para>
0369 The <guibutton>Save</guibutton> button <action>saves your new vocabulary content</action>, and enables its use directly in &kanagram; (it will immediately become available within the application, selectable via. the <interface>Vocabulary Selector</interface>).
0370 </para>
0371 </listitem>
0372 <listitem>
0373 <para>
0374 The <guibutton>Close</guibutton> button <action>closes the <guilabel>Vocabulary Editor</guilabel> dialog</action> without saving the content of your new or modified vocabulary.
0375 </para>
0376 </listitem>
0377 </itemizedlist>
0378 </sect2>
0379
0380 </sect1>
0381
0382 <sect1 id="newstuff">
0383 <title>New Stuff</title>
0384
0385 <para>
0386 The <guibutton>Download new vocabulary</guibutton> button on the <guilabel>Vocabularies</guilabel>
0387 configuration page allows you to obtain new vocabulary files from the Internet:
0388 </para>
0389
0390 <screenshot>
0391 <screeninfo>&kanagram; new stuff dialog</screeninfo>
0392 <mediaobject>
0393 <imageobject>
0394 <imagedata fileref="newstuff-dialog.png" format="PNG"/>
0395 </imageobject>
0396 <textobject>
0397 <phrase>&kanagram; new stuff dialog</phrase>
0398 </textobject>
0399 </mediaobject>
0400 </screenshot>
0401
0402 <para>
0403 To install a vocabulary from the Internet, click on the vocabulary item in the list, then press the <guibutton>Install</guibutton> button to install to your system. The downloaded vocabulary will then be available to play immediately.
0404 </para>
0405 <para>If you have already downloaded a vocabulary this button will change to <guibutton>Uninstall</guibutton> which allows you to remove a vocabulary.
0406 </para>
0407 <para>To get more information about a vocabulary like the author, a description about the content, and the changelog, press the <guibutton>Details</guibutton> button.
0408 </para>
0409 </sect1>
0410 </chapter>
0411
0412
0413 <chapter id="credits">
0414 <title>Credits and License</title>
0415
0416 <para>
0417 &kanagram;
0418 </para>
0419 <para>
0420 Program copyright 2007 Jeremy Whiting <email>jpwhiting@kde.org</email> 2005 Joshua Keel <email>joshuakeel@gmail.com</email> and &Danny.Allen; &Danny.Allen.mail;
0421 </para>
0422 <para>
0423 Contributors:
0424 </para>
0425 <itemizedlist>
0426 <listitem>
0427 <para>Sound effects: Artemio
0428 <email>fillme</email>
0429 </para>
0430 </listitem>
0431 </itemizedlist>
0432
0433 <para>
0434 Documentation copyright 2005 &Danny.Allen; &Danny.Allen.mail;
0435 </para>
0436
0437 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0438
0439 &underFDL;
0440 &underGPL;
0441
0442 </chapter>
0443
0444 &documentation.index;
0445 </book>
0446 <!--
0447 Local Variables:
0448 mode: sgml
0449 sgml-minimize-attributes:nil
0450 sgml-general-insert-case:lower
0451 sgml-indent-step:0
0452 sgml-indent-data:nil
0453 End:
0454
0455 // vim:ts=2:sw=2:tw=78:noet:noai
0456 -->