diff --git a/docs/CHANGES.txt b/docs/CHANGES.txt index fec433b79..0a1713f62 100644 --- a/docs/CHANGES.txt +++ b/docs/CHANGES.txt @@ -20,10 +20,8 @@ $Id$ https://github.com/ImageOptim/libimagequant (GPL v3 or later, for Free/Libre Open Source Software) * WORK IN PROGRESS -- Ignores speed - * WORK IN PROGRESS -- Needs documentation * Single image (PNG) export from the Open dialog. (Closes https://sourceforge.net/p/tuxpaint/feature-requests/192/) - * WORK IN PROGRESS -- Needs documentation * Both utilize XDG user dirs settings, if available, to determine where to store them, or "~/Pictures", otherwise. In those cases, files are stored in a new "TuxPaint" subdirectory. diff --git a/docs/en/README.txt b/docs/en/README.txt index 22e68110e..db01643d6 100644 --- a/docs/en/README.txt +++ b/docs/en/README.txt @@ -497,6 +497,10 @@ Available Tools Note: As of version 0.9.22, the picture will be placed in your desktop's trash can, on Linux only. + * Click the "Export" button near the lower right to + export the image to your export folder. (e.g., + "~/Pictures/TuxPaint/") + * Click the blue "Slides" (slide projector) button at the lower left to go to slideshow mode. See "Slides", below, for details. @@ -653,43 +657,80 @@ Available Tools Slides (under "Open") The "Slides" button is available in the "Open" dialog. It - displays a list of your saved files, just like the "Open" - dialog. + can be used to play a simple animation within Tux Paint, or + a slideshow of pictures. It can also export an animated GIF + based on the chosen images. - Click each of the images you wish to display in a - slideshow-style presentation, one by one. A digit will - appear over each image, letting you know in which order they - will be displayed. + Chosing pictures - You can click a selected image to unselect it (take it out - of your slideshow). + When you enter the "Slides" section of + Tux Paint, it displays a list of your saved + files, just like the "Open" dialog. - A sliding scale at the lower left of the screen (next to the - "Play" button) can be used to adjust the speed of the - slideshow, from slowest to fastest. Choose the leftmost - setting to disable automatic advancement — you will need to - press a key or click to go to the next slide (see below). + Click each of the images you wish to display in + a slideshow-style presentation, one by one. A + digit will appear over each image, letting you + know in which order they will be displayed. - Note: The slowest setting does not automatically advance - through the slides. Use it for when you want to step through - them manually. + You can click a selected image to unselect it + (take it out of your slideshow). Click it again + if you wish to add it to the end of the list. - When you're ready, click the "Play" button to begin the - slideshow. (Note: If you hadn't selected ANY images, then - ALL images will be played in the slideshow.) + Set playback speed - During the slideshow, press [Space], [Enter] or [Return] or - the [Right Arrow], or click the "Next" button at the lower - left, to manually advance to the next slide. Press [Left] to - go back to the previous slide. + A sliding scale at the lower left of the screen + (next to the "Play" button) can be used to + adjust the speed of the slideshow or animated + GIF, from slowest to fastest. Choose the + leftmost setting to disable automatic + advancement during playback within Tux Paint — + you will need to press a key or click to go to + the next slide (see below). - Press [Escape], or click the "Back" button at the lower - right, to exit the slideshow and return to the slideshow - image selection screen. + Note: The slowest setting does not + automatically advance through the slides. Use + it for when you want to step through them + manually. (This does not apply to an exported + animated GIF.) + + Playback in Tux Paint + + To play a slideshow within Tux Paint, click the + "Play" button. (Note: If you hadn't selected + ANY images, then ALL of your saved images will + be played in the slideshow!) + + During the slideshow, press [Space], [Enter] or + [Return], or the [Right Arrow] — or click the + "Next" button at the lower left — to manually + advance to the next slide. Press [Left] to go + back to the previous slide. + + Press [Escape], or click the "Back" button at + the lower right, to exit the slideshow and + return to the slideshow image selection screen. + + Exporting an animated GIF + + Click the "GIF Export" button near the lower + right to have Tux Paint generate an animated + GIF file based on the selected images. + + Note: At least two images must be selected. (To + export a single image, use the "Export" option + from the "Open" dialog.) If no images are + selected, Tux Paint will NOT attempt to + generate a GIF based on all saved images. + + Pressing [Escape] during export will abort the + process, and return you to the "Slideshow" + dialog. Click "Back" in the slideshow image selection screen to return to the "Open" dialog. + ---------------------------------------------------------------------- + Quit Clicking the "Quit" button, closing the Tux Paint window, or @@ -720,6 +761,8 @@ Available Tools [Shift] + [Control] + [Escape] may be used to quit. (See the "Options" documentation.) + ---------------------------------------------------------------------- + Sound Muting There is no on-screen control button at this time, but by diff --git a/docs/en/html/README.html b/docs/en/html/README.html index ab29bc40f..27230e0a6 100644 --- a/docs/en/html/README.html +++ b/docs/en/html/README.html @@ -347,7 +347,7 @@ The toolbar contains the drawing and editing controls.

- +

+

  • + +

    + Click the "Export" button near the lower right + to export the image to your export folder. + (e.g., "~/Pictures/TuxPaint/") +

    +
    +
    • +

  • The "Slides" button is available in the "Open" - dialog. It displays a list of your saved files, - just like the "Open" dialog. + dialog. It can be used to play a simple animation + within Tux Paint, or a slideshow of pictures. + It can also export an animated GIF based on the + chosen images.

    -

    - Click each of the images you wish to display in a - slideshow-style presentation, one by one. A digit - will appear over each image, letting you know in - which order they will be displayed. -

    +
    +
    Chosing pictures
    +
    +

    + When you enter the "Slides" section of Tux Paint, + it displays a list of your saved files, just like the + "Open" dialog. +

    -

    - You can click a selected image to unselect it (take - it out of your slideshow). -

    +

    + Click each of the images you wish to display in a + slideshow-style presentation, one by one. A digit + will appear over each image, letting you know in + which order they will be displayed. +

    -

    - A sliding scale at the lower left of the screen - (next to the "Play" button) can be used to adjust - the speed of the slideshow, from slowest to - fastest. Choose the leftmost setting to disable - automatic advancement — you will need to press a - key or click to go to the next slide (see below). -

    +

    + You can click a selected image to unselect it (take + it out of your slideshow). Click it again if you + wish to add it to the end of the list. +

    +
    -

    - Note: The slowest setting does not - automatically advance through the slides. Use it - for when you want to step through them manually. -

    +
    Set playback speed
    +
    +

    + A sliding scale at the lower left of the screen + (next to the "Play" button) can be used to adjust + the speed of the slideshow or animated GIF, + from slowest to fastest. Choose the leftmost setting + to disable automatic advancement during playback within + Tux Paint — you will need to press a key or click + to go to the next slide (see below). +

    -

    - When you're ready, click the "Play" button to begin - the slideshow. (Note: If you hadn't selected ANY - images, then ALL images will be played in the - slideshow.) -

    +

    + Note: The slowest setting does not + automatically advance through the slides. Use it + for when you want to step through them manually. + (This does not apply to an exported animated GIF.) +

    +
    -

    - During the slideshow, press [Space], - [Enter] or [Return] or the - [Right Arrow], or click the "Next" - button at the lower left, to manually advance to - the next slide. Press [Left] to go back to - the previous slide. -

    +
    Playback in Tux Paint
    +
    +

    + To play a slideshow within Tux Paint, click the + "Play" button. (Note: If you hadn't selected ANY + images, then ALL of your saved images will be played + in the slideshow!) +

    -

    - Press [Escape], or click the "Back" button - at the lower right, to exit the slideshow and - return to the slideshow image selection screen. -

    +

    + During the slideshow, press [Space], + [Enter] or [Return], or the + [Right Arrow] — or click the "Next" + button at the lower left — to manually advance to + the next slide. Press [Left] to go back to + the previous slide. +

    + +

    + Press [Escape], or click the "Back" button + at the lower right, to exit the slideshow and + return to the slideshow image selection screen. +

    +
    + +
    Exporting an animated GIF
    +
    +

    + + Click the "GIF Export" button near the lower right + to have Tux Paint generate an animated GIF file + based on the selected images. +

    +

    + Note: At least two images must be selected. + (To export a single image, use the "Export" option + from the "Open" dialog.) If no images are selected, + Tux Paint will NOT attempt to generate a GIF + based on all saved images. +

    +

    + Pressing [Escape] during export will abort the process, + and return you to the "Slideshow" dialog. +

    +
    +
    +

    Click "Back" in the slideshow image selection screen to return to the "Open" dialog.


    + +
    @@ -1586,6 +1650,8 @@ "OPTIONS.html">Options" documentation.)


    + +
    diff --git a/docs/html/images/open_export.png b/docs/html/images/open_export.png new file mode 100644 index 000000000..79bc075b7 Binary files /dev/null and b/docs/html/images/open_export.png differ diff --git a/docs/html/images/open_slides_export_gif.png b/docs/html/images/open_slides_export_gif.png new file mode 100644 index 000000000..471bd6af6 Binary files /dev/null and b/docs/html/images/open_slides_export_gif.png differ