Warning, /education/kanagram/doc/index.docbook is written in an unsupported language. File is not indexed.

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 <!--FIXME 
0053 Debjit Mondal "Show Wiki Content" (hidden -> crash?) https://debjitmondal.blogspot.com/
0054 Souvik Das   SoK Project- 2player Implementation https://dassouvik.wordpress.com/2015/01/13/kanagram-is-now-2-player/
0055 Hide 'Say correct words' option if built without QtSpeech/Jovie
0056 -->
0057 <chapter id="introduction">
0058 <title>Introduction</title>
0059 
0060 <para>
0061 &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.
0062 </para>
0063 
0064 </chapter>
0065 
0066 
0067 <chapter id="using-kanagram">
0068 <title>Using &kanagram;</title>
0069 
0070 <para>
0071 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.
0072 </para>
0073 
0074 <screenshot>
0075 <screeninfo>Here is the screen that is presented on startup of &kanagram;</screeninfo>
0076 <mediaobject>
0077 <imageobject>
0078 <imagedata fileref="kanagram.png" format="PNG"/>
0079 </imageobject>
0080 <textobject>
0081 <phrase>&kanagram; screenshot</phrase>
0082 </textobject>
0083 </mediaobject>
0084 </screenshot>
0085 
0086 <orderedlist>
0087 <listitem>
0088 <para>
0089 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>.
0090 </para>
0091 </listitem>
0092 <listitem>
0093 <para>
0094 In the center of the <interface>blackboard</interface> is the anagram puzzle to be solved.
0095 </para>
0096 </listitem>
0097 <listitem>
0098 <para>
0099 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>.
0100 </para>
0101 </listitem>
0102 <listitem>
0103 <para>
0104 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>.
0105 </para>
0106 </listitem>
0107 <listitem>
0108 <para>
0109 The <guibutton>Reveal Word</guibutton> (<keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo>) button <action>solves the current word puzzle</action>.
0110 </para>
0111 </listitem>
0112 <listitem>
0113 <para>
0114 The <interface>Entry Box</interface> allows you to <action>input your attempts</action> to solve the current word puzzle.
0115 </para>
0116 </listitem>
0117 <listitem>
0118 <para>
0119 The <interface>Next Anagram</interface> (<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>) button lets you switch to the next guess.
0120 </para>
0121 </listitem>
0122 <listitem>
0123 <para>
0124 This is the <guiicon>Configure</guiicon> button, which <action>opens the <guilabel>Configure</guilabel> &kanagram; dialog</action>.
0125 </para>
0126 </listitem>
0127 <listitem>
0128 <para>
0129 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:
0130 
0131 <screenshot>
0132 <screeninfo>The 3 different states of the <guiicon>Help</guiicon> button</screeninfo>
0133 <mediaobject>
0134 <imageobject>
0135 <imagedata fileref="helpstates.png" format="PNG"/>
0136 </imageobject>
0137 <textobject>
0138 <phrase>&kanagram; screenshot</phrase>
0139 </textobject>
0140 </mediaobject>
0141 </screenshot>
0142 </para>
0143 </listitem>
0144 <listitem>
0145 <para>
0146 Use the <guiicon>Change mode</guiicon> button to switch between 1 and 2 player mode.
0147 </para>
0148 </listitem>
0149 <listitem>
0150 <para>
0151 The <guiicon>Quit</guiicon> button <action>closes the application</action>.
0152 </para>
0153 </listitem>
0154 </orderedlist>
0155 
0156 <sect1 id="playing-game">
0157 <title>Playing a game</title>
0158 
0159 <para>
0160 Now that you are familiar with the user interface of &kanagram;, lets play a game!
0161 </para>
0162 
0163 <procedure>
0164 <step>
0165 <para>
0166 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.
0167 <tip>
0168 <para>
0169 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>:
0170 </para>
0171 <screenshot>
0172 <screeninfo>&kanagram; hint</screeninfo>
0173 <mediaobject>
0174 <imageobject>
0175 <imagedata fileref="kanagram-hint.png" format="PNG"/>
0176 </imageobject>
0177 <textobject>
0178 <phrase>&kanagram; hint</phrase>
0179 </textobject>
0180 </mediaobject>
0181 </screenshot>
0182 </tip>
0183 </para>
0184 </step>
0185 
0186 <step>
0187 <para>
0188 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.
0189 </para>
0190 </step>
0191 </procedure>
0192 
0193 </sect1>
0194 
0195 </chapter>
0196 
0197 
0198 <chapter id="configuring">
0199 <title>Configuring &kanagram;</title>
0200 
0201 <para>
0202 The <guilabel>Configure</guilabel> dialog is opened by clicking on the <guiicon>Configure</guiicon> button:
0203 </para>
0204 
0205 <screenshot>
0206 <screeninfo>&kanagram; general settings</screeninfo>
0207 <mediaobject>
0208 <imageobject>
0209 <imagedata fileref="general-settings.png" format="PNG"/>
0210 </imageobject>
0211 <textobject>
0212 <phrase>&kanagram; general settings</phrase>
0213 </textobject>
0214 </mediaobject>
0215 </screenshot>
0216 
0217 <itemizedlist>
0218 
0219 <listitem>
0220 <para>
0221 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>).
0222 </para>
0223 </listitem>
0224 
0225 <listitem>
0226 <para>
0227 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>.
0228 </para>
0229 </listitem>
0230 
0231 <listitem>
0232 <para>
0233 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.
0234 </para>
0235 </listitem>
0236 
0237 <listitem>
0238 <para>
0239 The <guilabel>Set timer for scoring purpose:</guilabel> drop down box allows you to set in seconds the time interval of the scoring timer.
0240 </para>
0241 </listitem>
0242 
0243 <listitem>
0244 <para>
0245 The <guilabel>Score Point Settings</guilabel> checkbox can be used to reveal or hide options to configure scoring of answers.
0246 </para>
0247 </listitem>
0248 
0249 <listitem>
0250 <para>
0251 The <guilabel>Use sounds</guilabel> check box allows you to either allow or suppress sound effects.
0252 </para>
0253 </listitem>
0254 
0255 <listitem>
0256 <para>
0257 The <guilabel>Only uppercase letters</guilabel> check box allows you to switch &kanagram; to the uppercase only mode for words on the blackboard.
0258 </para>
0259 </listitem>
0260 
0261 <listitem>
0262 <para>
0263 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.
0264 </para>
0265 </listitem>
0266 </itemizedlist>
0267 
0268 <sect1 id="vocabularies-config">
0269 <title>Vocabularies</title>
0270 
0271 <para>
0272 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:
0273 </para>
0274 
0275 <screenshot>
0276 <screeninfo>&kanagram; vocabulary settings</screeninfo>
0277 <mediaobject>
0278 <imageobject>
0279 <imagedata fileref="vocab-settings.png" format="PNG"/>
0280 </imageobject>
0281 <textobject>
0282 <phrase>&kanagram; vocabulary settings</phrase>
0283 </textobject>
0284 </mediaobject>
0285 </screenshot>
0286 
0287 <itemizedlist>
0288 <listitem>
0289 <para>
0290 The <guibutton>Create New</guibutton> button <action>opens the <link
0291 linkend="vocab-editor"><guilabel>Vocabulary Editor</guilabel></link> dialog</action> so that you can author your own vocabularies which you can then play with.
0292 </para>
0293 </listitem>
0294 <listitem>
0295 <para>
0296 The <guibutton>Edit</guibutton> button allows you to <action>make changes to vocabularies that you have either created or downloaded off the Internet</action>.
0297 </para>
0298 </listitem>
0299 <!-- not in 4.5 listitem>
0300 <para>
0301 The <guibutton>Delete</guibutton> button allows you to <action>delete vocabularies that you have created or downloaded</action>.
0302 </para>
0303 </listitem-->
0304 <listitem>
0305 <para>
0306 You can select which vocabulary you would like to apply these actions to by using the <interface>list of vocabularies</interface>.
0307 </para>
0308 </listitem>
0309 </itemizedlist>
0310 
0311 <sect2 id="vocab-editor">
0312 <title>Vocabulary Editor</title>
0313 
0314 <para>
0315 The Vocabulary Editor allows you to create your own vocabularies, which &kanagram; can then test you with:
0316 </para>
0317 
0318 <screenshot>
0319 <screeninfo>&kanagram; <guilabel>Vocabulary Editor</guilabel></screeninfo>
0320 <mediaobject>
0321 <imageobject>
0322 <imagedata fileref="vocab-editor.png" format="PNG"/>
0323 </imageobject>
0324 <textobject>
0325 <phrase>&kanagram; <guilabel>Vocabulary Editor</guilabel></phrase>
0326 </textobject>
0327 </mediaobject>
0328 </screenshot>
0329 
0330 <itemizedlist>
0331 <listitem>
0332 <para>
0333 The <guilabel>Vocabulary Name:</guilabel> field lets you <action>name your vocabulary</action>.
0334 </para>
0335 </listitem>
0336 <listitem>
0337 <para>
0338 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.
0339 </para>
0340 <note>
0341 <para>
0342 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.
0343 </para>
0344 </note>
0345 </listitem>
0346 <listitem>
0347 <para>
0348 The <guibutton>Remove Word</guibutton> button lets you <action>remove words from your vocabulary</action>.
0349 </para>
0350 </listitem>
0351 <listitem>
0352 <para>
0353 The <guibutton>New Word</guibutton> button <action>creates a new word entry in your vocabulary</action>, ready for you to expand.
0354 </para>
0355 </listitem>
0356 <listitem>
0357 <para>
0358 The <guilabel>Word:</guilabel> field lets you <action>write word values into your vocabulary</action>.
0359 </para>
0360 </listitem>
0361 <listitem>
0362 <para>
0363 The <guilabel>Hint</guilabel> field allows you to <action>write hints to accompany your words</action>.
0364 </para>
0365 <note>
0366 <para>
0367 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).
0368 </para>
0369 </note>
0370 </listitem>
0371 <listitem>
0372 <para>
0373 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>).
0374 </para>
0375 </listitem>
0376 <listitem>
0377 <para>
0378 The <guibutton>Close</guibutton> button <action>closes the <guilabel>Vocabulary Editor</guilabel> dialog</action> without saving the content of your new or modified vocabulary.
0379 </para>
0380 </listitem>
0381 </itemizedlist>
0382 </sect2>
0383 
0384 </sect1>
0385 
0386 <sect1 id="newstuff">
0387 <title>New Stuff</title>
0388 
0389 <para>
0390 The <guibutton>Download new vocabulary</guibutton> button on the <guilabel>Vocabularies</guilabel> 
0391 configuration page allows you to obtain new vocabulary files from the Internet:
0392 </para>
0393 
0394 <screenshot>
0395 <screeninfo>&kanagram; new stuff dialog</screeninfo>
0396 <mediaobject>
0397 <imageobject>
0398 <imagedata fileref="newstuff-dialog.png" format="PNG"/>
0399 </imageobject>
0400 <textobject>
0401 <phrase>&kanagram; new stuff dialog</phrase>
0402 </textobject>
0403 </mediaobject>
0404 </screenshot>
0405 
0406 <para>
0407 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.
0408 </para>
0409 <para>If you have already downloaded a vocabulary this button will change to <guibutton>Uninstall</guibutton> which allows you to remove a vocabulary.
0410 </para>
0411 <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.
0412 </para>
0413 </sect1>
0414 </chapter>
0415 
0416 
0417 <chapter id="credits">
0418 <title>Credits and License</title>
0419 
0420 <para>
0421 &kanagram;
0422 </para>
0423 <para>
0424 Program copyright 2007 Jeremy Whiting <email>jpwhiting@kde.org</email> 2005 Joshua Keel <email>joshuakeel@gmail.com</email> and &Danny.Allen; &Danny.Allen.mail;
0425 </para>
0426 <para>
0427 Contributors:
0428 </para>
0429 <itemizedlist>
0430 <listitem>
0431 <para>Sound effects: Artemio
0432 <email>fillme</email>
0433 </para>
0434 </listitem>
0435 </itemizedlist>
0436 
0437 <para>
0438 Documentation copyright 2005 &Danny.Allen; &Danny.Allen.mail;
0439 </para>
0440 
0441 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0442 
0443 &underFDL;
0444 &underGPL;
0445 
0446 </chapter>
0447 
0448 &documentation.index;
0449 </book>
0450 <!--
0451 Local Variables:
0452 mode: sgml
0453 sgml-minimize-attributes:nil
0454 sgml-general-insert-case:lower
0455 sgml-indent-step:0
0456 sgml-indent-data:nil
0457 End:
0458 
0459 // vim:ts=2:sw=2:tw=78:noet:noai
0460 -->