


                  - GalleryBuilder  by Mario Corsolini -


                         Version 2.01  for Python

                            URL: www.oipaz.net
                          eMail: OiPaz@oipaz.net

                          © 2015 Mario Corsolini




 -- 0. Table of Contents -----------------------------------------------


    0. Table of Contents
    1. Introduction
    2. Licence
    3. System Requirements
    4. How to Install
    5. How to Use
    6. How to Uninstall
    7. Feedback, Suggestions, Bug-Reports
    8. Release History
    9. Acknowledgements




 -- 1. Introduction ----------------------------------------------------


    GalleryBuilder  is a command-line tool that builds  HTML galleries
    using custom templates, images, thumbnails and comments.




 -- 2. Licence ---------------------------------------------------------


    GalleryBuilder is licenced under the Creative Commons Attribution-
    NonCommercial-NoDerivatives 4.0 International Licence (CC BY-NC-ND
    4.0). To view a copy of the licence, visit:
            http://creativecommons.org/licenses/by-nc-nd/4.0/




 -- 3. System Requirements ---------------------------------------------


    GalleryBuilder  needs  Python  (either 2 or 3)  and it should work
    under most existing operating systems.




 -- 4. How to Install --------------------------------------------------


    Just unzip and run it!




 -- 5. How to Use ------------------------------------------------------


    Usage  of  GalleryBuilder.py   (parameters  between  brackets  are
    optional):
        GalleryBuilder.py -i:path [options]

    Options:
        -i:path     address of the index template (required);
        -d:path     directory   containing  images  (either  .jpeg  or
                    .png), thumbnails  (.jpg)  and  optional  comments
                    (.txt,  but  HTML  tags are allowed); path must be
                    relative to the current directory;
        -f:file     creates  a  full  HTML  gallery  using  "file"  as
                    template;
        -l:file     address  of  the  index  page (to be used with -f,
                    relative to -d:path; default: _GB_.html);
        -t:title    title  of  the index page (to be used with -f, use
                    quotes; default: "NO Title!");
        -s:n        side length of thumbnails, in pixels (they must be
                    square .jpg images; default: n=200);
        -e          exit without asking for confirmation;
        -h          print these notes and exit.

    Any other parameter will be ignored.
    The parameters are case sensitive, the order is irrelevant.

    Inside the index template these meta commands are available:
    #GB-Index_title#
        the title of the index page;
    #GB-TheGallery#
        the  complete gallery of available images, with thumbnails and
        (optional) comments.

    Inside the picture template these meta commands are available:
    #GB-Filename#
        file name of the current image, without extension;
    #GB-Filename.ext#
        file name of the current image, with extension;
    #GB-Index_img#
        link the thumbnail of the current image inside the index page;
    #GB-Index_link#
        link to the index page;
    #GB-Index_title#
        the title of the index page;
    #GB-First#
        link to the first image of the gallery;
    #GB-Previous#
        link to the previous image of the gallery;
    #GB-Next#
        link to the next image of the gallery;
    #GB-Last#
        link to the last image of the gallery;
    #GB-#n/N#
        the  number  of the current image / the total number of images
        in the gallery;
    #GB-Asx#
        link  to  the  previous  image of the gallery, mapped into the
        left part of the currently shown image;
    #GB-Adx#
        link  to  the next image of the gallery, mapped into the right
        part of the currently shown image.

    By  way  of  example,  the "Galleria [Personale]" available at the
    address   http://www.oipaz.net/GalleriaPersonale.html   was  built
    using  the  templates  included  in  this  distribution  and these
    options:
        -i:GalleryBuilder_Index.htm
        -d:IMG/GalleriaPersonale/
        -f:GalleryBuilder_Picture.htm
        -l:../../GalleriaPersonale.html
        -t:"Galleria [Personale]"




 -- 6. How to Uninstall ------------------------------------------------


    If,  for some reason,  you do not like  GalleryBuilder: delete its
    folder and any shortcut you created.
    That will completely uninstall GalleryBuilder. :-(

    GalleryBuilder  does  NOT  leave any rubbish on the HD or Registry
    but, if you had to install Python,  you may remove it  through the
    usual  Add/Remove  applet of the Control Panel (be careful: it may
    be used by other applications!).




 -- 7. Feedback, Suggestions, Bug-Reports ------------------------------


    Any  comments,  suggestions  and  (most  of  all)  bug-reports are
    welcome. Please use the eMail address: OiPaz@oipaz.net
    It is advisable to specify "GalleryBuilder" in the  subject field,
    to  report  the  version  of Python in use and some info about the
    operating system of your computer.




 -- 8. Release History -------------------------------------------------


    Version 2.01 - September 13th, 2015
        Improved navigation meta commands.
        Meta command #GB-MainIndex# renamed as #GB-TheGallery#.
        Option -a not any more officially supported.
        Minor cosmetic changes.

    Version 2.00 - July 22nd, 2015
        First public release.




 -- 9. Acknowledgements ------------------------------------------------


    The author wants to thank all the people who helped him with ideas
    and valuable suggestions, and the beta testers!

    And, obviously, thanks to Laura!!

    Well, that's all about it, happy playing!!!


 -----------------------------------------------------------------------
