[kde-doc-english] [ktuberling] doc: Update KTuberling handbook to 16.04
Burkhard Lück
lueck at hube-lueck.de
Sat May 14 20:36:48 UTC 2016
Git commit 5c07ec901024b6b392c8335386f85e25561a9641 by Burkhard Lück.
Committed on 14/05/2016 at 20:36.
Pushed by lueck into branch 'master'.
Update KTuberling handbook to 16.04
remove entities kappname + package
new screenshots
bump date + releaseinfo
remove screenshots in Interface Overview, wast space + no additional info
remove obsolete comments
remove guimenu markup in title
REVIEW:127892
D +- -- doc/button-new.png
D +- -- doc/button-open.png
D +- -- doc/button-print.png
D +- -- doc/button-save.png
M +- -- doc/edit-redo.png
M +- -- doc/edit-undo.png
M +- -- doc/gameboard.png
M +25 -62 doc/index.docbook
D +- -- doc/ktuberling.png
D +- -- doc/menu-edit.png
D +- -- doc/menu-game.png
D +- -- doc/menu-settings.png
M +9 -8 doc/technical-reference.docbook
D +- -- doc/toolbar.png
http://commits.kde.org/ktuberling/5c07ec901024b6b392c8335386f85e25561a9641
diff --git a/doc/button-new.png b/doc/button-new.png
deleted file mode 100644
index 06e2e8c..0000000
Binary files a/doc/button-new.png and /dev/null differ
diff --git a/doc/button-open.png b/doc/button-open.png
deleted file mode 100644
index bf37cc1..0000000
Binary files a/doc/button-open.png and /dev/null differ
diff --git a/doc/button-print.png b/doc/button-print.png
deleted file mode 100644
index 8b66f8b..0000000
Binary files a/doc/button-print.png and /dev/null differ
diff --git a/doc/button-save.png b/doc/button-save.png
deleted file mode 100644
index 349e091..0000000
Binary files a/doc/button-save.png and /dev/null differ
diff --git a/doc/edit-redo.png b/doc/edit-redo.png
index d759f13..703d9cf 100644
Binary files a/doc/edit-redo.png and b/doc/edit-redo.png differ
diff --git a/doc/edit-undo.png b/doc/edit-undo.png
index c893a1a..939a02f 100644
Binary files a/doc/edit-undo.png and b/doc/edit-undo.png differ
diff --git a/doc/gameboard.png b/doc/gameboard.png
index c50b06c..588ab40 100644
Binary files a/doc/gameboard.png and b/doc/gameboard.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index 40629f7..91cbdef 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1,7 +1,5 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
- <!ENTITY kappname "&ktuberling;">
- <!ENTITY package "kdegames">
<!ENTITY technical.reference SYSTEM "technical-reference.docbook">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
@@ -37,8 +35,8 @@
</authorgroup>
-<date>2013-05-06</date>
-<releaseinfo>0.8.0 (&kde; 4.11)</releaseinfo>
+<date>2016-05-11</date>
+<releaseinfo>1.0.0 (Applications 16.04)</releaseinfo>
<copyright>
<year>1999</year><year>2000</year><year>2002</year><year>2006</year>
@@ -78,6 +76,18 @@
<title>Introduction</title>
<para>Gametype: Toy</para>
<para>Number of possible players: One</para>
+
+<screenshot>
+<mediaobject>
+<imageobject>
+<imagedata fileref="ktuberling-pizzeria.png" format="PNG"/>
+</imageobject>
+<textobject>
+<phrase>Pizzeria Playground</phrase>
+</textobject>
+</mediaobject>
+</screenshot>
+
<para>
&ktuberling; a simple constructor game suitable for children and adults alike. The idea of the game is based around a once popular doll making concept. A potato was decorated with various small artifacts to make it look more like a tiny person. &ktuberling; however, goes much further in terms of content and adds a surprising variety of different themes.
</para>
@@ -87,9 +97,6 @@
<title>How to Play</title>
<para>
-<!--<inlinemediaobject><imageobject>
-<imagedata fileref="ktuberling.png" format="PNG"/></imageobject>
-</inlinemediaobject>-->
&ktuberling; is a game intended for small children. Of course, it may be
suitable for adults who have remained young at heart.
</para>
@@ -179,13 +186,6 @@ area, drag it back from the <quote>playground</quote> area to the
<sect1 id="the-tool-bar">
<title>The Tool Bar</title>
-<mediaobject>
-<imageobject>
-<imagedata format="PNG" fileref="toolbar.png"/>
-</imageobject>
-<textobject><phrase>Toolbar</phrase></textobject>
-</mediaobject>
-
<para>
The toolbar provides buttons for the commonly used functions.
</para>
@@ -208,7 +208,7 @@ The toolbar provides buttons for the commonly used functions.
<entry>
<inlinemediaobject>
<imageobject>
- <imagedata format="PNG" fileref="button-new.png"/>
+ <imagedata format="PNG" fileref="document-new.png"/>
</imageobject>
<textobject><phrase>New Game Button</phrase></textobject>
</inlinemediaobject>
@@ -231,7 +231,7 @@ playground so a new decoration may be created.
<entry>
<inlinemediaobject>
<imageobject>
- <imagedata format="PNG" fileref="button-open.png"/>
+ <imagedata format="PNG" fileref="document-open.png"/>
</imageobject>
<textobject><phrase>Load Button</phrase></textobject>
</inlinemediaobject>
@@ -251,7 +251,7 @@ Opens an existing tuberling file from the disk.
<entry>
<inlinemediaobject>
<imageobject>
- <imagedata format="PNG" fileref="button-save.png"/>
+ <imagedata format="PNG" fileref="document-save.png"/>
</imageobject>
<textobject><phrase>Save Button</phrase></textobject>
</inlinemediaobject>
@@ -274,7 +274,7 @@ position of objects are saved.
<entry>
<inlinemediaobject>
<imageobject>
- <imagedata format="PNG" fileref="button-print.png"/>
+ <imagedata format="PNG" fileref="document-print.png"/>
</imageobject>
<textobject><phrase>Print Button</phrase></textobject>
</inlinemediaobject>
@@ -333,26 +333,6 @@ Prints your picture.
Re-does last operation.</entry>
</row>
-<!-- Currently there is no HELP button on the toolbar
-<row>
-<entry>
-<inlinemediaobject>
-<imageobject>
-<imagedata format="PNG" fileref="button-help.png"/>
-</imageobject>
-<imageobject>
-<imagedata format="EPS" fileref="button.help.eps"/>
-</imageobject>
-<textobject><phrase>Help Button</phrase></textobject>
-</inlinemediaobject>
-</entry>
-<entry>
-Help
-</entry>
-<entry>Displays this handbook.</entry>
-</row>
--->
-
</tbody>
</tgroup>
</table>
@@ -362,13 +342,7 @@ Help
<title>The Menu Items</title>
<sect2>
-<title>The <guimenu>Game</guimenu> Menu</title>
-<mediaobject>
-<imageobject>
-<imagedata format="PNG" fileref="menu-game.png"/>
-</imageobject>
-<textobject><phrase><guimenu>Game</guimenu> Menu</phrase></textobject>
-</mediaobject>
+<title>The Game Menu</title>
<variablelist>
@@ -448,13 +422,7 @@ containing a picture of your tuberling.
</sect2>
<sect2>
-<title>The <guimenu>Edit</guimenu> Menu</title>
-<mediaobject>
-<imageobject>
-<imagedata format="PNG" fileref="menu-edit.png"/>
-</imageobject>
-<textobject><phrase>Edit Menu</phrase></textobject>
-</mediaobject>
+<title>The Edit Menu</title>
<variablelist>
@@ -503,7 +471,7 @@ clipboard.</para></listitem>
</sect2>
<sect2>
-<title>The <guimenu>Playground</guimenu> Menu</title>
+<title>The Playground Menu</title>
<variablelist>
@@ -538,9 +506,10 @@ It will contain the playgrounds installed in your system.
</sect2>
<sect2>
-<title>The <guimenu>Speech</guimenu> Menu</title>
+<title>The Speech Menu</title>
-<!--<para>
+<!--FIXME
+<para>
Please note that you need to have <command>&phonon;</command> installed
and properly configured to be able to hear sounds.
</para>-->
@@ -573,13 +542,7 @@ and properly configured to be able to hear sounds.
</sect2>
<sect2 id="settings">
-<title>The <guimenu>Settings</guimenu> Menu</title>
-<mediaobject>
-<imageobject>
-<imagedata format="PNG" fileref="menu-settings.png"/>
-</imageobject>
-<textobject><phrase>Settings Menu</phrase></textobject>
-</mediaobject>
+<title>The Settings Menu</title>
<variablelist>
diff --git a/doc/ktuberling.png b/doc/ktuberling.png
deleted file mode 100644
index dd5e6b8..0000000
Binary files a/doc/ktuberling.png and /dev/null differ
diff --git a/doc/menu-edit.png b/doc/menu-edit.png
deleted file mode 100644
index 1f3ee93..0000000
Binary files a/doc/menu-edit.png and /dev/null differ
diff --git a/doc/menu-game.png b/doc/menu-game.png
deleted file mode 100644
index 573e342..0000000
Binary files a/doc/menu-game.png and /dev/null differ
diff --git a/doc/menu-settings.png b/doc/menu-settings.png
deleted file mode 100644
index 96697b1..0000000
Binary files a/doc/menu-settings.png and /dev/null differ
diff --git a/doc/technical-reference.docbook b/doc/technical-reference.docbook
index 8436d76..10a04dc 100644
--- a/doc/technical-reference.docbook
+++ b/doc/technical-reference.docbook
@@ -9,8 +9,8 @@
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
-<date>2009-12-15</date>
-<releaseinfo>0.6.0</releaseinfo>
+<date>2016-05-11</date>
+<releaseinfo>1.0.0 (Applications 16.04)</releaseinfo>
<keywordset>
<keyword>KDE</keyword>
@@ -29,7 +29,7 @@ adding appropriate sound files, translators can change the sounds to their
native tongue!
</para>
-<para>
+<para><!--FIXME email alex ok?-->
If you extend or add to the game please consider sending your additions to the
maintainer <ulink url="mailto:alex at eyeos.org">Alex Fiestas</ulink> for
inclusion in future releases.
@@ -140,10 +140,11 @@ To create a new &ktuberling; sound theme you have to:
<listitem><para>Add the sound files and the .soundtheme files to the data/kdegames/ktuberling directory
of your language translations.</para></listitem>
<listitem><para>On that very same dir you need a CMakeLists.txt describing how to install the files, typically it will be.</para>
+<!--FIXME l10n-kf5/*/data/kdegames/ktuberling/CMakeLists.txt has DATA_INSTALL_DIR, has this to be changed?-->
<programlisting>
-FILE(GLOB datafiles *.ogg)
-install( FILES ${datafiles} DESTINATION ${DATA_INSTALL_DIR}/ktuberling/sounds/<replaceable>yourLanguageTwoLetterCode</replaceable> )
-install( FILES <replaceable>yourLanguageTwoLetterCode</replaceable>.soundtheme DESTINATION ${DATA_INSTALL_DIR}/ktuberling/sounds/ )
+FILE( GLOB oggfiles *.ogg )
+INSTALL( FILES ${oggfiles} DESTINATION ${KDE_INSTALL_DATADIR}/ktuberling/sounds/<replaceable>yourLanguageTwoLetterCode</replaceable> )
+INSTALL( FILES <replaceable>yourLanguageTwoLetterCode</replaceable>.soundtheme DESTINATION ${KDE_INSTALL_DATADIR}/ktuberling/sounds/ )
</programlisting>
</listitem>
</itemizedlist>
@@ -152,8 +153,8 @@ install( FILES <replaceable>yourLanguageTwoLetterCode</replaceable>.soundtheme D
<listitem>
<para>If you want to install it for yourself:</para>
<itemizedlist>
-<listitem><para>Place <replaceable>yourLanguageTwoLetterCode</replaceable>.soundtheme file in `kde4-config --prefix`/share/apps/ktuberling/sounds</para></listitem>
-<listitem><para>Place yourSoundFiles in `kde4-config --prefix`/share/apps/ktuberling/sounds/someUniquePath</para></listitem>
+<listitem><para>Place <replaceable>yourLanguageTwoLetterCode</replaceable>.soundtheme file in `kde5-config --prefix`/share/apps/ktuberling/sounds</para></listitem>
+<listitem><para>Place yourSoundFiles in `kde5-config --prefix`/share/apps/ktuberling/sounds/someUniquePath</para></listitem>
</itemizedlist>
</listitem>
diff --git a/doc/toolbar.png b/doc/toolbar.png
deleted file mode 100644
index 1316019..0000000
Binary files a/doc/toolbar.png and /dev/null differ
More information about the kde-doc-english
mailing list