|
0
|
1 ========================================================== |
|
|
2 BINS Photo Album |
|
|
3 Version 1.1.29 |
|
|
4 Mar. 17, 2002 |
|
|
5 http://bins.sautret.org/ |
|
|
6 Jerome@Sautret.org |
|
|
7 BINS is free software, licensed under the GNU GPL. See the |
|
|
8 COPYING file for details. |
|
|
9 ========================================================== |
|
|
10 |
|
|
11 (Une documentation en fran?ais est disponible dans |
|
|
12 doc/index_fr.html |
|
|
13 ou en-ligne sur |
|
|
14 http://bins.sautret.org/index_fr.html ) |
|
|
15 |
|
|
16 A complete documention in HTML format can be found in doc/index.html |
|
|
17 or on-line on http://bins.sautret.org. See it for BINS installation |
|
|
18 and usage. |
|
|
19 |
|
|
20 See also the bins(1), bins_edit(1) and bins-edit-gui(1) man pages. |
|
|
21 |
|
|
22 The aim of BINS is to generate HTML photo albums. |
|
|
23 Some of the functionalities of BINS are: |
|
|
24 - album can contains other albums (sub albums): the album |
|
|
25 can have a tree structure ; |
|
|
26 - generation of a thumbnail and of scaled images of each picture ; |
|
|
27 - number and size of scaled pictures can be personalized, in pixels |
|
|
28 or percentage of the original image ; |
|
|
29 - several description fields (date, location, etc...) can be associated with |
|
|
30 the pictures ; |
|
|
31 - usethe EXIF data structure found on some JPEG (usually, those |
|
|
32 produced by digital cameras) to fill automatically some fields (date and |
|
|
33 time for example). |
|
|
34 |
|
|
35 You can see an example of an album generated by BINS at |
|
|
36 http://album.sautret.org/ |
|
|
37 This my personal album with french I18N. |
|
|
38 |
|
|
39 BINS (BINS Is Not SWIGS) is a modified version of SWIGS (Structured |
|
|
40 Web Image Gallery System). I've made these modifications because I need |
|
|
41 them. I tried to contact SWIGS author, but I've got no response, so I |
|
|
42 decided to publish my modified version in case someone is interested. |
|
|
43 |
|
|
44 See ChangeLog file for differences between SWIGS and BINS. |
|
|
45 |
|
|
46 Migrating from BINS version earlier than 1.1.0 |
|
|
47 ============================================== |
|
|
48 |
|
|
49 A new XML format is use for pictures and albums description files in |
|
|
50 BINS 1.1.0. There is an utility bins_txt2xml to convert from old |
|
|
51 format to new one: |
|
|
52 |
|
|
53 WARNING: make a backup of your album before proceding to the |
|
|
54 migration, just in case something goes wrong. |
|
|
55 |
|
|
56 Install the new bins and bins_edit program in tour path as explained |
|
|
57 in the installation documentation. |
|
|
58 |
|
|
59 Run the bins_txt2xml with the source directory of the album as a parameter : |
|
|
60 bins_txt2xml ~/album |
|
|
61 |
|
|
62 This will create .xml files for each .txt in your album and its |
|
|
63 subalbums. This can take some time... |
|
|
64 |
|
|
65 You can then run the new bins to check if the new desc files are OK. |
|
|
66 |
|
|
67 When you are sure all is OK. You can delete the old .txt files: |
|
|
68 find ~/album -name \*.txt -exec rm -f {} \; |
|
|
69 |
|
|
70 |
|
|
71 License |
|
|
72 ======= |
|
|
73 |
|
|
74 BINS is free software, licensed under the GNU GPL. See COPYING file |
|
|
75 for details. |
|
|
76 |
|
|
77 BINS is Copyright (c) 2001-2004 J?r?me Sautret (Jerome @ Sautret.org). |
|
|
78 |
|
|
79 Original SWIGS code is Copyright (c) 2000 Brendan McMahan |
|
|
80 (mcmahahb @ whitman.edu). |
|
|
81 |
|
|
82 Initial code based on IDS 0.21 is Copyright (c) John Moose |
|
|
83 (moosejc @ muohio.edu). |
|
|
84 |
|
|
85 |
|
|
86 Original SWIGS README: |
|
|
87 ====================== |
|
|
88 _______________________________________________________________________________ |
|
|
89 SWIGS README, INSTALL, and DOCUMENTATION |
|
|
90 version 0.1.1 |
|
|
91 Dec. 31, 2000 |
|
|
92 Brendan McMahan (mcmahahb@whitman.edu) |
|
|
93 http://people.whitman.edu/~mcmahahb/projects/swigs.html |
|
|
94 _______________________________________________________________________________ |
|
|
95 |
|
|
96 Document Contents: |
|
|
97 Requirements |
|
|
98 Installation and Usage Overview |
|
|
99 SWIGS command line options |
|
|
100 File Formats for Image Text Files |
|
|
101 File Formats for Album Text Files |
|
|
102 |
|
|
103 Requirements: |
|
|
104 * ImageMagick with PerlMagick (http://www.imagemagick.org/) |
|
|
105 * the "Image::Size" Perl module (http://www.cpan.org/). |
|
|
106 |
|
|
107 Installation and Usage Overview: |
|
|
108 1 Decompress swigs.tar.gz into a directory, say ~/swigs/ |
|
|
109 2 To immediately test your installation, run |
|
|
110 ./swigs.pl -t templates/ sample_input/ sample_output/ |
|
|
111 3 The default search location for templates is $HOME/.swigs_templates |
|
|
112 You can copy the templates to that location so you don't have to |
|
|
113 specificy the -t option everytime you run swigs. |
|
|
114 4 Put the images you want into a directory |
|
|
115 (possibly including subdirectories), say ~/pics/ |
|
|
116 5 Edit the HTML templates in ~/swigs/templates/ if desired |
|
|
117 6 Create text files with annotations for each image and directory |
|
|
118 if desired. For a description of the file formats, see below. |
|
|
119 7 run ./swigs.pl ~/pics/ ~/swigs-output/ |
|
|
120 |
|
|
121 SWIGS command line options: |
|
|
122 |
|
|
123 swigs.pl [-o [src]] [-t template_dir] source_dir target_dir |
|
|
124 |
|
|
125 -o Tells script to use only one copy of image, using html size specs |
|
|
126 (height, width specs in the image tag) for scaled versions. The |
|
|
127 default src of the single image is scaled. The possible values are: |
|
|
128 "scaled" (make scaled copy of orig in target_dir hierarchy, |
|
|
129 sized to max size). Default. |
|
|
130 "copied" (copy orig to web dir) |
|
|
131 "custom" (use copy if filesize < 1meg |
|
|
132 resize, resave, if bigger than 1 meg) |
|
|
133 |
|
|
134 -t template_dir |
|
|
135 directory where html templates are stored. If nothing is |
|
|
136 specified, then the direcory is assumed to be templates/ |
|
|
137 |
|
|
138 -p If this option is given, then prefix ordering numbers on |
|
|
139 directories are removed. For example, if one has directories |
|
|
140 may, june, and august, they can be renamed 0_may, 1_june, and |
|
|
141 2_august and they will appear in the album in the correct order. |
|
|
142 Procceeding numbers followed by an underscore are stripped. |
|
|
143 |
|
|
144 |
|
|
145 File Formats for Image Text Files: |
|
|
146 |
|
|
147 * If the image is named foo.jpg (or foo.someothersupportedformat) |
|
|
148 then the associated description file should be foo.jpg.txt. The |
|
|
149 older format, foo.txt, is also still recognized, but should be |
|
|
150 avoid do to possible conflicts if you hava a foo.jpg and a foo.png |
|
|
151 in the same directory (for example). |
|
|
152 |
|
|
153 * Each starting or ending tag goes on its own line. Each block of |
|
|
154 data between tags may take any number of lines. |
|
|
155 |
|
|
156 <title> |
|
|
157 Type a short title for the image. |
|
|
158 </title> |
|
|
159 |
|
|
160 <event> |
|
|
161 The event where the image was taken. |
|
|
162 </event> |
|
|
163 |
|
|
164 <location> |
|
|
165 The location where the image was taken. |
|
|
166 </location> |
|
|
167 |
|
|
168 <people> |
|
|
169 The names of the people in the image. Should be a comma separated |
|
|
170 list without the word "and" to allow for easy parsing in future |
|
|
171 versions that allow searching. For example: |
|
|
172 Colin, Mike, Steph, Jeff, Marc |
|
|
173 </people> |
|
|
174 |
|
|
175 <date> |
|
|
176 The date and time the image was taken. |
|
|
177 </date> |
|
|
178 |
|
|
179 <description> |
|
|
180 A description of the image and any other information. |
|
|
181 </description> |
|
|
182 |
|
|
183 File Formats for Album Text Files: |
|
|
184 * Each starting or ending tag goes on its own line. Each block of |
|
|
185 data between tags may take any number of lines. |
|
|
186 * The text file must be called album.txt |
|
|
187 * One album.txt file may be included in each directory. |
|
|
188 |
|
|
189 <title> |
|
|
190 A short title for the album. If none is specified, the directory name |
|
|
191 is used with underscores replaced by spaces. |
|
|
192 </title> |
|
|
193 |
|
|
194 <sampleimage> |
|
|
195 The name of an image (without any path information) in the directory |
|
|
196 to use as a representative for the album. Only specified if there are |
|
|
197 actually images in the directory. For example: |
|
|
198 Image003.jpg |
|
|
199 </sampleimage> |
|
|
200 |
|
|
201 <shortdesc> |
|
|
202 A short description of the contents of the album. |
|
|
203 </shortdesc> |
|
|
204 |
|
|
205 <longdesc> |
|
|
206 A longer description of the contents of the album. If none is |
|
|
207 specified, the short description is used. |
|
|
208 </longdesc> |
|
|
209 |
|
|
210 |
|
|
211 |
