changeset 2668:e2f68d2ff2a0

Additional pixbuf loader documentation Also update web/help files
author Colin Clark <colin.clark@cclark.uk>
date Thu, 16 Nov 2017 10:07:31 +0000
parents 07fe0499a310
children 598aadefd022
files README.md doc/docbook/GuideReferencePixbufLoaders.xml web/help/GuideMainWindowFolderPane.html web/help/GuideMainWindowMenus.html web/help/GuideOptionsBehavior.html web/help/GuideOptionsImage.html web/help/GuideReferencePixbufLoaders.html web/installing.html
diffstat 8 files changed, 142 insertions(+), 49 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Mon Nov 13 10:41:19 2017 +0000
+++ b/README.md	Thu Nov 16 10:07:31 2017 +0000
@@ -204,6 +204,14 @@
         enabled by default
         disable with configure option: --disable-lua
 
+    librsvg2-common
+        for displaying .svg images
+
+    libwmf0.2-7-gtk
+        for displaying .wmf images
+
+    (see also "Additional pixbuf loaders" in the References section of the Help file)
+
     awk
         when running Geeqie, to use the geo-decode function
 
--- a/doc/docbook/GuideReferencePixbufLoaders.xml	Mon Nov 13 10:41:19 2017 +0000
+++ b/doc/docbook/GuideReferencePixbufLoaders.xml	Thu Nov 16 10:07:31 2017 +0000
@@ -1,11 +1,16 @@
 <?xml version="1.0" encoding="utf-8"?>
 <section id="GuideReferencePixbufLoaders">
   <title id="titleGuideReferencePixbufLoaders">Additional pixbuf loaders</title>
-  <para>
-    Geeqie is limited to displaying files for which there are existing pixbuf loaders. In addition to the standard ones included with most distributions, the following loaders may also work.
-    <para />
-    However, you are required to compile and install them yourself.
-  </para>
+  <para>Geeqie can display files for which there are existing pixbuf loaders. In addition to the standard ones included with most distributions, the following loaders may also be available to you.</para>
+  <para>However, in some cases you are required to compile and install them yourself.</para>
+  <section id="svg">
+    <title>svg</title>
+    <para>librsvg2-common</para>
+  </section>
+  <section id="wmf">
+    <title>wmf</title>
+    <para>libwmf0.2-7-gtk</para>
+  </section>
   <section id="webp">
     <title>webp</title>
     <para>
--- a/web/help/GuideMainWindowFolderPane.html	Mon Nov 13 10:41:19 2017 +0000
+++ b/web/help/GuideMainWindowFolderPane.html	Thu Nov 16 10:07:31 2017 +0000
@@ -860,31 +860,42 @@
 <td class="td-colsep td-rowsep"></td>
 <td class="td-colsep td-rowsep">Copy path</td>
 <td class="td-rowsep">
-              <span class="para">Copy sjkhsdlfjhvfljhDelete file or folder</span>
+              <span class="para">
+                Copy selected item-path(s) to clipboard
+                <a name="-noteref-ref1"></a><sup><a class="footnote" href="#ref1">1</a></sup>
+                . Each data item copied will be enclosed in quotes.
+              </span>
             </td>
 </tr>
 <tr class="tr-shade">
 <td class="td-colsep td-rowsep"></td>
+<td class="td-colsep td-rowsep">Copy path unquoted</td>
+<td class="td-rowsep">
+              <span class="para">Copy selected item-path(s) to clipboard. The data will not be enclosed in quotes.</span>
+            </td>
+</tr>
+<tr>
+<td class="td-colsep td-rowsep"></td>
 <td class="td-colsep td-rowsep">View as list</td>
 <td class="td-rowsep">
               <span class="para">Switches to list tree mode of the folder pane.</span>
             </td>
 </tr>
-<tr>
+<tr class="tr-shade">
 <td class="td-colsep td-rowsep"></td>
 <td class="td-colsep td-rowsep">View as tree</td>
 <td class="td-rowsep">
               <span class="para">Switches to tree mode of the folder pane.</span>
             </td>
 </tr>
-<tr class="tr-shade">
+<tr>
 <td class="td-colsep td-rowsep"></td>
 <td class="td-colsep td-rowsep">Show hiden files</td>
 <td class="td-rowsep">
               <span class="para">Switches to list tree mode of the folder pane.</span>
             </td>
 </tr>
-<tr>
+<tr class="tr-shade">
 <td class="td-colsep">
               <span class="guiicon">
                 <span class="inlinegraphic"><img src="view-refresh.png"></span>
@@ -915,6 +926,11 @@
     </p>
 <p class="para block"></p>
 </div>
+<div class="footnotes"><div class="footnote">
+<a name="ref1"></a><span class="footnote-number"><a class="footnote-ref" href="#-noteref-ref1">1</a></span>
+                  The clipboard used is selected
+                  <a class="link" href="GuideOptionsBehavior.html#Behaviour" title="Behavior">here.</a>
+                </div></div>
 </div></div>
 <div class="navbar navbar-bottom"><table class="navbar"><tr>
 <td class="navbar-prev"><a class="navbar-prev" href="GuideMainWindowFilePane.html" title="File Pane">File Pane</a></td>
--- a/web/help/GuideMainWindowMenus.html	Mon Nov 13 10:41:19 2017 +0000
+++ b/web/help/GuideMainWindowMenus.html	Thu Nov 16 10:07:31 2017 +0000
@@ -711,7 +711,17 @@
           <span class="menuchoice"><span class="guimenu">Copy path</span></span>
         </dt>
 <dd>
-          <p class="para block block-first">Copy selected item path to clipboard.</p>
+          <p class="para block block-first">
+            Copy selected item-path(s) to clipboard
+            <a name="-noteref-ref1"></a><sup><a class="footnote" href="#ref1">1</a></sup>
+            . Each data item copied will be enclosed in quotes.
+          </p>
+        </dd>
+<dt class="term">
+          <span class="menuchoice"><span class="guimenu">Copy path unquoted</span></span>
+        </dt>
+<dd>
+          <p class="para block block-first">Copy selected item-path(s) to clipboard. The data will not be enclosed in quotes.</p>
         </dd>
 <dt class="term">
           <span class="menuchoice"><span class="guimenu">Show marks</span> <span class="shortcut">(
@@ -1362,6 +1372,11 @@
       descibes how to modify the keyboard shortcuts used in the main menu.
     </p>
 </div>
+<div class="footnotes"><div class="footnote">
+<a name="ref1"></a><span class="footnote-number"><a class="footnote-ref" href="#-noteref-ref1">1</a></span>
+              The clipboard used is selected
+              <a class="link" href="GuideOptionsBehavior.html#Behaviour" title="Behavior">here.</a>
+            </div></div>
 </div></div>
 <div class="navbar navbar-bottom"><table class="navbar"><tr>
 <td class="navbar-prev"><a class="navbar-prev" href="GuideMainWindowNavigation.html" title="Navigation">Navigation</a></td>
--- a/web/help/GuideOptionsBehavior.html	Mon Nov 13 10:41:19 2017 +0000
+++ b/web/help/GuideOptionsBehavior.html	Thu Nov 16 10:07:31 2017 +0000
@@ -585,6 +585,28 @@
 <dd>
           <p class="para block block-first">This is the width and height of the icon generated from image and displayed when doing drag and drop actions. High resolution screens may require to increase this number.</p>
         </dd>
+<dt class="term">
+          <span class="guilabel">Copy path clipboard selection</span>
+        </dt>
+<dd>
+          <p class="para block block-first">
+            This option determines which clipboard selection is used for the "Copy path" menu item. The exact method of the paste operation will depend on the operating system, but in general will be:
+            <div class="block list variablelist"><dl class="variablelist">
+<dt class="term dt-first">
+                  <span class="guilabel">PRIMARY</span>
+                </dt>
+<dd>
+                  <p class="para block block-first">Paste using mouse middle-click, or shift-insert.</p>
+                </dd>
+<dt class="term">
+                  <span class="guilabel">CLIPBOARD</span>
+                </dt>
+<dd>
+                  <p class="para block block-first">Paste using mouse right-click and select paste, or control-v.</p>
+                </dd>
+</dl></div>
+          </p>
+        </dd>
 </dl></div>
 </div>
 <div class="division section">
--- a/web/help/GuideOptionsImage.html	Mon Nov 13 10:41:19 2017 +0000
+++ b/web/help/GuideOptionsImage.html	Thu Nov 16 10:07:31 2017 +0000
@@ -462,10 +462,13 @@
 <span class="label">11.2.1. </span><a class="xref" href="GuideOptionsImage.html#Zoom" title="Zoom">Zoom</a>
 </li>
 <li>
-<span class="label">11.2.2. </span><a class="xref" href="GuideOptionsImage.html#Appearance" title="Appearance">Appearance</a>
+<span class="label">11.2.2. </span><a class="xref" href="GuideOptionsImage.html#FitImageToWindow" title="Fit Image To Window">Fit Image To Window</a>
 </li>
 <li>
-<span class="label">11.2.3. </span><a class="xref" href="GuideOptionsImage.html#Convenience" title="Convenience">Convenience</a>
+<span class="label">11.2.3. </span><a class="xref" href="GuideOptionsImage.html#Appearance" title="Appearance">Appearance</a>
+</li>
+<li>
+<span class="label">11.2.4. </span><a class="xref" href="GuideOptionsImage.html#Convenience" title="Convenience">Convenience</a>
 </li>
 </ul></div>
 <div class="division section">
@@ -524,26 +527,6 @@
           </p>
         </dd>
 <dt class="term">
-          <span class="guilabel">Allow enlargement of image for zoom to fit</span>
-        </dt>
-<dd>
-          <p class="para block block-first">
-            Enable this to allow Geeqie to increase the image size for images that are smaller than the current view area when the zoom is set to
-            <span class="emphasis">Fit image to window</span>
-            . The value in the adjoining spin box sets the maximum size permitted in percent i.e. 100% is full-size.
-          </p>
-        </dd>
-<dt class="term">
-          <span class="guilabel">Limit image size when autofitting</span>
-        </dt>
-<dd>
-          <p class="para block block-first">
-            This percentage will affect the size of the image when
-            <span class="emphasis">Fit image to window</span>
-            is set. Instead of using 100% of the window, it will use the specified percentage. It allows one to keep a border around the image (values lower than 100%) or to auto zoom the image (values greater than 100%). It affects fullscreen mode too.
-          </p>
-        </dd>
-<dt class="term">
           <span class="guilabel">Zoom increment</span>
         </dt>
 <dd>
@@ -552,7 +535,32 @@
 </dl></div>
 </div>
 <div class="division section">
-<a name="Appearance"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">11.2.2. </span>Appearance</span></h2></div>
+<a name="FitImageToWindow"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">11.2.2. </span>Fit Image To Window</span></h2></div>
+<div class="block list variablelist"><dl class="variablelist">
+<dt class="term dt-first">
+          <span class="guilabel">Allow enlargement of image (max. size in %)</span>
+        </dt>
+<dd>
+          <p class="para block block-first">
+            Enable this to allow Geeqie to increase the image size for images that are smaller than the current view area when the zoom is set to
+            <span class="emphasis">Fit image to window</span>
+            . This value sets the maximum expansion permitted in percent i.e. 100% is full-size.
+          </p>
+        </dd>
+<dt class="term">
+          <span class="guilabel">Virtual window size (% of actual window)</span>
+        </dt>
+<dd>
+          <p class="para block block-first">
+            This value will set the virtual size of the window when
+            <span class="emphasis">Fit image to window</span>
+            is set. Instead of using the actual size of the window, the specified percentage of the window will be used. It allows one to keep a border around the image (values lower than 100%) or to auto zoom the image (values greater than 100%). It affects fullscreen mode too.
+          </p>
+        </dd>
+</dl></div>
+</div>
+<div class="division section">
+<a name="Appearance"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">11.2.3. </span>Appearance</span></h2></div>
 <div class="block list variablelist"><dl class="variablelist">
 <dt class="term dt-first">
           <span class="guilabel">Custom border color</span>
@@ -570,7 +578,7 @@
           <div class="admonition block note block-indent"><div class="note-inner">
             <p class="para block block-first">
               You may use the
-              <span class="emphasis">Limit image size when autofitting</span>
+              <span class="emphasis">Virtual window size</span>
               (see above) option to keep a border around the image in fullscreen mode.
             </p>
           </div></div>
@@ -586,7 +594,7 @@
 </dl></div>
 </div>
 <div class="division section">
-<a name="Convenience"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">11.2.3. </span>Convenience</span></h2></div>
+<a name="Convenience"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">11.2.4. </span>Convenience</span></h2></div>
 <div class="block list variablelist"><dl class="variablelist">
 <dt class="term dt-first">
           <span class="guilabel">Auto rotate proofs using EXIF information</span>
--- a/web/help/GuideReferencePixbufLoaders.html	Mon Nov 13 10:41:19 2017 +0000
+++ b/web/help/GuideReferencePixbufLoaders.html	Thu Nov 16 10:07:31 2017 +0000
@@ -458,46 +458,57 @@
 <li class="linktrail linktrail-first"><a class="linktrail" href="GuideIndex.html" title="The Geeqie User Manual">The Geeqie User Manual</a></li>
 <li class="linktrail linktrail-last"><a class="linktrail" href="GuideReference.html" title="Reference">Reference</a></li>
 </ul>
-<p class="para block block-first">
-    Geeqie is limited to displaying files for which there are existing pixbuf loaders. In addition to the standard ones included with most distributions, the following loaders may also work.
-    <p class="para block block-first"></p>
-    However, you are required to compile and install them yourself.
-  </p>
+<p class="para block block-first">Geeqie can display files for which there are existing pixbuf loaders. In addition to the standard ones included with most distributions, the following loaders may also be available to you.</p>
+<p class="para block">However, in some cases you are required to compile and install them yourself.</p>
 <div class="autotoc"><ul>
 <li>
-<span class="label">13.10.1. </span><a class="xref" href="GuideReferencePixbufLoaders.html#webp" title="webp">webp</a>
+<span class="label">13.10.1. </span><a class="xref" href="GuideReferencePixbufLoaders.html#svg" title="svg">svg</a>
+</li>
+<li>
+<span class="label">13.10.2. </span><a class="xref" href="GuideReferencePixbufLoaders.html#wmf" title="wmf">wmf</a>
 </li>
 <li>
-<span class="label">13.10.2. </span><a class="xref" href="GuideReferencePixbufLoaders.html#xcf" title="xcf">xcf</a>
+<span class="label">13.10.3. </span><a class="xref" href="GuideReferencePixbufLoaders.html#webp" title="webp">webp</a>
 </li>
 <li>
-<span class="label">13.10.3. </span><a class="xref" href="GuideReferencePixbufLoaders.html#psd" title="psd">psd</a>
+<span class="label">13.10.4. </span><a class="xref" href="GuideReferencePixbufLoaders.html#xcf" title="xcf">xcf</a>
 </li>
 <li>
-<span class="label">13.10.4. </span><a class="xref" href="GuideReferencePixbufLoaders.html#jp2" title="JP2/JPC/JPX/J2K/JPF">JP2/JPC/JPX/J2K/JPF</a>
+<span class="label">13.10.5. </span><a class="xref" href="GuideReferencePixbufLoaders.html#psd" title="psd">psd</a>
+</li>
+<li>
+<span class="label">13.10.6. </span><a class="xref" href="GuideReferencePixbufLoaders.html#jp2" title="JP2/JPC/JPX/J2K/JPF">JP2/JPC/JPX/J2K/JPF</a>
 </li>
 </ul></div>
 <div class="division section">
-<a name="webp"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">13.10.1. </span>webp</span></h2></div>
+<a name="svg"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">13.10.1. </span>svg</span></h2></div>
+<p class="para block block-first">librsvg2-common</p>
+</div>
+<div class="division section">
+<a name="wmf"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">13.10.2. </span>wmf</span></h2></div>
+<p class="para block block-first">libwmf0.2-7-gtk</p>
+</div>
+<div class="division section">
+<a name="webp"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">13.10.3. </span>webp</span></h2></div>
 <p class="para block block-first">
       <div dir="ltr" class=" block programlisting block-indent block-first"><pre class="programlisting">https://github.com/aruiz/webp-pixbuf-loader</pre></div>
     </p>
 <p class="para block"></p>
 </div>
 <div class="division section">
-<a name="xcf"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">13.10.2. </span>xcf</span></h2></div>
+<a name="xcf"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">13.10.4. </span>xcf</span></h2></div>
 <p class="para block block-first">
       <div dir="ltr" class=" block programlisting block-indent block-first"><pre class="programlisting">https://gitorious.org/xcf-pixbuf-loader/mainline?p=xcf-pixbuf-loader:mainline.git;a=summary</pre></div>
     </p>
 </div>
 <div class="division section">
-<a name="psd"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">13.10.3. </span>psd</span></h2></div>
+<a name="psd"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">13.10.5. </span>psd</span></h2></div>
 <p class="para block block-first">
       <div dir="ltr" class=" block programlisting block-indent block-first"><pre class="programlisting">https://cgit.sukimashita.com/gdk-pixbuf-psd.git/</pre></div>
     </p>
 </div>
 <div class="division section">
-<a name="jp2"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">13.10.4. </span>JP2/JPC/JPX/J2K/JPF</span></h2></div>
+<a name="jp2"></a><div class="header"><h2 class="section title"><span class="title"><span class="label">13.10.6. </span>JP2/JPC/JPX/J2K/JPF</span></h2></div>
 <p class="para block block-first">If your distribution has the libpixbufloader-jasper.so loader, these file formats will also be displayed.</p>
 </div>
 </div></div>
--- a/web/installing.html	Mon Nov 13 10:41:19 2017 +0000
+++ b/web/installing.html	Thu Nov 16 10:07:31 2017 +0000
@@ -131,7 +131,15 @@
           support for lua scripting
           enabled by default
           disable with configure option: --disable-lua
-          
+
+          librsvg2-common
+          for displaying .svg images
+
+          libwmf0.2-7-gtk
+          for displaying .wmf images
+
+          (see also "Additional pixbuf loaders" in the References section of the Help file)
+
           awk
           when running Geeqie, to use the geo-decode function