[kde-doc-english] [kpat] doc: Update KPat Handbook to 16.04
Burkhard Lück
lueck at hube-lueck.de
Fri May 13 04:14:29 UTC 2016
Git commit 52ceeed106918f63aa0e0a1fadba3af1d2b7a271 by Burkhard Lück.
Committed on 13/05/2016 at 04:14.
Pushed by lueck into branch 'master'.
Update KPat Handbook to 16.04
remove kappname, kappversion, package entities - no longer used
bump date + releaseinfo
update screenshots
replace kappname with kpatience
merge settings + help menu, add link to fundamentals
remove appendix
rewrite of manpage
REVIEW:127894
M +- -- doc/clubs.png
M +- -- doc/diamonds.png
M +- -- doc/hearts.png
M +24 -47 doc/index.docbook
M +41 -278 doc/man-kpat.6.docbook
M +- -- doc/playfield.png
M +- -- doc/spades.png
http://commits.kde.org/kpat/52ceeed106918f63aa0e0a1fadba3af1d2b7a271
diff --git a/doc/clubs.png b/doc/clubs.png
index 1c9a78e..e228f52 100644
Binary files a/doc/clubs.png and b/doc/clubs.png differ
diff --git a/doc/diamonds.png b/doc/diamonds.png
index 79708aa..6ee9dfd 100644
Binary files a/doc/diamonds.png and b/doc/diamonds.png differ
diff --git a/doc/hearts.png b/doc/hearts.png
index 1268426..cd66a14 100644
Binary files a/doc/hearts.png and b/doc/hearts.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index 00ca3ee..5665263 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1,16 +1,13 @@
<?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 "&kpatience;">
- <!ENTITY kappversion "3.6"><!--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="kpat" 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 &kpatience; 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>
@@ -65,12 +62,12 @@
<legalnotice>&FDLNotice;</legalnotice>
-<date>2012-08-06</date><!-- Date of (re)writing, or update.-->
-<releaseinfo>&kappversion; (&kde; 4.9)</releaseinfo><!-- Application version number. Use the variable definitions within header to change this value.-->
+<date>2016-05-11</date>
+<releaseinfo>3.6 (Applications 16.04)</releaseinfo>
<!--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 &kpatience; version 3.6</para>
</abstract>
<!--List of relevan keywords-->
@@ -119,7 +116,7 @@ moving, turning and reordering them.
<note><title>Objective:</title><para>Rearrange the cards by suit in as few moves as possible.</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>
- As &kappname; offers you a multiplicity of different solitaire games, there is no straightforward how-to which could fit all of them. Therefore, it is essential that you read each individual subsection of Game Rules, Strategies and Tips section before you start playing a version you are not familiar with.</para>
+ As &kpatience; offers you a multiplicity of different solitaire games, there is no straightforward how-to which could fit all of them. Therefore, it is essential that you read each individual subsection of Game Rules, Strategies and Tips section before you start playing a version you are not familiar with.</para>
<para>
Essentially there are two types of solitaire games – the ones that let you arrange the cards by same color and the ones that let you arrange the cards by alternating color. You can easily determine which game you are trying out using trial-and-error method. Once you know which one you are dealing with the rest is easy; keep arranging and rearranging the cards and collecting the matching ones.</para>
<para>
@@ -178,7 +175,7 @@ completely new game.
</varlistentry>
<varlistentry><term>3. Foundation</term>
<listitem><para><indexterm><primary>foundation</primary></indexterm>The foundation piles are where you want your cards to end up. Typically, the game is one only once all cards have been moved to the foundation piles in the correct order. The number of foundation piles and the ordering required varies from game to game.</para>
- <para>Most games start with the foundation piles empty. Choosing the <guimenuitem>Drop</guimenuitem> action from the menu or toolbar will cause &kpatience; to scan through all the piles move as many cards to the foundation piles as it can. If you have the <guimenuitem>Enabled Autodrop</guimenuitem> setting activated, &kpatience; will attempt to perform a drop whenever possible.</para>
+ <para>Most games start with the foundation piles empty. Choosing the <guimenuitem>Drop</guimenuitem> action from the menu or toolbar will cause &kpatience; to scan through all the piles move as many cards to the foundation piles as it can. If you have the <guimenuitem>Enabled Autodrop</guimenuitem> setting activated, &kpatience; will attempt to perform a drop whenever possible.</para>
</listitem>
</varlistentry>
<varlistentry><term>4. Playing Piles</term>
@@ -622,7 +619,7 @@ win at Easy level, and very difficult to win at Hard level.
<term><menuchoice>
<guimenu>Game</guimenu>
<guisubmenu>Load Recent</guisubmenu>
- <guimenuitem>List of recently accessed files.</guimenuitem>
+ <guimenuitem><replaceable>List of recently accessed files</replaceable></guimenuitem>
</menuchoice></term>
<listitem><para><action>List recently accessed save files in order of last use.</action> Selecting a game will load it. This action abandons the deal in progress.</para></listitem>
</varlistentry>
@@ -647,7 +644,7 @@ win at Easy level, and very difficult to win at Hard level.
<guimenu>Game</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice></term>
- <listitem><para><action>Quit</action> &kappname;.</para></listitem>
+ <listitem><para><action>Quit</action> &kpatience;.</para></listitem>
</varlistentry>
</variablelist>
</sect1>
@@ -712,14 +709,17 @@ win at Easy level, and very difficult to win at Hard level.
</varlistentry>
</variablelist>
</sect1>
-<sect1 id="settings-menu">
- <title>The Settings Menu</title>
+<sect1 id="settings-help-menu">
+ <title>The Settings and Help Menu</title>
+<para>Apart from the common &kde; Settings and Help menus described in the <ulink url="help:/fundamentals/ui.html#menus">Menu</ulink>
+chapter of the &kde; Fundamentals documentation &kpatience; has these application specific menu entries:
+</para>
<variablelist>
<varlistentry id="settings-menu-game-type-options">
<term><menuchoice>
<guimenu>Settings</guimenu>
- <guisubmenu>"Game Type" Options</guisubmenu>
- <guimenuitem>List of game type specific options.</guimenuitem>
+ <guisubmenu><replaceable>Game Type Options</replaceable></guisubmenu>
+ <guimenuitem><replaceable>List of game type specific options</replaceable></guimenuitem>
</menuchoice></term>
<listitem><para><action>List options specific to the current game type.</action> This menu is available in only certain games (Klondike and Spider).</para></listitem>
</varlistentry>
@@ -760,26 +760,17 @@ win at Easy level, and very difficult to win at Hard level.
</menuchoice></term>
<listitem><para><action>Enable automatic saving of the game state when &kpatience; is shut down.</action> If enabled, &kpatience; will load the previous game state automatically the next time it is started.</para></listitem>
</varlistentry>
- <varlistentry id="settings-menu-toolbar">
- <term><menuchoice>
- <guimenu>Settings</guimenu>
- <guimenuitem>Show Toolbar</guimenuitem>
- </menuchoice></term>
- <listitem><para>Show or hide the toolbar.</para></listitem>
- </varlistentry>
- <varlistentry id="settings-menu-statusbar">
+ <varlistentry id="help-menu-remember">
<term><menuchoice>
- <guimenu>Settings</guimenu>
- <guimenuitem>Show Statusbar</guimenuitem>
+ <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>F1</keycap></keycombo></shortcut>
+ <guimenu>Help</guimenu>
+ <guimenuitem>Help with Current Game</guimenuitem>
</menuchoice></term>
- <listitem><para>Show or hide the statusbar.</para></listitem>
+ <listitem><para>Opens the section with the Rules for the current game in this handbook </para></listitem>
</varlistentry>
</variablelist>
</sect1>
-<sect1 id="help"><!--This is a standard Help menubar entry. Only change if needed.-->
-<title>The Help Menu</title>
-&help.menu.documentation;
-</sect1>
+
</chapter>
<chapter id="faq"><title>Frequently asked questions</title> <!-- do not change this! -->
@@ -796,7 +787,7 @@ win at Easy level, and very difficult to win at Hard level.
</qandaentry>
<qandaentry>
<question><para>Can I use the keyboard to play the game?</para></question>
- <answer><para>No, &kappname; features no keyboard only play. However, most menu options do have keyboard shortcuts.</para></answer>
+ <answer><para>No, &kpatience; features no keyboard only play. However, most menu options do have keyboard shortcuts.</para></answer>
</qandaentry>
<qandaentry>
<question><para>Even with hints I still have no clue how to play. Help!</para></question>
@@ -809,7 +800,7 @@ win at Easy level, and very difficult to win at Hard level.
<!--This chapter is for credits and licenses.-->
<para>
-&kappname; <!-- do not change this! -->
+&kpatience; <!-- do not change this! -->
</para>
<!--List all the copyright holders here-->
<para>
@@ -841,7 +832,7 @@ Documentation rewritten for &kpatience; 2.0 (&kde; 2.1) by &Maren.Pakura;
</para>
<para>
-Documentation proofread and update for &kpatience; &kappversion; by &Richard.Hawthorne;
+Documentation proofread and update for &kpatience; 3.6 by &Richard.Hawthorne;
&Richard.Hawthorne.mail;
</para>
@@ -853,20 +844,6 @@ Documentation proofread and update for &kpatience; &kappversion; by &Richard.Haw
</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/man-kpat.6.docbook b/doc/man-kpat.6.docbook
index 4543cde..fa4c698 100644
--- a/doc/man-kpat.6.docbook
+++ b/doc/man-kpat.6.docbook
@@ -5,30 +5,39 @@
]>
<refentry lang="&language;">
+<refentryinfo>
+<title>KPat User's Manual</title>
+<date>2016-05-11</date>
+<releaseinfo>3.6 (Applications 16.04)</releaseinfo>
+<productname>KDE Applications</productname>
+</refentryinfo>
+
<refmeta>
-<refentrytitle>KPat</refentrytitle>
+<refentrytitle><command>kpat</command></refentrytitle>
<manvolnum>6</manvolnum>
-<refmiscinfo class="date">2010-11-09</refmiscinfo>
-<refmiscinfo class="source">kdegames</refmiscinfo>
-<refmiscinfo class="title">KDE User's Manual</refmiscinfo>
</refmeta>
<refnamediv>
-<refname>&kappname;</refname>
+<refname><command>kpat</command></refname>
<refpurpose>A highly addictive &kde; card game.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>kpat</command>
-<arg choice="opt" rep="repeat">Qt-option</arg>
-<arg choice="opt" rep="repeat">KDE-option</arg>
+<group choice="opt"><option>-v, --version</option></group>
+<group choice="opt"><option>-h, --help</option></group>
<group choice="opt"><option>--solvegame</option> <replaceable> file</replaceable></group>
<group choice="opt"><option>--solve</option> <replaceable> num</replaceable></group>
<group choice="opt"><option>--start</option> <replaceable> num</replaceable></group>
<group choice="opt"><option>--end</option> <replaceable> num</replaceable></group>
<group choice="opt"><option>--gametype</option> <replaceable> game</replaceable></group>
-
+<group choice="opt"><option>--testdir</option> <replaceable> directory</replaceable></group>
+<group choice="opt"><option>--generate</option></group>
+<group choice="opt"><option>--author</option></group>
+<group choice="opt"><option>--license</option></group>
+<group choice="opt"><option>--desktopfile</option></group>
+<group choice="opt"><option><replaceable>file</replaceable></option></group>
</cmdsynopsis>
</refsynopsisdiv>
@@ -49,328 +58,83 @@ with long options starting with two dashes (`--'). A
summary of the options supported by <command>kpat</command>
is included below.</para>
-<refsect2>
-<title>Generic Options</title>
<variablelist>
<varlistentry>
-<term><option>--author</option></term>
-<listitem>
-<para>Show author information</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><option>--help</option></term>
-<listitem>
-<para>Show help about options</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><option>--help-qt</option></term>
-<listitem>
-<para>Show Qt specific options</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><option>--help-kde</option></term>
-<listitem>
-<para>Show &kde; specific options</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><option>--help-all</option></term>
-<listitem>
-<para>Show all options</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><option>--license</option></term>
-<listitem>
-<para>Show license information</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><option>-v</option>, <option>--version</option></term>
-<listitem>
-<para>Show version information and exit.</para>
-</listitem>
-</varlistentry>
-</variablelist>
-
-</refsect2>
-
-<!-- Cut here: From here to the end of the KDE options will be entities -->
-<refsect2>
-<title>Qt Options</title>
-
-<variablelist>
-<varlistentry>
-<term><option>--display <replaceable>displayname</replaceable></option></term>
-<listitem>
-<para>Use the X-server display <emphasis>displayname</emphasis>.</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><option>--session <replaceable>sessionId</replaceable></option></term>
-<listitem>
-<para>
-Restore the application for the given <replaceable>sessionId</replaceable>.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><option>--cmap</option></term>
-<listitem>
-<para>
-Causes the application to install a private
-color map on an 8-bit display.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><option>--ncols <replaceable>count</replaceable></option></term>
-<listitem>
-<para>
-Limits the number of colors allocated in the
-color cube on a 8-bit display, if the application
-is using the <methodname>QApplication::ManyColor</methodname>
-color specification.
-</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--nograb</option></term>
-<listitem>
-<para>tells Qt to never grab the mouse or the keyboard.</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--dograb</option></term>
-<listitem>
-<para>
-running under a debugger can cause an implicit
-<option>-nograb</option>, use <option>-dograb</option>
-to override.
-</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--sync</option></term>
-<listitem>
-<para>switches to synchronous mode for debugging.</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--fn</option>, <option>--font <replaceable>fontname</replaceable></option></term>
-<listitem>
-<para>defines the application font.</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--bg</option>, <option>--background <replaceable>color</replaceable></option></term>
-<listitem>
-<para>
-sets the default background color and an
-application palette (light and dark shades
-are calculated).
-</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--fg</option>,<option>--foreground <replaceable>color</replaceable></option></term>
-<listitem>
-<para>sets the default foreground color.</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--btn</option>, <option>--button <replaceable>color</replaceable></option></term>
-<listitem>
-<para>sets the default button color.</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--name <replaceable>name</replaceable></option></term>
-<listitem>
-<para>sets the application name.</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--title <replaceable>title</replaceable></option></term>
-<listitem>
-<para>sets the application title (caption).</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--visual <replaceable>TrueColor</replaceable></option></term>
-<listitem>
-<para>
-forces the application to use a TrueColor
-visual on an 8-bit display.
-</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--inputstyle</option></term>
-<listitem>
-<para>
-sets XIM (X Input Method) input style. Possible
-values are onthespot, overthespot, offthespot
-and root.
-</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--im <replaceable>XIM server</replaceable></option></term>
-<listitem>
-<para>set XIM server.</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--noxim</option></term>
-<listitem>
-<para>disable XIM.</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--reverse</option></term>
-<listitem>
-<para>mirrors the whole layout of widgets.</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--stylesheet <replaceable>file.qss</replaceable></option></term>
-<listitem>
-<para>applies the Qt stylesheet to the application widgets.</para>
-</listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--graphicssystem <replaceable>system</replaceable></option></term>
-<listitem>
-<para>use a different graphics system instead of the default one,
-options are <quote>raster</quote> and <quote>opengl</quote> (experimental).</para>
-</listitem>
-</varlistentry>
-</variablelist>
-</refsect2>
-
-<refsect2>
-<title>KDE Options</title>
-<variablelist>
-<varlistentry>
-<term><option>--caption <replaceable>caption</replaceable></option></term>
-<listitem>
-<para>Use <emphasis>caption</emphasis> as name in the titlebar.</para>
+<term><option>-h</option> <option>--help</option></term>
+<listitem><para>This lists the options available at the command line</para>
</listitem>
</varlistentry>
<varlistentry>
-<term><option>--icon <replaceable>icon</replaceable></option></term>
+<term><option>-v</option> <option>--version</option></term>
<listitem>
-<para>Use <emphasis>icon</emphasis> as the application icon.</para>
-</listitem>
+<para>Lists version information for &kpatience;</para></listitem>
</varlistentry>
<varlistentry>
-<term><option>--config <replaceable>filename</replaceable></option></term>
+<term><option>--solvegame</option> <replaceable> file</replaceable></term>
<listitem>
-<para>
-Use alternative configuration file.
-</para>
+<para>Try to find a solution to the given savegame</para>
</listitem>
</varlistentry>
<varlistentry>
-<term><option>--nocrashhandler</option></term>
+<term><option>--solve</option> <replaceable> num</replaceable></term>
<listitem>
-<para>Disable crash handler, to get core dumps.</para>
+<para>Dealer to solve (debug)</para>
</listitem>
</varlistentry>
<varlistentry>
-<term><option>--waitforwm</option></term>
+<term><option>--start</option> <replaceable> num</replaceable></term>
<listitem>
-<para>
-Waits for a WM_NET compatible windowmanager.
-</para>
+<para>Game range start (default 0:INT_MAX)</para>
</listitem>
</varlistentry>
<varlistentry>
-<term><option>--style <replaceable>style</replaceable></option></term>
+<term><option>--end</option> <replaceable> num</replaceable></term>
<listitem>
-<para>sets the application &GUI; style.</para>
+<para>Game range end (default start:start if start given)</para>
</listitem>
</varlistentry>
<varlistentry>
-<term><option>--geometry <replaceable>geometry</replaceable></option></term>
+<term><option>--gametype</option> <replaceable> game</replaceable></term>
<listitem>
-<para>
-sets the client geometry of the main widget - see the manual page
-<ulink url="man:/X">man:/X</ulink> for the argument format (usually WidthxHeight+XPos+YPos).
-</para>
+<para>Skip the selection screen and load a particular game type. Valid values are: acesup, fortyeight, freecell, golf, grandfather, grandfathersclock, gypsy, klondike, mod3, simplesimon, spider, yukon</para>
</listitem>
</varlistentry>
-</variablelist>
-</refsect2>
-
-<!-- Stop cutting here: End of entity text -->
-
-<refsect2>
-<title>Options</title>
-<variablelist>
<varlistentry>
-<term><option>--solvegame</option> <replaceable> file</replaceable></term>
+<term><option>--testdir</option> <replaceable> directory</replaceable></term>
<listitem>
-<para>Try to find a solution to the given savegame</para>
+<para>Directory with test cases</para>
</listitem>
</varlistentry>
<varlistentry>
-<term><option>--solve</option> <replaceable> num</replaceable></term>
-<listitem>
-<para>Dealer to solve (debug)</para>
+<term><option>--generate</option></term>
+<listitem><para>Generate random test cases</para>
</listitem>
</varlistentry>
<varlistentry>
-<term><option>--start</option> <replaceable> num</replaceable></term>
-<listitem>
-<para>Game range start (default 0:INT_MAX)</para>
-</listitem>
+<term><option>--author</option></term>
+<listitem><para>Lists &kpatience;'s authors in the terminal window</para></listitem>
</varlistentry>
<varlistentry>
-<term><option>--end</option> <replaceable> num</replaceable></term>
-<listitem>
-<para>Game range end (default start:start if start given)</para>
-</listitem>
+<term><option>--license</option></term>
+<listitem><para>Shows license information</para></listitem>
</varlistentry>
<varlistentry>
-<term><option>--gametype</option> <replaceable> game</replaceable></term>
-<listitem>
-<para>Skip the selection screen and load a particular game type. Valid values are: acesup, fortyeight, freecell, golf, grandfather, grandfathersclock, gypsy, klondike, mod3, simplesimon, spider, yukon</para>
-</listitem>
+<term><option>--desktopfile</option> <replaceable>file name</replaceable></term>
+<listitem><para>The base file name of the desktop entry for this application.</para></listitem>
</varlistentry>
-</variablelist>
-</refsect2>
-
-<refsect2>
-<title>Arguments</title>
-<variablelist>
-
<varlistentry>
<term><replaceable> file</replaceable></term>
<listitem>
@@ -379,7 +143,6 @@ sets the client geometry of the main widget - see the manual page
</varlistentry>
</variablelist>
-</refsect2>
</refsect1>
diff --git a/doc/playfield.png b/doc/playfield.png
index 88a7b82..72914de 100644
Binary files a/doc/playfield.png and b/doc/playfield.png differ
diff --git a/doc/spades.png b/doc/spades.png
index 41bbfe2..07e1b59 100644
Binary files a/doc/spades.png and b/doc/spades.png differ
More information about the kde-doc-english
mailing list