[games/kspaceduel] doc: Documentation updates
Antoni Bella Pérez
null at kde.org
Mon Aug 23 17:59:22 BST 2021
Git commit cd071fb042ed210330d53bafd86b71bb1c1d2669 by Antoni Bella Pérez.
Committed on 23/08/2021 at 16:58.
Pushed by bellaperez into branch 'master'.
Documentation updates
* Update date and version numbers
* Remove final whitespaces
* Remove old entities and use kspaceduel entity from kdoctools
* Suitable tags and punctuation
* Add small sreenshots to powerups
* Indent all menu items
* Rework all configuration dialog section
A +- -- doc/bullet.png
A +- -- doc/energy.png
M +280 -256 doc/index.docbook
A +- -- doc/mine.png
A +- -- doc/shield.png
https://invent.kde.org/games/kspaceduel/commit/cd071fb042ed210330d53bafd86b71bb1c1d2669
diff --git a/doc/bullet.png b/doc/bullet.png
new file mode 100644
index 0000000..e13565f
Binary files /dev/null and b/doc/bullet.png differ
diff --git a/doc/energy.png b/doc/energy.png
new file mode 100644
index 0000000..a998e28
Binary files /dev/null and b/doc/energy.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index 4a16b12..7973adb 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1,15 +1,12 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
- <!ENTITY kappname "&kspaceduel;">
- <!ENTITY kappversion "2.0"><!--Applicaion version. Use this variable everywhere it's needed.-->
- <!ENTITY package "kdegames"> <!-- do not change this! -->
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
<!ENTITY % addindex "IGNORE"> <!-- do not change this! -->
]>
-
+
<book id="kspaceduel" lang="&language;"> <!-- do not change this! -->
<bookinfo>
- <title>The &kappname; Handbook</title> <!-- This is the title of the docbook. Leave as is unless change is necessary.-->
+ <title>The &kspaceduel; Handbook</title> <!-- This is the title of the docbook. Leave as is unless change is necessary.-->
<!-- List of immidiate authors begins here. -->
<!--INPORTANT! - All other contributors: [to be determined] -->
<authorgroup>
@@ -24,7 +21,7 @@
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
-
+
<copyright>
<year>1999</year><year>2000</year>
<holder>&Andreas.Zehender;</holder>
@@ -32,20 +29,20 @@
<legalnotice>&FDLNotice;</legalnotice>
-<date>2013-05-05</date><!-- Date of (re)writing, or update.-->
-<releaseinfo>&kappversion; (&kde; 4.11)</releaseinfo><!-- Application version number. Use the variable definitions within header to change this value.-->
-
+<date>2021-08-23</date><!-- Date of (re)writing, or update.-->
+<releaseinfo>2.1 (KDE Gear 21.08)</releaseinfo><!-- Application version number. Use the variable definitions within header to change this value.-->
+
<!--Short description of this document. Do not change unless necessary!-->
<abstract>
- <para>This documentation describes the game of &kappname; version &kappversion;</para>
+ <para>This documentation describes the game of &kspaceduel; version 2.1</para>
</abstract>
-
+
<!--List of relevan keywords-->
<keywordset>
<keyword>KDE</keyword> <!-- do not change this! -->
<keyword>kdegames</keyword> <!-- do not change this! -->
<keyword>game</keyword> <!-- do not change this! -->
- <keyword>kspaceduel</keyword><!--Application name goes here-->
+ <keyword>KSpaceDuel</keyword><!--Application name goes here-->
<!-- Game genre. Use as many as necessary. Available game types are: Arcade, Board, Card, Dice, Toys, Logic, Strategy.-->
<keyword>arcade</keyword>
<keyword>space</keyword>
@@ -60,37 +57,37 @@
</bookinfo>
<!--Content begins here: -->
<chapter id="introduction"><title>Introduction</title> <!-- do not change this! -->
- <note><title>Gametype:</title><para> Arcade</para></note><!-- Game genre. Use as many as necessary. Available game types are: Arcade, Board, Card, Dice, Toys, Logic, Strategy.-->
+ <note><title>Gametype:</title><para>Arcade</para></note><!-- Game genre. Use as many as necessary. Available game types are: Arcade, Board, Card, Dice, Toys, Logic, Strategy.-->
<note><title>Number of possible players:</title><para>Two</para></note><!--Number of possible players. It can be: One, Two,..., Multiplayer-->
<!--Short game description starts here. 3-4 sentences (paragraphs)-->
- <para>The idea behind &kappname; is simple, but addictive. Each of two possible players controls a satellite spaceship orbiting the sun. As the game progresses players have to eliminate opponent's spacecraft. As soon as the opponent's satellite is destroyed, the remaining player wins the round.</para>
+ <para>The idea behind &kspaceduel; is simple, but addictive. Each of two possible players controls a satellite spaceship orbiting the sun. As the game progresses players have to eliminate opponent's spacecraft. As soon as the opponent's satellite is destroyed, the remaining player wins the round.</para>
</chapter>
-
+
<chapter id="howto"><title>How to Play</title> <!-- do not change this! -->
<!--IMPORTANT: If the game has no defined objective, please remove the below line.-->
<note><title>Objective:</title><para>Destroy the opponent's satellite, while keeping the own one in tact.</para></note><!--Describe the objective of the game.-->
<!--How to play description. Don't be to specific on rules as they have a separate section in this document-->
<para>
- &kappname; loads directly into the game mode; however, the action does not start until either player makes the first move.</para>
-<note><title>Note:</title><para>If the opponent's satellite is controlled by the built in artificial intelligence, game action does not start until the human player makes the first move.</para></note>
+ &kspaceduel; loads directly into the game mode; however, the action does not start until either player makes the first move.</para>
+<note><para>If the opponent's satellite is controlled by the built in artificial intelligence, game action does not start until the human player makes the first move.</para></note>
<para>
-In &kappname; you control the ship's rotation, acceleration, and weaponry. Your satellite is constantly drawn towards the sun by gravity. You have to adjust the rotation and acceleration of your ship to make it stay on course.</para>
-<note><title>Note:</title><para>Approaching the sun too close causes the satellite to explode.</para></note>
-<para>In the same time you have to monitor the opponent's movement and use your weapons consisting of bullets and mines, to destroy the enemy spacecraft. </para>
-<note><title>Note:</title><para> Your own weapons are as harmful to your satellite as they are to the enemy one.</para></note>
+In &kspaceduel; you control the ship's rotation, acceleration, and weaponry. Your satellite is constantly drawn towards the sun by gravity. You have to adjust the rotation and acceleration of your ship to make it stay on course.</para>
+<note><para>Approaching the sun too close causes the satellite to explode.</para></note>
+<para>In the same time you have to monitor the opponent's movement and use your weapons consisting of bullets and mines, to destroy the enemy spacecraft.</para>
+<note><para>Your own weapons are as harmful to your satellite as they are to the enemy one.</para></note>
</chapter>
-
+
<chapter id="rules_and_tips"><title>Game Rules, Strategies and Tips</title> <!-- do not change this! -->
<sect1 id="screen">
- <title>&kappname; Game Screen Overview.</title>
+ <title>&kspaceduel; Game Screen Overview.</title>
<screenshot>
- <screeninfo>&kappname; game screen</screeninfo>
+ <screeninfo>&kspaceduel; game screen</screeninfo>
<mediaobject><imageobject><imagedata fileref="kspaceduel3.png" format="PNG"/></imageobject>
- <textobject><phrase>&kappname; game screen</phrase></textobject></mediaobject>
+ <textobject><phrase>&kspaceduel; game screen</phrase></textobject></mediaobject>
</screenshot>
<itemizedlist>
<listitem><para>The top of the playing area is occupied by the menubar and toolbar.</para></listitem>
- <listitem><para>The central part of the &kappname; screen is the playing area.</para></listitem>
+ <listitem><para>The central part of the &kspaceduel; screen is the playing area.</para></listitem>
<listitem><para>On the left and on the right sides of the playing area there are the Red Player's and the Blue Player's information screens.</para></listitem>
<listitem><para>The top box on the information screen represents the <quote>Hit Points</quote> of the spacecraft.</para></listitem>
<listitem><para>The middle box on the information screen represents the battery power.</para></listitem>
@@ -100,26 +97,26 @@ In &kappname; you control the ship's rotation, acceleration, and weaponry. Your
</sect1>
<sect1 id="keys">
<title>Default Shortcuts</title>
- <para>The following table contains the default shortcuts for &kappname;.</para>
+ <para>The following table contains the default shortcuts for &kspaceduel;.</para>
<informaltable frame="all">
<tgroup cols="3">
<colspec colname="c1"/><colspec colname="c2"/><colspec colname="c3"/>
<thead><row><entry>Action</entry><entry>Red Player</entry><entry>Blue Player</entry></row></thead>
<tbody>
- <row><entry>Rotate Left</entry><entry>S</entry><entry>Left Arrow</entry></row>
- <row><entry>Rotate Right</entry><entry>F</entry><entry>Right Arrow</entry></row>
- <row><entry>Accelerate</entry><entry>E</entry><entry>Up Arrow</entry></row>
- <row><entry>Shot</entry><entry>D</entry><entry>Down Arrow</entry></row>
- <row><entry>Mines</entry><entry>A</entry><entry>Insert</entry></row>
+ <row><entry>Rotate Left</entry><entry><keycap>S</keycap></entry><entry>&Left; arrow</entry></row>
+ <row><entry>Rotate Right</entry><entry><keycap>F</keycap></entry><entry>&Right; arrow</entry></row>
+ <row><entry>Accelerate</entry><entry><keycap>E</keycap></entry><entry>&Up; arrow</entry></row>
+ <row><entry>Shot</entry><entry><keycap>D</keycap></entry><entry>&Down; arrow</entry></row>
+ <row><entry>Mines</entry><entry><keycap>A</keycap></entry><entry>&Ins;</entry></row>
</tbody>
</tgroup>
</informaltable>
- <note><title>Note:</title><para>To change these keys, please refer to the <link linkend="options-keys">Game Configuration</link> section.</para></note>
+ <note><para>To change these keys, please refer to the <link linkend="options-keys">Game Configuration</link> section.</para></note>
</sect1>
<sect1 id="rules">
<title>Rules</title>
<sect2 id="energy">
- <title>About Energy Points.</title>
+ <title>About Energy Points</title>
<itemizedlist>
<listitem><para>Each player controls one ship.</para></listitem>
<listitem><para>The ships can rotate, accelerate, shoot and set mines.</para></listitem>
@@ -127,11 +124,10 @@ In &kappname; you control the ship's rotation, acceleration, and weaponry. Your
<listitem><para>Each ship has a limited amount of energy.</para></listitem>
<listitem><para>Ships absorb solar energy required for the ship's operation. The amount of energy the ship gets depends on the distance from and the direction to the sun.</para></listitem>
</itemizedlist>
- <note><title>Note:</title><para>A ship gets more energy near the sun and less energy near the border. It gets the full amount of energy if the
-sun shines directly on the solar panels and less or even no energy if the sun shines at an angle to the panels or at the other side of the panels.</para></note>
+ <note><para>A ship gets more energy near the sun and less energy near the border. It gets the full amount of energy if the sun shines directly on the solar panels and less or even no energy if the sun shines at an angle to the panels or at the other side of the panels.</para></note>
</sect2>
<sect2 id="bullets-and-mines">
- <title>About Bullets and Mines.</title>
+ <title>About Bullets and Mines</title>
<itemizedlist>
<listitem><para>Bullets fly around the sun just like a ship does.</para></listitem>
<listitem><para>Mines have an amount of energy to stay at the same position. When the energy is spent, the mines collide with the sun and disintegrate.</para></listitem>
@@ -145,75 +141,73 @@ sun shines directly on the solar panels and less or even no energy if the sun sh
<itemizedlist>
<listitem><para>Collision with own bullets, or enemy bullets or mines decreases the hit points.</para></listitem>
<listitem><para>If two ships collide then the weaker ship is destroyed and the hit points of the stronger ship are decreased by the amount of the hit points the weaker ship had.</para></listitem>
- <listitem><para>If the satellite's amount of hit points goes to zero then satellite explodes.</para></listitem>
- <listitem><para>If a satellite collides with the sun it is destroyed regardless of the amount of hit points remaining.</para></listitem>
+ <listitem><para>If the ship's amount of hit points goes to zero then ship explodes.</para></listitem>
+ <listitem><para>If a ship collides with the sun it is destroyed regardless of the amount of hit points remaining.</para></listitem>
</itemizedlist>
</sect2>
<sect2 id="powerups">
- <title>Powerups</title>
- <para>From time to time powerups appear on the play field.</para>
- <para>There are four different powerups:</para>
- <variablelist>
- <varlistentry><term>Mine</term>
- <listitem><para>The maximum number of mines is increased.</para></listitem>
+ <title>Powerups</title>
+
+ <para>From time to time powerups appear on the play field.</para>
+ <para>There are four different powerups:</para>
+
+ <variablelist>
+ <varlistentry><term></term><listitem>
+ <variablelist>
+ <varlistentry>
+ <term><inlinemediaobject><imageobject><imagedata fileref="mine.png" format="PNG"/> </imageobject></inlinemediaobject> <guiicon>Mine</guiicon></term>
+ <listitem><para>The maximum number of mines is increased.</para></listitem>
</varlistentry>
- <varlistentry><term>Bullet</term>
- <listitem><para>The maximum number of bullets is increased.</para></listitem>
+ <varlistentry>
+ <term><inlinemediaobject><imageobject><imagedata fileref="bullet.png" format="PNG"/> </imageobject></inlinemediaobject> <guiicon>Bullet</guiicon></term>
+ <listitem><para>The maximum number of bullets is increased.</para></listitem>
</varlistentry>
- <varlistentry><term>Energy (yellow sphere)</term>
- <listitem><para>Player's energy increases.</para></listitem>
+ <varlistentry>
+ <term><inlinemediaobject><imageobject><imagedata fileref="energy.png" format="PNG"/> </imageobject></inlinemediaobject> <guiicon>Energy</guiicon> (yellow or green sphere)</term>
+ <listitem><para>Player's energy increases.</para></listitem>
</varlistentry>
- <varlistentry><term>Shield (blue sphere)</term>
- <listitem><para>Player's hit points increase.</para></listitem>
+ <varlistentry>
+ <term><inlinemediaobject><imageobject><imagedata fileref="shield.png" format="PNG"/> </imageobject></inlinemediaobject> <guiicon>Shield</guiicon> (red or blue sphere)</term>
+ <listitem><para>Player's hit points increase.</para></listitem>
</varlistentry>
- </variablelist>
+ </variablelist>
+ </listitem></varlistentry>
+ </variablelist>
</sect2>
</sect1>
</chapter>
-
+
<chapter id="interface"><title>Menu Items</title>
-
+
<variablelist>
-<varlistentry>
-<term><menuchoice>
-<shortcut><keycombo action="simul">
-&Ctrl;<keycap>N</keycap></keycombo></shortcut>
-<guimenu>Game</guimenu><guimenuitem>New</guimenuitem> </menuchoice></term>
-<listitem><para>Starts a new game of &kappname;.</para></listitem>
-</varlistentry>
-
-<varlistentry id="game-menu-new">
-<term><menuchoice>
-<shortcut><keycombo action="simul">
-&Ctrl;<keycap>R</keycap></keycombo></shortcut>
-<guimenu>Game</guimenu><guimenuitem>New Round</guimenuitem> </menuchoice></term>
-<listitem><para>Starts a new round, at the current level.</para></listitem>
-</varlistentry>
-
-<varlistentry id="game-menu-pause">
-<term><menuchoice>
-<shortcut><keycombo action="simul"><keycap>P</keycap></keycombo></shortcut>
-<guimenu>Game</guimenu><guimenuitem>Pause</guimenuitem> </menuchoice></term>
-<listitem><para>Pauses and unpauses the game.</para></listitem>
-</varlistentry>
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycombo action="simul">&Ctrl;
-<keycap>Q</keycap></keycombo></shortcut>
-<guimenu>Game</guimenu><guimenuitem>Quit</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>Quits</action> &kappname;</para></listitem>
-</varlistentry>
-<varlistentry id="settings-menu-settings">
-<term><menuchoice>
-<guimenu>Settings</guimenu>
-<guimenuitem>Configure &kappname;...</guimenuitem>
-</menuchoice></term>
-<listitem><para>Opens a configuration dialog which lets you define many
-settings of the game, refer to the chapter <link linkend="configuration">Game
-Options</link> for further information.</para></listitem>
-</varlistentry>
+ <varlistentry>
+ <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut>
+ <guimenu>Game</guimenu> <guimenuitem>New</guimenuitem></menuchoice></term>
+ <listitem><para><action>Starts a new game</action> of &kspaceduel;.</para></listitem>
+ </varlistentry>
+
+ <varlistentry id="game-menu-new">
+ <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo></shortcut>
+ <guimenu>Game</guimenu> <guimenuitem>New Round</guimenuitem></menuchoice></term>
+ <listitem><para><action>Starts a new round</action>, at the current level.</para></listitem>
+ </varlistentry>
+
+ <varlistentry id="game-menu-pause">
+ <term><menuchoice><shortcut><keycombo action="simul"><keycap>P</keycap></keycombo></shortcut>
+ <guimenu>Game</guimenu> <guimenuitem>Pause</guimenuitem></menuchoice></term>
+ <listitem><para><action>Pauses and unpauses the game.</action></para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></shortcut>
+ <guimenu>Game</guimenu> <guimenuitem>Quit</guimenuitem></menuchoice></term>
+ <listitem><para><action>Quits</action> &kspaceduel;.</para></listitem>
+ </varlistentry>
+
+ <varlistentry id="settings-menu-settings">
+ <term><menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure &kspaceduel;...</guimenuitem></menuchoice></term>
+ <listitem><para><action>Opens a configuration dialog</action> which lets you define many settings of the game, refer to the chapter <link linkend="configuration">Game Configuration</link> for further information.</para></listitem>
+ </varlistentry>
</variablelist>
<para>
@@ -225,242 +219,272 @@ of the &kde; Fundamentals.
</para>
</chapter>
-
+
<chapter id="faq"><title>Frequently asked questions</title> <!-- do not change this! -->
<!--This chapter is for frequently asked questions. Please use <qandaset> <qandaentry> only!-->
<qandaset>
<!--Following is a standard list of FAQ questions.-->
<qandaentry>
<question><para>I want to change the way this game looks. Can I? </para></question>
- <answer><para>No. At this moment &kappname; features only one theme.</para></answer>
+ <answer><para>No. At this moment &kspaceduel; features only one theme.</para></answer>
</qandaentry>
<qandaentry>
<question><para>I have made a mistake. Can I undo? </para></question>
- <answer><para>No. &kappname; does not have an <quote>Undo</quote> feature.</para></answer>
+ <answer><para>No. &kspaceduel; does not have an <quote>Undo</quote> feature.</para></answer>
</qandaentry>
<qandaentry>
<question><para>I cannot figure out what to do here! Are there hints? </para></question>
- <answer><para>No. &kappname; does not have a <quote>Hint</quote> feature. However, if you carefully read through the <link linkend="rules_and_tips">Game Rules, Strategies and Tips</link> section you shouldn't have this problem.</para></answer>
+ <answer><para>No. &kspaceduel; does not have a <quote>Hint</quote> feature. However, if you carefully read through the <link linkend="rules_and_tips">Game Rules, Strategies and Tips</link> section you shouldn't have this problem.</para></answer>
</qandaentry>
<qandaentry>
<question><para>I have to quit the game now, but I am not finished yet. Can I save my progress?</para></question>
- <answer><para>No. &kappname; does not have a <quote>Save</quote> feature.</para></answer>
+ <answer><para>No. &kspaceduel; does not have a <quote>Save</quote> feature.</para></answer>
</qandaentry>
<!--Please add more Q&As if needed-->
-
+
</qandaset>
</chapter>
-
+
<chapter id="configuration"><title>Game Configuration</title> <!-- do not change this! -->
<!--This section describes configuration &GUI;. If your game is configured using menubar exclusively, please remove this section.-->
<sect1 id="options-keys">
<title>Game Keys</title>
- <para>&kappname; has a default set of keys to control the game. For a list of default keys see the section entitled <link linkend="keys">Default Shortcuts</link>.</para>
- <para>Keys can be configured by selecting <menuchoice> <guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts...</guimenuitem> </menuchoice> from the menubar.</para>
+ <para>&kspaceduel; has a default set of keys to control the game. For a list of default keys see the section entitled <link linkend="keys">Default Shortcuts</link>.</para>
+ <para>Keys can be configured by selecting the <menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice> menu item.</para>
<para>This will bring up a dialog box which lets you configure all hotkeys, including the keys used for steering the space ships, for firing bullets, and for laying mines.</para>
<para>You can see that each player (Red and Blue), has 5 keystrokes corresponding to Rotate Left, Rotate Right, Accelerate, Shot, and Mines.</para>
<para>When you are finished configuring your keys, you should click on <guibutton>OK</guibutton> to apply your changes.</para>
- <para>If you want to restore the default keys, simply click on the <guibutton>Default</guibutton> button once. To make these changes permanent, press <guibutton>OK</guibutton>.</para>
+ <para>If you want to restore the default keys, simply click on the <guibutton>Default</guibutton> button once. To make these changes permanent, press <guibutton>OK</guibutton>.</para>
<para>If you want to abandon the changes you made, and return to your previously selected keys, simply click <guibutton>Cancel</guibutton>, and your changes will be lost.</para>
</sect1>
<sect1 id="options-configurations">
<title>Game Configuration</title>
- <para>All game settings of &kappname; are configurable.</para>
- <para>If you want to change the game settings, simply select <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kappname;...</guimenuitem></menuchoice> from the menubar.</para>
+ <para>All game settings of &kspaceduel; are configurable.</para>
+ <para>If you want to change the game settings, simply select the <menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure &kspaceduel;...</guimenuitem></menuchoice> menu item.</para>
<para>This will bring up a dialog box with two pages, labelled <guilabel>General</guilabel> and <guilabel>Game</guilabel>. The first page is rather simple, the second one has seven tabs across the top.</para>
<para>Settings are collected in different configurations. You can choose from several pre-defined configurations.</para>
<para>If you choose the <guilabel>Custom</guilabel> configuration, you can define all settings for yourself.</para>
<note><para>If you have not selected <guilabel>Custom</guilabel>, you will not be able to make any changes to these options.</para></note>
- <tip><para> If you have found an interesting configuration, mail it to the author of the game. It can be implemented in a future version (send the part [Game] in the file <filename>~/.kde/share/config/kspaceduelrc</filename>).</para></tip>
+ <tip><para>If you have found an interesting configuration, mail it to the author of the game. It can be implemented in a future version (send the part [Game] in the file <filename>~/.config/kspaceduelrc</filename>).</para></tip>
<para>When you are finished altering the options, you should click on <guibutton>OK</guibutton> to apply your changes.</para>
- <para>If you want to restore the default, simply click on the <guibutton>Default</guibutton> button once. To make these changes permanent, press <guibutton>OK</guibutton>.</para>
+ <para>If you want to restore the default, simply click on the <guibutton>Default</guibutton> button once. To make these changes permanent, press <guibutton>OK</guibutton>.</para>
<para>If you want to abandon the changes you made, and return to your previous options, simply click <guibutton>Cancel</guibutton>, and your changes will be lost.</para>
+
<para>The settings are:</para>
- <sect2 id="general">
- <title><guilabel>General</guilabel></title>
+
+ <sect2 id="general">
+ <title>The General Page</title>
<variablelist>
<varlistentry>
<term><guilabel>Hit Points</guilabel></term>
- <listitem><para>These two sliders allow you to define the hitpoints for each of the two players; you might want to decrease the hitpoints for a player to give that player a handycap.</para></listitem>
+ <listitem><para>This section contains two sliders allow you to define the hitpoints for each of the two players; you might want to decrease the hitpoints for a player to give that player a handycap.</para></listitem>
</varlistentry>
<varlistentry>
- <term><guilabel>Refresh time</guilabel></term>
+ <term><guilabel>Refresh time:</guilabel></term>
<listitem><para>Time between two screen refreshes in milliseconds. All other settings are independent of the refresh time.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Red Player</guilabel></term>
- <listitem><para>Here you can define whether the red player gets controlled by the AI, and also choose the skill level of the AI for this player. Just experiment with the different skill level to find one which fits you.</para></listitem>
+ <listitem><para>In this section you can define whether the red player gets controlled by the AI, and also choose the skill level of the AI for this player. Just experiment with the different skill level to find one which fits you.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Blue Player</guilabel></term>
- <listitem><para>This works the same as the options for the <guilabel>Red Player</guilabel> described above.</para></listitem>
- </varlistentry>
- </variablelist>
- </sect2>
- <sect2 id="game">
- <title><guilabel>Game</guilabel></title>
- <variablelist>
- <varlistentry>
- <term><guilabel>Game speed</guilabel></term>
- <listitem><para>Controls the speed of the whole game.</para></listitem>
+ <listitem><para>This works the same as the options for the <guilabel>Red Player</guilabel> section described above.</para></listitem>
</varlistentry>
</variablelist>
- </sect2>
- <sect2 id="bullet">
- <title><guilabel>Bullet</guilabel></title>
- <variablelist>
- <varlistentry>
- <term><guilabel>Shot speed</guilabel></term>
- <listitem><para>The speed of bullets</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><guilabel>Energy need</guilabel></term>
- <listitem><para>The amount of energy needed for one shot.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><guilabel>Max number</guilabel></term>
- <listitem><para>The maximum number of bullets a player can have on the screen.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><guilabel>Damage</guilabel></term>
- <listitem><para>The number of hit points damage done when a bullet hits a ship.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><guilabel>Life time</guilabel></term>
- <listitem><para>The maximum life time of a bullet.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><guilabel>Reload time</guilabel></term>
- <listitem><para>The time a ship needs to reload a bullet.</para></listitem>
- </varlistentry>
- </variablelist>
- </sect2>
- <sect2 id="mine">
- <title><guilabel>Mine</guilabel></title>
- <variablelist>
- <varlistentry>
- <term><guilabel>Mine fuel</guilabel></term>
- <listitem><para>The amount of fuel on a mine.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><guilabel>Energy need</guilabel></term>
- <listitem><para>The amount of energy needed for laying a mine.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><guilabel>Activate time</guilabel></term>
- <listitem><para>The time a mine is inactive.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><guilabel>Damage</guilabel></term>
- <listitem><para>The number of hit points of damage done when a ship hits a mine.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><guilabel>Max number</guilabel></term>
- <listitem><para>Maximum number of mines a player can have on the screen.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><guilabel>Reload time</guilabel></term>
- <listitem><para>The time a ship needs to reload a mine.</para></listitem>
- </varlistentry>
- </variablelist>
- </sect2>
- <sect2 id="ship">
- <title><guilabel>Ship</guilabel></title>
- <variablelist>
- <varlistentry>
- <term><guilabel>Acceleration</guilabel></term>
- <listitem><para>Acceleration of the ships</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><guilabel>Energy need</guilabel></term>
- <listitem><para>The energy needed to accelerate a ship.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><guilabel>Rotation speed</guilabel></term>
- <listitem><para>The speed at which a ship rotates.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><guilabel>Energy need</guilabel></term>
- <listitem><para>The energy needed to rotate a ship.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><guilabel>Crash damage</guilabel></term>
- <listitem><para>The number of hit points damage done when two ships collide.</para></listitem>
- </varlistentry>
- </variablelist>
- </sect2>
- <sect2 id="sun">
- <title><guilabel>Sun</guilabel></title>
+ </sect2>
+
+ <sect2 id="game">
+ <title>The Game Page</title>
+
+ <para>Here you can select a custom setting set from a drop-down list. Then use the tabs to customize the settings a bit more.</para>
+
<variablelist>
<varlistentry>
- <term><guilabel>Sun energy</guilabel></term>
- <listitem><para>The strength of the sun. The higher the value, the quicker ships will be recharged.</para></listitem>
+ <term><guilabel>General</guilabel> tab</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term><guilabel>Game speed:</guilabel></term>
+ <listitem><para>Controls the speed of the whole game.</para></listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
</varlistentry>
- <varlistentry>
- <term><guilabel>Gravity</guilabel></term>
- <listitem><para>The strength of the gravitational pull of the sun.</para></listitem>
- </varlistentry>
- </variablelist>
- </sect2>
- <sect2 id="start">
- <title><guilabel>Start</guilabel></title>
- <variablelist>
- <varlistentry>
- <term><guilabel>Position X</guilabel> and <guilabel>Position Y</guilabel></term>
- <listitem><para>The ships position at the beginning of a new round. The ships start at opposite sides of the sun.</para></listitem>
+
+ <varlistentry id="bullet">
+ <term><guilabel>Bullet</guilabel> tab</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term><guilabel>Shot speed:</guilabel></term>
+ <listitem><para>The speed of bullets.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Energy need:</guilabel></term>
+ <listitem><para>The amount of energy needed for one shot.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Max number:</guilabel></term>
+ <listitem><para>The maximum number of bullets a player can have on the screen.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Damage:</guilabel></term>
+ <listitem><para>The number of hit points damage done when a bullet hits a ship.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Life time:</guilabel></term>
+ <listitem><para>The maximum life time of a bullet.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Reload time:</guilabel></term>
+ <listitem><para>The time a ship needs to reload a bullet.</para></listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
</varlistentry>
- <varlistentry>
- <term><guilabel>Velocity X</guilabel> and <guilabel>Velocity Y</guilabel></term>
- <listitem><para>Velocity at the beginning of a new round.</para></listitem>
+
+ <varlistentry id="mine">
+ <term><guilabel>Mine</guilabel> tab</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term><guilabel>Mine fuel:</guilabel></term>
+ <listitem><para>The amount of fuel on a mine.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Energy need:</guilabel></term>
+ <listitem><para>The amount of energy needed for laying a mine.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Activate time:</guilabel></term>
+ <listitem><para>The time a mine is inactive.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Damage:</guilabel></term>
+ <listitem><para>The number of hit points of damage done when a ship hits a mine.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Max number:</guilabel></term>
+ <listitem><para>The maximum number of mines a player can have on the screen.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Reload time:</guilabel></term>
+ <listitem><para>The time a ship needs to reload a mine.</para></listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
</varlistentry>
- </variablelist>
- </sect2>
- <sect2 id="powerup-options">
- <title><guilabel>Powerups</guilabel></title>
- <variablelist>
- <varlistentry>
- <term><guilabel>Appearance time</guilabel></term>
- <listitem><para>Maximal time between the appearance of two powerups.</para></listitem>
+
+ <varlistentry id="ship">
+ <term><guilabel>Ship</guilabel> tab</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term><guilabel>Acceleration:</guilabel></term>
+ <listitem><para>Acceleration of the ships.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Energy need:</guilabel></term>
+ <listitem><para>The energy needed to accelerate a ship.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Rotation speed:</guilabel></term>
+ <listitem><para>The speed at which a ship rotates.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Energy need:</guilabel></term>
+ <listitem><para>The energy needed to rotate a ship.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Crash damage:</guilabel></term>
+ <listitem><para>The number of hit points damage done when two ships collide.</para></listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
</varlistentry>
- <varlistentry>
- <term><guilabel>Life time</guilabel></term>
- <listitem><para>Maximal life time of a powerup.</para></listitem>
+
+ <varlistentry id="sun">
+ <term><guilabel>Sun</guilabel> tab</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term><guilabel>Sun energy:</guilabel></term>
+ <listitem><para>The strength of the sun. The higher the value, the quicker ships will be recharged.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Gravity:</guilabel></term>
+ <listitem><para>The strength of the gravitational pull of the sun.</para></listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
</varlistentry>
- <varlistentry>
- <term><guilabel>Energy amount</guilabel></term>
- <listitem><para>Amount of energy a player gets from an energy powerup.</para></listitem>
+
+ <varlistentry id="start">
+ <term><guilabel>Start</guilabel> tab</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term><guilabel>Position X:</guilabel> and <guilabel>Position Y:</guilabel></term>
+ <listitem><para>The ships position at the beginning of a new round. The ships start at opposite sides of the sun.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Velocity X:</guilabel> and <guilabel>Velocity Y:</guilabel></term>
+ <listitem><para>Velocity at the beginning of a new round.</para></listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
</varlistentry>
- <varlistentry>
- <term><guilabel>Shield amount</guilabel></term>
- <listitem><para>Amount of hit points a player gets from a shield powerup.</para></listitem>
+
+ <varlistentry id="powerup-options">
+ <term><guilabel>Powerups</guilabel> tab</term>
+ <listitem>
+ <variablelist>
+ <varlistentry>
+ <term><guilabel>Appearance time:</guilabel></term>
+ <listitem><para>Maximal time between the appearance of two powerups.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Life time:</guilabel></term>
+ <listitem><para>Maximal life time of a powerup.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Energy amount:</guilabel></term>
+ <listitem><para>Amount of energy a player gets from an energy powerup.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><guilabel>Shield amount:</guilabel></term>
+ <listitem><para>Amount of hit points a player gets from a shield powerup.</para></listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
</varlistentry>
</variablelist>
- </sect2>
- </sect1>
+ </sect2>
+ </sect1>
</chapter>
-
+
<chapter id="credits"><title>Credits and License</title> <!-- do not change this! -->
<!--This chapter is for credits and licenses.-->
-
+
<para>
-&kappname;
+&kspaceduel;
</para>
-<para>
-Program copyright 1999-2000 &Andreas.Zehender; <email>az at azweb.de</email></para>
-<para>Documentation copyright 2000 &Andreas.Zehender; <email>az at azweb.de</email></para>
-<para>Documentation updated for &kde; &kappversion; &Mike.McBride; &Mike.McBride.mail;</para>
+<para>Program Copyright 1999-2000 &Andreas.Zehender; &Andreas.Zehender.mail;</para>
+<para>Documentation Copyright 2000 &Andreas.Zehender; &Andreas.Zehender.mail;</para>
+<para>Documentation updated for &kde; 4.11 by &Mike.McBride; &Mike.McBride.mail;</para>
<!-- !!!do not change ANYTHING after this line!!!! -->
-<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
+<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
&underGPL;
-
+
</chapter>
-
-&documentation.index;
+
+&documentation.index;
</book>
<!--
Local Variables:
diff --git a/doc/mine.png b/doc/mine.png
new file mode 100644
index 0000000..eeb6ae6
Binary files /dev/null and b/doc/mine.png differ
diff --git a/doc/shield.png b/doc/shield.png
new file mode 100644
index 0000000..81c58a0
Binary files /dev/null and b/doc/shield.png differ
More information about the kde-doc-english
mailing list