Mercurial > bins

comparison doc/usage_tools.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_xml SYSTEM "usage_desc_xml.xml" NDATA XML>
6 <!ENTITY faq SYSTEM "faq.xml" NDATA XML>
7 ]>
8 <!-- $Id: usage_tools.xml,v 1.2 2005/08/22 23:53:32 jerome Exp $ -->
9 <webpage id="usage_tools">
10 <config param="rcsdate" value="$Date: 2005/08/22 23:53:32 $"/>
11
12 <head>
13 <title>Tools</title>
14 <keywords>SAUTRET, BINS, album, gallery, photos, EXIF</keywords>
15 </head>
16
17
18 <webtoc/>
19
20 <para>
21 The BINS archive contains a <filename>tools</filename> directory
22 with some small BINS related utilities. Here is a quick
23 documentation about these tools.
24 </para>
25 <section>
26 <title><command>bins_cleanupgallery</command></title>
27 <para>
28 The <command>bins_cleanupgallery</command> script can be use to
29 remove any unused file in your HTML galleries, for example
30 images you have removed from you source tree. Run it without
31 argument for usage information. Note that this script is still
32 experimental, so if it performs wrong, just re-run bins to
33 recreate erased files.
34 </para>
35 <para>
36 This program was written by Jochen Schaeuble
37 <email>psionic&nbsp;@&nbsp;psionic.de</email>.
38 </para>
39 </section>
40
41 <section>
42 <title><command>anti_bins</command></title>
43 <para>
44 This program creates a image files tree for each image size from
45 a BINS generated album. Edit the variables in the configuration
46 section and run it.
47 </para>
48 <para>
49 Note that this program will not work if there is files or
50 directories with space in their name in your tree.
51 </para>
52 </section>
53
54 <section>
55 <title><command>remove_num_prefix</command></title>
56 <para>
57 This script remove numeric prefixes added with
58 <command>add_num_prefix</command>. See below.
59 </para>
60 </section>
61
62 <section>
63 <title><command>add_num_prefix</command></title>
64 <para>
65 <command>add_num_prefix</command> adds incremental numeric
66 prefixes to files. You can use it to order the images in your
67 albums. Note that there is an alternate method to order images
68 and sub-albums, using the <filename>album.list</filename> file
69 (see the <olink localinfo="faq">FAQ</olink>).
70 </para>
71 <programlisting>
72 Usage:
73 add_num_prefix start step files...
74 Add a numeric prefix starting at 'start', incrementing by 'step' on 'files'.
75 </programlisting>
76 <para>
77 For example, say that you have two sets of images, from two
78 digicams. The images are named <filename>IMG_*</filename> for
79 the first one, and <filename>DSC*</filename> for the second one.
80 You want that the first set appears first in the album, and
81 then, you want to change the order of some pictures. You start
82 by adding a prefix on the first set:
83 </para>
84 <programlisting>
85 add_num_prefix 0100 100 IMG_*
86 </programlisting>
87 <para>The images are now named like this:
88 </para>
89 <programlisting>
90 0100_IMG_5103.JPG
91 0200_IMG_5104.JPG
92 0300_IMG_5105.JPG
93 ....
94 2500_IMG_6144.JPG
95 </programlisting>
96 <para>
97 Then do the same on the second set (note that the last image of
98 the first set in now named
99 <filename>2500_IMG_*</filename>):</para>
100 <programlisting>
101 add_num_prefix 2600 100 DSC*
102 </programlisting>
103 <para>
104 Then, you can reorder some of the pictures by changing their
105 prefix. Just rename them with a file manager or on command line:
106 </para>
107 <programlisting>
108 mv 1400_IMG_3450.JPG 0550_IMG_3450.JPG
109 </programlisting>
110 <para>
111 You can also change the order of several pictures with
112 <command>remove_num_prefix</command> and
113 <command>add_num_prefix</command>. For example, to move all
114 pictures between 1200 (included) to 1600 (not included) after
115 the picture number 0100, use the following
116 commands:
117 </para>
118 <programlisting>
119 remove_num_prefix 1[2-5]*_IMG*.JPG
120 add_num_prefix 0110 10 IMG*
121 </programlisting>
122 <para>This remove the prefix of the pictures you want to move, and
123 add a new one beginning after 0100, with a small step. If you have
124 already some XML files in your album, run also:
125 </para>
126 <programlisting>
127 remove_num_prefix 1[2-5]00_*.xml
128 add_num_prefix 0110 10 IMG*
129 </programlisting>
130 </section>
131
132 <section>
133 <title><command>bins_addtext</command></title>
134 <para>
135
136 Adrian Rossiter <email>adrian_r @ teleline.es</email> wrote this
137 program. It can be used to set description fields in an
138 alternate way. Here are the instructions from Adrian:
139 </para>
140
141 <para>
142 I build a directory tree of image albums as normal, but in each
143 album directory I create an
144 <filename>include_images.txt</filename> file containing a list
145 of the album images in the order I want them. I get bins to only
146 consider the images in the
147 <filename>include_images.txt</filename> files by setting the
148 <literal>excludeFiles</literal> parameter in
149 <filename>binsrc</filename> to exclude all files
150 (<filename>.*</filename>).
151 </para>
152 <para>
153 I then add comment lines to the
154 <filename>include_images.txt</filename> files which I process
155 with a <command>bins_addtext</command> to set up the album. At
156 the beginning I add the album details, then after each image I
157 add the title and description. <command>bins_addtext</command>
158 simply calls the <command>bins_edit</command> program with the
159 various details as arguments.
160 </para>
161 <para>
162
163 This is working out reasonably well as I can easily change the
164 album, image text, order of images, etc just by editing one text
165 file. Here is an example include_images.txt file for a one image album:
166 </para>
167 <programlisting>
168 <![CDATA[
169 #Some Album Title (1 line)
170 #Long description of Some Album
171 #(can be many
172 #lines)
173 #|Short description of Some Album (starts after the pipe symbol)
174 #can be many lines, then put another pipe symbol and this is followed
175 #by the sample album image)
176 #|some_image.gif
177
178 some_image.gif
179 #Some Image Title (1 line)
180 #Description of Some Image
181 #can be many lines
182 #and include html <BR>
183 #but you may have to escape certain symbols for the command line e.g.
184 #<A HREF=\"http://www.somesite.com\">Some Site</A>
185 ]]>
186 </programlisting>
187 <para>
188 I call the script <command>bins_addtext</command>. It just takes
189 a list of directories where it looks for
190 <filename>include_images.txt</filename> and processes it. You
191 can use a different file by passing the name with the
192 <literal>-f</literal> option, e.g process
193 <filename>include_images.txt</filename> in the current directory:
194 </para>
195 <programlisting>
196 bin_addtext ./
197 </programlisting>
198 <para>
199 Process album_desc.txt in directories some_album1 and some_album2:
200 </para>
201 <programlisting>
202 bin_addtext -f album_desc.txt some_album1 some_album2
203 </programlisting>
204 </section>
205
206 <section>
207 <title><command>bins_txt2xml</command></title>
208 <para>
209 This is used to convert the old txt description files used in
210 BINS older than 1.1.0 version to the new XML one. Run it with
211 the directory of your image tree as parameter.
212 </para>
213 </section>
214
215 </webpage>