Update documentation for orientation commands

Clarify some sections and remove a TBD
BestImageViewer · Jan 23, 2017 · 24c93fa · 24c93fa
1 parent 3799ee6
commit 24c93fa
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 5 deletions.
diff --git a/doc/docbook/GuideMainWindowMenus.xml b/doc/docbook/GuideMainWindowMenus.xml
@@ -645,6 +645,13 @@
         </term>
         <listitem>
           <para>Swaps the top and bottom sides of the image, does not modify the file on disk.</para>
+          <warning>
+            <para>
+              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
+              <link linkend="MetadataMiscellaneous">Metadata tab of the Preferences Dialog</link>
+              if you wish these changes to be written to metadata.
+            </para>
+          </warning>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -661,7 +668,7 @@
           </menuchoice>
         </term>
         <listitem>
-          <para>Removes all effects applied through the Adjust menu, reverting image to its original state.</para>
+          <para>Removes all temporary effects applied through the above commands, reverting the image according to its Exif Orientation tag.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -672,9 +679,14 @@
           </menuchoice>
         </term>
         <listitem>
-          The commands above modifies image metadata only. This commands actually transforms image pixels. See
-          <link linkend="GuideImageManagementExternalEditing">Editors section</link>
-          for details
+          <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>
+          <warning>
+            <para>
+              The file rotate.desktop, using external commands exiftran, exiv2 and mogrify, is used to implement this command. Refer to
+              <link linkend="GuideImageManagementExternalEditing">Editors section</link>
+              for details.
+            </para>
+          </warning>
         </listitem>
       </varlistentry>
       <varlistentry>

diff --git a/doc/docbook/GuideOptionsMetadata.xml b/doc/docbook/GuideOptionsMetadata.xml
@@ -112,8 +112,11 @@
         <para>
           <guilabel>Write altered image orientation to the metadata</guilabel>
           <para />
-          TBD
+          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.
         </para>
+        <warning>
+          <para>If this option is not checked, the results of orientation commands will be lost when Geeqie closes.</para>
+        </warning>
       </listitem>
     </itemizedlist>
     <para />