Git commit 913a32a03b7d447c20cfb70844dc63a4c73fd452 by Burkhard L?ck. Committed on 07/05/2013 at 06:45. Pushed by lueck into branch 'master'.
replace part of menu chapter with link to fundamentals, change shortcuts from variablelist to table, rm unused screenshot M +39 -219 doc/index.docbook D +- -- doc/shortcuts.png http://commits.kde.org/kmahjongg/913a32a03b7d447c20cfb70844dc63a4c73fd452 diff --git a/doc/index.docbook b/doc/index.docbook index d4e05e6..d9b384c 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -30,8 +30,8 @@ <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>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.--> <!--Short description of this document. Do not change unless necessary!--> <abstract> @@ -209,8 +209,9 @@ <chapter id="interface"><title>Interface Overview</title> <!-- do not change this! --> <!-- This section has to do with menubar. Describe every single entry in order. Use <variablelist> and <varlistentry>. Split the chapter into sections using <sect1(2,3)> for better viewing.--> - <sect1 id="game-menu"> - <title>The <guimenu>Game</guimenu> Menu</title> +<sect1 id="menu"> +<title>Menu Items</title> + <variablelist> <varlistentry id="game-menu-new"> <term><menuchoice> @@ -301,11 +302,7 @@ </menuchoice></term> <listitem><para><action>Quits</action> &kappname;.</para></listitem> </varlistentry> - </variablelist> -</sect1> -<sect1 id="move-menu"> - <title>The <guimenu>Move</guimenu> Menu</title> - <variablelist> + <varlistentry id="move-menu-undo"> <term><menuchoice> <shortcut><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></shortcut> @@ -345,11 +342,7 @@ </menuchoice></term> <listitem><para><action>Shuffles the tiles</action> on the board.</para></listitem> </varlistentry> - </variablelist> -</sect1> -<sect1 id="view-menu"> - <title>The <guimenu>View</guimenu> Menu</title> - <variablelist> + <varlistentry id="view-menu-rotate-c"> <term><menuchoice> <shortcut><keycap>G</keycap></shortcut> @@ -367,57 +360,13 @@ <listitem><para><action>Rotates</action> the tile viewing angle counter clockwise.</para></listitem> </varlistentry> </variablelist> -</sect1> -<sect1 id="settings-menu"> - <title>The <guimenu>Settings</guimenu> Menu</title> - <variablelist> - <varlistentry> - <term><menuchoice> - <guimenu>Settings</guimenu> - <guimenuitem>Show Toolbar</guimenuitem> - </menuchoice></term> - <listitem><para>Shows or hides the Toolbar.</para></listitem> - </varlistentry> - <varlistentry id="settings-menu-statusbar"> - <term><menuchoice> - <guimenu>Settings</guimenu> - <guimenuitem>Show Statusbar</guimenuitem> - </menuchoice></term> - <listitem><para>Shows or hides the Statusbar.</para></listitem> - </varlistentry> - <!--varlistentry id="settings-menu-hide-matching"> - <term><menuchoice> - <guimenu>Settings</guimenu> - <guimenuitem>Show/Hide Matching Tiles</guimenuitem> - </menuchoice></term> - <listitem><para>Shows or hides matching tiles by not flashing the matching free tiles when a corresponding tile is selected.</para></listitem> - </varlistentry--> - <varlistentry id="settings-menu-shortcuts"> - <term><menuchoice> - <guimenu>Settings</guimenu> - <guimenuitem>Configure Shortcuts...</guimenuitem> - </menuchoice></term> - <listitem><para><action>Displays a standard &kde; shortcut configuration dialog</action> to change the <link linkend="default-keybindings">keyboard shortcuts</link> for &kappname;.</para></listitem> - </varlistentry> - <varlistentry id="settings-menu-toolbar"> - <term><menuchoice> - <guimenu>Settings</guimenu> - <guimenuitem>Configure Toolbars...</guimenuitem> - </menuchoice></term> - <listitem><para>Displays a standard &kde; dialog where you can configure the toolbar icons.</para></listitem> - </varlistentry> - <varlistentry id="settings-menu-settings"> - <term><menuchoice> - <guimenu>Settings</guimenu> - <guimenuitem>Configure &kappname;...</guimenuitem> - </menuchoice></term> - <listitem><para><action>Opens a dialog to configure &kappname;.</action> For details, see <link linkend="configuration">here</link>.</para></listitem> - </varlistentry> - </variablelist> -</sect1> - <sect1 id="help"><!--This is a standard Help menubar entry. Only change if needed.--> -<title>The <guimenu>Help</guimenu> Menu</title> -&help.menu.documentation; +<para> +Additionally &kappname; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu> +menu items, for more information read the sections about the <ulink url="help:/fundamentals/ui.html#menus-settings" +>Settings Menu</ulink> and <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink> +of the &kde; Fundamentals. +</para> + </sect1> </chapter> @@ -428,7 +377,7 @@ <!--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>Yes. To change the way &kappname; looks use the <link linkend="settings-menu-settings">menubar</link> to open the <link linkend="configuration">configuration utility</link>.</para></answer> + <answer><para>Yes. To change the way &kappname; looks use the <link linkend="menu">menubar</link> to open the <link linkend="configuration">configuration utility</link>.</para></answer> </qandaentry> <qandaentry> <question><para>Can I use the keyboard to play the game?</para></question> @@ -545,163 +494,34 @@ <para><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice> allows you to change the default keyboard bindings.</para> -<screenshot> -<screeninfo>Keybindings Configure Dialog</screeninfo> - <mediaobject> - - <imageobject> - <imagedata fileref="shortcuts.png" format="PNG"/> - </imageobject> - <textobject> - <phrase>Keybindings Configure Dialog</phrase> - </textobject> - </mediaobject> -</screenshot> - <para> The default kebindings are as follows: </para> -<para> -<variablelist> - -<varlistentry> -<term><keycap>D</keycap></term> -<listitem> -<para> -Plays the game in Demo mode. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term><keycap>H</keycap></term> -<listitem> -<para> -Gives you a hint by flashing two matching tiles. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term><keycap>F1</keycap></term> -<listitem> -<para> -Displays this handbook. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></term> -<listitem> -<para> -Loads a previously saved game. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></term> -<listitem> -<para> -Starts a new game. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term><keycap>P</keycap></term> -<listitem> -<para> -Pauses or resumes a game. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></term> -<listitem> -<para> -Quits the game. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></term> -<listitem> -<para> -Move redo. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term><keycap>F5</keycap></term> -<listitem> -<para> -Restart the game. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></term> -<listitem> -<para> -Saves the game. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></term> -<listitem> -<para> -Show the highscores. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></term> -<listitem> -<para> -Move undo. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term><keycap>F</keycap></term> -<listitem> -<para> -Rotate the view angle clockwise. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term><keycap>G</keycap></term> -<listitem> -<para> -Rotate the view angle counter-clockwise. -</para> -</listitem> -</varlistentry> - -<varlistentry> -<term><keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo></term> -<listitem> -<para> -What's this? Help -</para> -</listitem> -</varlistentry> - -</variablelist> -</para> +<table> +<title>Keyboard Shortcuts</title> +<tgroup cols="2"> +<thead><row><entry>Key Combo</entry><entry>Action</entry></row></thead> +<tbody> +<row><entry><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></entry><entry>Starts a new game</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></entry><entry>Loads a previously saved game</entry></row> +<row><entry><keycap>F5</keycap></entry><entry>Restart the game</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></entry><entry>Saves the game</entry></row> +<row><entry><keycap>P</keycap></entry><entry>Pauses or resumes a game</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></entry><entry>Show the highscores</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></entry><entry>Quits the game</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></entry><entry>Move undo</entry></row> +<row><entry><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></entry><entry>Move redo</entry></row> +<row><entry><keycap>H</keycap></entry><entry>Gives you a hint by flashing two matching tiles</entry></row> +<row><entry><keycap>D</keycap></entry><entry>Plays the game in Demo mode</entry></row> +<row><entry><keycap>G</keycap></entry><entry>Rotate the view angle clockwise</entry></row> +<row><entry><keycap>F</keycap></entry><entry>Rotate the view angle counter-clockwise</entry></row> +<row><entry><keycap>F1</keycap></entry><entry>Displays this handbook</entry></row> +<row><entry><keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo></entry><entry>What's This Help</entry></row> + +</tbody> +</tgroup> +</table> </sect1> </chapter> diff --git a/doc/shortcuts.png b/doc/shortcuts.png deleted file mode 100644 index 1e89198..0000000 Binary files a/doc/shortcuts.png and /dev/null differ
