[digikam-doc] /: start to split editor chapter

Gilles Caulier caulier.gilles at gmail.com
Tue Aug 23 11:15:05 UTC 2016


Git commit f0e4eacadbc4fa46f3445a6b2c78d94d80006527 by Gilles Caulier.
Committed on 23/08/2016 at 11:14.
Pushed by cgilles into branch 'master'.

start to split editor chapter

R  +0    -0    digikam/editor-photoediting.docbook [from: digikam/photo-editing.docbook - 100% similarity]
A  +170  -0    digikam/editor-using.docbook
M  +5    -166  digikam/index.docbook
M  +1    -1    digikam/using-mainwindow.docbook
M  +15   -17   showfoto/index.docbook

http://commits.kde.org/digikam-doc/f0e4eacadbc4fa46f3445a6b2c78d94d80006527

diff --git a/digikam/photo-editing.docbook b/digikam/editor-photoediting.docbook
similarity index 100%
rename from digikam/photo-editing.docbook
rename to digikam/editor-photoediting.docbook
diff --git a/digikam/editor-using.docbook b/digikam/editor-using.docbook
new file mode 100644
index 0000000..5bb7ed9
--- /dev/null
+++ b/digikam/editor-using.docbook
@@ -0,0 +1,170 @@
+<sect1 id="editor-using"> <title>Introduction to Image Editor</title>
+    <anchor id="imageeditor.anchor"/>
+
+    <sect2 id="imageeditor-window"> <title>The Image Editor Window</title>
+        <para>
+        &digikam; incorporates a fast Image Editor with a few basic yet powerful image editing tools. You can use the Image Editor to view your photographs and to make corrections and alterations. The Image Editor can be accessed either by clicking on a thumbnail in the Image Window or by right-clicking on a thumbnail and selecting <guilabel>Edit</guilabel> from the context menu.
+        </para>
+
+        <para>
+        The Image Editor provides a number of tools that enable you to adjust a photograph. Some of these tools are provided by plugins to &digikam;. So they may not be available by default on your distribution. See the <link linkend="setup-kipiplugins">Setup Image Editor Section</link> for more details about Kipi-plugins.
+        </para>
+
+        <example>  <title>The Image Editor Window</title>
+            <screenshot><screeninfo>The Image Editor Window</screeninfo><mediaobject><imageobject><imagedata fileref="&path;editorpreview.png" format="PNG" /> </imageobject></mediaobject></screenshot>
+        </example>
+
+        <para>
+        The image editor has just one main window with:
+
+        <itemizedlist>
+
+            <listitem><para>
+            A status at the bottom which shows the filename, the current file number, the current zoom level, and the current image size.
+            </para></listitem>
+
+            <listitem><para>
+            A menu bar across the top and below that a tool bar that provides quick access to some commonly used functions.
+            </para></listitem>
+
+        </itemizedlist>
+        </para>
+
+        <para>
+            <inlinemediaobject>
+                <imageobject><imagedata fileref="&path;editortoolbar.png" format="PNG"/></imageobject>
+                <textobject> <phrase>The Image Editor Toolbar</phrase> </textobject>
+            </inlinemediaobject>
+        </para>
+
+        <para>
+
+        <orderedlist>
+
+            <listitem><para>First Current Album Image.</para></listitem>
+
+            <listitem><para>Previous Image.</para></listitem>
+
+            <listitem><para>Next Image.</para></listitem>
+
+            <listitem><para>Last Current Album Image.</para></listitem>
+
+            <listitem><para>Save the modified image.</para></listitem>
+
+            <listitem><para>Undoing last action.</para></listitem>
+
+            <listitem><para>Redoing previous action.</para></listitem>
+
+            <listitem><para>Restore the Current Image From Disk.</para></listitem>
+
+            <listitem><para>Zoom Into the Image.</para></listitem>
+
+            <listitem><para>Zoom Out of the Image.</para></listitem>
+
+            <listitem><para>Toggle Auto Zooming (if selected image will fit in the window).</para></listitem>
+
+            <listitem><para>Rotate the Current Image.</para></listitem>
+
+            <listitem><para>Crop Image to the Selected Region.</para></listitem>
+
+        </orderedlist>
+
+        </para>
+        </sect2>
+
+    <sect2>       <title>Restoring Your Original Photograph</title>
+
+        <para>
+        The editing functions of the Image Editor will make changes to your photograph. None of the editing functions will change the original photograph unless you select
+        <menuchoice><guimenu>File</guimenu>
+        <guimenuitem>Save</guimenuitem></menuchoice>
+        or click the <guilabel>Save</guilabel> button in the tool bar. Note that once you have saved the changed version you will not be able to recover the original photograph.
+        </para>
+
+        <para>
+        You might prefer to take a copy of your photograph before you make any changes. You can use
+        <menuchoice><guimenu>File</guimenu>
+        <guimenuitem>Save As</guimenuitem></menuchoice>
+        to save a working copy.
+        </para>
+
+        <para>
+        At any time <emphasis>before</emphasis> you save your photograph you can restore the view to the original image by selecting
+        <menuchoice><guimenu>File</guimenu>
+        <guimenuitem>Revert</guimenuitem></menuchoice>
+        or clicking the
+        <inlinemediaobject>
+            <imageobject><imagedata fileref="&path;editorrevertbutton.png" format="PNG"/></imageobject>
+            <textobject><phrase>The Image Editor Revert Button</phrase></textobject>
+        </inlinemediaobject>
+        <guilabel>Revert</guilabel> button on the tool bar. You will lose any changes that you have made to the photograph since it was last saved.
+        </para>
+
+    </sect2>
+
+    <sect2>       <title>Undoing/Redoing Actions</title>
+
+        <para>
+        Almost anything you do to an image in Image Editor can be undone/redone. You can undo the most recent action by choosing <menuchoice><guimenu>Edit</guimenu><guimenuitem>Undo</guimenuitem></menuchoice>, and redo by <menuchoice><guimenu>Edit</guimenu><guimenuitem>Redo</guimenuitem></menuchoice>
+        </para>
+
+        <para>
+        If these are done frequently, you really should memorize the keyboard shortcuts, <guilabel>&Ctrl;-Z</guilabel> to undo an action, and <guilabel>&Ctrl;-Shift-Z</guilabel> to redo an action.
+        </para>
+
+        <para>
+        You have to press the &LMB; over the undo or redo icon in the tool bar and hold it down for a moment to produce a context menu. If you choose one of the menu items, all undo/redo actions until the chosen ones are undone/redone.
+        </para>
+
+    </sect2>
+
+    <sect2>       <title>Moving Between Photographs</title>
+
+        <para>
+        Once you have started the Image Editor you can move between photographs in the same view you started from by using the navigator buttons on the toolbar, <keycap>PgUp</keycap>, <keycap>PgDown</keycap> or the entries in the <guilabel>File</guilabel> menu. If you have made any changes to the current photograph you will be asked if you want to save them.
+        </para>
+
+    </sect2>
+
+    <sect2>       <title>Changing the View</title>
+
+        <para>
+        You can zoom in and out of a photograph using the <keycombo action="press">&Ctrl;<keycap>scroll wheel</keycap></keycombo>, the toolbar icons or the entries in the View menu.
+        </para>
+        <para>
+        To make a photograph fit the window use this button on the tool bar: <guilabel>Zoom Autofit</guilabel>
+        <inlinemediaobject>
+            <imageobject><imagedata fileref="&path;editorautosizebutton.png" format="PNG"/></imageobject>
+            <textobject> <phrase>The Image Editor AutoFit Button</phrase> </textobject>
+        </inlinemediaobject>
+        </para>
+
+        <para>
+        <menuchoice><guimenu>View</guimenu>
+        <guimenuitem>Full Screen Mode</guimenuitem></menuchoice> will display the photograph using the full screen mode. You can move back to the normal view by pressing the <keycombo>&Esc;</keycombo> key. By default the toolbar is still displayed even in Full Screen Mode. If you would prefer that the toolbar is not displayed you can turn it off in the Configure &digikam; dialog accessed from the main &digikam; window, see the <link linkend="setup-editor">Setup Image Editor Section</link>.
+        </para>
+
+        </sect2>
+
+    <sect2>       <title>Printing Images</title>
+
+        <para>
+        When you want to print the current image from the Image Editor, select
+        <menuchoice><guimenu>File</guimenu>
+        <guimenuitem>Print image</guimenuitem></menuchoice> (&Ctrl;+P) and you get the standard Print dialog, where you can adjust the settings before printing your photograph.
+        </para>
+
+        <para>
+            From the main window view you can print single images or whole sets of them. Entire thumbnail pages can be printed with your selection. All you need to do is selecting images the standard way and call <menuchoice><guimenu>Image</guimenu> <guimenuitem>Print Assistant</guimenuitem></menuchoice>. Then follow the instructions and choices to make.
+        </para>
+        </sect2>
+
+</sect1>
+ 
+<!--
+Local Variables:
+mode: sgml
+sgml-omittag: nil
+sgml-shorttag: t
+End:
+-->
diff --git a/digikam/index.docbook b/digikam/index.docbook
index d58f301..def7501 100644
--- a/digikam/index.docbook
+++ b/digikam/index.docbook
@@ -21,7 +21,8 @@
   <!ENTITY doc-using-camera           SYSTEM "using-camera.docbook">  
   <!ENTITY doc-using-setup            SYSTEM "using-setup.docbook">  
 <!-- Image Editor Chapter -->
-  <!ENTITY doc-photo-editing          SYSTEM "photo-editing.docbook">
+  <!ENTITY doc-editor-using           SYSTEM "editor-using.docbook">
+  <!ENTITY doc-editor-photoediting    SYSTEM "editor-photoediting.docbook">
   <!ENTITY doc-editor-color           SYSTEM "editor-color.docbook">
   <!ENTITY doc-editor-enhance         SYSTEM "editor-enhance.docbook">
   <!ENTITY doc-editor-transform       SYSTEM "editor-transform.docbook">
@@ -128,172 +129,10 @@
 
 <!-- ****************************************************************************************** -->
 
-<chapter id="image-editor">     <title>The Image Editor</title>
+<chapter id="image-editor"> <title>The Image Editor</title>
 
- <sect1 id="using-imageeditor">        <title>Introduction to Image Editor</title>
-      <anchor id="imageeditor.anchor"/>
-
-        <sect2 id="imageeditor-window"> <title>The Image Editor Window</title>
-            <para>
-            &digikam; incorporates a fast Image Editor with a few basic yet powerful image editing tools. You can use the Image Editor to view your photographs and to make corrections and alterations. The Image Editor can be accessed either by clicking on a thumbnail in the Image Window or by right-clicking on a thumbnail and selecting <guilabel>Edit</guilabel> from the context menu.
-            </para>
-
-            <para>
-            The Image Editor provides a number of tools that enable you to adjust a photograph. Some of these tools are provided by plugins to &digikam;. So they may not be available by default on your distribution. See the <link linkend="setup-kipiplugins">Setup Image Editor Section</link> for more details about Kipi-plugins.
-            </para>
-
-            <example>  <title>The Image Editor Window</title>
-                <screenshot><screeninfo>The Image Editor Window</screeninfo><mediaobject><imageobject><imagedata fileref="&path;editorpreview.png" format="PNG" /> </imageobject></mediaobject></screenshot>
-            </example>
-
-            <para>
-            The image editor has just one main window with:
-
-            <itemizedlist>
-
-                <listitem><para>
-                A status at the bottom which shows the filename, the current file number, the current zoom level, and the current image size.
-                </para></listitem>
-
-                <listitem><para>
-                A menu bar across the top and below that a tool bar that provides quick access to some commonly used functions.
-                </para></listitem>
-
-            </itemizedlist>
-            </para>
-
-            <para>
-                <inlinemediaobject>
-                    <imageobject><imagedata fileref="&path;editortoolbar.png" format="PNG"/></imageobject>
-                    <textobject> <phrase>The Image Editor Toolbar</phrase> </textobject>
-                </inlinemediaobject>
-            </para>
-
-            <para>
-
-            <orderedlist>
-
-                <listitem><para>First Current Album Image.</para></listitem>
-
-                <listitem><para>Previous Image.</para></listitem>
-
-                <listitem><para>Next Image.</para></listitem>
-
-                <listitem><para>Last Current Album Image.</para></listitem>
-
-                <listitem><para>Save the modified image.</para></listitem>
-
-                <listitem><para>Undoing last action.</para></listitem>
-
-                <listitem><para>Redoing previous action.</para></listitem>
-
-                <listitem><para>Restore the Current Image From Disk.</para></listitem>
-
-                <listitem><para>Zoom Into the Image.</para></listitem>
-
-                <listitem><para>Zoom Out of the Image.</para></listitem>
-
-                <listitem><para>Toggle Auto Zooming (if selected image will fit in the window).</para></listitem>
-
-                <listitem><para>Rotate the Current Image.</para></listitem>
-
-                <listitem><para>Crop Image to the Selected Region.</para></listitem>
-
-            </orderedlist>
-
-            </para>
-          </sect2>
-
-        <sect2>       <title>Restoring Your Original Photograph</title>
-
-            <para>
-            The editing functions of the Image Editor will make changes to your photograph. None of the editing functions will change the original photograph unless you select
-            <menuchoice><guimenu>File</guimenu>
-            <guimenuitem>Save</guimenuitem></menuchoice>
-            or click the <guilabel>Save</guilabel> button in the tool bar. Note that once you have saved the changed version you will not be able to recover the original photograph.
-            </para>
-
-            <para>
-            You might prefer to take a copy of your photograph before you make any changes. You can use
-            <menuchoice><guimenu>File</guimenu>
-            <guimenuitem>Save As</guimenuitem></menuchoice>
-            to save a working copy.
-            </para>
-
-            <para>
-            At any time <emphasis>before</emphasis> you save your photograph you can restore the view to the original image by selecting
-            <menuchoice><guimenu>File</guimenu>
-            <guimenuitem>Revert</guimenuitem></menuchoice>
-            or clicking the
-            <inlinemediaobject>
-                <imageobject><imagedata fileref="&path;editorrevertbutton.png" format="PNG"/></imageobject>
-                <textobject><phrase>The Image Editor Revert Button</phrase></textobject>
-            </inlinemediaobject>
-            <guilabel>Revert</guilabel> button on the tool bar. You will lose any changes that you have made to the photograph since it was last saved.
-            </para>
-
-        </sect2>
-
-        <sect2>       <title>Undoing/Redoing Actions</title>
-
-            <para>
-            Almost anything you do to an image in Image Editor can be undone/redone. You can undo the most recent action by choosing <menuchoice><guimenu>Edit</guimenu><guimenuitem>Undo</guimenuitem></menuchoice>, and redo by <menuchoice><guimenu>Edit</guimenu><guimenuitem>Redo</guimenuitem></menuchoice>
-            </para>
-
-            <para>
-            If these are done frequently, you really should memorize the keyboard shortcuts, <guilabel>&Ctrl;-Z</guilabel> to undo an action, and <guilabel>&Ctrl;-Shift-Z</guilabel> to redo an action.
-            </para>
-
-            <para>
-            You have to press the &LMB; over the undo or redo icon in the tool bar and hold it down for a moment to produce a context menu. If you choose one of the menu items, all undo/redo actions until the chosen ones are undone/redone.
-            </para>
-
-        </sect2>
-
-        <sect2>       <title>Moving Between Photographs</title>
-
-            <para>
-            Once you have started the Image Editor you can move between photographs in the same view you started from by using the navigator buttons on the toolbar, <keycap>PgUp</keycap>, <keycap>PgDown</keycap> or the entries in the <guilabel>File</guilabel> menu. If you have made any changes to the current photograph you will be asked if you want to save them.
-            </para>
-
-        </sect2>
-
-        <sect2>       <title>Changing the View</title>
-
-            <para>
-            You can zoom in and out of a photograph using the <keycombo action="press">&Ctrl;<keycap>scroll wheel</keycap></keycombo>, the toolbar icons or the entries in the View menu.
-            </para>
-            <para>
-            To make a photograph fit the window use this button on the tool bar: <guilabel>Zoom Autofit</guilabel>
-            <inlinemediaobject>
-                <imageobject><imagedata fileref="&path;editorautosizebutton.png" format="PNG"/></imageobject>
-                <textobject> <phrase>The Image Editor AutoFit Button</phrase> </textobject>
-            </inlinemediaobject>
-            </para>
-
-            <para>
-            <menuchoice><guimenu>View</guimenu>
-            <guimenuitem>Full Screen Mode</guimenuitem></menuchoice> will display the photograph using the full screen mode. You can move back to the normal view by pressing the <keycombo>&Esc;</keycombo> key. By default the toolbar is still displayed even in Full Screen Mode. If you would prefer that the toolbar is not displayed you can turn it off in the Configure &digikam; dialog accessed from the main &digikam; window, see the <link linkend="setup-editor">Setup Image Editor Section</link>.
-            </para>
-
-         </sect2>
-
-        <sect2>       <title>Printing Images</title>
-
-            <para>
-            When you want to print the current image from the Image Editor, select
-            <menuchoice><guimenu>File</guimenu>
-            <guimenuitem>Print image</guimenuitem></menuchoice> (&Ctrl;+P) and you get the standard Print dialog, where you can adjust the settings before printing your photograph.
-            </para>
-
-           <para>
-                From the main window view you can print single images or whole sets of them. Entire thumbnail pages can be printed with your selection. All you need to do is selecting images the standard way and call <menuchoice><guimenu>Image</guimenu> <guimenuitem>Print Assistant</guimenuitem></menuchoice>. Then follow the instructions and choices to make.
-           </para>
-         </sect2>
-
-    </sect1>
-
- &doc-photo-editing;
+ &doc-editor-using;
+ &doc-editor-photoediting;
  &doc-color-management;
 
 </chapter>
diff --git a/digikam/using-mainwindow.docbook b/digikam/using-mainwindow.docbook
index b83d2b6..d269645 100644
--- a/digikam/using-mainwindow.docbook
+++ b/digikam/using-mainwindow.docbook
@@ -273,7 +273,7 @@
                     <shortcut><keycap>F4</keycap></shortcut>
                         <guimenu>Image</guimenu><guimenuitem>Edit...</guimenuitem>
                 </menuchoice>
-            or by right-clicking and selecting <guilabel>Edit</guilabel> from the context menu. See the <link linkend="using-imageeditor">&digikam; Image Editor</link> section for instructions on how to edit your photographs. The Image Editor lets you view your photographs and make a number of adjustments to them.
+            or by right-clicking and selecting <guilabel>Edit</guilabel> from the context menu. See the <link linkend="editor-using">&digikam; Image Editor</link> section for instructions on how to edit your photographs. The Image Editor lets you view your photographs and make a number of adjustments to them.
             </para>
 
         </sect3>
diff --git a/showfoto/index.docbook b/showfoto/index.docbook
index 43dd281..d3e336f 100644
--- a/showfoto/index.docbook
+++ b/showfoto/index.docbook
@@ -8,17 +8,17 @@
   <!ENTITY digikam-app '<application>digiKam</application>'>
   <!-- relative path to snapshots for showfoto -->
   <!ENTITY path "../digikam/">
-  <!ENTITY doc-intro-fileformats SYSTEM "../digikam/intro-fileformats.docbook">
-  <!ENTITY doc-using-sidebar     SYSTEM "../digikam/using-sidebar.docbook">
-  <!ENTITY doc-photo-editing     SYSTEM "../digikam/photo-editing.docbook">
-  <!ENTITY doc-editor-color      SYSTEM "../digikam/editor-color.docbook">
-  <!ENTITY doc-editor-enhance    SYSTEM "../digikam/editor-enhance.docbook">
-  <!ENTITY doc-editor-transform  SYSTEM "../digikam/editor-transform.docbook">
-  <!ENTITY doc-editor-filters    SYSTEM "../digikam/editor-filters.docbook">
-  <!ENTITY doc-editor-decorate   SYSTEM "../digikam/editor-decorate.docbook">
-  <!ENTITY doc-color-management  SYSTEM "../digikam/color-management.docbook">
-  <!ENTITY doc-ie-menu           SYSTEM "../digikam/ie-menu.docbook">
-  <!ENTITY doc-credits-annexes   SYSTEM "../digikam/credits-annex.docbook">
+  <!ENTITY doc-intro-fileformats    SYSTEM "../digikam/intro-fileformats.docbook">
+  <!ENTITY doc-using-sidebar        SYSTEM "../digikam/using-sidebar.docbook">
+  <!ENTITY doc-editor-photoediting  SYSTEM "../digikam/editor-photoediting.docbook">
+  <!ENTITY doc-editor-color         SYSTEM "../digikam/editor-color.docbook">
+  <!ENTITY doc-editor-enhance       SYSTEM "../digikam/editor-enhance.docbook">
+  <!ENTITY doc-editor-transform     SYSTEM "../digikam/editor-transform.docbook">
+  <!ENTITY doc-editor-filters       SYSTEM "../digikam/editor-filters.docbook">
+  <!ENTITY doc-editor-decorate      SYSTEM "../digikam/editor-decorate.docbook">
+  <!ENTITY doc-color-management     SYSTEM "../digikam/color-management.docbook">
+  <!ENTITY doc-ie-menu              SYSTEM "../digikam/ie-menu.docbook">
+  <!ENTITY doc-credits-annexes      SYSTEM "../digikam/credits-annex.docbook">
 
   <!-- Do not define any other entities; instead, use the entities
        from kde-genent.entities and $LANG/user.entities. -->
@@ -135,18 +135,18 @@
 
 </chapter>
 
-<chapter id="sidebar">  <title>The &showfoto; sidebar</title>
+<chapter id="sidebar"> <title>The &showfoto; sidebar</title>
 
     &doc-using-sidebar;
 
 </chapter>
 
-<chapter id="using-kapp">        <title>Using &showfoto;</title>
+<chapter id="using-showfoto"> <title>Using &showfoto;</title>
 
-  &doc-photo-editing;
+  &doc-editor-photoediting;
   &doc-color-management;
 
-  <sect1 id="using-setup">        <title>&showfoto; Configuration</title>
+  <sect1 id="using-setup"> <title>&showfoto; Configuration</title>
 
         <anchor id="setupdialog.anchor"/>
 
@@ -192,12 +192,10 @@
 
      </sect2>
 
-
     </sect1>
 
 </chapter>
 
-
 <chapter id="menudescriptions">  <title>Menu Descriptions</title>
 
 &doc-ie-menu;


More information about the kde-doc-english mailing list