Update documentation for orientation commands
authorColin Clark <cclark@mcb.net>
Mon, 23 Jan 2017 20:17:13 +0000 (20:17 +0000)
committerColin Clark <cclark@mcb.net>
Mon, 23 Jan 2017 20:17:13 +0000 (20:17 +0000)
Clarify some sections and remove a TBD

doc/docbook/GuideMainWindowMenus.xml
doc/docbook/GuideOptionsMetadata.xml

index bc1fab5..c2a27a1 100644 (file)
         </term>\r
         <listitem>\r
           <para>Swaps the top and bottom sides of the image, does not modify the file on disk.</para>\r
+          <warning>\r
+            <para>\r
+              The above orientation commands - Rotate, Mirror and Flip - do not change the image on disk. The changes will be lost when Geeqie closes. Refer to the\r
+              <link linkend="MetadataMiscellaneous">Metadata tab of the Preferences Dialog</link>\r
+              if you wish these changes to be written to metadata.\r
+            </para>\r
+          </warning>\r
         </listitem>\r
       </varlistentry>\r
       <varlistentry>\r
           </menuchoice>\r
         </term>\r
         <listitem>\r
-          <para>Removes all effects applied through the Adjust menu, reverting image to its original state.</para>\r
+          <para>Removes all temporary effects applied through the above commands, reverting the image according to its Exif Orientation tag.</para>\r
         </listitem>\r
       </varlistentry>\r
       <varlistentry>\r
           </menuchoice>\r
         </term>\r
         <listitem>\r
-          The commands above modifies image metadata only. This commands actually transforms image pixels. See\r
-          <link linkend="GuideImageManagementExternalEditing">Editors section</link>\r
-          for details\r
+          <para>This command affects only jpeg, tiff and png files. The image file on disk is rotated to the orientation as specified by its Exif Orientation tag.</para>\r
+          <warning>\r
+            <para>\r
+              The file rotate.desktop, using external commands exiftran, exiv2 and mogrify, is used to implement this command. Refer to\r
+              <link linkend="GuideImageManagementExternalEditing">Editors section</link>\r
+              for details.\r
+            </para>\r
+          </warning>\r
         </listitem>\r
       </varlistentry>\r
       <varlistentry>\r
index 11595cc..9f72095 100644 (file)
         <para>\r
           <guilabel>Write altered image orientation to the metadata</guilabel>\r
           <para />\r
-          TBD\r
+          If checked, the results of orientation commands (Rotate, Mirror and Flip) issued on an image will be written to metadata either automatically as specified below or when manually initiated.\r
         </para>\r
+        <warning>\r
+          <para>If this option is not checked, the results of orientation commands will be lost when Geeqie closes.</para>\r
+        </warning>\r
       </listitem>\r
     </itemizedlist>\r
     <para />\r