[kde-doc-english] [ksquares] doc: Proofread + update KSquares handbook to 16.04

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


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

Proofread + update KSquares handbook to 16.04

remove entities kappname, kappversion, package - not used anymore
bump date + releaseinfo
add screenshots
remove obsolete info about filled lines depending on ai
remove appendix

A  +-    --    doc/configure-display.png
A  +-    --    doc/gameboard.png
M  +35   -21   doc/index.docbook
A  +-    --    doc/newgame.png

http://commits.kde.org/ksquares/3c91b114b6d994684edaf42d218f9f62a6506301

diff --git a/doc/configure-display.png b/doc/configure-display.png
new file mode 100644
index 0000000..e098bb1
Binary files /dev/null and b/doc/configure-display.png differ
diff --git a/doc/gameboard.png b/doc/gameboard.png
new file mode 100644
index 0000000..83fe185
Binary files /dev/null and b/doc/gameboard.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index 857a713..10c23a7 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 "&ksquares;">
-  <!ENTITY kappversion "0.4"><!--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! -->
 ]>
@@ -35,12 +32,12 @@
     <holder>Matt Williams</holder>
   </copyright>
 <legalnotice>&FDLNotice;</legalnotice> 
-<date>2013-05-05</date><!-- Date of (re)writing, or update.-->
-<releaseinfo>&kappversion;</releaseinfo><!-- Application version number. Use the variable definitions within header to change this value.-->
+<date>2016-05-10</date>
+<releaseinfo>0.6 (Applications 16.04)</releaseinfo>
  
 <!--Short description of this document. Do not change unless necessary!-->
 <abstract>
-	<para>This documentation describes the game of &ksquares; version &kappversion;</para>
+	<para>This documentation describes the game of &ksquares; version 0.6</para>
 </abstract>
  
 <!--List of relevan keywords-->
@@ -79,7 +76,18 @@
 	<para>
   At the start of the game, the game board is empty. There is simply a grid of dots showing where lines can be drawn.
 </para>
-<note><title>Note:</title><para>Depending on the game difficulty chosen, the game field may already contain lines at the beginning of the game round.</para></note>
+
+<screenshot>
+<mediaobject>
+<imageobject>
+<imagedata fileref="gameboard.png" format="PNG"/>
+</imageobject>
+<textobject>
+<phrase>&ksquares; Game Board</phrase>
+</textobject>
+</mediaobject>
+</screenshot>
+
   <para>Each player takes it in turns to draw a line between two adjacent dots on the board. By hovering the mouse over the game board, a yellow indicator line will show you where your line will be placed when you click.
   Once you have decided where you want to draw your line, click - and the line will be drawn.
   If by drawing a line, you completed a square then this square now belongs to you and earns you a point. Each time you complete a square, you must draw another line. If your line did not complete a square then the next player(s) take their turn.
@@ -212,6 +220,16 @@
 <chapter id="configuration"><title>Game Configuration</title> <!-- do not change this! -->
 <sect1 id="newgame-dialog">
 <title>New Game Dialog</title>
+<screenshot>
+<mediaobject>
+<imageobject>
+<imagedata fileref="newgame.png" format="PNG"/>
+</imageobject>
+<textobject>
+<phrase>New game</phrase>
+</textobject>
+</mediaobject>
+</screenshot>
 <para>The <guilabel>New Game</guilabel> dialog consistes of the following groupboxes:</para>
 <variablelist>
   <varlistentry>
@@ -230,6 +248,16 @@
 </sect1>
 <sect1 id="configuration-dialog">
 <title>Configuration Dialog</title>
+<screenshot>
+<mediaobject>
+<imageobject>
+<imagedata fileref="configure-display.png" format="PNG"/>
+</imageobject>
+<textobject>
+<phrase>Configuration dialog</phrase>
+</textobject>
+</mediaobject>
+</screenshot>
 <para>The <guilabel>Configure - &ksquares;</guilabel> dialog consists of the following tabs:</para>
 <variablelist>
   <varlistentry>
@@ -264,20 +292,6 @@
 &underGPL;
  
 </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>
diff --git a/doc/newgame.png b/doc/newgame.png
new file mode 100644
index 0000000..986f562
Binary files /dev/null and b/doc/newgame.png differ


More information about the kde-doc-english mailing list