[digikam-doc] /: split editor decorate sections

Gilles Caulier caulier.gilles at gmail.com
Sun Aug 28 09:55:17 UTC 2016


Git commit e0941de233aff405932a3a64fb48530d549f4410 by Gilles Caulier.
Committed on 28/08/2016 at 09:54.
Pushed by cgilles into branch 'master'.

split editor decorate sections

M  +5    -173  digikam/editor-decorate.docbook
M  +17   -17   digikam/editor-photoediting.docbook
M  +5    -0    digikam/index.docbook
M  +2    -2    digikam/menu-editor.docbook
M  +5    -0    showfoto/index.docbook

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

diff --git a/digikam/editor-decorate.docbook b/digikam/editor-decorate.docbook
index 44a369b..378e1c0 100644
--- a/digikam/editor-decorate.docbook
+++ b/digikam/editor-decorate.docbook
@@ -1,177 +1,9 @@
-<sect2> <title>Adding decorative elements</title>
-    
-    <sect3 id="texture">
-        
-        <sect3info>
-            
-            <title>Apply Texture</title>
+<sect2 id="editor-decorate-tools" >
+    <title>Adding decorative elements</title>
 
-            <abstract>
-            <para>
-            The &digikam; <emphasis>Apply Texture</emphasis> is a tool for applying decorative textures to an image.
-            </para>
-            </abstract>
-
-        </sect3info>
-
-        <title>Introduction</title>
-
-        <para>
-        By adding texture to your image, whether color or black and white, you can make it look like an oil painting on canvas, an Old Masters etching, a Pop Art portrait composed of enlarged half-tone dots, or even a mural on a brick wall. The <menuchoice><guimenu>Image</guimenu>
-        <guimenuitem>Apply Texture</guimenuitem></menuchoice> Image Editor menu can be used for that.
-        </para>
-
-        <sect4 id="using-texture"> <title>Using the Texture Tool</title>
-
-            <para><inlinemediaobject><imageobject> 
-                <imagedata fileref="&path;editor-texture.png" format="PNG" /> </imageobject>
-                <textobject><phrase>The Apply Texture Tool Dialog</phrase></textobject></inlinemediaobject>
-            </para>
-
-            <para>
-            Two options give you control over the texture applying on image:
-            </para>
-            
-            <para>
-            <guilabel>Type</guilabel>: this option specifies the decorative texture style to apply under the image.
-            </para>
-
-            <para>
-            <guilabel>Relief</guilabel>: dragging this option to the right increases the appearance of depth or three-dimensionality of the texture on image.
-            </para>
-
-        </sect4>
-
-        <sect4 id="inaction-texture"> <title>The Texture tool in action</title>
-
-            <para>
-            A <guilabel>Paper</guilabel> texture effect apply to a photograph is available below. The original image is (1), the target image is (2). <guilabel>Relief</guilabel> factor used is 200.
-            </para>
-
-            <para><inlinemediaobject><imageobject> 
-                <imagedata fileref="&path;editor-texture-preview.png" format="PNG" /> </imageobject>
-                <textobject><phrase>The Texture Effect Preview</phrase></textobject></inlinemediaobject>
-            </para>
-
-        </sect4>
-
-    </sect3>
-
-    <sect3 id="border">
-        
-        <sect3info>
-
-            <title>Add Border</title>
-
-            <abstract>
-            <para>
-            The &digikam; <emphasis>Add Border</emphasis> is a tool to frame an image with decorative borders.
-            </para>
-            </abstract>
-
-        </sect3info>
-
-        <title>Introduction</title>
-
-        <para>
-        Keeping the viewer's interest within the confines of the edges of a photograph is not a simple task. One of the simplest ways to hold the attention on an image is to incorporate a decorative frame around an image. It acts as a kind of psychological barrier to the straying eye. The <menuchoice><guimenu>Image</guimenu>
-        <guimenuitem>Add Border</guimenuitem></menuchoice> Image Editor menu can be used for that.
-        </para>
-
-        <sect4 id="using-border"> <title>Using the Add-border tool</title>
-
-            <para>
-            Four options give you control over the decorative frame rendering:
-            </para>
-            
-            <para>
-                <guilabel>Type</guilabel>: this option specifies the decorative frame style to apply around the image. <guilabel>Solid</guilabel> style just surrounds the image with a colored line, <guilabel>Niepce</guilabel> style surrounds the image with a fine line and a large border (ideal for black and white images), <guilabel>Beveled</guilabel> style adds a neat dimension to your image (ideal to create a button effect), and <guilabel>Decorative</guilabel> style adds an ornamental border using patterns.
-            </para>
-
-            <para>
-            <guilabel>Width</guilabel>: this option specifies the border width in percents of image size. The border is added around the image. The width range is limited between 1% and 50%.
-            </para>
-
-            <para>
-            <guilabel>First</guilabel>: this option specifies the first color to use with the current border type. 
-            </para>
-
-            <para>
-            <guilabel>Second</guilabel>: this option specifies the second color to use with the current border type. 
-            </para>
-
-            <para>
-            Click on the <guilabel>OK</guilabel> button to apply the border around the current image.
-            </para>
-
-            <note><para>
-            The border decorated target image will be bigger than the original, but it will retain the same aspect ratio. This is important for printing images, especially if you have used the Aspect Ratio Crop tool before.
-            </para></note>
-
-        </sect4>
-
-        <sect4 id="inaction-border"> <title>The Add-border tool in action</title>
-
-            <para>
-            The Add Border dialog tool in action is available below.
-            </para>
-
-            <para><inlinemediaobject><imageobject> 
-                <imagedata fileref="&path;editor-border-preview.png" format="PNG" /> </imageobject>
-                <textobject><phrase>The Add Border Tool Dialog in Action</phrase></textobject></inlinemediaobject>
-            </para>
-
-        </sect4>
-
-    </sect3>
-
-    <sect3 id="inserttext">
-        
-        <sect3info>
-
-        <title>Insert Text</title>
-
-        <abstract>
-        <para>
-        The &digikam; <emphasis>Insert Text</emphasis> is a tool for adding text to an image.
-        </para>
-        </abstract>
-
-        </sect3info>
-
-        <title>Introduction</title>
-
-        <para>
-        This is a handy tool as it lets you add formatted text easily to an image wherever you want, at several places when needed. 
-        </para>
-
-        <sect4 id="using-inserttext"> <title>Using the Insert Text tool</title>
-
-            <para>
-            This tool seems very intuitive to use. Type in your text and place it with the mouse. Use the block settings as you please. Choose the orientation, color from a color space, and fonts with all their properties. You will have to scale the font size to the image size, the larger the image, the larger the font has to be!
-            Finally choose to add a border around the text and/or a semitransparent background. VoilĂ , it's finished!
-            </para>
-
-            <para>
-            Any text setting you have chosen can always be changed as long as you don't click the OK button. In saved and reloaded images the text has become part of the image, it cannot be changed anymore.
-            </para>
-        
-        </sect4>
-
-        <sect4 id="inaction-inserttext"> <title>The Insert Text tool in action</title>
-
-            <para>
-            The Insert Text dialog tool in action is shown below.
-            </para>
-
-            <para><inlinemediaobject><imageobject> 
-                <imagedata fileref="&path;editor-inserttext-preview.png" format="PNG" /> </imageobject>
-                <textobject><phrase>The Insert Text Tool Dialog in Action</phrase></textobject></inlinemediaobject>
-            </para>
-
-        </sect4>
-
-    </sect3>
+        &doc-editor-decorate-texture;
+        &doc-editor-decorate-border;
+        &doc-editor-decorate-inserttext;
 
 </sect2>
 
diff --git a/digikam/editor-photoediting.docbook b/digikam/editor-photoediting.docbook
index 176e7e6..ad8dd02 100644
--- a/digikam/editor-photoediting.docbook
+++ b/digikam/editor-photoediting.docbook
@@ -58,35 +58,35 @@
             <para>
 
                 <itemizedlist>
-                    
+
                     <listitem><para>
 
                         <emphasis>(1)</emphasis>: The seven buttons to the top left select the comparison style of the preview area. The modes are:
 
                         <itemizedlist>
-                            
+
                             <listitem><para>Original image</para></listitem>
-                            
+
                             <listitem>
                                 <para>Split vertically without duplication. The left area shows the original whereas the right side shows the filter applied to the continuation of the selected zoom.</para>
                             </listitem>
-                            
+
                             <listitem>
                                 <para>Split horizontally without duplication. The top area shows the original whereas the lower area shows the filter applied to the continuation of the selected zoom.</para>
                             </listitem>
-                            
+
                             <listitem>
                                 <para>Split vertically. The left area shows the original and the right one the filter effect for comparison.</para>
                             </listitem>
-                            
+
                             <listitem>
                                 <para>Split horizontally. The top area shows the original and the lower one the filter effect for comparison.</para>
                             </listitem>
-                            
+
                             <listitem>
                                 <para>Effect preview. This is a live effect preview without comparison.</para>
                             </listitem>
-                            
+
                             <listitem>
                                 <para>'Mouse over' style: preview when mouse is off the preview (in the settings area), otherwise shows original.</para>
                             </listitem>
@@ -168,9 +168,9 @@
 
                 <listitem><para>Image Decoration
                     <itemizedlist>
-                    <listitem><para><link linkend="border">Add Border</link></para></listitem>
-                    <listitem><para><link linkend="inserttext">Insert Text</link></para></listitem>
-                    <listitem><para><link linkend="texture">Apply Texture</link></para></listitem>
+                    <listitem><para><link linkend="editor-decorate-border">Add Border</link></para></listitem>
+                    <listitem><para><link linkend="editor-decorate-inserttext">Insert Text</link></para></listitem>
+                    <listitem><para><link linkend="editor-decorate-texture">Apply Texture</link></para></listitem>
                     </itemizedlist>
                 </para></listitem>
 
@@ -201,11 +201,11 @@
             <itemizedlist>
 
                 <listitem><para>Setting up the RAW conversion and color management preferences
-                    
+
                     <itemizedlist>
-                    
+
                         <listitem><para>get the ICC color profiles for the camera, display and printer</para></listitem>
-                    
+
                         <listitem><para>setup &digikam; correctly defining a color work space </para></listitem>
 
                     </itemizedlist>
@@ -213,11 +213,11 @@
                 </para></listitem>
 
                 <listitem><para>Camera whitepoint setting</para></listitem>
-                
+
                 <listitem><para>Demosaicing (includes interpolation, noise filtering and
                     <ulink url="help:/digikam/using-setup.html#CA.anchor">chromatic aberration correction</ulink>)
-                    </para></listitem>
-                
+                </para></listitem>
+
                 <listitem><para>Conversion to a color space</para> </listitem>
 
                 <listitem><para>Gamma correction, tone mapping</para> </listitem>
diff --git a/digikam/index.docbook b/digikam/index.docbook
index 8388dba..b2d71ba 100644
--- a/digikam/index.docbook
+++ b/digikam/index.docbook
@@ -43,7 +43,12 @@
 
   <!ENTITY doc-editor-transform             SYSTEM "editor-transform.docbook">
   <!ENTITY doc-editor-filters               SYSTEM "editor-filters.docbook">
+
   <!ENTITY doc-editor-decorate              SYSTEM "editor-decorate.docbook">
+  <!ENTITY doc-editor-decorate-texture      SYSTEM "editor-decorate-texture.docbook">
+  <!ENTITY doc-editor-decorate-border       SYSTEM "editor-decorate-border.docbook">
+  <!ENTITY doc-editor-decorate-inserttext   SYSTEM "editor-decorate-inserttext.docbook">
+
   <!ENTITY doc-editor-colormanagement       SYSTEM "editor-colormanagement.docbook">
 <!-- Tools Chapter -->
   <!-- native -->
diff --git a/digikam/menu-editor.docbook b/digikam/menu-editor.docbook
index 5983f47..de050ea 100644
--- a/digikam/menu-editor.docbook
+++ b/digikam/menu-editor.docbook
@@ -483,7 +483,7 @@
             </menuchoice></term>
             <listitem>
                 <para><action>
-                    Image Editor plugin to add a decorative border around the current image <link linkend="border">(help)</link>.
+                    Image Editor plugin to add a decorative border around the current image <link linkend="editor-decorate-border">(help)</link>.
                 </action></para>
             </listitem>
         </varlistentry>
@@ -494,7 +494,7 @@
             </menuchoice></term>
             <listitem>
                 <para><action>
-                    Image Editor plugin to insert text in the current image <link linkend="inserttext">(help)</link>.
+                    Image Editor plugin to insert text in the current image <link linkend="editor-decorate-inserttext">(help)</link>.
                 </action></para>
             </listitem>
         </varlistentry>      
diff --git a/showfoto/index.docbook b/showfoto/index.docbook
index 3346dde..e8d7e82 100644
--- a/showfoto/index.docbook
+++ b/showfoto/index.docbook
@@ -28,7 +28,12 @@
 
   <!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-editor-decorate-texture      SYSTEM "../digikam/editor-decorate-texture.docbook">
+  <!ENTITY doc-editor-decorate-border       SYSTEM "../digikam/editor-decorate-border.docbook">
+  <!ENTITY doc-editor-decorate-inserttext   SYSTEM "../digikam/editor-decorate-inserttext.docbook">
+
   <!ENTITY doc-editor-colormanagement       SYSTEM "../digikam/editor-colormanagement.docbook">
 
   <!ENTITY doc-tool-acquireimages           SYSTEM "../digikam/tool-acquireimages.docbook">


More information about the kde-doc-english mailing list