From c90c389a8a8d9d8661e9772ec4144c5cf2039f23 Mon Sep 17 00:00:00 2001 From: toma Date: Wed, 25 Nov 2009 17:56:58 +0000 Subject: Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdegames@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- doc/ktuberling/Makefile.am | 4 + doc/ktuberling/button-new.png | Bin 0 -> 712 bytes doc/ktuberling/button-open.png | Bin 0 -> 939 bytes doc/ktuberling/button-print.png | Bin 0 -> 847 bytes doc/ktuberling/button-redo.png | Bin 0 -> 611 bytes doc/ktuberling/button-save.png | Bin 0 -> 694 bytes doc/ktuberling/button-undo.png | Bin 0 -> 598 bytes doc/ktuberling/gameboard.png | Bin 0 -> 18180 bytes doc/ktuberling/index.docbook | 811 +++++++++++++++++++++++++++++ doc/ktuberling/ktuberling.png | Bin 0 -> 5916 bytes doc/ktuberling/menu-edit.png | Bin 0 -> 4579 bytes doc/ktuberling/menu-game.png | Bin 0 -> 9785 bytes doc/ktuberling/menu-help.png | Bin 0 -> 10124 bytes doc/ktuberling/menu-playground.png | Bin 0 -> 3059 bytes doc/ktuberling/menu-raw.png | Bin 0 -> 9022 bytes doc/ktuberling/menu-settings.png | Bin 0 -> 4836 bytes doc/ktuberling/menu-speech.png | Bin 0 -> 12226 bytes doc/ktuberling/technical-reference.docbook | 262 ++++++++++ doc/ktuberling/toolbar.png | Bin 0 -> 3804 bytes 19 files changed, 1077 insertions(+) create mode 100644 doc/ktuberling/Makefile.am create mode 100644 doc/ktuberling/button-new.png create mode 100644 doc/ktuberling/button-open.png create mode 100644 doc/ktuberling/button-print.png create mode 100644 doc/ktuberling/button-redo.png create mode 100644 doc/ktuberling/button-save.png create mode 100644 doc/ktuberling/button-undo.png create mode 100644 doc/ktuberling/gameboard.png create mode 100644 doc/ktuberling/index.docbook create mode 100644 doc/ktuberling/ktuberling.png create mode 100644 doc/ktuberling/menu-edit.png create mode 100644 doc/ktuberling/menu-game.png create mode 100644 doc/ktuberling/menu-help.png create mode 100644 doc/ktuberling/menu-playground.png create mode 100644 doc/ktuberling/menu-raw.png create mode 100644 doc/ktuberling/menu-settings.png create mode 100644 doc/ktuberling/menu-speech.png create mode 100644 doc/ktuberling/technical-reference.docbook create mode 100644 doc/ktuberling/toolbar.png (limited to 'doc/ktuberling') diff --git a/doc/ktuberling/Makefile.am b/doc/ktuberling/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/ktuberling/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/ktuberling/button-new.png b/doc/ktuberling/button-new.png new file mode 100644 index 00000000..4e744438 Binary files /dev/null and b/doc/ktuberling/button-new.png differ diff --git a/doc/ktuberling/button-open.png b/doc/ktuberling/button-open.png new file mode 100644 index 00000000..c62d21d6 Binary files /dev/null and b/doc/ktuberling/button-open.png differ diff --git a/doc/ktuberling/button-print.png b/doc/ktuberling/button-print.png new file mode 100644 index 00000000..8a48c035 Binary files /dev/null and b/doc/ktuberling/button-print.png differ diff --git a/doc/ktuberling/button-redo.png b/doc/ktuberling/button-redo.png new file mode 100644 index 00000000..67733a91 Binary files /dev/null and b/doc/ktuberling/button-redo.png differ diff --git a/doc/ktuberling/button-save.png b/doc/ktuberling/button-save.png new file mode 100644 index 00000000..49e4dae5 Binary files /dev/null and b/doc/ktuberling/button-save.png differ diff --git a/doc/ktuberling/button-undo.png b/doc/ktuberling/button-undo.png new file mode 100644 index 00000000..fb918436 Binary files /dev/null and b/doc/ktuberling/button-undo.png differ diff --git a/doc/ktuberling/gameboard.png b/doc/ktuberling/gameboard.png new file mode 100644 index 00000000..0d1fd1c4 Binary files /dev/null and b/doc/ktuberling/gameboard.png differ diff --git a/doc/ktuberling/index.docbook b/doc/ktuberling/index.docbook new file mode 100644 index 00000000..33b87804 --- /dev/null +++ b/doc/ktuberling/index.docbook @@ -0,0 +1,811 @@ + + + + + + +]> + + + +The &ktuberling; Handbook + + + +Éric +Bischoff + +
&Eric.Bischoff.mail;
+ + + +Paul +E. +Ahlquist +Jr. + +
&Paul.E.Ahlquist.Jr.mail;
+ + + + +Lauri +Watts +Reviewer + + + + + + +2006-05-05 +0.05.01 + + +1999200020022006 +Éric Bischoff + + + +2001 +&Paul.E.Ahlquist.Jr; + + +&FDLNotice; + + + +&ktuberling; is a game intended for small children. + + + + +KDE +KTuberling +game +children +tuberling +potato +penguin +aquarium + + + + +Introduction + + + + + +&ktuberling; is a game intended for small children. Of course, it may be +suitable for adults who have remained young at heart. + + + +It is a potato editor. That means that you can drag and drop +eyes, mouths, mustache, and other parts of face and goodies onto a potato-like +guy. Similarly, you have a penguin and an aquarium on which you can drop other stuff. + + + +There is no winner for the game. The only purpose is to make the funniest faces +you can. + + + +There is a museum (like a Madame Tusseau gallery) where +you can find many funny examples of decorated potatoes, penguins and +aquariums. Of course, you can send your own creations to the programmer, +Éric Bischoff, who will +include them in the museum if he gets some spare time. + + + +&ktuberling; can also speak. It will spell out the name of +the objects you drag and drop. It will speak in a language +that you can chose. You can even use it to learn a bit of vocabulary +in foreign languages. Currently, &ktuberling; can speak +Danish, German, English, Spanish, French, Italian, Dutch, Portuguese, Romanian, +Serbian, Slovak, Slovenian and Swedish. + + + + +On Screen Fundamentals + + +Mouse Operation + + +There are two areas in the main window: + + + +Playground area, on the left side. + + +Objects area, on the right side, where you select objects to +place on your playground. + + + + +Main Window of &ktuberling; + + + + + + + +Main Window + + + + +Placing an Object + + +To drag an object, move the mouse pointer to the objects +area on the right. Click on the object you want to drag, but do not release +the mouse button until you have moved the mouse pointer to the location in +the playground area where you want to drop the object. + + + + +Moving an Object + +Once dropped in the playground area, an object can be moved. +Just click on the object to select it for further drag and drop. When you +click on it, it goes on top of other objects that were partially hiding it. +This trick is useful for getting the glasses and eyes placed correctly. + + + + +Removing an Object + +To remove an object that has been dropped in the playground +area, drag it back from the playground area to the +objects area. + + + + + +The Tool Bar + + + + + + + + +Toolbar + + + +The toolbar provides buttons for the commonly used functions. + + + +Toolbar Buttons + + + + +Button +Name +Menu Equivalent +Action + + + + + + + + + + + + + + New Game Button + + + + New + + + Game New + + + +Resets the playground area. This cleans all parts off the +playground so a new decoration may be created. + + + + + + + + + + + + + + Load Button + + +Load + + + Game Load... + + + +Opens an existing tuberling file from the museum or from other folders. + + + + + + + + + + + + + Save Button + + +Save + + + Game Save + + + +Saves your creation to your home folder, or to some other folder like +the museum if you wish. The tuberling is saved to a small file where only the +position of objects are saved. + + + + + + + + + + + + + + Print Button + + + +Print + + + + Game Print + + + +Prints your picture (&PostScript; format). + + + + + + + + + + + + + Undo Button + + + + Undo + + + + Edit Undo + + +Undoes last operation. + + + + + + + + + + + + Redo Button + + + +Redo + + + + Edit Redo + + + +Re-does last operation. + + + + + + +
+ + + +The Menu Items + + + + + + + + +Menu Bar + + + +The <guimenu>Game</guimenu> Menu + + + + + + + +File Menu + + + + + + + +&Ctrl;N + +Game + New + +Clears the playground +area + + + + + +&Ctrl;O + +Game + Load... + + Opens an existing tuberling file from +the museum or from somewhere else if you wish. + + + + + +&Ctrl;S + +Game +Save + +Saves your creation. The tuberling is +saved to a small file where only the position of objects are saved. + + + + + +Game +Save as Picture... + +Creates a graphics file +containing a picture of your tuberling. Available file formats +are XPM, JPEG, PNG and BMP. + + + + + + +&Ctrl;P + +Game +Print... + +Print your tuberling picture using + &PostScript; format. + + + + + + +&Ctrl;Q + +Game +Quit + +Quit &ktuberling;. + + + + + + + + +The <guimenu>Edit</guimenu> Menu + + + + + + + +Edit Menu + + + + + + + +&Ctrl;Z + +Edit +Undo + +Undo the last +object placement. + + + + + + +&Ctrl;Shift +Z + +Edit +Redo + +Re-does the last object +placement. This menu option is active only if you have previously used +Undo. + + + + + + +&Ctrl;C + +Edit +Copy + +Copy the playground area to the +clipboard. + + + + + + + +The <guimenu>Playground</guimenu> Menu + + + + + + + + +Playground Menu + + + + + + +Playground +Potato Guy + +Switches to potato playground. +&ktuberling; remembers the last chosen playground the next +time it starts up. + + + + +Playground +Penguin + +Switches to penguin playground. +&ktuberling; remembers the last chosen playground the next +time it starts up. + + + + +Playground +Aquarium + +Switches to aquarium playground. +&ktuberling; remembers the last chosen playground the next +time it starts up. + + + + + +The <guimenu>Speech</guimenu> Menu + + + + + + + + +Speech Menu + + + +Please note that you need to have kdemultimedia installed +and &artsd; running to be able to hear sounds. + + + + + + +Speech +No Sound + +Toggles sound off. &ktuberling; +remembers of this option the next time it starts up. + + + + +Speech +Danish + +Toggles sound on and speaks Danish. +If Danish sounds are not installed then this option is grayed out. &ktuberling; +remembers of this option the next time it starts up. + + + + +Speech +German + +Toggles sound on and speaks German. +If German sounds are not installed then this option is grayed out. &ktuberling; +remembers of this option the next time it starts up. + + + + +Speech +English + +Toggles sound on and speaks English. +If English sounds are not installed then this option is grayed out. &ktuberling; +remembers of this option the next time it starts up. + + + +etc... +Same for the other languages. + + + + + +The <guimenu>Settings</guimenu> Menu + + + + +Settings Menu + + + + + + +Settings +Show/Hide Toolbar + +Toggle the Toolbar display on and off. + + + + + +Settings +Configure Shortcuts... + +Opens a standard &kde; shortcut configuration dialog, where you can change the +keyboard shortcuts used by &ktuberling;. + + + + + +Settings +Configure Toolbars... + +Display the standard &kde; toolbar configuration dialog. + + + + + + + +The <guimenu>Help</guimenu> Menu + + + + + + + +Help Menu + + +&help.menu.documentation; + + + + + +&technical.reference; + + +Credits and License + +&ktuberling; + + + +John Calhoun - Original idea, original pictures and English +sounds + + + +Éric Bischoff &Eric.Bischoff.mail; - &kde; +Programming + + + +François-Xavier Duranceau duranceau@free.fr - Tests, +advice and help + + + +Agnieszka Czajkowska agnieszka@imagegalaxy.de - Penguin graphics + + + +Bas Willems next@euronet.nl - Graphics reworks and aquarium theme + + + +Roger Larsson roger.larsson@norran.net - Sounds tuning + + + +Dolores Almansa dolores.almansa@corazondemaria.org - Educative graphics for COR-EDUX initiative + + + +Peter Silva peter.silva@videotron.ca - Proofreading of +the documentation + + + +Paul Ahlquist &Paul.E.Ahlquist.Jr.mail; - Bettering of +documentation + + + +This game is dedicated to my little daughter Sunniva Bischoff + +Thanks to Apple Computer and to the &LinuxPPC; project for having made +ports of &Linux; to the &Mac;. &ktuberling; would never have existed without +that! + + + +&underFDL; +&underGPL; + + + + + +Installation + + +How to obtain <application>ktuberling</application> + +&install.intro.documentation; + + + + +Requirements + + +In order to successfully compile &ktuberling;, you need &kde; 3.5. +All required libraries as well as &ktuberling; itself can be found on +&kde-ftp;. + + +To be able to hear the sounds, you need to have kdemultimedia installed. + + + + +Compilation and Installation + +&install.compile.documentation; + + + + + diff --git a/doc/ktuberling/ktuberling.png b/doc/ktuberling/ktuberling.png new file mode 100644 index 00000000..3b44966d Binary files /dev/null and b/doc/ktuberling/ktuberling.png differ diff --git a/doc/ktuberling/menu-edit.png b/doc/ktuberling/menu-edit.png new file mode 100644 index 00000000..d5090713 Binary files /dev/null and b/doc/ktuberling/menu-edit.png differ diff --git a/doc/ktuberling/menu-game.png b/doc/ktuberling/menu-game.png new file mode 100644 index 00000000..93981973 Binary files /dev/null and b/doc/ktuberling/menu-game.png differ diff --git a/doc/ktuberling/menu-help.png b/doc/ktuberling/menu-help.png new file mode 100644 index 00000000..dd02e340 Binary files /dev/null and b/doc/ktuberling/menu-help.png differ diff --git a/doc/ktuberling/menu-playground.png b/doc/ktuberling/menu-playground.png new file mode 100644 index 00000000..c85a7e45 Binary files /dev/null and b/doc/ktuberling/menu-playground.png differ diff --git a/doc/ktuberling/menu-raw.png b/doc/ktuberling/menu-raw.png new file mode 100644 index 00000000..0e0276c6 Binary files /dev/null and b/doc/ktuberling/menu-raw.png differ diff --git a/doc/ktuberling/menu-settings.png b/doc/ktuberling/menu-settings.png new file mode 100644 index 00000000..c581dac7 Binary files /dev/null and b/doc/ktuberling/menu-settings.png differ diff --git a/doc/ktuberling/menu-speech.png b/doc/ktuberling/menu-speech.png new file mode 100644 index 00000000..b8f6e1c5 Binary files /dev/null and b/doc/ktuberling/menu-speech.png differ diff --git a/doc/ktuberling/technical-reference.docbook b/doc/ktuberling/technical-reference.docbook new file mode 100644 index 00000000..94abf945 --- /dev/null +++ b/doc/ktuberling/technical-reference.docbook @@ -0,0 +1,262 @@ + + + + + +Éric +Bischoff + + + + +2006-05-05 +0.05.01 + + +KDE +KTuberling +technical reference + + + +Technical reference + + +&ktuberling; offers a gentle and rewarding introduction to &kde; customization +and programming. The application can be extended. For example, without any +coding, new playgrounds can be added by changing the graphics files. By +adding appropriate sound files, translators can change the sounds to their +native tongue! + + + +If you extend or add to the game please consider sending your additions to the +developer Éric Bischoff for +inclusion in future releases. + + + +For artists + + +The size and shape of the playground and the number of objects can be +changed. New playgrounds can be added. Only two image files need to be +created for each playground: a gameboard and a mask. A maximum of 8 +playgrounds is allowed, out of which only 3 are currently used. + + + +Six images are used in &ktuberling;: potato-game.png, +potato-mask.png, penguin-game.png, +penguin-mask.png, aquarium-game.png +and aquarium-mask.png. The standard location +for these files is the folder $KDEDIR/share/apps/ktuberling/pics/. + + + +The first type of images, *-game.png holds the playground +and the objects that the user selects. This is the graphic that the user sees +when playing the game. + + + +The second type of images, *-mask.png, contains only masks of the +objects. The masks are used to delimit the borders of the objects and, in some +cases, give the object some transparency (for example, the spectacles). It is +mandatory to put the objects at the same position in +the gameboard file as in the mask file. + + + +In the same folder, a file named layout.xml. +($KDEDIR/share/apps/ktuberling/pics/layout.xml) tells +which images to use and links them to menu entries. It also contains the +position parameters of the playground and the objects in the gameboard and +in the masks. It assigns the sounds to objects and places the +objects in groups. It finally declares languages as sets of translated sounds. +It follows standard &XML; syntax (see details +below). + + + +Still in the same folder, a file named layout.i18n +($KDEDIR/share/apps/ktuberling/pics/layout.xml) +recapitulates the strings in layout.xml that can be +translated: + +The menu entries that allow to choose the playground and the language +The names of the categories of objects + + + + +One folder above, a file named ktuberlingui.rc +($KDEDIR/share/apps/ktuberling/ktuberlingui.rc) is a +second &XML; file describing the menus of &ktuberling;. It should contain +one <action> tag per playground and language. +The symbolic name of the action in this file should be identical to +the symbolic name of the action in layout.xml. + + + + + +Translation + + +Besides the usual .po files mechanism for +translating program labels and prompts, the sounds can be localized too. + + + +If the various +translators can record their voice to a .wav +file, they can store that file to the language-specific subfolder of the +sounds folder. The name of the sound is then assigned to a file in the +layout.xml file. For example, if destination language is +Italian, translators can record their voice in .wav files located in +$KDEDIR/share/apps/ktuberling/sounds/it. Then they can +assign the sound named hat to the filename +it/cappello.wav. + + + +In a future release, &ktuberling; will use OGG Vorbis rc3 file format for sounds. +At that moment, it will be possible to convert the WAV files to OGG Vorbis rc3 +through the following command line: + +$ oggenc -q 10 -o sound.ogg sound.wav + + + + +Information on how to work with the translation mechanisms in &kde; is available +in The +&kde; Translation HOWTO. + + + + + + +For programmers +&ktuberling; isn't really difficult to extend for programmers. + + +C++ classes + + + +TopLevel + +Top-level window and basic program management + + + + +PlayGround + +Description of one of the game levels + + + +ToDraw + +Description of one of the graphical objects to be +drawn + + + +SoundFactory + +Description of one of the languages and its sounds + + + +Action + +One of the user's manipulation in the undo/redo stack + + + + + + +<literal role="extension">.tuberling</literal> files structure + +A .tuberling file holds all the +necessary data to redraw a tuberling. It can be edited with an ordinary text +editor. + +The first line holds the number of the playground. + +On all other lines, there is one graphical object per line, in the order +that is used to draw them. Each line contains 5 numbers: the identifier of the object, +and the rectangle where it should be drawn (left, top, right, bottom). The numbers are +separated by whitespaces. + + + + + +Structure of the layout file (<filename>layout.xml</filename>) + + +The top-level tag is unique and is named <ktuberling>. +It contains several <playground> tags, one per +playground, and several <language> tags, one per language. + + + +The <playground> tag has two attributes: gameboard +and masks. These attributes give the name of the files holding the +pictures. The <playground> tag also contains one +<menuitem> tag, one <editablearea> +tag, several <category> tags, and several +<object> tags. + + + +The <menuitem> tag describes the action identifier +of the menu item allowing to select position of the +area where you can drop objects, and the label of this menu item. +This action identifier should be identical to the one in +ktuberlingui.rc. + + + +The <editablearea> tag describes the position of the +area where you can drop objects, and the name of the sound associated with it. + + + +The <category> tag describes the position and +the label of a text describing a group of objects. For example, it +can describe the position and the text of the group of goodies. + + + +The <object> tag describes the position (in the +gameboard and in the masks) of an object, as well as the name of the sound +associated with it. + + + +The <language> tag has one attribute: code +This attribute give the code of the locale for that language. +The <language> tag also contains one +<menuitem> tag and several +<sound> tags. + + + +The lower level tags are not explained here, since their meaning is +quite straightforward. If you modify layout.xml, +don't forget to modify layout.i18n and +ktuberlingui.rc accordingly. + + + + diff --git a/doc/ktuberling/toolbar.png b/doc/ktuberling/toolbar.png new file mode 100644 index 00000000..9ff20d9a Binary files /dev/null and b/doc/ktuberling/toolbar.png differ -- cgit v1.2.1