notgne2/tuxpaint-pencil-sharpener
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Regen DOCs after clean up (removal of "as of..." notes)

Browse source
This commit is contained in:
Bill Kendrick 2025-01-12 10:40:45 -08:00
parent 277d902235
commit b88145b924
77 changed files with 753 additions and 1032 deletions
Download patch file Download diff file Expand all files Collapse all files

28
docs/en/html/EXTENDING.html
View file

@ -95,12 +95,12 @@
version 0.9.35 </h1>
<p>
Copyright &copy; 2002-2024 by various contributors; see <a href="../../AUTHORS.txt">AUTHORS.txt</a>.<br>
Copyright &copy; 2002-2025 by various contributors; see <a href="../../AUTHORS.txt">AUTHORS.txt</a>.<br>
<a href="https://tuxpaint.org/">https://tuxpaint.org/</a>
</p>
<p>
December 25, 2024 </p>
January 12, 2025 </p>
</center>
</header>
@ -337,7 +337,7 @@
<dt><strong>Brush Spacing</strong></dt>
<dd>
<p>
As of Tux Paint version 0.9.16, you can now specify the spacing for brushes (that is, how often they are drawn). By default, the spacing will be the brush's height, divided by 4. </p>
You may specify the spacing for brushes &mdash; that is, how frequently they are drawn across the length of a line or stroke. By default, the spacing will be the brush's height, divided by 4. </p>
<p>
Add a line containing the line "<code><b>spacing=<i>N</i></b></code>" to the brush's data file, where "<i>N</i>" is the spacing you want for the brush. (The lower the number, the more often the brush is drawn.) </p>
</dd>
@ -345,9 +345,9 @@
<dt><strong>Animated Brushes</strong></dt>
<dd>
<p>
As of Tux Paint version 0.9.16, you may now create animated brushes. As the brush is used, each frame of the animation is drawn. </p>
Brushes may be animated. As the brush is used, each frame of the animation is drawn in sequence. </p>
<p>
Lay each frame out across a wide PNG image. For example, if your brush is 30x30 and you have 5 frames, the image should be 150x30. </p>
Lay each frame out across a wide PNG image. For example, if the brush is 30x30 and there are 5 frames, the image should be 150x30. </p>
<p>
Add a line containing the line "<code><b>frames=<i>N</i></b></code>" to the brush's data file, where "<i>N</i>" is the number of frames in the brush. </p>
<p class="note">
@ -357,9 +357,9 @@
<dt><strong>Directional Brushes</strong></dt>
<dd>
<p>
As of Tux Paint version 0.9.16, you may now create directional brushes. As the brush is used, different shapes are drawn, depending on the direction the brush is going. </p>
Brushes may be configured to draw a different shape based on the direction of the line or brush stroke. Different shapes will be drawn depending on which of the eight compass directions the brush is moving &mdash; up (aka North), up/right (aka Northeast), right (aka East), down/right (aka Southeast), etc.). A ninth "center" shape is used when there's no motion (e.g., simply clicking/tapping and releasing the "Paint" tool, without dragging). </p>
<p>
The directional shapes are divided into a 3x3 square in a PNG image. For example, if your brush is 30x30, the image should be 90x90, and each of the direction's shapes placed in a 3x3 grid. The center region is used for no motion. The top right is used for motion that's both up, and to the right. And so on. </p>
The directional shapes are divided into a 3x3 square in a PNG image. For example, if your brush is 30x30, the image should be 90x90, and each of the direction's shapes placed in a 3x3 grid. </p>
<p>
Add a line containing the word "<code><b>directional</b></code>" to the brush's data file. </p>
</dd>
@ -367,7 +367,7 @@
<dt><strong>Rotating Brushes</strong></dt>
<dd>
<p>
As of Tux Paint version 0.9.27, you may now create rotating brushes. As the brush is used, it is rotated 360 degrees, depending on the direction the brush is going. </p>
Brushes may be configured to rotate based on the angle of the line or brush stroke. (Unlike Directional Brushes, described above, only a single brush shape may be provided. </p>
<p>
Add a line containing the word "<code><b>rotate</b></code>" to the brush's data file. </p>
</dd>
@ -375,7 +375,7 @@
<dt><strong>Chaotic Brushes</strong></dt>
<dd>
<p>
As of Tux Paint version 0.9.34, brushes can be configured to continuously pick random directions as you draw with them. </p>
Brushes may be configured to continuously choose a random direction as you draw with them. </p>
<p>
Add a line containing the word "<code><b>chaotic</b></code>" to the brush's data file. </p>
</dd>
@ -424,7 +424,7 @@
alt=""
align="right">
<p>
As of Tux Paint version 0.9.17, Stamps may be either PNG bitmap images or SVG vector images. They can be full-color or greyscale. The alpha (transparency) channel of PNGs is used to determine the actual shape of the picture (otherwise you'll stamp a large rectangle on your drawings). </p>
Stamps may be either PNG bitmap images or SVG vector images. They can be full-color or greyscale. The alpha (transparency) channel of PNGs is used to determine the actual shape of the picture (otherwise you'll stamp a large rectangle on your drawings). </p>
<p>
PNGs can be any size, and Tux Paint (by default) provides a set of sizing buttons to let the user scale the stamp up (larger) and down (smaller). </p>
@ -662,7 +662,7 @@
For example, for the stamp "<code>stamp.png</code>" you would create another file named "<code>stamp_mirror.png</code>", which will be used when the stamp is mirrored (rather than using a backwards version of "<code>stamp.png</code>"). </p>
<p>
As of Tux Paint 0.9.18, you may similarly provide a pre-flipped image with "<code><b>_flip</b></code>" in the name, and/or an image that is both mirrored and flipped, by naming it "<code><b>_mirror_flip</b></code>". </p>
You may also provide a pre-flipped image with "<code><b>_flip</b></code>" in the name, and/or an image that is both mirrored <em>and</em> flipped, by naming it "<code><b>_mirror_flip</b></code>". </p>
<p class="note">
<span title="Information">&#128161;</span> <strong>Note:</strong> If the user flips and mirrors an image, and a pre-drawn "<code>_mirror_flip</code>" doesn't exist, but either "<code>_flip</code>" or "<code>_mirror</code>" does, it will be used, and mirrored or flipped, respectively. </p>
@ -720,7 +720,7 @@
The most basic kind of 'starter' is similar to a picture in a coloring book. It's an outline of a shape which you can then color in and add details to. In Tux Paint, as you draw, type text, or stamp stamps, the outline remains 'above' what you draw. You can erase the parts of the drawing you made, but you can't erase the outline. </p>
<p>
To create this kind of 'starter' image, simply create an outlined black and white picture in a paint program, and save it as a raster PNG file, or vector SVG. If saving as a PNG, you may optionally render the image as black-and-transparent, rather than black-and-white, but (as of Tux Paint 0.9.21) this is not required. </p>
To create this kind of 'starter' image, simply create an outlined black and white picture in a paint program, and save it as a raster PNG file, or vector SVG. If saving as a PNG, you may optionally render the image as black-and-transparent, rather than black-and-white, although this is not required. </p>
</section><!-- H2: Coloring-Book Style Starters -->
<section><!-- H2: Scene-Style Starters -->
@ -957,7 +957,7 @@
alt=""
align="right">
<p>
'Template' images also appear in the 'New' dialog, along with solid color background choices and 'Starters'. (Note: Tux Paint prior to version 0.9.22 did not have the 'Template' feature.) </p>
'Template' images also appear in the 'New' dialog, along with solid color background choices and 'Starters'. </p>
<p>
Unlike pictures drawn in Tux Paint by users and then opened later, opening a 'template' creates a new drawing. When you save, the 'template' image is not overwritten. Unlike 'starters', there is no immutable 'layer' above the canvas. You may draw over any part of it. </p>
@ -1118,7 +1118,7 @@
</header>
<p>
As of version 0.9.22, Tux Paint's 'Text' and 'Label' tools can present an on-screen keyboard that allows the pointer (via a mouse, touch screen, eye-tracking systems, etc.) to be used to input characters. Files that describe the layout and available keys are stored in Tux Paint "<code>osk</code>" directory. Each keyboard layout is defined by a number of files (some of which may be shared by different layouts). </p>
Tux Paint's 'Text' and 'Label' tools can present an on-screen keyboard that allows the pointer (via a mouse, touch screen, eye-tracking systems, etc.) to be used to input characters. Files that describe the layout and available keys are stored in Tux Paint "<code>osk</code>" directory. Each keyboard layout is defined by a number of files (some of which may be shared by different layouts). </p>
<p>
We'll use the QWERTY keyboard as an example: </p>

10
docs/en/html/FAQ.html
View file

@ -96,7 +96,7 @@
</p>
<p>
January 9, 2025 </p>
January 12, 2025 </p>
</center>
<table border="2"
@ -141,7 +141,7 @@
This means that Tux Paint either couldn't find any stamp images, or was asked not to load them. </p>
<p>
If you installed Tux Paint, but did not install the separate, optional "Stamps" collection, quit Tux Paint and install it now. It should be available from the same place you got the main Tux Paint program. <i>(Note: As of version 0.9.14, Tux Paint comes with a small collection of example stamps.)</i> </p>
If you installed Tux Paint, but did not install the separate, optional "Stamps" collection, quit Tux Paint and install it now. It should be available from the same place you got the main Tux Paint program. <i>(Note: Tux Paint ships with a very small collection of example stamps.)</i> </p>
<p>
If you don't want to install the default collection of stamps, you can just create your own. See the "Extending Tux Paint" documentation for more on creating PNG and SVG image files, TXT text description files, Ogg Vorbis, MP3 or WAV sound files, and DAT text data files that make up stamps. </p>
@ -286,12 +286,6 @@
<p>
If that program is not available (for example, you're using CUPS, the Common Unix Printing System, and do not have "<code>cups-lpr</code>" installed), you will need to specify an appropriate command using the "<code>printcommand</code>" option in Tux Paint's configuration file. (See the "Options Documentation".) </p>
<p>
<i>Note:</i> Versions of Tux Paint prior to 0.9.15 used a different default command for printing, "<code>pngtopnm | pnmtops | lpr</code>", as Tux Paint output PNG format, rather than PostScript. </p>
<p>
If you had changed your "printcommand" option prior to Tux Paint 0.9.15, you will need to go back and alter it to accept PostScript. </p>
</dd>
<dt>

10
docs/en/html/INSTALL.html
View file

@ -93,12 +93,12 @@
Installation Documentation </h1>
<p>
Copyright &copy; 2002-2024 by various contributors; see <a href="../../AUTHORS.txt">AUTHORS.txt</a>.<br>
Copyright &copy; 2002-2025 by various contributors; see <a href="../../AUTHORS.txt">AUTHORS.txt</a>.<br>
<a href="https://tuxpaint.org/">https://tuxpaint.org/</a>
</p>
<p>
April 29, 2024 </p>
January 12, 2025 </p>
</center>
</header>
@ -206,7 +206,7 @@
<dt><strong>libpaper (Linux/Unix only)</strong></dt>
<dd>
<p>
As of Tux Paint 0.9.17, Tux Paint can determine your system's default paper size (e.g., A4 or Letter), or can be told to use a particular paper size, thanks to "libpaper". </p>
Tux Paint can determine your system's default paper size (e.g., A4 or Letter), or can be told to use a particular paper size, thanks to "libpaper". </p>
<p>
<a href="https://github.com/naota/libpaper">https://github.com/naota/libpaper</a>
@ -226,7 +226,7 @@
<dt><strong>SVG graphics support</strong></dt>
<dd>
<p>
As of Tux Paint 0.9.17, Tux Paint can load SVG (Scalable Vector Graphics) images as stamps. Two sets of libraries are supported, and SVG support can be completely disabled (via "<code style="white-space: nowrap;">make SVG_LIB:=</code>") </p>
Tux Paint can load SVG (Scalable Vector Graphics) images as stamps. Two sets of libraries are supported, and SVG support can be completely disabled (via "<code style="white-space: nowrap;">make SVG_LIB:=</code>") </p>
<dl>
<dt>librsvg-2 &amp; libCairo2 (newer libraries)</dt>
@ -311,7 +311,7 @@
</header>
<p>
As of February 2005 (starting with Tux Paint 0.9.15), the "<code>Makefile</code>" includes support for building on a Windows system using MinGW/MSYS (<a href="https://sourceforge.net/projects/msys2/">https://sourceforge.net/projects/msys2/</a>). </p>
The "<code>Makefile</code>" includes support for building on a Windows system using MinGW/MSYS (<a href="https://sourceforge.net/projects/msys2/">https://sourceforge.net/projects/msys2/</a>). </p>
<p>
Many tools and libraries are required to build Tux Paint. The package management system "<code>pacman</code>" helps you install them automatically solving complicated dependencies. </p>

6
docs/en/html/MAGIC-API.html
View file

@ -97,12 +97,12 @@
Magic Tool Plugin API Documentation </h2>
<p>
Copyright &copy; 2007-2024 by various contributors; see <a href="../../AUTHORS.txt">AUTHORS.txt</a>.<br>
Copyright &copy; 2007-2025 by various contributors; see <a href="../../AUTHORS.txt">AUTHORS.txt</a>.<br>
<a href="https://tuxpaint.org/">https://tuxpaint.org/</a>
</p>
<p>
September 17, 2024 </p>
January 12, 2025 </p>
</center>
</header>
@ -153,7 +153,7 @@
</header>
<p>
Beginning with version 0.9.18, Tux Paint's 'Magic' tools were converted from routines that lived within the application itself, to a set of 'plugins' that are loaded when Tux Paint starts up. </p>
Tux Paint's 'Magic' tools come as a set of 'plugins' which are loaded when Tux Paint starts up. </p>
<p>
This division allows more rapid development of 'Magic' tools, and allows programmers to create and test new tools without needing to integrate them within the main Tux Paint source code. (Users of more professional graphics tools, such as GIMP, should be familiar with this plugin concept.) </div>

15
docs/en/html/OPTIONS.html
View file

@ -97,12 +97,12 @@
Options Documentation </h2>
<p>
Copyright &copy; 2002-2024 by various contributors; see <a href="../../AUTHORS.txt">AUTHORS.txt</a>.<br>
Copyright &copy; 2002-2025 by various contributors; see <a href="../../AUTHORS.txt">AUTHORS.txt</a>.<br>
<a href="https://tuxpaint.org/">https://tuxpaint.org/</a>
</p>
<p>
April 29, 2024 </p>
January 12, 2025 </p>
</center>
</header>
@ -519,10 +519,7 @@
<dd>
<p>
Prior to Tux Paint 0.9.15, the middle and right buttons on a mouse could also be used for clicking. In version 0.9.15, it was changed so that <i>only</i> the left mouse button worked, so as to not train children to use the wrong button. </p>
<p>
However, for children who have trouble with the mouse, this distinction between the two or three buttons on a mouse can be disabled (returning Tux Paint to its old behavior) by using this option. </p>
For children who have trouble with the mouse, this distinction between the two or three buttons on a mouse may be disabled by using this option. </p>
<p class="note">
<span title="Configuration option">&#9881;</span> <strong>Note:</strong> If used in a system-wide configuration file, may be overridden by the user's configuration file using "<code>nobuttondistinction=no</code>" or "<code>buttondistinction=yes</code>". In both cases, may be overridden by the command-line option "<code>--buttondistinction</code>". </p>
</dd>
@ -1637,12 +1634,6 @@
<blockquote>
<code>lpr</code>
</blockquote>
<p class="note">
<span title="Version variation">&#128220;</span> <b>Note:</b> Versions of Tux Paint prior to 0.9.15 sent PNG format data to the print command (which defaulted to "<code>pngtopnm | pnmtops | lpr</code>"). </p>
<p>
If you set an alternative <code><b>printcommand</b></code> in the configuration file prior to version 0.9.15, you will need to change it. </p>
</dd>
<dt>