Mercurial > bins
diff README @ 0:a84c32f131df 1.1.29
Import vendor version
author | Peter Gervai <grin@grin.hu> |
---|---|
date | Wed, 15 Oct 2008 23:28:56 +0200 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README Wed Oct 15 23:28:56 2008 +0200 @@ -0,0 +1,211 @@ +========================================================== +BINS Photo Album +Version 1.1.29 +Mar. 17, 2002 +http://bins.sautret.org/ +Jerome@Sautret.org +BINS is free software, licensed under the GNU GPL. See the +COPYING file for details. +========================================================== + + (Une documentation en français est disponible dans + doc/index_fr.html + ou en-ligne sur + http://bins.sautret.org/index_fr.html ) + +A complete documention in HTML format can be found in doc/index.html +or on-line on http://bins.sautret.org. See it for BINS installation +and usage. + +See also the bins(1), bins_edit(1) and bins-edit-gui(1) man pages. + +The aim of BINS is to generate HTML photo albums. +Some of the functionalities of BINS are: +- album can contains other albums (sub albums): the album + can have a tree structure ; +- generation of a thumbnail and of scaled images of each picture ; +- number and size of scaled pictures can be personalized, in pixels + or percentage of the original image ; +- several description fields (date, location, etc...) can be associated with + the pictures ; +- usethe EXIF data structure found on some JPEG (usually, those + produced by digital cameras) to fill automatically some fields (date and + time for example). + +You can see an example of an album generated by BINS at +http://album.sautret.org/ +This my personal album with french I18N. + +BINS (BINS Is Not SWIGS) is a modified version of SWIGS (Structured +Web Image Gallery System). I've made these modifications because I need +them. I tried to contact SWIGS author, but I've got no response, so I +decided to publish my modified version in case someone is interested. + +See ChangeLog file for differences between SWIGS and BINS. + +Migrating from BINS version earlier than 1.1.0 +============================================== + +A new XML format is use for pictures and albums description files in +BINS 1.1.0. There is an utility bins_txt2xml to convert from old +format to new one: + +WARNING: make a backup of your album before proceding to the +migration, just in case something goes wrong. + +Install the new bins and bins_edit program in tour path as explained +in the installation documentation. + +Run the bins_txt2xml with the source directory of the album as a parameter : +bins_txt2xml ~/album + +This will create .xml files for each .txt in your album and its +subalbums. This can take some time... + +You can then run the new bins to check if the new desc files are OK. + +When you are sure all is OK. You can delete the old .txt files: +find ~/album -name \*.txt -exec rm -f {} \; + + +License +======= + +BINS is free software, licensed under the GNU GPL. See COPYING file +for details. + +BINS is Copyright (c) 2001-2004 Jérôme Sautret (Jerome @ Sautret.org). + +Original SWIGS code is Copyright (c) 2000 Brendan McMahan + (mcmahahb @ whitman.edu). + +Initial code based on IDS 0.21 is Copyright (c) John Moose + (moosejc @ muohio.edu). + + +Original SWIGS README: +====================== +_______________________________________________________________________________ +SWIGS README, INSTALL, and DOCUMENTATION +version 0.1.1 +Dec. 31, 2000 +Brendan McMahan (mcmahahb@whitman.edu) +http://people.whitman.edu/~mcmahahb/projects/swigs.html +_______________________________________________________________________________ + +Document Contents: + Requirements + Installation and Usage Overview + SWIGS command line options + File Formats for Image Text Files + File Formats for Album Text Files + +Requirements: + * ImageMagick with PerlMagick (http://www.imagemagick.org/) + * the "Image::Size" Perl module (http://www.cpan.org/). + +Installation and Usage Overview: + 1 Decompress swigs.tar.gz into a directory, say ~/swigs/ + 2 To immediately test your installation, run + ./swigs.pl -t templates/ sample_input/ sample_output/ + 3 The default search location for templates is $HOME/.swigs_templates + You can copy the templates to that location so you don't have to + specificy the -t option everytime you run swigs. + 4 Put the images you want into a directory + (possibly including subdirectories), say ~/pics/ + 5 Edit the HTML templates in ~/swigs/templates/ if desired + 6 Create text files with annotations for each image and directory + if desired. For a description of the file formats, see below. + 7 run ./swigs.pl ~/pics/ ~/swigs-output/ + +SWIGS command line options: + +swigs.pl [-o [src]] [-t template_dir] source_dir target_dir + + -o Tells script to use only one copy of image, using html size specs + (height, width specs in the image tag) for scaled versions. The + default src of the single image is scaled. The possible values are: + "scaled" (make scaled copy of orig in target_dir hierarchy, + sized to max size). Default. + "copied" (copy orig to web dir) + "custom" (use copy if filesize < 1meg + resize, resave, if bigger than 1 meg) + + -t template_dir + directory where html templates are stored. If nothing is + specified, then the direcory is assumed to be templates/ + + -p If this option is given, then prefix ordering numbers on + directories are removed. For example, if one has directories + may, june, and august, they can be renamed 0_may, 1_june, and + 2_august and they will appear in the album in the correct order. + Procceeding numbers followed by an underscore are stripped. + + +File Formats for Image Text Files: + + * If the image is named foo.jpg (or foo.someothersupportedformat) + then the associated description file should be foo.jpg.txt. The + older format, foo.txt, is also still recognized, but should be + avoid do to possible conflicts if you hava a foo.jpg and a foo.png + in the same directory (for example). + + * Each starting or ending tag goes on its own line. Each block of + data between tags may take any number of lines. + +<title> +Type a short title for the image. +</title> + +<event> +The event where the image was taken. +</event> + +<location> +The location where the image was taken. +</location> + +<people> +The names of the people in the image. Should be a comma separated +list without the word "and" to allow for easy parsing in future +versions that allow searching. For example: +Colin, Mike, Steph, Jeff, Marc +</people> + +<date> +The date and time the image was taken. +</date> + +<description> +A description of the image and any other information. +</description> + +File Formats for Album Text Files: + * Each starting or ending tag goes on its own line. Each block of + data between tags may take any number of lines. + * The text file must be called album.txt + * One album.txt file may be included in each directory. + +<title> +A short title for the album. If none is specified, the directory name +is used with underscores replaced by spaces. +</title> + +<sampleimage> +The name of an image (without any path information) in the directory +to use as a representative for the album. Only specified if there are +actually images in the directory. For example: +Image003.jpg +</sampleimage> + +<shortdesc> +A short description of the contents of the album. +</shortdesc> + +<longdesc> +A longer description of the contents of the album. If none is +specified, the short description is used. +</longdesc> + + +