Commit e5b8f775 authored by Antoni Bella Pérez's avatar Antoni Bella Pérez 🚵🏻
Browse files

Documentation updates

* Update date and version numbers
* Remove final whitespaces
* Add i18n-ktuberling entity as "Potato Guy" (use the localized name)
* Suitable tags and punctuation
* Indent some areas better
* Sync with the GUI
    - Add 'View -> Full Screen Mode'
parent 37489af1
This diff is collapsed.
......@@ -9,8 +9,8 @@
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<date>2016-05-11</date>
<releaseinfo>1.0.0 (Applications 16.04)</releaseinfo>
<date>2021-10-04</date>
<releaseinfo>KDE Gear 21.08</releaseinfo>
<keywordset>
<keyword>KDE</keyword>
......@@ -43,59 +43,65 @@ To create a new &ktuberling; playground you have to:
</para>
<itemizedlist>
<listitem>
<para>Draw the playground in a SVG file, there you have to:
<itemizedlist>
<listitem><para>Name the place where items can dragged "background".</para></listitem>
<listitem><para>Name each of the draggable items with an unique name.</para></listitem>
</itemizedlist>
<listitem>
<para>Draw the playground in a &SVG; file, there you have to:
<itemizedlist>
<listitem><para>Name the place where items can dragged <quote>background</quote>.</para></listitem>
<listitem><para>Name each of the draggable items with an unique name.</para></listitem>
</itemizedlist>
</para>
</listitem>
<listitem>
<para>Create a .theme file, it has to follow this schema:</para>
<programlisting>
&lt;playground gameboard="<replaceable>yourSVGFile</replaceable>" name="<replaceable>theDesktopFile</replaceable>"&gt;
&lt;object name="<replaceable>itemName</replaceable>" sound="<replaceable>soundName</replaceable>" scale="<replaceable>someValue</replaceable>" /&gt;
...
...
...
&lt;/playground&gt;
</programlisting>
</listitem>
<listitem>
<para>Create a <literal role="extension">.theme</literal> file, it has to follow this schema:</para>
<programlisting>
&lt;playground gameboard="<replaceable>yourSVGFile</replaceable>" name="<replaceable>theDesktopFile</replaceable>"&gt;
&lt;object name="<replaceable>itemName</replaceable>" sound="<replaceable>soundName</replaceable>" scale="<replaceable>someValue</replaceable>" /&gt;
...
...
...
&lt;/playground&gt;
</programlisting>
<itemizedlist>
<listitem><para><replaceable>yourSVGFile</replaceable> is the name of the svg file that has the drawing.</para></listitem>
<listitem><para><replaceable>theDesktopFile</replaceable> is the name of the desktop file that has the name of the theme.</para></listitem>
<listitem><para>For each object you need a &lt;object&gt; entry. <replaceable>itemName</replaceable> is the unique
name you used on the SVG file, <replaceable>soundName</replaceable> is the sound name that will
be played when dragging it, see sound themes howto for more information.</para></listitem>
<listitem><para>scale is optional and <replaceable>someValue</replaceable> is the scale factor that will be used
when drawing this object outside the warehouse, if not specified is 1.</para></listitem>
<listitem><para><replaceable>yourSVGFile</replaceable> is the name of the &SVG; file that has the drawing.</para></listitem>
<listitem><para><replaceable>theDesktopFile</replaceable> is the name of the desktop file that has the
name of the theme.</para></listitem>
<listitem><para>For each object you need a <literal>&lt;object&gt;</literal> entry.
<replaceable>itemName</replaceable> is the unique name you used on the &SVG; file,
<replaceable>soundName</replaceable> is the sound name that will be played when dragging it, see the
<filename>sounds/soundthemes.HOWTO</filename> file from source code for more information.</para></listitem>
<listitem><para><literal>scale</literal> is optional and <replaceable>someValue</replaceable> is the scale
factor that will be used when drawing this object outside the warehouse, if not specified is 1.</para></listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Create a .desktop file, it has to follow this schema</para>
<programlisting>
[KTuberlingTheme]
Name=<replaceable>themeName</replaceable>
</programlisting>
</listitem>
<listitem>
<para>Create a <literal role="extension">.desktop</literal> file, it has to follow this schema:</para>
<programlisting>
[KTuberlingTheme]
Name=<replaceable>themeName</replaceable>
</programlisting>
<itemizedlist>
<listitem><para><replaceable>themeName</replaceable> is the name that identifies the theme, will be shown in the Playground menu.</para></listitem>
<listitem><para><replaceable>themeName</replaceable> is the name that identifies the theme, will be shown in the
Playground menu.</para></listitem>
</itemizedlist>
</listitem>
</listitem>
<listitem>
<para>If you are adding the theme to &ktuberling; repository, add .svg, .theme, and .desktop files to FILES section of the CMakeLists.txt in the pics/ directory
<listitem>
<para>If you are adding the theme to &ktuberling; repository, add <literal role="extension">.svg</literal>,
<literal role="extension">.theme</literal>, and <literal role="extension">.desktop</literal> files to
<literal>FILES</literal> section of the <filename>CMakeLists.txt</filename> into the
<filename class="directory">pics/</filename> folder.
</para>
</listitem>
</listitem>
<listitem>
<para>If you want to install it for yourself, place .svg, .theme, and .desktop files in <filename class="directory">ktuberling/pics</filename>
in <userinput><command>qtpaths</command> <option>--paths GenericDataLocation</option></userinput>
<listitem>
<para>If you want to install it for yourself, place <literal role="extension">.svg</literal>,
<literal role="extension">.theme</literal>, and <literal role="extension">.desktop</literal> files into
the <filename class="directory">ktuberling/pics</filename> folder in
<userinput><command>qtpaths</command> <option>--paths GenericDataLocation</option></userinput>
</para>
</listitem>
</listitem>
</itemizedlist>
</sect1>
......@@ -113,11 +119,9 @@ To create a new &ktuberling; sound theme you have to:
</para>
<itemizedlist>
<listitem><para>Record the sounds in OGG Vorbis rc3 file format.</para></listitem>
<listitem>
<para>Create a <replaceable>yourLanguageTwoLetterCode</replaceable>.soundtheme file, it has to follow this schema:</para>
<listitem><para>Record the sounds in OGG Vorbis rc3 file format.</para></listitem>
<listitem><para>Create a <filename><replaceable>yourLanguageTwoLetterCode</replaceable>.soundtheme</filename>
file, it has to follow this schema:</para>
<programlisting>
&lt;language code="<replaceable>yourLanguageTwoLetterCode</replaceable>"&gt;
&lt;sound name="<replaceable>soundName</replaceable>" file="<replaceable>relativePath</replaceable>" /&gt;
......@@ -126,46 +130,50 @@ To create a new &ktuberling; sound theme you have to:
...
&lt;/language&gt;
</programlisting>
<itemizedlist>
<listitem><para><replaceable>yourLanguageTwoLetterCode</replaceable> is your language two letter code, for example gl for Galician.</para></listitem>
<listitem><para>For each sound a &lt;sound&gt; entry. <replaceable>soundName</replaceable> should match with the soundName specified
in the playground theme (see themes HOWTO). <replaceable>relativePath</replaceable> should be the relative path you
are going to install the file with this sound to, typically it will be
someUniquePath/soundName.format (someUniquePath can be your language two letter code for
example).</para></listitem>
</itemizedlist>
</listitem>
<itemizedlist>
<listitem><para><replaceable>yourLanguageTwoLetterCode</replaceable> is your language two
letter code, for example gl for Galician.</para></listitem>
<listitem><para>For each sound a <literal>&lt;sound&gt;</literal> entry. <replaceable>soundName</replaceable>
should match with the soundName specified in the playground theme (see the <filename>pics/themes.HOWTO</filename>
from source code). <replaceable>relativePath</replaceable> should be the relative path you are going
to install the file with this sound to, typically it will be
<filename><replaceable>someUniquePath</replaceable>/<replaceable>soundName</replaceable>.<replaceable>format</replaceable></filename>
(<replaceable>someUniquePath</replaceable> can be your language two letter code for example).</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>If you are adding the sound theme to &ktuberling; in your language folder:</para>
<itemizedlist>
<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>
<listitem><para>If you are adding the sound theme to &ktuberling; in your language folder:</para>
<itemizedlist>
<listitem><para>Add the sound files and the <literal role="extension">.soundtheme</literal>
files into the <filename class="directory">data/kdegames/ktuberling</filename> folder of your
language translations.</para></listitem>
<listitem><para>On that very same dir you need a <filename>CMakeLists.txt</filename> file
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 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>
</listitem>
<listitem>
<para>If you want to install it for yourself:</para>
<itemizedlist>
<listitem><para>Place <replaceable>yourLanguageTwoLetterCode</replaceable>.soundtheme file in <filename class="directory">ktuberling/sounds</filename>
in <userinput><command>qtpaths</command> <option>--paths GenericDataLocation </option></userinput></para></listitem>
<listitem><para>Place your sound files in <filename class="directory">ktuberling/sounds/someUniquePath</filename>
in<userinput><command>qtpaths</command> <option>--paths GenericDataLocation </option></userinput></para></listitem>
</itemizedlist>
</listitem>
</listitem>
</itemizedlist>
</listitem>
<listitem><para>If you want to install it for yourself:</para>
<itemizedlist>
<listitem><para>Place <filename><replaceable>yourLanguageTwoLetterCode</replaceable>.soundtheme</filename>
file into the <filename class="directory">ktuberling/sounds</filename> folder in
<userinput><command>qtpaths</command> <option>--paths GenericDataLocation</option></userinput></para></listitem>
<listitem><para>Place your sound files into the
<filename class="directory">ktuberling/sounds/<replaceable>someUniquePath</replaceable></filename> folder in
<userinput><command>qtpaths</command> <option>--paths GenericDataLocation</option></userinput></para></listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
Information on how to work with the translation mechanisms in &kde; is available
in <ulink url="http://l10n.kde.org/docs/translation-howto/index.html">The
in <ulink url="https://l10n.kde.org/docs/translation-howto/index.html">The
&kde; Translation HOWTO</ulink>.
</para>
......@@ -180,37 +188,31 @@ in <ulink url="http://l10n.kde.org/docs/translation-howto/index.html">The
<title>C++ classes</title>
<variablelist>
<varlistentry>
<term><classname>TopLevel</classname></term>
<listitem>
<para>Top-level window and basic program management</para>
</listitem>
</varlistentry>
<varlistentry>
<term><classname>PlayGround</classname></term>
<listitem>
<para>Description of one of the game levels</para> </listitem>
</varlistentry>
<varlistentry>
<term><classname>ToDraw</classname></term>
<listitem>
<para>Description of one of the graphical <quote>objects</quote> to be
drawn</para> </listitem>
</varlistentry>
<varlistentry>
<term><classname>SoundFactory</classname></term>
<listitem>
<para>Description of one of the languages and its sounds</para> </listitem>
</varlistentry>
<varlistentry>
<term><classname>Action</classname></term>
<listitem>
<para>One of the user's manipulation in the undo/redo stack</para> </listitem>
</varlistentry>
<varlistentry>
<term><classname>TopLevel</classname></term>
<listitem><para>Top-level window and basic program management.</para></listitem>
</varlistentry>
<varlistentry>
<term><classname>PlayGround</classname></term>
<listitem><para>Description of one of the game levels.</para></listitem>
</varlistentry>
<varlistentry>
<term><classname>ToDraw</classname></term>
<listitem><para>Description of one of the graphical <quote>objects</quote> to be
drawn.</para></listitem>
</varlistentry>
<varlistentry>
<term><classname>SoundFactory</classname></term>
<listitem><para>Description of one of the languages and its sounds.</para></listitem>
</varlistentry>
<varlistentry>
<term><classname>Action</classname></term>
<listitem><para>One of the user's manipulation in the undo/redo stack.</para></listitem>
</varlistentry>
</variablelist>
</sect2>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment