Mercurial > bins

view doc/faq.xml @ 6:3021deef1599

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Encoding related fixes * chomp encoding string * reformat else (seems someone hacked it in) * debug print encoding * do not use :utf8 binmode ("re-encode") on written file if the input is _already_ UTF-8
author Peter Gervai <grin@grin.hu>
date Thu, 16 Oct 2008 00:02:14 +0200
parents a84c32f131df
children
line wrap: on
line source

<?xml version="1.0" encoding="LATIN1" ?>
<!DOCTYPE webpage PUBLIC "-//Norman Walsh//DTD Website V2.2//EN" 
 "http://docbook.sourceforge.net/release/website/2.2/website.dtd" [
<!NOTATION XML SYSTEM "xml">
<!ENTITY usage_desc_cli    SYSTEM "usage_desc_cli.xml"    NDATA XML>
<!ENTITY usage_desc_gui SYSTEM "usage_desc_gui.xml" NDATA XML>
<!ENTITY usage_httpd    SYSTEM "usage_httpd.xml"    NDATA XML>
<!ENTITY usage_tools SYSTEM "usage_tools.xml" NDATA XML>
]>

<!-- $Id: faq.xml,v 1.4 2005/08/24 20:04:39 jerome Exp $ -->
<webpage id="faq">
  <config param="rcsdate" value="$Date: 2005/08/24 20:04:39 $"/>
  
  <head>
    <title>FAQ</title> 

    <keywords>SAUTRET, BINS, album, faq</keywords>

  </head>

  <webtoc/>
  
  <section>
    <title>Frequent Asked Questions</title>

    <section>
      <title>What does BINS means ?</title>
      <para>
	BINS Is Not Swigs. BINS is a fork of Swigs, which is not
	maintained anymore.
      </para>
    </section>

    <section>
      <title>Does BINS run on Windows ?</title>
      <para>
	I've never tried, but I don't think. It's written in Perl,
	which is portable, but it uses some *nix specific commands. 
	Though it should not be so difficult to port, or maybe it can
	run with cygwin ?
      </para>
    </section>

    <section>
      <title>When I visualize a big image, it don't fit in my window,
      I must scroll to see it, should I buy a bigger monitor ?</title>
      <para>
	Yes. Or else, you can click on the big image. By default,
	browsers like <ulink
	url="http://www.mozilla-europe.org/en/products/firefox/">firefox</ulink>
	will display it automatically re-sized to your window.
      </para>
    </section>

    <section>
      <title>How can I get bins to automatically rotate destination
      images ?</title>
      <para>
	If your camera has a accelerometer to know which way is up, it
	will be done automatically. If not, you have to set manually
	the orientation of the images on your camera before
	downloading them on you computer. You can also use
	<command><olink
	targetdocent="usage_desc_gui">bins-edit-gui</olink></command>
	to set the orientation of the image. If you don't want to use
	the GUI, this can be done directly in the XML image
	description file. Put (or set if it is already there) the
	following tag in the <sgmltag>&lt;exif></sgmltag> section:
      </para>
      <programlisting>
	<![CDATA[
	<tag name="Orientation" priority="1">
	   left_bot
        </tag>
	]]>
      </programlisting>
      <para>
	Adjust the <literal>left_bot</literal> to the orientation
	of your image (can be <literal>right_top</literal>,
	<literal>left_bot</literal> or <literal>bot_right</literal>).
      </para>
    </section>

    <section>
      <title>Is it possible to give my own order number for each
	image ?</title>
      <para>
	This can be done with two different ways.
      </para>
      <itemizedlist>
	<listitem>
	  <para>
	    You can prefix the name of images and directories with a
	    number. You can use the <olink
	      targetdocent="usage_tools">add_num_prefix tool</olink> to
	    help you. You have the possibility to choose to reverse sort
	    with the <literal>reverseOrder</literal> option or the
	    <literal>-r</literal> command line switch.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    You can put an optional file <filename>album.list</filename>
	    in your albums (a slibling file to
	    <filename>album.xml</filename>) that lists the files in the
	    order you want them displayed. If
	    <filename>album.list</filename> doesn't exist in a directory
	    the sorting by image name is done as usual.
	  </para>
	</listitem>
      </itemizedlist>
    </section>

    <section>
      <title>Does BINS recreate all the albums even if I add or modify
	just a sub-album ? </title>
      <para>
	For each picture, if it doesn't exists in destination album,
	it is processed. If it exists and the date of the source is
	greater than the date of the destination, it is also
	processed. If the destination is more recent, it is left
	unchanged. All the HTML is regenerated when
	<command>bins</command> is run.
      </para>
    </section>

    <section>
      <title>Can I put some HTML in description fields ? </title>
      <para>
	Yes, take a look at the <literal>-m</literal> option of
	<command>bins_edit</command>, see the <ulink
	  url="bins_edit_man.html">man page</ulink>.
      </para>
    </section>

    <section>
      <title>I tried to change the color style (or e-mail, home page,
	other template customisation...) but I can't see any change on
	the generated album, is this a bug ?</title> 

      <para>Some customisation parameters are not implemented in all
	templates. For example, color style is not implemented in
	<literal>joi</literal> templates. Instead, it uses the more
	modern alternate stylesheets mechanism, with the
	<literal>customStyleSheet</literal> parameters, which is not
	supported by the <literal>swigs</literal> template.</para>
    </section>

    <section>
      <title>How can I tell BINS to skip resizing the image (just use
      the default image) ?</title>

      <para>
	Add this in the <filename>album.xml</filename>:
      </para>
      <programlisting>
      <![CDATA[
       <sizes>
          <size name="Full Size" shortname="Full" height="100%" width="100%">
       </sizes>
	]]>
      </programlisting>
      <para>
	Its goes under the <sgmltag>&lt;bins></sgmltag> stanza.
      </para>
    </section>

    <section>
      <title>Having two separate trees (source and HTML) is not
      efficient for my disk space usage, can I use only one tree
      ?</title>

      <para>
	No, but you can use the <literal>linkInsteadOfCopy</literal>
	parameter to avoid any image file duplicate. Also, look at the
	<literal>linkRelative</literal> parameter. All is in the
	<ulink url="bins_man.html">man page</ulink>.
      </para>
    </section>

    <section>
      <title>Having one description file per image is to complex to
      maintain, can I put all description fields for all images in
      just one file ?</title>
      <para>
	Yes, try the <command>bins_addtext</command> <olink
	targetdocent="usage_tools">tool</olink>.
      </para>
    </section>

    <section>
      <title>Why special characters (like those with accents) are not
	correctly rendered ?</title>
      <para>
	Have you copied the <filename>.htaccess</filename> in the root
	of your published album ? See <emphasis>Encoding</emphasis>
	<olink targetdocent="usage_httpd">here</olink>.
      </para>
    </section>

    <section>
      <title>I've generated an album, but I can't find the search
      engine, where is it ?</title>
      <para>
	For now, the search engine is only available with the
	<literal>swigs</literal> templates. Note that the
	<literal>search</literal> link will only show up with a
	browser supporting javascript.
      </para>
    </section>

    <section>
      <title>The "Loading Data" screen took a bit too long to go to
	the search page, is this normal ?</title>
      <para>
	It depends of the size of your album. You can enable
	compression on your web server to reduce this time. See
	<emphasis>Compression</emphasis> <olink targetdocent="usage_httpd"
	  localinfo="usage_httpd.compression">here</olink>.
      </para>
    </section>

    <section>
      <title>Can I have several versions of an album in different
      languages without duplicating the pictures ?</title>
      <para>
	Multi-languages albums are not handled by BINS, but you can do
	this manually with the <literal>mod_rewrite</literal> Apache
	module.
      </para>
      <para>
	Say you have four albums trees corresponding to the same album
	in different languages, in four different directories named
	with the language code:
      </para>
      <programlisting>
	/var/www/album/da/...
	/var/www/album/de/...
	/var/www/album/en/...
	/var/www/album/fr/...
      </programlisting>
      <para>
	To have only one copy of each picture, remove them from all
	trees except one (say <literal>en</literal>):
      </para>
      <programlisting>
	find /var/www/album/{da,de,fr} \( -iname \*.JPG -o -iname \*.jpg -o \
	   -iname \*.gif -o -iname \*.png -o -iname \*.avi -o -iname \*.mpg \) \
	   -exec rm -f {} \;
      </programlisting>
      <para>
	And add a <literal>RewriteRule</literal> to your Apache
	configuration file to redirect all request for an image to the
	<literal>en</literal> tree :
      </para>
      <programlisting>
	RewriteEngine on
	RewriteRule   ^/album/[^e][^n]/(.*\.(jpg|gif|png|avi|mpg))$ \
	              /album/en/$1 [NC]
      </programlisting>
    </section>

    <section>
      <title>I've put some image names in the excludeFiles parameter,
      but it doesn't seems to works. Can you explain how to use this
      stuff ?</title>
      <para>
	This should be set to <emphasis>one</emphasis> regexp, so, for
	example, to ignore two images, the correct parameter should
	looks like :
      </para>
      <programlisting>
      <![CDATA[
        <parameter name="excludeFiles">
            dscn20(89|90)
        </parameter>
	]]>
      </programlisting>
    </section>

    <section>
      <title>Why bins fails with "<computeroutput>Assertion flags == 0
      failed: file "Storable.xs", line 2336 at /usr/local/bin/bins
      line 4213.</computeroutput>" ?</title>
      <para>
	See this <ulink
	url="http://www.email-lists.org/pipermail/bins/2004-January/000117.html">post</ulink>. 
	You can find more details <ulink
	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>.
      </para>
    </section>

    <section>
      <title>What is the syntax used in templates ?</title>
      <para>
	<command>man HTML::Template</command>
      </para>
    </section>

  </section>
</webpage>