Sync docs after enumeration & accessibility note

This commit is contained in:
Bill Kendrick 2023-07-09 11:42:10 -07:00
parent 153671b7c4
commit b63b070325
13 changed files with 1668 additions and 1433 deletions

View file

@ -118,20 +118,20 @@
<tr>
<td>
<ul>
<li><a href="#about">About Tux Paint</a></li> <li><a href="#using">Using Tux Paint</a> <ul>
<li><a href="#using_loading">Launching Tux Paint</a></li> <li><a href="#using_title">Title Screen</a></li> <li><a href="#using_main">Main Screen</a></li> <li><a href="#using_tools">Available Tools</a> <ul>
<li><a href="#using_tools_drawing">Drawing Tools</a> <ul>
<li><a href="#using_tools_drawing_paint">"Paint" Tool (Brush)</a></li> <li><a href="#using_tools_drawing_stamp">"Stamp" Tool (Rubber Stamps)</a></li> <li><a href="#using_tools_drawing_lines">"Lines" Tool</a></li> <li><a href="#using_tools_drawing_shapes">"Shapes" Tool</a></li> <li><a href="#using_tools_drawing_text_and_label">"Text" and "Label" Tools</a></li> <li><a href="#using_tools_drawing_fill">"Fill" Tool</a></li> <li><a href="#using_tools_drawing_magic">"Magic" Tool (Special Effects)</a></li> <li><a href="#using_tools_drawing_eraser">"Eraser" Tool</a></li> </ul>
<ol type="I">
<li><a href="#about">About Tux Paint</a></li> <li><a href="#using">Using Tux Paint</a> <ol type="A">
<li><a href="#using_loading">Launching Tux Paint</a></li> <li><a href="#using_title">Title Screen</a></li> <li><a href="#using_main">Main Screen</a></li> <li><a href="#using_tools">Available Tools</a> <ol type="1">
<li><a href="#using_tools_drawing">Drawing Tools</a> <ol type="a">
<li><a href="#using_tools_drawing_paint">"Paint" Tool (Brush)</a></li> <li><a href="#using_tools_drawing_stamp">"Stamp" Tool (Rubber Stamps)</a></li> <li><a href="#using_tools_drawing_lines">"Lines" Tool</a></li> <li><a href="#using_tools_drawing_shapes">"Shapes" Tool</a></li> <li><a href="#using_tools_drawing_text_and_label">"Text" and "Label" Tools</a></li> <li><a href="#using_tools_drawing_fill">"Fill" Tool</a></li> <li><a href="#using_tools_drawing_magic">"Magic" Tool (Special Effects)</a></li> <li><a href="#using_tools_drawing_eraser">"Eraser" Tool</a></li> </ol>
</li>
<li><a href="#using_tools_other">Other Controls</a> <ul>
<li><a href="#using_tools_other_undo_and_redo">"Undo" and "Redo" Commands</a></li> <li><a href="#using_tools_other_new">"New" Command</a></li> <li><a href="#using_tools_other_open">"Open" Command</a></li> <li><a href="#using_tools_other_save">"Save" Command</a></li> <li><a href="#using_tools_other_print">"Print" Command</a></li> <li><a href="#using_tools_other_open_slides">"Slides" Command (under "Open")</a></li> <li><a href="#using_tools_other_quit">"Quit" Command</a></li> <li><a href="#using_tools_other_sound_muting">Sound Muting</a></li> </ul>
<li><a href="#using_tools_other">Other Controls</a> <ol type="a">
<li><a href="#using_tools_other_undo_and_redo">"Undo" and "Redo" Commands</a></li> <li><a href="#using_tools_other_new">"New" Command</a></li> <li><a href="#using_tools_other_open">"Open" Command</a></li> <li><a href="#using_tools_other_save">"Save" Command</a></li> <li><a href="#using_tools_other_print">"Print" Command</a></li> <li><a href="#using_tools_other_open_slides">"Slides" Command (under "Open")</a></li> <li><a href="#using_tools_other_quit">"Quit" Command</a></li> <li><a href="#using_tools_other_sound_muting">Sound Muting</a></li> </ol>
</li>
</ul>
</ol>
</li>
</ul>
</ol>
</li>
<li><a href="#loading_into">Loading Other Pictures into Tux Paint</a></li> <li><a href="#further">Further Reading</a></li> <li><a href="#help">How to Get Help</a></li> <li><a href="#participate">How to Participate</a></li> </ul>
<li><a href="#loading_into">Loading Other Pictures into Tux Paint</a></li> <li><a href="#further">Further Reading</a></li> <li><a href="#help">How to Get Help</a></li> <li><a href="#participate">How to Participate</a></li> </ol>
</td>
</tr>
</table>
@ -141,13 +141,13 @@
<section class="outer">
<header>
<h1 id="about">
About Tux Paint </h1>
I. About Tux Paint </h1>
</header>
<section class="indent">
<header>
<h2>
What Is "Tux Paint"? </h2>
A. What Is "Tux Paint"? </h2>
<header>
<p>
@ -157,7 +157,7 @@
<section class="indent">
<header>
<h2>
Objectives </h2>
B. Objectives </h2>
</header>
<dl>
@ -196,13 +196,22 @@
<dd>
There is no direct access to the computer's underlying intricacies. The current image is kept when the program quits, and reappears when it is restarted. Saving images requires no need to create filenames or use the keyboard. Opening an image is done by selecting it from a collection of thumbnails. Access to other files on the computer is restricted. </dd>
</div>
<div class="keeptogether">
<dt>
<strong>Accessibility</strong>
</dt>
<dd>
Tux Paint offers a number of accessibility options, including increasing the size of control buttons, changing the UI font, options to control the cursor (mouse pointer) using the keyboard or other input devices (joystick, gamepad, etc.), an on-screen keyboard, and "stick" mouse clicks. </dd>
</div>
</dl>
</section>
<section class="indent">
<header>
<h2>
License </h2>
C. License </h2>
</header>
<p>
@ -215,7 +224,7 @@
<section class="indent">
<header>
<h2>
What's New in Tux Paint version 0.9.31? </h2>
D. What's New in Tux Paint version 0.9.31? </h2>
</header>
<dl>
@ -245,19 +254,19 @@
<section class="outer">
<header>
<h1 id="using">
Using Tux Paint </h1>
II. Using Tux Paint </h1>
</header>
<section class="outer">
<header>
<h2 id="using_loading">
Launching Tux Paint </h2>
A. Launching Tux Paint </h2>
</header>
<section class="indent">
<header>
<h3>
Linux/Unix Users </h3>
1. Linux/Unix Users </h3>
<header>
<p>
@ -279,7 +288,7 @@
<section class="indent">
<header>
<h3>
Windows Users </h3>
2. Windows Users </h3>
</header>
<table border="0"
@ -315,7 +324,7 @@
<section class="indent">
<header>
<h3>
macOS Users </h3>
3. macOS Users </h3>
</header>
<p>
@ -332,7 +341,7 @@
alt="[Title screen]">
</div>
<h2 id="using_title">
Title Screen </h2>
B. Title Screen </h2>
</header>
<p>
@ -348,7 +357,7 @@
<div class="keeptogether">
<header>
<h2 id="using_main">
Main Screen </h2>
C. Main Screen </h2>
</header>
<p>
@ -516,19 +525,19 @@
<section>
<header>
<h2 id="using_tools">
Available Tools </h2>
D. Available Tools </h2>
</header>
<!-- Using: Tools: Drawing -->
<section>
<header>
<h3 id="using_tools_drawing">
Drawing Tools </h3>
1. Drawing Tools </h3>
</header>
<dl>
<dt id="using_tools_drawing_paint">
<strong>"Paint" Tool (Brush)</strong>
<strong>a. "Paint" Tool (Brush)</strong>
</dt>
<dd>
@ -580,7 +589,7 @@
</blockquote>
</dd>
<dt id="using_tools_drawing_stamp">
<strong>"Stamp" Tool (Rubber Stamps)</strong>
<strong>b."Stamp" Tool (Rubber Stamps)</strong>
</dt>
<dd>
@ -683,7 +692,7 @@
</dd>
<dt id="using_tools_drawing_lines">
<strong>"Lines" Tool</strong>
<strong>c."Lines" Tool</strong>
</dt>
<dd>
@ -715,7 +724,7 @@
</div>
</dd>
<dt id="using_tools_drawing_shapes">
<strong>"Shapes" Tool</strong>
<strong>d."Shapes" Tool</strong>
</dt>
<dd>
@ -797,7 +806,7 @@
</div>
</dd>
<dt id="using_tools_drawing_text_and_label">
<strong>"Text" and "Label" Tools</strong>
<strong>e."Text" and "Label" Tools</strong>
</dt>
<dd>
@ -889,7 +898,7 @@
</dl>
</dd>
<dt id="using_tools_drawing_fill">
<strong>"Fill" Tool</strong>
<strong>f."Fill" Tool</strong>
</dt>
<dd>
@ -912,7 +921,7 @@
<span title="Version variation">&#128220;</span> <strong>Note:</strong> Prior to Tux Paint 0.9.24, "Fill" was a Magic tool (see below). Prior to Tux Paint 0.9.26, the "Fill" tool only offered the 'Solid' method of filling. 'Shaped' fill was introduced in Tux Paint 0.9.29. </p>
</dd>
<dt id="using_tools_drawing_magic">
<strong>"Magic" Tool (Special Effects)</strong>
<strong>g."Magic" Tool (Special Effects)</strong>
</dt>
<dd>
@ -965,7 +974,7 @@
See the <a href="../magic-docs/html/index.html">instructions for each Magic tool</a> (in the 'magic-docs' folder). </p>
</dd>
<dt id="using_tools_drawing_eraser">
<strong>"Eraser" Tool</strong>
<strong>h."Eraser" Tool</strong>
</dt>
<dd>
@ -998,12 +1007,12 @@
<section>
<header>
<h3 id="using_tools_other">
Other Controls </h3>
2. Other Controls </h3>
</header>
<dl>
<dt id="using_tools_other_undo_and_redo">
<strong>"Undo" and "Redo" Commands</strong>
<strong>a."Undo" and "Redo" Commands</strong>
</dt>
<dd>
@ -1034,7 +1043,7 @@
<span title="Keyboard shortcut">&#9000;</span> <strong>Note:</strong> You can also press <b><code>[Control / &#8984;]</code></b> + <code><b>[R]</b></code> on the keyboard to Redo. </p>
</dd>
<dt id="using_tools_other_new">
<strong>"New" Command</strong>
<strong>b."New" Command</strong>
</dt>
<dd>
@ -1099,7 +1108,7 @@
</dd>
<dt id="using_tools_other_open">
<strong>"Open" Command</strong>
<strong>c."Open" Command</strong>
</dt>
<dd>
@ -1217,7 +1226,7 @@
<span title="Keyboard shortcut">&#9000;</span> <strong>Note:</strong> You can also press <b><code>[Control / &#8984;]</code></b> + <code><b>[O]</b></code> on the keyboard to bring up the 'Open' dialog. </p>
</dd>
<dt id="using_tools_other_save">
<strong>"Save" Command</strong>
<strong>d."Save" Command</strong>
</dt>
<dd>
@ -1252,7 +1261,7 @@
<span title="Keyboard shortcut">&#9000;</span> <strong>Note:</strong> You can also press <b><code>[Control / &#8984;]</code></b> + <code><b>[S]</b></code> on the keyboard to save. </p>
</dd>
<dt id="using_tools_other_print">
<strong>"Print" Command</strong>
<strong>e."Print" Command</strong>
</dt>
<dd>
@ -1370,7 +1379,7 @@
</dl>
</dd>
<dt id="using_tools_other_open_slides">
<strong>"Slides" Command (under "Open")</strong>
<strong>f."Slides" Command (under "Open")</strong>
</dt>
<dd>
@ -1462,7 +1471,7 @@
Click 'Back' in the slideshow image selection screen to return to the 'Open' dialog. </p>
</dd>
<dt id="using_tools_other_quit">
<strong>"Quit" Command</strong>
<strong>g."Quit" Command</strong>
</dt>
<dd>
@ -1496,7 +1505,7 @@
<span title="Configuration option">&#9881;</span> See the "<a href="OPTIONS.html"><em>Options</em></a>" documentation. </p>
</dd>
<dt id="using_tools_other_sound_muting">
<strong>Sound Muting</strong>
<strong>h.Sound Muting</strong>
</dt>
<dd>
@ -1522,52 +1531,61 @@
<section class="outer indent">
<header>
<h1 id="loading_into">
Loading Other Pictures into Tux Paint </h1>
III. Loading Other Pictures into Tux Paint </h1>
</header>
<p>
Tux Paint's 'Open' dialog only displays pictures you created with Tux Paint. So what do you do if you want to load some other drawinng or even a photograph into Tux Paint, so you can edit or draw on it? </p>
<section class="inner">
<header>
<h2>
A. Overview </h2>
</header>
<p>
You can simply convert the picture to the format Tux Paint uses &mdash; PNG (Portable Network Graphic) &mdash; and place it in Tux Paint's "<code>saved</code>" directory/folder. Here is where to find it (by default): </p>
<p>
Tux Paint's 'Open' dialog only displays pictures you created with Tux Paint. So what do you do if you want to load some other drawinng or even a photograph into Tux Paint, so you can edit or draw on it? </p>
<p>
You can simply convert the picture to the format Tux Paint uses &mdash; PNG (Portable Network Graphic) &mdash; and place it in Tux Paint's "<code>saved</code>" directory/folder. Here is where to find it (by default): </p>
<dl>
<dt>
<strong>Windows 10, 8, 7, Vista</strong>
</dt>
<dd>
Inside the user's "<code>AppData</code>" folder, e.g.: "<code>C:\Users\<em>username</em>\AppData\Roaming\TuxPaint\saved\</code>". </dd>
<dt>
<strong>Windows 2000, XP</strong>
</dt>
<dd>
Inside the user's "<code>Application Data</code>" folder, e.g.: "<code>C:\Documents and Settings\<em>username</em>\Application Data\TuxPaint\saved\</code>". </dd>
<dt>
<strong>macOS</strong>
</dt>
<dd>
Inside the user's "<code>Library</code>" folder, e.g.: "<code>/Users/<em>username</em>/Library/Application Support/Tux Paint/saved/</code>". </dd>
<dt>
<strong>Linux/Unix</strong>
</dt>
<dd>
Inside a hidden "<code>.tuxpaint</code>" directory, in the user's home directory ("<code>$HOME</code>"), e.g. "<code>/home/<em>username</em>/.tuxpaint/saved/</code>". </dd>
</dl>
<p class="note">
<span title="Information">&#128161;</span> <strong>Note:</strong> It is also from this folder that you can copy or open pictures drawn in Tux Paint using <em>other</em> applications, though the 'Export' option from Tux Paint's 'Open' dialog can be used to copy them to a location that's easier and safer to access. </p>
</section>
<dl>
<dt>
<strong>Windows 10, 8, 7, Vista</strong>
</dt>
<section class="inner">
<header>
<h2>
B. Using the import script, "<code>tuxpaint-import</code>" </h2>
</header>
<dd>
Inside the user's "<code>AppData</code>" folder, e.g.: "<code>C:\Users\<em>username</em>\AppData\Roaming\TuxPaint\saved\</code>". </dd>
<dt>
<strong>Windows 2000, XP</strong>
</dt>
<dd>
Inside the user's "<code>Application Data</code>" folder, e.g.: "<code>C:\Documents and Settings\<em>username</em>\Application Data\TuxPaint\saved\</code>". </dd>
<dt>
<strong>macOS</strong>
</dt>
<dd>
Inside the user's "<code>Library</code>" folder, e.g.: "<code>/Users/<em>username</em>/Library/Application Support/Tux Paint/saved/</code>". </dd>
<dt>
<strong>Linux/Unix</strong>
</dt>
<dd>
Inside a hidden "<code>.tuxpaint</code>" directory, in the user's home directory ("<code>$HOME</code>"), e.g. "<code>/home/<em>username</em>/.tuxpaint/saved/</code>". </dd>
</dl>
<p class="note">
<span title="Information">&#128161;</span> <strong>Note:</strong> It is also from this folder that you can copy or open pictures drawn in Tux Paint using <em>other</em> applications, though the 'Export' option from Tux Paint's 'Open' dialog can be used to copy them to a location that's easier and safer to access. </p>
<h2>
Using the import script, "<code>tuxpaint-import</code>" </h2>
<blockquote>
<p>
Linux and Unix users can use the "<code>tuxpaint-import</code>" shell script which gets installed when you install Tux Paint. It uses some NetPBM tools to convert the image ("<code>anytopnm</code>"), resize it so that it will fit in Tux Paint's canvas ("<code>pnmscale</code>"), and convert it to a PNG ("<code>pnmtopng</code>"). </p>
@ -1597,12 +1615,14 @@
<p>
Now you can load Tux Paint, and a version of that original picture will be available under the 'Open' dialog. Just double-click its icon! </p>
</blockquote>
</section>
<h2>
Importing Pictures Manually </h2>
<section class="inner">
<header>
<h2>
C. Importing Pictures Manually </h2>
</header>
<blockquote>
<p>
Windows, macOS, and Haiku users who wish to import arbitrary images into Tux Paint must do so via a manual process. </p>
@ -1615,41 +1635,50 @@
<p>
To avoid having the image stretched or smeared, you can resize it to Tux Paint's canvas size. This size depends on the size of the Tux Paint window, or resolution at which Tux Paint is run, if in fullscreen. (<strong>Note:</strong> The default resolution is 800x600.) See "Calculating Image Dimensions", below. </p>
<p>
Save the picture in PNG format. It is <strong>highly</strong> recommended that you name the filename using the current date and time, since that's the convention Tux Paint uses: </p>
<section class="inner">
<header>
<h3>
1. Naming the File </h3>
</header>
<blockquote>
<code><strong>YYYYMMDDhhmmss</strong>.png</code>
</blockquote>
<p>
Save the picture in PNG format. It is <strong>highly</strong> recommended that you name the filename using the current date and time, since that's the convention Tux Paint uses: </p>
<blockquote>
<code><strong>YYYYMMDDhhmmss</strong>.png</code>
</blockquote>
<ul>
<li><code>YYYY</code> = Year</li>
<li><code>MM</code> = Month (two digits, "01"-"12")</li>
<li><code>DD</code> = Day of month (two digits, "01"-"31")</li>
<li><code>HH</code> = Hour (two digits, in 24-hour format, "00"-"23")</li>
<li><code>mm</code> = Minute (two digits, "00"-"59")</li>
<li><code>ss</code> = Seconds (two digits, "00"-"59")</li>
</ul>
<p>
Example: "<code>20210731110500.png</code>", for July 31, 2021 at 11:05am. </p>
<p>
Place this PNG file in your Tux Paint "<code>saved</code>" directory/folder. (See above.) </p>
</section>
<ul>
<li><code>YYYY</code> = Year</li>
<li><code>MM</code> = Month (two digits, "01"-"12")</li>
<li><code>DD</code> = Day of month (two digits, "01"-"31")</li>
<li><code>HH</code> = Hour (two digits, in 24-hour format, "00"-"23")</li>
<li><code>mm</code> = Minute (two digits, "00"-"59")</li>
<li><code>ss</code> = Seconds (two digits, "00"-"59")</li>
</ul>
<section class="inner">
<header>
<h3>
2. Calculating Image Dimensions </h3>
</header>
<p>
Example: "<code>20210731110500.png</code>", for July 31, 2021 at 11:05am. </p>
<p>
Place this PNG file in your Tux Paint "<code>saved</code>" directory/folder. (See above.) </p>
<h3>
Calculating Image Dimensions </h3>
<blockquote>
<p>
This part of the documentation needs to be rewritten, since the new "<code>buttonsize</code>" option was added. For now, try drawing and saving an image within Tux Paint, then determine what size (pixel width and height) it came out to, and try to match that when scaling the picture(s) you're importing into Tux Paint. </p>
</blockquote>
</blockquote>
</section>
</section>
</section>
<section class="outer indent">
<header>
<h1 id="further">
Further Reading </h1>
IV.Further Reading </h1>
</header>
<p>
@ -1727,7 +1756,7 @@
<section class="outer indent">
<header>
<h1 id="help">
How to Get Help </h1>
V.How to Get Help </h1>
</header>
<p>
@ -1744,7 +1773,7 @@
<section class="outer indent">
<header>
<h1 id="participate">
How to Participate </h1>
VI.How to Participate </h1>
</header>
<p>
@ -1765,7 +1794,7 @@
<section class="outer indent">
<header>
<h1 id="participate">
Follow the Tux Paint project on social media </h1>
VII.Follow the Tux Paint project on social media </h1>
</header>
<p>
@ -1797,7 +1826,7 @@
<section class="outer">
<header>
<h1>
Trademark notices</a>
VIII. Trademark notices</a>
</h1>
</header>