annotate doc/intro.xml @ 9:0f248ad86f9f 1.1.29.e2

bins_edit: try to get encoding stuff right, move it into main
author Peter Gervai <grin@grin.hu>
date Thu, 16 Oct 2008 00:11:14 +0200
parents a84c32f131df
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
1 <?xml version="1.0" encoding="LATIN1" ?>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
2 <!DOCTYPE webpage PUBLIC "-//Norman Walsh//DTD Website V2.2//EN"
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
3 "http://docbook.sourceforge.net/release/website/2.2/website.dtd" [
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
4 <!NOTATION XML SYSTEM "xml">
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
5 <!ENTITY intro SYSTEM "intro.xml" NDATA XML>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
6 ]>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
7 <!-- $Id: intro.xml,v 1.13 2005/08/21 20:12:33 jerome Exp $ -->
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
8 <webpage id="intro">
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
9 <config param="rcsdate" value="$Date: 2005/08/21 20:12:33 $"/>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
10
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
11 <head>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
12 <title>Introduction</title>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
13 <keywords>SAUTRET, BINS, album, gallery, photos, EXIF</keywords>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
14 </head>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
15 <section>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
16 <title>Features</title>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
17
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
18 <para>The aim of BINS is to generate <emphasis role="bold">static
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
19 HTML photo albums</emphasis>. Some of the functionalities of BINS
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
20 are&nbsp;:</para>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
21
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
22 <itemizedlist>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
23
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
24 <listitem><para> generated album is <emphasis
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
25 role="bold">static</emphasis>&nbsp;: it's just plain
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
26 HTML/CSS/Javascript files (Javascript is not mandatory to view
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
27 the album), no need of any dynamic language (php, asp, etc.) nor
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
28 database on server side. Album can be burned on
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
29 CD or DVD.</para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
30
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
31 <listitem><para> album can contains other albums (<emphasis
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
32 role="bold">sub albums</emphasis>): the album can have a tree
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
33 structure&nbsp;; </para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
34
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
35 <listitem><para> generation
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
36 of a <emphasis role="bold">thumbnail</emphasis> and of <emphasis
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
37 role="bold">scaled images</emphasis> for each picture&nbsp;;
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
38 </para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
39
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
40 <listitem><para> generated album appearance
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
41 is <emphasis role="bold">fully customizable</emphasis> by using
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
42 <emphasis role="bold">HTML templates</emphasis> (5 different
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
43 templates sets are currently provided) and <emphasis
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
44 role="bold">configuration parameters</emphasis>: colors, number
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
45 and size of thumbnails per page, number and size of scaled
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
46 pictures (in pixels or percentage of the original image for the
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
47 size), fields to display, etc. Those parameters can be <emphasis
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
48 role="bold">set globally</emphasis> (system wide or per user),
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
49 <emphasis role="bold">per album</emphasis> or sub album or
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
50 <emphasis role="bold">per picture</emphasis> (for example, you
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
51 can change the colors of one sub album or one just one picture
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
52 page in an album by editing its description file)&nbsp;;
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
53 </para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
54
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
55 <listitem><para> several <emphasis
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
56 role="bold">description fields</emphasis> (date, location,
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
57 etc...) can be associated with the pictures (in text or HTML
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
58 format). You can easily add or customize these fields&nbsp;;
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
59 </para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
60
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
61 <listitem><para> description fields can be
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
62 set or modified via a <emphasis role="bold">command line
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
63 interface</emphasis> or a <emphasis role="bold">GTK+/GNOME-based
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
64 GUI</emphasis>&nbsp;; </para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
65
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
66 <listitem><para> A <emphasis role="bold">search engine</emphasis> is
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
67 included in the album&nbsp;: you can find some pictures by searching
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
68 keywords in their description fields.</para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
69
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
70 <listitem><para> Album can be generated from pictures managed by
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
71 <ulink url="http://www.nother.net/zoph/">Zoph</ulink>.
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
72 </para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
73
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
74 <listitem><para> <emphasis role="bold">speed up</emphasis> album
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
75 browsing by performing a clean up of <acronym>HTML</acronym>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
76 code to reduce its size and by <emphasis
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
77 role="bold">pre-loading</emphasis> thumbnails in browser cache
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
78 using <emphasis>JavaScript</emphasis> code&nbsp;;
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
79 </para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
80
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
81 <listitem><para>Exif information and <emphasis role="bold">Digital
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
82 camera support</emphasis>?:
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
83 <itemizedlist>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
84 <listitem><para>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
85 use the EXIF data structure found on some image files
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
86 (usually, those produced by digital cameras) to fill
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
87 automatically some fields (date and time for example).
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
88 </para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
89 <listitem><para>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
90 BINS use the Orientation EXIF tag (which is normally set
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
91 when you rotate a image on you DigiCam) to
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
92 <emphasis role="bold">rotate the picture to correct
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
93 orientation</emphasis>.
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
94 </para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
95 <listitem><para>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
96 For each image, a page provides all information
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
97 available on the picture and the <emphasis role="bold">DigiCam
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
98 settings</emphasis> when the photo was taken.
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
99 </para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
100 <listitem><para>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
101 Additional information are provided for <emphasis
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
102 role="bold">Canon DigiCams</emphasis>.
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
103 </para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
104 <listitem><para>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
105 Tooltips provide information about the meaning of some of
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
106 the fields.
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
107 </para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
108 <listitem><para>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
109 All EXIF information is saved in the XML description file,
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
110 preventing they disappear when the image is
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
111 modified&nbsp;;
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
112 </para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
113 </itemizedlist>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
114 </para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
115
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
116 <listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
117 <para>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
118 <emphasis role="bold">internationalization</emphasis>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
119 (generation of album in different languages) using gettext.
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
120 Current languages supported are Catalan, Dutch, English, Esperanto,
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
121 Finish, French, German, Hungarian, Italian, Japanese, Polish,
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
122 Russian, Spanish and Traditional Chinese &nbsp;;
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
123 </para>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
124 </listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
125 <listitem><para>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
126 <emphasis role="bold">customizable charset
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
127 encoding</emphasis> for HTML generation, including <emphasis
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
128 role="bold">UTF-8 (Unicode)</emphasis> support by
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
129 default. Generation of the Apache
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
130 <filename>.htaccess</filename> file for correct encoding
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
131 charset in HTTP headers&nbsp;;
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
132 </para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
133 <listitem><para>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
134 use of <emphasis role="bold">XML files</emphasis> to save user
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
135 description of pictures and albums/subalbums and Exif data
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
136 from image file&nbsp;;
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
137 </para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
138 <listitem><para>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
139 handle correctly file and directory names with spaces or
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
140 other odd characters (excepted '/'), and create
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
141 <emphasis role="bold">valid escaped URLs</emphasis>&nbsp;;
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
142 </para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
143
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
144 <listitem><para> generate <emphasis role="bold">valid
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
145 HTML/XHTML</emphasis> code. The level of HTML depends of the
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
146 style used. Some of the styles are valid, table free
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
147 XHTML.</para></listitem>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
148 </itemizedlist>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
149
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
150 </section>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
151 <section>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
152 <title>History</title>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
153
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
154 <para>BINS (BINS Is Not SWIGS) is a modified version of <ulink
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
155 url="http://sourceforge.net/projects/swigs/">SWIGS</ulink>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
156 (Structured Web Image Gallery System). I've made these
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
157 modifications because I need them. I tried to contact SWIGS
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
158 author, but I've got no response, so I decided to publish my
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
159 modified version in case someone is interested.</para>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
160
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
161 <para>See <ulink url="ChangeLog">ChangeLog</ulink> file for
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
162 differences between SWIGS and BINS and new functionalities of each
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
163 version.</para>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
164 </section>
a84c32f131df Import vendor version
Peter Gervai <grin@grin.hu>
parents:
diff changeset
165 </webpage>