Skip to content

Commit 4f0a853

Browse files
committed
Update/revise documentation.
1 parent 1ed6c48 commit 4f0a853

File tree

2 files changed

+36
-24
lines changed

2 files changed

+36
-24
lines changed

Readme.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,40 @@ This is a simple web page that provides tools to help solve sudoku puzzles.
33

44
To access the web page, go to http://delta42.github.io/sudoku.
55

6-
Note: This web page does not save any entered values or pencilmarks. Refreshing or navigating away from it will reset the page to its initial state without warning.
6+
Note: This web page does not automatically save any entered values or pencilmarks. Refreshing or navigating away from it will reset the page to its initial state without warning.
77

88
##Features:
99
* Pencil marks
1010
* Cell highlighting based on pencil marks
1111
* Flag duplicate values
1212
* Show solution
13+
* Import sudoku puzzles.
14+
* Save/reload a sudoku puzzle using a cookie.
1315
* Hints
1416
* Mark guesses for quick removal
1517

1618
##Instructions:
17-
1. To begin, __enter some values__. Find a sudoku puzzle and input its values using the number keys to insert values. The arrow keys, TAB, and ENTER can be used for navigation, while DELETE and BACKSPACE remove values. Alternatively enter values using the Paste puzzle link.
18-
2. __Submit the values__ by clicking the begin solving link. This sets the values as read-only and enables several features.
19+
1. To begin, __enter some values__. Find a sudoku puzzle and input its values using the number keys to insert values. The arrow keys, TAB, and ENTER can be used for navigation, while DELETE and BACKSPACE remove values. Alternatively enter values using the tools under the Save/Load sidebar.
20+
2. __Submit the values__ by clicking the begin solving link. This sets the values as read-only and enables the solving tools.
1921
3. __Solve the puzzle__ using pencil marks, cell highlighting, guesses, hints, and if all else fails, show solution.
2022

2123
##Button/link descriptions:
22-
* __Clear cells__: Deletes all values, resets pencil marks, and removes all highlighting. This resets the page to its initial state.
23-
* __Begin solving__: Sets the entered values as read-only and submits them to the puzzle solver. Once the values have been submitted, they cannot be changed. This generates a solution for the values and enables the solving features.
24-
* __Paste puzzle__: Allows values to be inputted from the clipboard. This overwrites existing values. Zeros can be used as placeholders for empty cells. Characters other than 0-9 are ignored. There must be exactly 81 numbers for this to work properly.
25-
* __1-9__: Highlights all cells that do not have a pencil mark of 1-9 a pale green color. If the pencil marks have been updated, this can be used to easily determine which cells do not have a value of 1-9. Does not update automatically.
26-
* __Clear__: Removes all cell highlighting.
27-
* __Enter values__: When this option is selected, typing a number in a cell changes its value.
28-
* __Enter pencil marks__: When this option is selected, typing a number in a cell toggles the corresponding pencil mark.
29-
* __Automatically remove pencil marks__: When this option is enabled, entering a value in a cell removes that pencil mark from all of the cell's neighbors (cells in the same row, box, or column).
30-
* __Update__: Changes all pencil marks so that they show the possible values that each cell could have. This overwrites existing pencil marks.
31-
* __Reset__: Adds all pencil marks to empty cells. Allows solving the puzzle without the aid of pencil marks. This overwrites existing pencil marks.
32-
* __Show duplicates__: When this option is enabled, neighboring cells with the same value are flagged red.
33-
* __Mark blank cells (color)__: Marks all blank cells with a certain color. Use this to make guesses so that if the guess is incorrect, all values entered afterward can be removed easily.
34-
* __Delete cells marked (color)__: Deletes all cells that have been marked a certain color. Does not affect cells marked a different color or pencil marks.
35-
* __Show solution__: When this option is enabled, the puzzle's solution will be shown. Does not affect cell values or pencil marks.
36-
* __Hint__: Gives a hint for cell that was last selected, up to three hints. Hints are based on the solution.
24+
*__Begin solving__: Sets the entered values as read-only clues and submits them to the puzzle solver. Once the values have been submitted, they cannot be changed. This generates a solution for the values and enables the solving features.
25+
*__Save/Load__: Shows a panel with options to save a sudoku puzzle in progress or reload a previously saved puzzle.
26+
*__Save/Load>Input Puzzle__: Allows values to be inputted from the clipboard. This overwrites existing values. Zeros, "*", ".", or "_" can be used as placeholders for empty cells. All other characters are ignored. There must be exactly 81 numbers for this to work properly.
27+
*__Save/Load>Import State__: Paste a text string copied from __export state__ to reload the state of the puzzle when the text string was copied. This overwrites existing values.
28+
*__Save/Load>Save to Cookie__: This saves the values, pencilmarks, and cell number coloring to a cookie. Cookies must be enabled in the browser.
29+
*__Save/Load>Load from Cookie__: If a previously saved cookie exists, this reloads the values, pencilmarks, and cell number coloring stored in the cookie. Overwrites existing values.
30+
*__Clear cells__: Deletes all values, resets pencil marks, and removes all highlighting. This resets the page to its initial state.
31+
*__1-9__: Highlights all cells that do not have a pencil mark of 1-9 a pale green color. If the pencil marks have been updated, this can be used to easily determine which cells do not have a value of 1-9. Does not update automatically.
32+
*__Clear__: Removes all cell highlighting.
33+
*__Enter values__: When this option is selected, typing a number in a cell changes its value.
34+
*__Enter pencil marks__: When this option is selected, typing a number in a cell toggles the corresponding pencil mark.
35+
*__Automatically remove pencil marks__: When this option is enabled, entering a value in a cell removes that pencil mark from all of the cell's neighbors (cells in the same row, box, or column).
36+
*__Update__: Changes all pencil marks so that they show the possible values that each cell could have. This overwrites existing pencil marks.
37+
*__Reset__: Adds all pencil marks to empty cells. Allows solving the puzzle without the aid of pencil marks. This overwrites existing pencil marks.
38+
*__Show duplicates__: When this option is enabled, neighboring cells with the same value are flagged red.
39+
*__Mark blank cells (color)__: Marks all blank cells with a certain color. Use this to make guesses so that if the guess is incorrect, all values entered afterward can be removed easily.
40+
*__Delete cells marked (color)__: Deletes all cells that have been marked a certain color. Does not affect cells marked a different color or pencil marks.
41+
*__Show solution__: This opens the sudoku puzzle's solution in a new window. If there are more than one solution, only one will be displayed.
42+
*__Hint__: Gives a hint for cell that was last selected, up to three hints. Hints are based on the solution.

help.html

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -132,27 +132,33 @@
132132
<h1>sudoku</h1>
133133
<p>This is a simple web page that provides tools to help solve sudoku puzzles.</p>
134134
<p>To access the web page, go to <a href="http://delta42.github.io/sudoku" style="color: rgb(65, 131, 196); text-decoration: none;">http://delta42.github.io/sudoku</a>.</p>
135-
<p>Note: This web page does not save any entered values or pencilmarks. Refreshing or navigating away from it will reset the page to its initial state without warning.</p>
135+
<p>Note: This web page does not automatically save any entered values or pencilmarks. Refreshing or navigating away from it will reset the page to its initial state without warning.</p>
136136
<h2>Features:</h2>
137137
<ul>
138138
<li>Pencil marks</li>
139139
<li>Cell highlighting based on pencil marks</li>
140140
<li>Flag duplicate values</li>
141141
<li>Show solution</li>
142+
<li>Import sudoku puzzles.</li>
143+
<li>Save/reload a sudoku puzzle using a cookie.</li>
142144
<li>Hints</li>
143145
<li>Mark guesses for quick removal</li>
144146
</ul>
145147
<h2>Instructions:</h2>
146148
<ol>
147-
<li>To begin, <strong>enter some values</strong>. Find a sudoku puzzle and input its values using the number keys to insert values. The arrow keys, TAB, and ENTER can be used for navigation, while DELETE and BACKSPACE remove values. Alternatively enter values using the Paste puzzle link..</li>
148-
<li><strong>Submit the values</strong> by clicking the begin solving link. This sets the values as read-only and enables several features.</li>
149+
<li>To begin, <strong>enter some values</strong>. Find a sudoku puzzle and input its values using the number keys to insert values. The arrow keys, TAB, and ENTER can be used for navigation, while DELETE and BACKSPACE remove values. Alternatively enter values using the tools under the Save/Load sidebar.</li>
150+
<li><strong>Submit the values</strong> by clicking the begin solving link. This sets the values as read-only and enables the solving tools.</li>
149151
<li><strong>Solve the puzzle</strong> using pencil marks, cell highlighting, guesses, hints, and if all else fails, show solution.</li>
150152
</ol>
151153
<h2>Button/link descriptions:</h2>
152154
<ul>
155+
<li><strong>Begin solving</strong>: Sets the entered values as read-only clues and submits them to the puzzle solver. Once the values have been submitted, they cannot be changed. This generates a solution for the values and enables the solving features.</li>
156+
<li><strong>Save/Load</strong>: Shows a panel with options to save a sudoku puzzle in progress or reload a previously saved puzzle.</li>
157+
<li><strong>Save/Load>Input Puzzle</strong>: Allows values to be inputted from the clipboard. This overwrites existing values. Zeros, "*", ".", or "_" can be used as placeholders for empty cells. All other characters are ignored. There must be exactly 81 numbers for this to work properly.</li>
158+
<li><strong>Save/Load>Import State</strong>: Paste a text string copied from <strong>export state</strong> to reload the state of the puzzle when the text string was copied. This overwrites existing values.</li>
159+
<li><strong>Save/Load>Save to Cookie</strong>: This saves the values, pencilmarks, and cell number coloring to a cookie. Cookies must be enabled in the browser.</li>
160+
<li><strong>Save/Load>Load from Cookie</strong>: If a previously saved cookie exists, this reloads the values, pencilmarks, and cell number coloring stored in the cookie. Overwrites existing values.</li>
153161
<li><strong>Clear cells</strong>: Deletes all values, resets pencil marks, and removes all highlighting. This resets the page to its initial state.</li>
154-
<li><strong>Begin solving</strong>: Sets the entered values as read-only and submits them to the puzzle solver. Once the values have been submitted, they cannot be changed. This generates a solution for the values and enables the solving features.</li>
155-
<li><strong>Paste puzzle</strong>: Allows values to be inputted from the clipboard. This overwrites existing values. Zeros can be used as placeholders for empty cells. Characters other than 0-9 are ignored. There must be exactly 81 numbers for this to work properly.</li>
156162
<li><strong>1-9</strong>: Highlights all cells that do not have a pencil mark of 1-9 a pale green color. If the pencil marks have been updated, this can be used to easily determine which cells do not have a value of 1-9. Does not update automatically.</li>
157163
<li><strong>Clear</strong>: Removes all cell highlighting.</li>
158164
<li><strong>Enter values</strong>: When this option is selected, typing a number in a cell changes its value.</li>
@@ -163,7 +169,7 @@ <h2>Button/link descriptions:</h2>
163169
<li><strong>Show duplicates</strong>: When this option is enabled, neighboring cells with the same value are flagged red.</li>
164170
<li><strong>Mark blank cells (color)</strong>: Marks all blank cells with a certain color. Use this to make guesses so that if the guess is incorrect, all values entered afterward can be removed easily.</li>
165171
<li><strong>Delete cells marked (color)</strong>: Deletes all cells that have been marked a certain color. Does not affect cells marked a different color or pencil marks.</li>
166-
<li><strong>Show solution</strong>: When this option is enabled, the puzzle's solution will be shown. Does not affect cell values or pencil marks.</li>
172+
<li><strong>Show solution</strong>: This opens the sudoku puzzle's solution in a new window. If there are more than one solution, only one will be displayed.</li>
167173
<li><strong>Hint</strong>: Gives a hint for cell that was last selected, up to three hints. Hints are based on the solution.</li>
168174
</ul>
169175
</body>

0 commit comments

Comments
 (0)