Addl fix #323: Rating system
[geeqie.git] / doc / docbook / GuideOptionsGeneral.xml
index a24dc44..5f6288f 100644 (file)
           <guilabel>Cache thumbnails</guilabel>\r
         </term>\r
         <listitem>\r
-          <para>\r
-            Enable this to save thumbnails to disk, subsequent requests for a thumbnail will be faster. Thumbnails are cached into:\r
-            <programlisting>$XDG_CACHE_HOME/geeqie/thumbnails/</programlisting>\r
-            <programlisting>($~/.cache/geeqie/thumbnails/)</programlisting>\r
-            Refer to\r
-            <link linkend="GuideReferenceThumbnails">Thumbnails Reference</link>\r
-            for additional details.\r
-          </para>\r
-        </listitem>\r
-      </varlistentry>\r
-    </variablelist>\r
-    <variablelist>\r
-      <varlistentry>\r
-        <term>\r
-          <guilabel>Use shared thumbnail cache</guilabel>\r
-        </term>\r
-        <listitem>\r
-          <para>\r
-            This will use a thumbnail caching method that is compatible with applications that use the standard thumbnail specification. When this option is enabled thumbnails will be stored in\r
-            <programlisting>$HOME/.thumbnails</programlisting>\r
-          </para>\r
-        </listitem>\r
-      </varlistentry>\r
-    </variablelist>\r
-    <variablelist>\r
-      <varlistentry>\r
-        <term>\r
-          <guilabel>Cache thumbnails into .thumbnails</guilabel>\r
-        </term>\r
-        <listitem>\r
-          <para>\r
-            When enabled, Geeqie attempts to store cached thumbnails closer to the source image. This way multiple users can benefit from a single cache, thereby reducing wasted disk space. The resulting location is the source image's folder, in a sub folder with the name\r
-            <programlisting>.thumbnails</programlisting>\r
-            When the image source folder cannot be written, Geeqie falls back to saving the thumbnail in the user's home folder.\r
-          </para>\r
-        </listitem>\r
-      </varlistentry>\r
-    </variablelist>\r
-    <variablelist>\r
-      <varlistentry>\r
-        <term>\r
-          <guilabel>Faster jpeg thumbnailing</guilabel>\r
-        </term>\r
-        <listitem>\r
-          <para>This will speed up thumbnails generation in some cases, but may reduce the quality</para>\r
+          <para>Enable this to save thumbnails to disk. Subsequent requests for a thumbnail will be faster.</para>\r
+          <variablelist>\r
+            <varlistentry>\r
+              <term>\r
+                <guilabel>Use Geeqie thumbnail style and cache</guilabel>\r
+              </term>\r
+              <listitem>\r
+                <para>Thumbnails are stored in a folder hierachy that mirrors the location of the source images. Thumbnails have the same name as the original appended by the file extension .png.</para>\r
+                <para>\r
+                  The root of the hierachy is:\r
+                  <para>\r
+                    <programlisting>$XDG_CACHE_HOME/geeqie/thumbnails/</programlisting>\r
+                    or, if $XDG_CACHE_HOME is not defined:\r
+                    <programlisting>$HOME/.cache/geeqie/thumbnails/</programlisting>\r
+                  </para>\r
+                </para>\r
+              </listitem>\r
+            </varlistentry>\r
+          </variablelist>\r
+          <variablelist>\r
+            <varlistentry>\r
+              <term>\r
+                <guilabel>Store thumbnails local to image folder (non-standard)</guilabel>\r
+              </term>\r
+              <listitem>\r
+                <para>\r
+                  When enabled, Geeqie attempts to store cached thumbnails closer to the source image. This way multiple users can benefit from a single cache, thereby reducing wasted disk space.\r
+                  <para />\r
+                  Thumbnails have the same name as the original appended by the file extension .png.\r
+                  <para />\r
+                  The resulting location is the source image's folder, in a sub folder with the name\r
+                  <programlisting>.thumbnails</programlisting>\r
+                  <para />\r
+                  When the image source folder cannot be written, Geeqie falls back to saving the thumbnail in the user's home folder.\r
+                </para>\r
+              </listitem>\r
+            </varlistentry>\r
+          </variablelist>\r
+          <variablelist>\r
+            <varlistentry>\r
+              <term>\r
+                <guilabel>Use standard thumbnail style and cache, shared with other applications</guilabel>\r
+              </term>\r
+              <listitem>\r
+                <para>\r
+                  This will use a thumbnail caching method that is compatible with applications that use the standard thumbnail specification. When this option is enabled thumbnails will be stored in:\r
+                  <para>\r
+                    <programlisting>$XDG_CACHE_HOME/thumbnails/</programlisting>\r
+                    or, if $XDG_CACHE_HOME is not defined:\r
+                    <programlisting>$HOME/.cache/thumbnails/</programlisting>\r
+                  </para>\r
+                  <para>\r
+                    All thumbnails are stored in the same folder, with computer-generated filenames. Refer to\r
+                    <link linkend="GuideReferenceThumbnails">Thumbnails Reference</link>\r
+                    for additional details.\r
+                  </para>\r
+                </para>\r
+              </listitem>\r
+            </varlistentry>\r
+          </variablelist>\r
         </listitem>\r
       </varlistentry>\r
     </variablelist>\r
         </listitem>\r
       </varlistentry>\r
     </variablelist>\r
-    <variablelist>\r
-      <varlistentry>\r
-        <term>\r
-          <guilabel>Use xvpics thumbnails when found</guilabel>\r
-        </term>\r
-        <listitem>\r
-          Refer to\r
-          <link linkend="GuideOptionsHidden" endterm="titleGuideOptionsHidden" />\r
-          .\r
-        </listitem>\r
-      </varlistentry>\r
-    </variablelist>\r
+  </section>\r
+  <section id="StarRatingCharacters">\r
+    <title>Star Rating</title>\r
+    <para>The characters used to display the Star Rating are defined here. They are defined as a hexadecimal Unicode character. The complete list of Unicode characters can be found in many places on the Internet.</para>\r
   </section>\r
   <section id="Slideshow">\r
     <title>Slide show</title>\r
     </note>\r
     <variablelist />\r
   </section>\r
+  <section id="OnLineHelpSearch">\r
+    <title>On-line help search</title>\r
+    <para>\r
+      An internet search engine may be used to search the help files on Geeqie's website. The string used to conduct the search is defined here. In most cases it will be in one of two formats:\r
+      <para />\r
+      <code>https://www.search-engine.com/search?q=site:geeqie.org/help</code>\r
+      <para />\r
+      <code>https://www.search-engine.com/?q=site:geeqie.org/help'</code>\r
+    </para>\r
+    <variablelist />\r
+  </section>\r
 </section>\r