annotate doc/docbook/GuideReferenceThumbnails.xml @ 1773:2ae81598b254

scripts for converting wiki documentation to docbook

<?xml version="1.0" encoding="utf-8"?>
<section id="GuideReferenceThumbnails">
    <title>
      Thumbnails
    </title>
    <para>
      Note: This page only refers the Geeqie thumbnail caching mechanism, the shared thumbnail cache mechanism is not explained here.
    </para>
    <para/><section id="Format"><title>
      Format
    </title>
    <para>
      Thumbnails are stored in PNG image format. The thumbnail name is the name of the source image with “.png” appended.
    </para>
    <para>
      The modification time (mtime) of the thumbnail is set to match the source file. Thumbnails are regenerated when the timestamps of the thumbnail and source file do not match.
    </para>
    <para/></section><section id="Location"><title>
      Location
    </title>
    <para>
      Thumbnails are stored in:
    </para>
    <para>
      <literal>($HOME)/.geeqie/thumbnails</literal>
    </para>
    <para>
      The directory structure of the thumbnail cache duplicates the location of the source files, for example a source file with the name:
    </para>
    <para>
      <literal>/path/to/image.jpg</literal>
    </para>
    <para>
      will store the thumbnail in:
    </para>
    <para>
      <literal>($HOME)/.geeqie/thumbnails/path/to/image.jpg.png</literal>
    </para>
    <para>
      When thumbnails are to be stored local to the source file, the thumbnail will be placed in:
    </para>
    <para>
      <literal>/path/to/.thumbnails/image.jpg.png</literal>
    </para>
    <para>
      Local thumbnail caching is enabled with the option “Cache thumbnails into .thumbnails” on the <link linkend="GuideOptionsGeneral">General</link> tab of the options dialog. If it is not possible to store the thumbnail local to the source file (usually due to no write permissions), Geeqie will fall back to saving the thumbnail in the user's ($HOME)/.geeqie/thumbnails folder.
    </para>
    <para/></section><section id="Size"><title>
      Size
    </title>
    <para>
      Geeqie allows the following sizes for thumbnails:
    </para>
    <para>
      24x24, 32x32, 48x48, 64x64, 96x72, 96x96, 129x96, 128x128, 160x120, 160x160, 192x144, 192x192, 256x192, 256x256
    </para>
    <para>
      The thumbnail is scaled to fit within the preferred size maintaining the aspect ratio. Thumbnails are not cached for images that are equal to or smaller than the preferred thumbnail size.
    </para>
    <para>
      When a cached thumbnail's width and height do not match the preferred size, the thumbnail is regenerated.
    </para>
  <para/></section></section>