git.defcon.no Git - plsgen/blob - README

   1 Perl Simple Gallery Generator v 0.1
   2 ==============================================
   3
   4 Requirements
   5 ------------------------
   6
   7 Perl modules
   8  * Image::ExifTool
   9    http://search.cpan.org/~exiftool/Image-ExifTool-8.15/
  10  * AppConfig
  11    http://search.cpan.org/~abw/AppConfig/
  12  * Getopt::Long (shipped with perl5->)
  13    http://search.cpan.org/~jv/Getopt-Long-2.38/
  14
  15 Programs:
  16  * convert from ImageMagick
  17    http://www.imagemagick.org/
  18  * jhead
  19    http://www.sentex.net/~mwandel/jhead/
  20
  21 And, of course you probably want to publish whis on
  22 a Web server. The generated result is static HTML,
  23 so no requirements at all exist in regard to type
  24 and functionality of HTTP daemon.
  25
  26 Installation
  27 -------------------------
  28
  29 * Place the navigation JavaScript and the CSS file
  30 somewhere convenient on your Web server.
  31
  32 * Place the template files (index.tpl, full.tpl)
  33 where You want, I prefer having them located in
  34 /usr/loca/share/plsgen
  35
  36 * Place the executable script so that execution
  37 is practical. I place it as /usr/local/bin/plsgen so
  38 that I have it in my search path.
  39
  40 * Take a look at the shipped configuration file.
  41 plsgen looks for a config file as /etc/plsgen.cfg,
  42 as ./plsgen.cfg or ../plgen.cfg relative to where
  43 it is executed. Alternatively, the --config option
  44 allows you to override the default locations.
  45 The shipped config lists all configuration options,
  46 along with their default values (used if no config present).
  47
  48 Execution / Use
  49 -------------------------
  50
  51 plsgen is written to be ececuted in a directory filled
  52 with image files, and will create all its data
  53 in this directory. The resulting album will list
  54 all present image files of types JPG, PNG and GIF.
  55 A display-size and thumbnail image will be created
  56 for each image, and will be stored in the sub-directories
  57 view and thumbs (respectively).
  58
  59 Recognized commandline options are:
  60     --title='Your album title'
  61         Sets the album title. Title will be stored in .title
  62         If no title is given, it will be read from .title, if present
  63     --htmlonly
  64         Add this option to only generate HTML files
  65         No image operations will be performed with this option
  66     --config=/path/to/config
  67         Overrides default config file location.
  68         Default is to look for ./plsgen.cfg, then ../plsgen.cfg
  69         and finally /etc/plsgen.cfg.
  70      --help
  71         Displays a list of available commandline options
  72
  73 Todo-list
  74 -------------------------
  75 # TODO: filename.txt for file comments
  76 # TODO: Templating of EXIF
  77 # TODO: Priority/sorting of EXIF tags
  78 # TODO: Possibility for hide/show EXIF
  79 # TODO: RSS support? Delegate that to frontend?
  80 # TODO: Save reference to main-index thumbnail.
  81 # TODO: Clear old generated files and meta on regen
  82 # TODO: Use perlmagick et. al instead of convert/jhead..
  83
  84 Lisencing
  85 -------------------------
  86 Copyright (c) 2010, Jon Langseth
  87 All rights reserved.
  88
  89 Redistribution and use in source and binary forms, with or without
  90 modification, are permitted provided that the following conditions are met:
  91     * Redistributions of source code must retain the above copyright
  92       notice, this list of conditions and the following disclaimer.
  93     * Redistributions in binary form must reproduce the above copyright
  94       notice, this list of conditions and the following disclaimer in the
  95       documentation and/or other materials provided with the distribution.
  96
  97 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  98 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  99 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 100 DISCLAIMED. IN NO EVENT SHALL JON LANGSETH BE LIABLE FOR ANY
 101 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 102 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 103 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 104 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 105 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 106 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.