<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
  <!ENTITY legal SYSTEM "legal.xml">
  <!ENTITY appversion "2.10">
  <!ENTITY manrevision "2.8">
  <!ENTITY date "September 2004">
  <!ENTITY app "<application>GNOME Mines</application>">
  <!ENTITY appname "GNOME Mines">
  <!ENTITY version "2.8">
]>

<!-- 
      (Do not remove this comment block.)
  Maintained by the GNOME Documentation Project
  http://developer.gnome.org/projects/gdp
  Template version: 2.0 beta
  Template last modified Feb 12, 2002
-->

<!-- =============Document Header ============================= -->

<article id="index" lang="en">
<!-- please do not change the id; for translations, change lang to -->
<!-- appropriate code -->
  <articleinfo>
    <title>&app; Manual V&manrevision;</title>
    <copyright>
      <year>2001</year>
      <holder>Tim Riehle</holder>
    </copyright>
<!-- translators: uncomment this:

  <copyright>
   <year>2002</year>
   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
  </copyright>

   -->
<!-- An address can be added to the publisher information.  If a role is 
     not specified, the publisher/author is the same for all versions of the 
     document.  -->
    <publisher> 
      <publishername> GNOME Documentation Project </publishername> 
    </publisher> 

   &legal;
   <!-- This file  contains link to license for the documentation (GNU FDL), and 
        other legal stuff such as "NO WARRANTY" statement. Please do not change 
	any of this. -->

    <authorgroup> 
      <author> 
	<firstname>Tim</firstname> 
	<surname>Riehle</surname> 
	<affiliation> 
	  <address> <email>tkriehle@citilink.com</email> </address> 
	</affiliation> 
      </author> 
<!-- This is appropriate place for other contributors: translators,
      maintainers,  etc. Commented out by default.
       <othercredit role="translator">
	<firstname>Latin</firstname> 
	<surname>Translator 1</surname> 
	<affiliation> 
	  <orgname>Latin Translation Team</orgname> 
	  <address> <email>translator@gnome.org</email> </address> 
	</affiliation>
	<contrib>Latin translation</contrib>
      </othercredit>
-->
    </authorgroup>
    <revhistory>
      <revision> 
	<revnumber>&appname; Manual V&manrevision;</revnumber> 
	<date>&date;</date> 
	<revdescription> 
	  <para role="author">Tim Riehle
	    <email>tkriehle@citilink.com</email>
	  </para>
	  <para role="publisher">GNOME Documentation Project</para>
	</revdescription> 
      </revision> 
    </revhistory> 

    <releaseinfo>This manual describes version &appversion; of &appname;.
    </releaseinfo>
    <!-- The following feedback information only applies to appliactions
    listed in bugzilla.gnome.org and bugzilla.ximian.com. For other
    applications, please provide your own feedback info or remove thsi
    section altogether -->
    <legalnotice> 
      <title>Feedback</title> 
      <para>To report a bug or make a suggestion regarding the &app; application or
	this manual, follow the directions in the 
	<ulink url="ghelp:gnome-feedback"
	  type="help">GNOME Feedback Page</ulink>. 
      </para>
<!-- Translators may also add here feedback address for translations -->
    </legalnotice>
  </articleinfo>

  <indexterm zone="index"> 
    <primary>GNOME Mines</primary> 
  </indexterm>
  
 <!-- ============= Document Body ============================= -->

 <!-- ============= Introduction ============================== -->
  <sect1 id="intro">
    <title>Introduction</title>

    <para>
     <application>GNOME Mines</application> is a variation of the
     popular logic puzzle minesweeper.
    </para>
    <para>
      <application>GNOME Mines</application> is included in the
      <filename>gnome-games</filename> package, which is part of the
      GNOME desktop environment. This document describes version
      &version; of <application>GNOME Mines</application>.
    </para>
  </sect1>


 <!-- ================ Objective ============================== -->

  <sect1 id="objective">
    <title>Objective</title>

    <para>
      The object of <application>GNOME Mines</application> is for the
      player to flag all mines hidden on the playing grid and to uncover
      all the remaining squares.  If the player mistakenly uncovers
      a square containing a mine the game is lost.  Winning games are
      ranked by how quickly the game was completed.
    </para>
  </sect1>

 <!-- ================ Usage ================================ -->

  <sect1 id="usage">
    <title>Usage</title>

    <para>
     This section describes how to use this application.
    </para>

    <!-- ========= Basic Usage =========================== -->
    <sect2 id="basic-usage">
      <title>Basic usage</title>
      <para>
<!-- Add info on starting the app from the command line -->
        Starting <application>GNOME Mines</application> opens the
        <interface>Main window</interface>, shown in <xref
        linkend="fresh-mainwindow-fig"/>.

        <!-- ==== Figure ==== -->
        <figure id="fresh-mainwindow-fig">
	  <title>GNOME Mines Main Window</title>
	  <screenshot>
	     <mediaobject> 
    <imageobject>
  <imagedata fileref="figures/gnomine-fresh.png" format="PNG" srccredit="Tim Riehle"/>
	     </imageobject>
    <textobject> 
      <phrase>GNOME Mines Main Window.</phrase> 
    </textobject> 
  </mediaobject>
	  </screenshot>
	</figure>
        <!-- ==== End of Figure ==== -->
      </para>

      <para>
        The bottom of the window shows a game timer on the right and a
        counter on the left showing how many flags have been placed and
        how many mines exist.
      </para>
      <para>
        Play proceeds by uncovering squares with the left mouse button and
        placing flags with the right mouse button. Successfully uncovered
        squares yield information: the number of mines in the adjacent
        squares. <xref linkend="begin-play-fig"/> shows a game
        in play. Note the numbers in the cleared squares and their relation
        to flags.
      </para>
   <para>
        <!-- ==== Figure ==== -->
        <figure id="begin-play-fig">
	  <title>GNOME Mines In Play</title>
	  <screenshot>
	     <mediaobject> 
    <imageobject>
  <imagedata fileref="figures/gnomine-begin-play.png"
                     format="PNG" srccredit="Tim Riehle"/>
    </imageobject>
    <textobject> 
      <phrase>GNOME Mines In Play.</phrase> 
    </textobject> 
  </mediaobject>
	  </screenshot>
	</figure>
        <!-- ==== End of Figure ==== -->

        Using the information gathered from the uncovered squares the
        player forms hypotheses about the location of undiscovered mines.
      </para>
      <para>
        As flags are added the middle mouse button may be used on the
        previously uncovered squares. If the number of flags adjacent
        to that square satisfies the number expected 
        the middle mouse button will automatically uncover all remaining
        adjacent squares. If a flag has been placed by mistake this action
        will uncover a mine and end play. <xref linkend="fail-fig"/>
        shows the result of just such a mistake, note the flag in the
        top row.

        <!-- ==== Figure ==== -->
        <figure id="fail-fig">
	  <title>GNOME Mines Showing A Failed Game</title>
	  <screenshot>
	     <mediaobject> 
    <imageobject>
  <imagedata fileref="figures/gnomine-fail.png"
                     format="PNG" srccredit="Tim Riehle"/>
           </imageobject>
    <textobject> 
      <phrase>GNOME Mines Showing A Failed Game.</phrase> 
    </textobject> 
  </mediaobject>
	  </screenshot>
	</figure>
        <!-- ==== End of Figure ==== -->
      </para>

      <para>
        If flags have been correctly placed on all the mines, and the
        remaining squares have been uncovered the game is won, as shown
        in <xref linkend="won-fig"/>.

        <!-- ==== Figure ==== -->
        <figure id="won-fig">
	  <title>GNOME Mines Showing A Won Game</title>
	  <screenshot>
            <mediaobject> 
              <imageobject>
                <imagedata fileref="figures/gnomine-won.png"
                           format="PNG" srccredit="Tim Riehle"/>
              </imageobject>
    <textobject> 
      <phrase>GNOME Mines Showing A Won Game.</phrase> 
    </textobject> 
  </mediaobject>
	  </screenshot>
	</figure>
        <!-- ==== End of Figure ==== -->
      </para>
      <para>
      When the focus moves away from the <application>GNOME
      Mines</application> window the game is paused and the playing
      area hidden.
      </para>
    </sect2>
  
    <!-- ================ Basic Strategy======================== -->

    <sect2 id="basic-strategy">
      <title>Basic Strategy</title>

      <para>
        The geometrical arrangement of uncovered and flagged squares
        often limits the possible locations that can contain hidden
        mines. <xref linkend="basic-corner"/> shows how the location
        of a mine, pointed to by the arrow, has been inferred using the
        square on the outside corner showing the numeral one. The geometry
        of the corner has left only one uncovered square next to the one.
        <!-- ==== Figure ==== -->
        <figure id="basic-corner">
	  <title>Inferring the location of a mine at a corner</title>
	  <screenshot>
	     <mediaobject> 
    <imageobject>
  <imagedata fileref="figures/basic-corner.png"
                     format="PNG" srccredit="Tim Riehle"/>
            </imageobject>
    <textobject> 
      <phrase>Inferring the location of a mine at a corner.</phrase> 
    </textobject> 
  </mediaobject>
	  </screenshot>
	</figure>
        <!-- ==== End of Figure ==== -->
      </para>

      <para>
        The same strategy has been used in <xref
        linkend="basic-wall"/> where the square showing the number three
        has only three remaining uncovered squares that can hold mines.
        to
        <!-- ==== Figure ==== -->
        <figure id="basic-wall">
	  <title>Inferring the location of mines next along a wall</title>
	  <screenshot>
	     <mediaobject> 
    <imageobject>
  <imagedata fileref="figures/basic-wall.png"
                     format="PNG" srccredit="Tim Riehle"/>
           </imageobject>
    <textobject> 
      <phrase>Inferring the location of mines next along a wall.</phrase> 
    </textobject> 
  </mediaobject>
	  </screenshot>
	</figure>
        <!-- ==== End of Figure ==== -->
      </para>

      <para>
         In the previous cases we found the location of mines using the
         information from a single uncovered square. More advanced play
         comes from combining information from two or more uncovered
         squares. Consider the arrangement of squares in <xref
         linkend="advanced-1"/>.
        <!-- ==== Figure ==== -->
        <figure id="advanced-1">
	  <title>Inferring the location of mines using information from several squares</title>
	  <screenshot>
	     <mediaobject> 
    <imageobject>
  <imagedata fileref="figures/advanced_121_a.png"
                     format="PNG" srccredit="Tim Riehle"/>
           </imageobject>
    <textobject> 
      <phrase>Inferring the location of mines using information from several squares.</phrase> 
    </textobject> 
  </mediaobject>
	  </screenshot>
	</figure>
        <!-- ==== End of Figure ==== -->
      </para>

      <para>
         If we focus on the leftmost square showing "1" we know that only
         a single flag can be contained in the three uncovered squares
         highlighted in green in <xref linkend="advanced-2"/>,
         thus we can infer where the second flag for the square showing
         "2" must be placed.
        <!-- ==== Figure ==== -->
        <figure id="advanced-2">
	  <title>finding the first mine by using the leftmost square showing "1"</title>
	  <screenshot>
	     <mediaobject> 
    <imageobject>
  <imagedata fileref="figures/advanced_121_b.png"
                     format="PNG" srccredit="Tim Riehle"/>
           </imageobject>
    <textobject> 
      <phrase>finding the first mine by using the leftmost square showing "1".</phrase> 
    </textobject> 
  </mediaobject>
	  </screenshot>
	</figure>
        <!-- ==== End of Figure ==== -->
      </para>

      <para>
        We can now repeat the same process with the rightmost square showing "1" to place
        the second flag, see <xref linkend="advanced-3"/>.
        <!-- ==== Figure ==== -->
        <figure id="advanced-3">
	  <title>finding the second mine by using the rightmost square showing "1"</title>
	  <screenshot>
	     <mediaobject> 
    <imageobject>
  <imagedata fileref="figures/advanced_121_c.png"
                     format="PNG" srccredit="Tim Riehle"/>
           </imageobject>
    <textobject> 
      <phrase>finding the second mine by using the rightmost square showing "1".</phrase> 
    </textobject> 
  </mediaobject>
	  </screenshot>
	</figure>
        <!-- ==== End of Figure ==== -->
      </para>

       </sect2>

    </sect1>

    <!-- ========= Menus =========================== --> 
    <sect1 id="menubar">
      <title>Menus</title>
      <para>
	The menu bar, located at the top of the <interface>Main
	Window</interface>, contains the following menus:
       </para>
      <variablelist>
	<varlistentry>
	  <term><guimenu>Game</guimenu></term>
	  <listitem>
	    <para>
	       This menu contains:
	       <itemizedlist>
		<listitem>
		  <para>
	            <menuchoice>
		      <shortcut>
			<keycombo><keycap>Ctrl</keycap><keycap>N</keycap></keycombo>
		      </shortcut>
		      <guimenuitem>New game</guimenuitem>
		     </menuchoice>
	             &mdash; Start a new game of
                             <application>GNOME Mines</application>.
	           </para>
		</listitem>
		<listitem>
		  <para>
	            <menuchoice>
		      <guimenuitem>Hint</guimenuitem>
		     </menuchoice>
	             &mdash; Uncovers one safe square, but adds ten
	             seconds to your time.
	           </para>
		</listitem>
		<listitem>
		  <para>
	             <menuchoice>
		      <guimenuitem>Scores...</guimenuitem>
		    </menuchoice>
	            &mdash; Display the local
                            <application>GNOME Mines</application>
                            score statistics.
	          </para>
		</listitem>
		<listitem>
		  <para>
	            <menuchoice>
		      <shortcut>
			<keycombo><keycap>Ctrl</keycap><keycap>Q</keycap></keycombo>
		      </shortcut>
		      <guimenuitem>Exit</guimenuitem>
		    </menuchoice>
	            &mdash; Quit; exit from
                            <application>GNOME Mines</application>.
	          </para>
		</listitem>
	      </itemizedlist>
	  </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><guimenu>Settings</guimenu></term>
	  <listitem>
	    <para>
	       This menu contains:
	       <itemizedlist>
		<listitem>
		  <para>
	            <menuchoice>
		      <guimenuitem>Preferences...</guimenuitem>
		     </menuchoice>
	             &mdash; Bring up the <application>GNOME Mines</application>
                             <interface>Preferences</interface> dialog,
                             as shown in <xref linkend="gnomine-preferences-fig"/>
                             This allows you to choose the size of the
                             playing grid and the number of mines. You
                             can either use one of the pre-defined
                             sizes on the left or create your own by
                             selecting
                             <guimenuitem>custom</guimenuitem> and
                             selecting the value you want on the
                             right.
                             <para>
                             Also there is an option to use an extra
                             "I'm not sure" flag with a question mark
                             for squares you aren't sure about. These
                             are there for your convenience and are
                             treated as unflagged squares by the
                             game. To mark a square in this way right
                             click on a square already marked with a
                             flag (i.e. right click twice). Clicking
                             it again will clear it.
                             </para>
                             <para>
                             All preferences are applied and saved the
                             moment you change them. If you change the
                             size of the grid, a new game is started.
                             </para>

                       <!-- ==== Figure ==== -->
                       <figure id="gnomine-preferences-fig">
	                 <title>GNOME Mines Preferences Dialog</title>
	                 <screenshot>
	                    <mediaobject> 
    <imageobject>
  <imagedata fileref="figures/gnomine-preferences.png"
                                    format="PNG" srccredit="Tim Riehle"/>
                          </imageobject>
    <textobject> 
      <phrase>GNOME Mines Preferences Dialog.</phrase> 
    </textobject> 
  </mediaobject>
	                 </screenshot>
	               </figure>
                       <!-- ==== End of Figure ==== -->
	           </para>
		</listitem>
	      </itemizedlist>
	  </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><guimenu>Help</guimenu></term>
	  <listitem>
	    <para>
	       This menu contains:
	       <itemizedlist>
		<listitem>
		  <para>
	            <menuchoice>
		      <guimenuitem>Contents</guimenuitem>
		     </menuchoice>
	             &mdash; Bring up this help.
	           </para>
		</listitem>
		<listitem>
		  <para>
	            <menuchoice>
		      <guimenuitem>About...</guimenuitem>
		     </menuchoice>
<!--	             &mdash; Display version, copyright, and authorship
                             information, and a brief explanation of what
                             GNOME Mines is. -->
	             &mdash; Bring up the <application>GNOME Mines</application>
                             <interface>About</interface> window.
                             If you need to know what version of GNOME Mines
                             you are running, who wrote it and who owns the
                             copyright, or you just want it summed up
                             in a pithy sentence then this menu item
                             is for you.  No rambling; no beating about the
                             bush. The <interface>About</interface> window
                             tells it like it is. In fact there is
                             more words in this description than
                             in the entire about box !
	           </para>
		</listitem>
	      </itemizedlist>
	  </para>
	  </listitem>
	</varlistentry>
      </variablelist>
    </sect1>

 <!-- ============= Bugs ================================== -->

 <sect1 id="bugs">
  <title>Known Bugs and Limitations</title>
  <para>
   This application has no known bugs.
  </para>
 </sect1>


<!-- ============= Authors ================================ -->

 <sect1 id="authors">
  <title>Authors</title>
  <para>
   <application>GNOME Mines</application> was written by Pista
   (<email>szekeres@cyberspace.mht.bme.hu</email>). Please send all comments,
   suggestions, and bug reports to the
   <ulink url="http://bugzilla.gnome.org" type="http">GNOME bug
   tracking database</ulink>. You can also use <application>Bug Report
   Tool</application> (<command>bug-buddy</command>), available in the
   <guisubmenu>Utilities</guisubmenu> submenu of
   <guimenu>Main Menu</guimenu>, for submitting bug reports.
  </para>
  <para>
   This manual was written by Tim Riehle
   (<email>tkriehle@citilink.com</email>). Please send all comments and
   suggestions regarding this manual to the <ulink type="http"
   url="http://developer.gnome.org/projects/gdp">GNOME Documentation
   Project</ulink> by sending an email to
   <email>docs@gnome.org</email>. You can also add your comments
   online by using the <ulink type="http"
   url="http://developer.gnome.org/projects/gdp/doctable/">GNOME
   Documentation Status Table</ulink>.
  </para>
 </sect1>


 <!-- ============= Application License ============================= -->

 <sect1 id="license">
  <title>License</title>
  <para>
   This program is free software; you can redistribute it and/or
   modify it under the terms of the  <ulink type="help" url="gnome-help:gpl">
    <citetitle>GNU General Public License</citetitle></ulink> as
   published by the Free Software Foundation; 
   either version 2 of the License, or (at your option) any later
   version.
  </para>
  <para>
   This program is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   <citetitle>GNU General Public License</citetitle> for more details.
  </para>
  <para>
   A copy of the <citetitle>GNU General Public License</citetitle> is
   included as an appendix to the <citetitle>GNOME Users
   Guide</citetitle>.  You may also obtain a copy of the
   <citetitle>GNU General Public License</citetitle> from the Free
   Software Foundation by visiting <ulink type="http"
   url="http://www.fsf.org">their Web site</ulink> or by writing to
   <address>
    Free Software Foundation, Inc.
    <street>59 Temple Place</street> - Suite 330
    <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
    <country>USA</country>
   </address>
  </para>
 </sect1>
</article>
