[kde-doc-english] [kiriki] doc: Proofread + update Kiriki handbook to 16.04

Burkhard Lück lueck at hube-lueck.de
Tue May 10 19:56:26 UTC 2016


Git commit e67b4f64ba2b8ef62b0cbd7ec09143d66ac76833 by Burkhard Lück.
Committed on 10/05/2016 at 19:56.
Pushed by lueck into branch 'master'.

Proofread + update Kiriki handbook to 16.04

remove entities kappname, package, kappversion - already defined in frameworks/kdoctools or not used anymore
bump date + releaseinfo
add screenshots
remove appendix
REVIEW:127880

A  +-    --    doc/configuration.png
A  +-    --    doc/gameboard.png
M  +34   -23   doc/index.docbook

http://commits.kde.org/kiriki/e67b4f64ba2b8ef62b0cbd7ec09143d66ac76833

diff --git a/doc/configuration.png b/doc/configuration.png
new file mode 100644
index 0000000..851cd3a
Binary files /dev/null and b/doc/configuration.png differ
diff --git a/doc/gameboard.png b/doc/gameboard.png
new file mode 100644
index 0000000..ef4fb30
Binary files /dev/null and b/doc/gameboard.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index 99559d7..bbe71b3 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1,9 +1,6 @@
 <?xml version="1.0" ?>
 <!--IMPORTANT: please note that'do not change this!' notice does not apply to translators -->
 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
-  <!ENTITY kappname "&kiriki;">
-  <!ENTITY kappversion "0.2"><!--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! -->
 ]>
@@ -28,12 +25,12 @@
 			<holder>&Albert.Astals.Cid;</holder>
 		</copyright>
 <legalnotice>&FDLNotice;</legalnotice> 
-<date>2013-05-06</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>2016-05-09</date>
+<releaseinfo>0.3.0 (Applications 16.04)</releaseinfo>
  
 <!--Short description of this document. Do not change unless necessary!-->
 <abstract>
-	<para>This documentation describes the game of &kiriki; version &kappversion;</para>
+	<para>This documentation describes the game of &kiriki; version 0.3.0</para>
 </abstract>
  
 <!--List of relevan keywords-->
@@ -55,7 +52,19 @@
 <chapter id="introduction"><title>Introduction</title> <!-- do not change this! -->
 	<note><title>Gametype:</title><para>Dice, 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>Six</para></note><!--Number of possible players. It can be: One, Two,..., Multiplayer-->
-	<para>
+
+<screenshot>
+<mediaobject>
+<imageobject>
+<imagedata fileref="gameboard.png" format="PNG"/>
+</imageobject>
+<textobject>
+<phrase>&kiriki; Game Board</phrase>
+</textobject>
+</mediaobject>
+</screenshot>
+
+<para>
 	&kiriki; is an addictive and fun dice game for &kde;, designed to be played by as many as six players. Participants have to collect points by rolling five dice for up to three times per single turn. Each roll generates a specific combination of numbers which the player is free to either accept or decline. However, each specific combination of numbers can be accepted only once. After thirteen turns the game ends and the scores are compared. The player with the largest amount of points wins the game.
 	</para>
 </chapter>
@@ -217,15 +226,31 @@ of the &kde; Fundamentals.
 </chapter>
 
 <chapter id="configuration"><title>Game Configuration</title> <!-- do not change this! -->
+
+<screenshot>
+<mediaobject>
+<imageobject>
+<imagedata fileref="configuration.png" format="PNG"/>
+</imageobject>
+<textobject>
+<phrase>Game Configuration</phrase>
+</textobject>
+</mediaobject>
+</screenshot>
+
 <para>The &kiriki; configuration dialog lets you configure the number of participants, manage their identities, and their response times.</para>
 <note><title>Note:</title><para>You can change the response times for Artificial Intelligence driven players only.</para></note>
 <para><guilabel>Number of players:</guilabel> this field defines the number of players for &kiriki;. The values allowed here range between two and six.</para>
-<note><title>Note:</title><para>The number of players cannot be less than two.</para></note>
+
 <para><guilabel>1.</guilabel>-<guilabel>6.</guilabel> Numbered fields are the identities of the participating players. You can change their names as well as specify whether they will be human controlled, or driven by the Artificial Intelligence. To define who controls the player use a check box located on the right hand side, right next to the name entry box.</para>
-<note><title>Note:</title><para>The first player must always be human controlled.</para></note>
+<para>The first player must always be human controlled.</para>
+
 <para>Changes to number of participants and their identities will be applied on the next game.</para>
+
 <para><guilabel>Delay between computers move (msec):</guilabel> lets you specify the delay between Artificial Intelligence's turns. The value of this field is zero by default, meaning that the Artificial Intelligence reacts instantaneously.</para>
+
 <note><title>Note:</title><para>The maximum value for this field is 999 milliseconds.</para></note>
+
 <para>Use <guilabel>Font Size</guilabel> and <guilabel>Row Height</guilabel> to adjust the score board to your liking.</para>
 <para>If you want to play immediately at &kiriki; startup disable the default option <guilabel>Show demonstration game at startup</guilabel>.</para>
 </chapter>
@@ -251,20 +276,6 @@ Documentation copyright 2007 Eugene Trounev <email>eugene.trounev at gmail.com</ema
  
 </chapter>
  
-<appendix id="installation">
-<title>Installation</title>
- 
-&install.intro.documentation;
- 
- 
-<sect1 id="Compilation">
-<title>Compilation and Installation</title>
- 
-&install.compile.documentation;
- 
-</sect1>
-</appendix>
- 
 &documentation.index; 
 </book>
 <!--


More information about the kde-doc-english mailing list