From f4210f67d558fa5cee06dff20434b7fbb48db5e5 Mon Sep 17 00:00:00 2001
From: Joe R <joeraz5@verizon.net>
Date: Tue, 3 Jan 2023 19:41:49 -0500
Subject: [PATCH] Added documentation page for assist options.

---
 html-src/assist_options.html | 56 ++++++++++++++++++++++++++++++++++++
 html-src/gen-html.py         |  1 +
 html-src/index.html          |  1 +
 3 files changed, 58 insertions(+)
 create mode 100644 html-src/assist_options.html

diff --git a/html-src/assist_options.html b/html-src/assist_options.html
new file mode 100644
index 00000000..5232ee8b
--- /dev/null
+++ b/html-src/assist_options.html
@@ -0,0 +1,56 @@
+<h1>Assist Options</h1>
+<p>
+PySolFC contains a number of assist options to make winning games easier.
+Note that if you manage to win a game without using assist options, the game
+will be credited as a perfect game in the statistics (though there are a few
+assist options that can be used freely without penalties, as seen below).
+Though some games have additional requirements to be credited as a perfect
+game.
+<p>
+Below are the assist options PySol offers:
+
+<h2>Undo/Redo</h2>
+<p>
+PySol allows you to undo/redo an infinite number of moves per game.  If you undo
+all moves, the game will not score in the statistics.
+
+<h2>Bookmarks</h2>
+<p>
+During each game, you can set up to nine bookmarks.  After setting each bookmark,
+you can return to each of them, restoring the game to the state it was in when the
+bookmark was set.  Bookmarks are saved for each game, and reset when you start a
+new game.
+
+<h2>Shuffle Tiles</h2>
+<p>
+In Mahjongg games, you can use the shuffle tiles option to reshuffle all of the
+remaining tiles and redeal the remaining parts of the layout.
+
+<h2>Hint</h2>
+<p>
+Hint points out a recommended move that you can make (or at least one possible
+valid move - the intelligence of the hints can vary from game to game).
+<p>
+If you use a hint, the game will be marked as a loss if completed.  However,
+if you enable the "Free Hints" option, the game will be marked as a win, just not
+a perfect game.
+
+<h2>Auto Drop</h2>
+<p>
+Auto drop will automatically move all cards that can be moved to foundations
+to the foundations.  It can also be enabled in the options menu to auto drop
+all the time without needing to select the option.
+<p>
+Auto drop is disabled for certain games where it is not relevant, or if it
+would make winning the game too much of a cheat.  Using auto drop does not
+disqualify you from getting a perfect game.
+
+<h2>Highlight Piles</h2>
+<p>
+Highlight piles highlights any sequences of cards in the tableau that can be
+moved as a unit.  Using this does not disqualify you from getting a perfect game.
+
+<h2>Find Card</h2>
+<p>
+The find card feature will locate and highlight any face-up instances of the chosen
+card.  Using this does not disqualify you from getting a perfect game.
diff --git a/html-src/gen-html.py b/html-src/gen-html.py
index c5745ee0..00895b71 100755
--- a/html-src/gen-html.py
+++ b/html-src/gen-html.py
@@ -61,6 +61,7 @@ files = [
     ('report_bug.html', 'PySol - Report a Bug'),
     # ('rules_alternate.html', 'PySol - a Solitaire Game Collection'),
     # ('rules.html', 'PySol - a Solitaire Game Collection'),
+    ('assist_options.html', 'PySol - Assist Options'),
     ('solitaire_wizard.html', 'PySol - Solitaire Wizard'),
     ]
 
diff --git a/html-src/index.html b/html-src/index.html
index 7e80bb1d..2dd9c9f8 100644
--- a/html-src/index.html
+++ b/html-src/index.html
@@ -13,6 +13,7 @@
 </ul>
 <h2>Features</h2>
 <ul>
+<li> <a href="assist_options.html">Assist Options</a>
 <li> <a href="solitaire_wizard.html">Solitaire Wizard</a>
 </ul>
 <h2>Misc</h2>