Mercurial > bins

comparison doc/faq.xml @ 0:a84c32f131df 1.1.29

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import vendor version
author Peter Gervai <grin@grin.hu>
date Wed, 15 Oct 2008 23:28:56 +0200
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:a84c32f131df
1 <?xml version="1.0" encoding="LATIN1" ?>
2 <!DOCTYPE webpage PUBLIC "-//Norman Walsh//DTD Website V2.2//EN"
3 "http://docbook.sourceforge.net/release/website/2.2/website.dtd" [
4 <!NOTATION XML SYSTEM "xml">
5 <!ENTITY usage_desc_cli SYSTEM "usage_desc_cli.xml" NDATA XML>
6 <!ENTITY usage_desc_gui SYSTEM "usage_desc_gui.xml" NDATA XML>
7 <!ENTITY usage_httpd SYSTEM "usage_httpd.xml" NDATA XML>
8 <!ENTITY usage_tools SYSTEM "usage_tools.xml" NDATA XML>
9 ]>
10
11 <!-- $Id: faq.xml,v 1.4 2005/08/24 20:04:39 jerome Exp $ -->
12 <webpage id="faq">
13 <config param="rcsdate" value="$Date: 2005/08/24 20:04:39 $"/>
14
15 <head>
16 <title>FAQ</title>
17
18 <keywords>SAUTRET, BINS, album, faq</keywords>
19
20 </head>
21
22 <webtoc/>
23
24 <section>
25 <title>Frequent Asked Questions</title>
26
27 <section>
28 <title>What does BINS means ?</title>
29 <para>
30 BINS Is Not Swigs. BINS is a fork of Swigs, which is not
31 maintained anymore.
32 </para>
33 </section>
34
35 <section>
36 <title>Does BINS run on Windows ?</title>
37 <para>
38 I've never tried, but I don't think. It's written in Perl,
39 which is portable, but it uses some *nix specific commands.
40 Though it should not be so difficult to port, or maybe it can
41 run with cygwin ?
42 </para>
43 </section>
44
45 <section>
46 <title>When I visualize a big image, it don't fit in my window,
47 I must scroll to see it, should I buy a bigger monitor ?</title>
48 <para>
49 Yes. Or else, you can click on the big image. By default,
50 browsers like <ulink
51 url="http://www.mozilla-europe.org/en/products/firefox/">firefox</ulink>
52 will display it automatically re-sized to your window.
53 </para>
54 </section>
55
56 <section>
57 <title>How can I get bins to automatically rotate destination
58 images ?</title>
59 <para>
60 If your camera has a accelerometer to know which way is up, it
61 will be done automatically. If not, you have to set manually
62 the orientation of the images on your camera before
63 downloading them on you computer. You can also use
64 <command><olink
65 targetdocent="usage_desc_gui">bins-edit-gui</olink></command>
66 to set the orientation of the image. If you don't want to use
67 the GUI, this can be done directly in the XML image
68 description file. Put (or set if it is already there) the
69 following tag in the <sgmltag>&lt;exif></sgmltag> section:
70 </para>
71 <programlisting>
72 <![CDATA[
73 <tag name="Orientation" priority="1">
74 left_bot
75 </tag>
76 ]]>
77 </programlisting>
78 <para>
79 Adjust the <literal>left_bot</literal> to the orientation
80 of your image (can be <literal>right_top</literal>,
81 <literal>left_bot</literal> or <literal>bot_right</literal>).
82 </para>
83 </section>
84
85 <section>
86 <title>Is it possible to give my own order number for each
87 image ?</title>
88 <para>
89 This can be done with two different ways.
90 </para>
91 <itemizedlist>
92 <listitem>
93 <para>
94 You can prefix the name of images and directories with a
95 number. You can use the <olink
96 targetdocent="usage_tools">add_num_prefix tool</olink> to
97 help you. You have the possibility to choose to reverse sort
98 with the <literal>reverseOrder</literal> option or the
99 <literal>-r</literal> command line switch.
100 </para>
101 </listitem>
102 <listitem>
103 <para>
104 You can put an optional file <filename>album.list</filename>
105 in your albums (a slibling file to
106 <filename>album.xml</filename>) that lists the files in the
107 order you want them displayed. If
108 <filename>album.list</filename> doesn't exist in a directory
109 the sorting by image name is done as usual.
110 </para>
111 </listitem>
112 </itemizedlist>
113 </section>
114
115 <section>
116 <title>Does BINS recreate all the albums even if I add or modify
117 just a sub-album ? </title>
118 <para>
119 For each picture, if it doesn't exists in destination album,
120 it is processed. If it exists and the date of the source is
121 greater than the date of the destination, it is also
122 processed. If the destination is more recent, it is left
123 unchanged. All the HTML is regenerated when
124 <command>bins</command> is run.
125 </para>
126 </section>
127
128 <section>
129 <title>Can I put some HTML in description fields ? </title>
130 <para>
131 Yes, take a look at the <literal>-m</literal> option of
132 <command>bins_edit</command>, see the <ulink
133 url="bins_edit_man.html">man page</ulink>.
134 </para>
135 </section>
136
137 <section>
138 <title>I tried to change the color style (or e-mail, home page,
139 other template customisation...) but I can't see any change on
140 the generated album, is this a bug ?</title>
141
142 <para>Some customisation parameters are not implemented in all
143 templates. For example, color style is not implemented in
144 <literal>joi</literal> templates. Instead, it uses the more
145 modern alternate stylesheets mechanism, with the
146 <literal>customStyleSheet</literal> parameters, which is not
147 supported by the <literal>swigs</literal> template.</para>
148 </section>
149
150 <section>
151 <title>How can I tell BINS to skip resizing the image (just use
152 the default image) ?</title>
153
154 <para>
155 Add this in the <filename>album.xml</filename>:
156 </para>
157 <programlisting>
158 <![CDATA[
159 <sizes>
160 <size name="Full Size" shortname="Full" height="100%" width="100%">
161 </sizes>
162 ]]>
163 </programlisting>
164 <para>
165 Its goes under the <sgmltag>&lt;bins></sgmltag> stanza.
166 </para>
167 </section>
168
169 <section>
170 <title>Having two separate trees (source and HTML) is not
171 efficient for my disk space usage, can I use only one tree
172 ?</title>
173
174 <para>
175 No, but you can use the <literal>linkInsteadOfCopy</literal>
176 parameter to avoid any image file duplicate. Also, look at the
177 <literal>linkRelative</literal> parameter. All is in the
178 <ulink url="bins_man.html">man page</ulink>.
179 </para>
180 </section>
181
182 <section>
183 <title>Having one description file per image is to complex to
184 maintain, can I put all description fields for all images in
185 just one file ?</title>
186 <para>
187 Yes, try the <command>bins_addtext</command> <olink
188 targetdocent="usage_tools">tool</olink>.
189 </para>
190 </section>
191
192 <section>
193 <title>Why special characters (like those with accents) are not
194 correctly rendered ?</title>
195 <para>
196 Have you copied the <filename>.htaccess</filename> in the root
197 of your published album ? See <emphasis>Encoding</emphasis>
198 <olink targetdocent="usage_httpd">here</olink>.
199 </para>
200 </section>
201
202 <section>
203 <title>I've generated an album, but I can't find the search
204 engine, where is it ?</title>
205 <para>
206 For now, the search engine is only available with the
207 <literal>swigs</literal> templates. Note that the
208 <literal>search</literal> link will only show up with a
209 browser supporting javascript.
210 </para>
211 </section>
212
213 <section>
214 <title>The "Loading Data" screen took a bit too long to go to
215 the search page, is this normal ?</title>
216 <para>
217 It depends of the size of your album. You can enable
218 compression on your web server to reduce this time. See
219 <emphasis>Compression</emphasis> <olink targetdocent="usage_httpd"
220 localinfo="usage_httpd.compression">here</olink>.
221 </para>
222 </section>
223
224 <section>
225 <title>Can I have several versions of an album in different
226 languages without duplicating the pictures ?</title>
227 <para>
228 Multi-languages albums are not handled by BINS, but you can do
229 this manually with the <literal>mod_rewrite</literal> Apache
230 module.
231 </para>
232 <para>
233 Say you have four albums trees corresponding to the same album
234 in different languages, in four different directories named
235 with the language code:
236 </para>
237 <programlisting>
238 /var/www/album/da/...
239 /var/www/album/de/...
240 /var/www/album/en/...
241 /var/www/album/fr/...
242 </programlisting>
243 <para>
244 To have only one copy of each picture, remove them from all
245 trees except one (say <literal>en</literal>):
246 </para>
247 <programlisting>
248 find /var/www/album/{da,de,fr} \( -iname \*.JPG -o -iname \*.jpg -o \
249 -iname \*.gif -o -iname \*.png -o -iname \*.avi -o -iname \*.mpg \) \
250 -exec rm -f {} \;
251 </programlisting>
252 <para>
253 And add a <literal>RewriteRule</literal> to your Apache
254 configuration file to redirect all request for an image to the
255 <literal>en</literal> tree :
256 </para>
257 <programlisting>
258 RewriteEngine on
259 RewriteRule ^/album/[^e][^n]/(.*\.(jpg|gif|png|avi|mpg))$ \
260 /album/en/$1 [NC]
261 </programlisting>
262 </section>
263
264 <section>
265 <title>I've put some image names in the excludeFiles parameter,
266 but it doesn't seems to works. Can you explain how to use this
267 stuff ?</title>
268 <para>
269 This should be set to <emphasis>one</emphasis> regexp, so, for
270 example, to ignore two images, the correct parameter should
271 looks like :
272 </para>
273 <programlisting>
274 <![CDATA[
275 <parameter name="excludeFiles">
276 dscn20(89|90)
277 </parameter>
278 ]]>
279 </programlisting>
280 </section>
281
282 <section>
283 <title>Why bins fails with "<computeroutput>Assertion flags == 0
284 failed: file "Storable.xs", line 2336 at /usr/local/bin/bins
285 line 4213.</computeroutput>" ?</title>
286 <para>
287 See this <ulink
288 url="http://www.email-lists.org/pipermail/bins/2004-January/000117.html">post</ulink>.
289 You can find more details <ulink
290 url="http://www.google.fr/search?q=site:email-lists.org+Storable.xs&amp;num=20&amp;hl=fr&amp;lr=&amp;ie=UTF-8&amp;oe=utf-8&amp;filter=0">here</ulink>.
291 </para>
292 </section>
293
294 <section>
295 <title>What is the syntax used in templates ?</title>
296 <para>
297 <command>man HTML::Template</command>
298 </para>
299 </section>
300
301 </section>
302 </webpage>
303