Further work on animated GIF export: XDG Pictures

Using XDG's user dir settings to determine where pictures are
stored for a user (e.g., "~/Pictures" -- used as a fallback).
May be overridden using "--exportdir".

Also, while I was updating some docs, replace references to
"Mac OS X" with "macOS", the new name of that OS these days.
This commit is contained in:
Bill Kendrick 2020-07-25 16:45:17 -07:00
parent 683bbf5f19
commit f8cce36435
13 changed files with 329 additions and 68 deletions

View file

@ -8,7 +8,7 @@ http://www.tuxpaint.org/
$Id$
2020.July.24 (0.9.25)
2020.July.25 (0.9.25)
* New Features
------------
* [WIP] GIF export option from Open -> Slideshow dialog.
@ -17,6 +17,9 @@ $Id$
* Depends on "libimagequant", from the "pngquant2" project:
https://github.com/ImageOptim/libimagequant
(GPL v3 or later, for Free/Libre Open Source Software)
* Uses XDG user dirs settings, if available, to determine
where to store them, or "~/Pictures", otherwise.
"--exportdir" option can be used to override this.
* Ports & Building
----------------

View file

@ -2,11 +2,11 @@ INSTALL.txt for Tux Paint
Tux Paint - A simple drawing program for children.
Copyright (c) 2002-2018
Copyright (c) 2002-2020
Various contributors (see below, and AUTHORS.txt)
http://www.tuxpaint.org/
June 27, 2002 - December 8, 2018
June 27, 2002 - July 25, 2020
$Id$
@ -119,6 +119,14 @@ Requirements:
Also depends on:
libxml2
Animated GIF Export feature
---------------------------
So support export of animated GIFs (slideshows), the
"libimagequant" library (from the "pngquant2" project)
is required.
https://github.com/ImageOptim/libimagequant
NetPBM Tools [OPTIONAL] [No longer used, by default]
------------------------
Under Linux and Unix, the NetPBM tools are what are currently

View file

@ -6,7 +6,7 @@ Options Documentation
Copyright (c) 2002-2020 by various contributors; see AUTHORS.txt
http://www.tuxpaint.org/
June 22, 2020
July 25, 2020
----------------------------------------------------------------------
@ -187,7 +187,7 @@ Windows Users
printcfg=yes
(Windows and Mac OS X only)
(Windows and macOS only)
Tux Paint will use a printer configuration file when printing.
Push the [Alt] key while clicking the 'Print' button in
@ -224,7 +224,7 @@ Windows Users
papersize=PAPERSIZE
(Platforms that use Tux Paint's internal PostScript generator
— not Windows, Mac OS X or BeOS.)
— not Windows, macOS, BeOS, or Haiku.)
Tell Tux Paint what size PostScript to generate. If none is
specified, Tux Paint first checks your $PAPER environment
@ -560,7 +560,7 @@ Windows Users
Example:
"C:\Documents and Settings\Username\Application Data\TuxPaint\saved\"
* Mac OS X — Inside a folder named "TuxPaint" in your
* macOS — Inside a folder named "TuxPaint" in your
"Application Support" folder.
Example:
"/Users/Username/Library/Application Support/TuxPaint/saved/"
@ -576,15 +576,40 @@ Windows Users
Example: savedir=Z:\tuxpaint\
exportdir=DIRECTORY
Use this option to change where Tux Paint exports files —
single images, or animated GIF slideshows — for external use.
If you do not override it, the default location is:
* Linux & Unix — If available, wherever your desktop
environment is configured for pictures to be stored,
based on your XDG (X Desktop Group) configuration. (Try
running the command-line "xdg-user-dir PICTURES" to find
out.)
Typically (in an English locale), this will be a
"Pictures/" subdirectory in your home directory (i.e.,
"$HOME/Pictures/" aka "~/Pictures").
Tux Paint will fall back to using that typical directory,
of no XDG configuration can be read, or nothing is set
for "XDG_PICTURES_DIR".
* Windows — TBD!
* macOS — TBD!
Example: exportdir=/home/penguin/TuxPaintExports
datadir=DIRECTORY
Use this option to change where Tux Paint looks for personal
data files (brushes, stamps, starters and fonts specific to
the current user).
data files (brushes, stamps, starters, templates, and fonts
specific to the current user).
Tux Paint will search for subdirectories/subfolders named
"brushes", "stamps", "starters" and "fonts" under the data
directory.
"brushes", "stamps", "starters", "templates", and "fonts"
under the specified data directory.
If you do not override it, the default location is:
* Linux & Unix — Under a hidden directory named ".tuxpaint"
@ -596,7 +621,7 @@ Windows Users
Example:
"C:\Documents and Settings\Username\Application Data\TuxPaint\brushes\"
* Mac OS X — Inside a folder named "TuxPaint" in your
* macOS — Inside a folder named "TuxPaint" in your
"Application Support" folder.
Example:
"/Users/Username/Library/Application Support/TuxPaint/brushes/"

View file

@ -121,7 +121,7 @@ Loading Tux Paint
----------------------------------------------------------------------
Mac OS X Users
macOS Users
Simply double-click the "Tux Paint" icon.
@ -604,7 +604,7 @@ Available Tools
Printer Settings
(Windows and Mac OS X)
(Windows and macOS)
By default, Tux Paint simply prints to the
default printer with default settings when the
@ -753,7 +753,7 @@ Available Tools
Inside the user's "Application Data" folder, e.g.: "C:\Documents
and Settings\(user name)\Application Data\TuxPaint\saved\"
Mac OS X
macOS
Inside the user's "Library" folder:
"/Users/(user name)/Library/Application
Support/Tux Paint/saved/"
@ -799,7 +799,7 @@ Using 'tuxpaint-import'
Doing it Manually
Windows, Mac OS X and BeOS users must currently do the conversion
Windows, macOS, BeOS, and Haiku users must currently do the conversion
manually.
Load a graphics program that is capable of both loading your picture

View file

@ -19,7 +19,7 @@ version
<p>Copyright (c) 2002-2020 by various contributors; see AUTHORS.txt<br/>
<a href="http://www.tuxpaint.org/">http://www.tuxpaint.org/</a></p>
<p>June 22, 2020</p>
<p>July 25, 2020</p>
</center>
@ -244,7 +244,7 @@ version
<dt><code><b>printcfg=yes</b></code></dt>
<dd>
<p><i>(Windows and Mac OS X only)</i></p>
<p><i>(Windows and macOS only)</i></p>
<p>Tux&nbsp;Paint will use a printer configuration file when printing.
Push the <b>[Alt]</b> key while clicking the 'Print' button in
@ -284,7 +284,7 @@ version
<dt><code><b>papersize=<i>PAPERSIZE</i></b></code></dt>
<dd>
<p><i>(Platforms that use Tux&nbsp;Paint's internal PostScript
generator &mdash; not Windows, Mac OS X or BeOS.)</i></p>
generator &mdash; not Windows, macOS, BeOS, or Haiku.)</i></p>
<p>Tell Tux&nbsp;Paint what size PostScript to generate.
If none is specified, Tux&nbsp;Paint first checks
@ -692,7 +692,7 @@ version
Example: "<code>C:\Documents&nbsp;and&nbsp;Settings\<i>Username</i>\Application&nbsp;Data\TuxPaint\saved\</code>"<br>
<br>
<li>Mac OS X &mdash; Inside a folder named "<code>TuxPaint</code>" in your
<li>macOS &mdash; Inside a folder named "<code>TuxPaint</code>" in your
"<code>Application&nbsp;Support</code>" folder.<br>
Example: "<code>/Users/<i>Username</i>/Library/Application&nbsp;Support/TuxPaint/saved/</code>"<br>
</ul>
@ -710,15 +710,46 @@ version
<p><b>Example:</b> <code>savedir=Z:\tuxpaint\</code></p>
</dd>
<dt><code><b>exportdir=<i>DIRECTORY</i></b></code></dt>
<dd>
<p>Use this option to change where Tux&nbsp;Paint exports files &mdash; single
images, or animated GIF slideshows &mdash; for external use.
<p>If you do not override it, the <b><i>default</i></b> location is:
<ul>
<li>Linux &amp; Unix &mdash; If available, wherever your desktop environment
is configured for pictures to be stored, based on your XDG
(X&nbsp;Desktop&nbsp;Group) configuration. (Try running the command-line
"<nobr><code>xdg-user-dir PICTURES</code></nobr>" to find out.)<br>
<br>
Typically (in an English locale), this will be a "<code>Pictures/</code>"
subdirectory in your home directory (i.e., "<code>$HOME/Pictures/</code>"
aka "<code>~/Pictures</code>").<br>
<br>
Tux&nbsp;Paint will fall back to using that typical directory, of no
XDG configuration can be read, or nothing is set for
"<code>XDG_PICTURES_DIR</code>".<br>
<br>
<li>Windows &mdash; TBD! <!-- FIXME -->
<li>macOS &mdash; TBD! <!-- FIXME -->
</ul>
</p>
<p><b>Example:</b> <code>exportdir=/home/penguin/TuxPaintExports</code></p>
</dd>
<dt><code><b>datadir=<i>DIRECTORY</i></b></code></dt>
<dd>
<p>Use this option to change where Tux&nbsp;Paint looks for personal
data files (brushes, stamps, starters and fonts specific to the
current user).</p>
data files (brushes, stamps, starters, templates, and fonts specific to
the current user).</p>
<p>Tux&nbsp;Paint will search for subdirectories/subfolders named
"<code>brushes</code>", "<code>stamps</code>", "<code>starters</code>"
and "<code>fonts</code>" under the data directory.</p>
"<code>brushes</code>", "<code>stamps</code>", "<code>starters</code>",
"<code>templates</code>", and "<code>fonts</code>" under the specified
data directory.</p>
<p>If you do not override it, the <b><i>default</i></b> location is:
<ul>
@ -733,7 +764,7 @@ version
Example: "<code>C:\Documents&nbsp;and&nbsp;Settings\<i>Username</i>\Application&nbsp;Data\TuxPaint\brushes\</code>"<br>
<br>
<li>Mac OS X &mdash; Inside a folder named "<code>TuxPaint</code>" in your
<li>macOS &mdash; Inside a folder named "<code>TuxPaint</code>" in your
"<code>Application&nbsp;Support</code>" folder.<br>
Example: "<code>/Users/<i>Username</i>/Library/Application&nbsp;Support/TuxPaint/brushes/</code>"<br>
</ul>

View file

@ -171,7 +171,7 @@ version
<hr size=1 noshade>
<h3>Mac OS X Users</h3>
<h3>macOS Users</h3>
<blockquote>
Simply double-click the "Tux&nbsp;Paint" icon.<p>
</blockquote>
@ -825,7 +825,7 @@ version
<dt>Printer Settings</dt>
<dd>
<p><i>(Windows and Mac&nbsp;OS&nbsp;X)</i></p>
<p><i>(Windows and macOS)</i></p>
<p>By default, Tux&nbsp;Paint simply prints to the default
printer with default settings when the 'Print' button is
@ -998,7 +998,7 @@ version
e.g.: <code>"C:\Documents and Settings\<i>(user&nbsp;name)</i>\Application
Data\TuxPaint\saved\</code>"</dd>
<dt>Mac OS X</dt>
<dt>macOS</dt>
<dd>Inside the user's "<code>Library</code>" folder:
<code>"/Users/<i>(user&nbsp;name)</i>/Library/Application Support/Tux&nbsp;Paint/saved/</code>"</dd>
@ -1052,7 +1052,7 @@ version
<h2>Doing it Manually</h2>
<blockquote>
<p>Windows, Mac OS X and BeOS users must currently do the conversion
<p>Windows, macOS, BeOS, and Haiku users must currently do the conversion
manually.</p>
<p>Load a graphics program that is capable of both loading your picture