GNOME.org
 

[gimp-help-2] Update templates

commit 0520c1d9c23d114b5ebee9972bae67d0ecf29ee1
Author: Ulf-D. Ehlert <ulfehlert svn gnome org>
Date:   Wed Jun 2 19:00:37 2010 +0200

    Update templates

 docs/templates/command_template.xml  |   28 ++++++++++------------
 docs/templates/dialog_template.xml   |   22 +++++++----------
 docs/templates/filter_template.xml   |   41 +++++++++++++++------------------
 docs/templates/tool_template.xml     |   31 ++++++++++++-------------
 docs/templates/tutorial_template.xml |   16 ++++---------
 5 files changed, 61 insertions(+), 77 deletions(-)
---
diff --git a/docs/templates/command_template.xml b/docs/templates/command_template.xml
index ea9fb1e..0019da4 100644
--- a/docs/templates/command_template.xml
+++ b/docs/templates/command_template.xml
@@ -1,26 +1,22 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
                 "http://www.docbook.org/xml/4.3/docbookx.dtd";>
 
-<!-- section history:
-  yyyy-mm-dd author: description of the change
--->
 <sect2 id="gimp-command-name">
-<title><!-- command name en --></title>
+<title><!-- command name --></title>
 
-  <indexterm><primary><!-- command name en --></primary></indexterm>
+  <indexterm><primary><!-- command name --></primary></indexterm>
 
   <!--
     General description of what the command is good for and how it
     can be used in the creative process
   -->
   <para>
-    The <quote><!-- command name en --></quote> command is
+    The <quote><!-- command name --></quote> command is
   </para>
   <!--
     Description of how to activate the command
-	-->
+  -->
 
   <sect3>
     <title>Activating the Command</title>
@@ -31,6 +27,7 @@
           You can access this command from the image menubar through
           <menuchoice>
             <guimenu></guimenu>
+            <guisubmenu></guisubmenu>
             <guimenuitem></guimenuitem>
           </menuchoice>.
         </para>
@@ -71,14 +68,14 @@
 
       <figure>
         <title>
-          <quote><!-- command name en --></quote><!-- tab name --> ptions tab
+          <quote><!-- command name --></quote><!-- tab name --> options tab
         </title>
-
         <mediaobject>
           <imageobject>
             <imagedata format="PNG"
-              fileref="../images/menu/options-menu-tab-name.png" />
+              fileref="images/menus/submenu/subsubmenu/name-tab.png" />
           </imageobject>
+          <!-- or: images/menus/submenu/subsubmenu/name-tab-options.png" -->
         </mediaobject>
       </figure>
 
@@ -107,13 +104,15 @@
       Otherwise remove content down to the end of the level 3 section.
     -->
     <figure>
-      <title><quote><!-- command name en --></quote> options</title>
-
+      <title>
+        <quote><!-- command name --></quote> options
+      </title>
       <mediaobject>
         <imageobject>
           <imagedata format="PNG"
-            fileref="../images/menu/options-command-name.png" />
+            fileref="images/menus/submenu/subsubmenu/name.png" />
         </imageobject>
+        <!-- or: images/menus/submenu/subsubmenu/name-options.png" -->
       </mediaobject>
     </figure>
 
@@ -121,7 +120,6 @@
     <variablelist>
       <varlistentry>
         <term><!-- name of the option / gui-element --></term>
-
         <listitem>
           <para>
             <!-- Description of the option / gui-element -->
diff --git a/docs/templates/dialog_template.xml b/docs/templates/dialog_template.xml
index a939b26..57af943 100644
--- a/docs/templates/dialog_template.xml
+++ b/docs/templates/dialog_template.xml
@@ -1,12 +1,8 @@
-<?xml version='1.0' encoding='UTF-8'?>
-
+<?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
                 "http://www.docbook.org/xml/4.3/docbookx.dtd";>
 
-<!-- section history:
-  yyyy-mm-dd author: description of the change
--->
-<sect2 id='gimp-document-dialog'>
+<sect2 id="gimp-document-dialog">
   <title><!-- dialog name --> dialog</title>
 
   <indexterm>
@@ -21,7 +17,7 @@
 
     <mediaobject>
       <imageobject>
-        <imagedata fileref="../images/dialogs/dialog-name.png"
+        <imagedata fileref="images/dialogs/name.png"
           format="PNG" />
       </imageobject>
     </mediaobject>
@@ -110,8 +106,8 @@
 
         <mediaobject>
           <imageobject>
-            <imagedata fileref="../images/dialogs/dialog-name-grid.png"
-                       format="PNG" />
+            <imagedata format="PNG"
+              fileref="images/dialogs/name-grid.png"/>
           </imageobject>
 
           <caption>
@@ -121,8 +117,8 @@
 
         <mediaobject>
           <imageobject>
-            <imagedata fileref="../images/dialogs/dialog-name-list.png"
-                       format="PNG" />
+            <imagedata format="PNG"
+              fileref="images/dialogs/name-list.png"/>
           </imageobject>
 
           <caption>
@@ -178,8 +174,8 @@
 
         <mediaobject>
           <imageobject>
-            <imagedata fileref="../images/dialogs/dialog-name-menu.png"
-                       format="PNG" />
+            <imagedata format="PNG"
+              fileref="images/dialogs/name-menu.png"/>
           </imageobject>
         </mediaobject>
       </figure>
diff --git a/docs/templates/filter_template.xml b/docs/templates/filter_template.xml
index 299c949..5a0edac 100644
--- a/docs/templates/filter_template.xml
+++ b/docs/templates/filter_template.xml
@@ -1,25 +1,20 @@
-<?xml version='1.0' encoding='UTF-8'?>
-
+<?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
                 "http://www.docbook.org/xml/4.3/docbookx.dtd";>
 
-<!-- section history:
-  yyyy-mm-dd author: description of the change
--->
 <sect2 id="plug-in-help-id">
-
-  <title><!-- Filter name --></title>
+  <title><!-- filter name --></title>
 
 
   <indexterm>
     <primary>Filters</primary>
     <secondary><!-- Category --></secondary>
-    <tertiary><!--Filter name or what the filter does : this tertiary is
+    <tertiary><!--filter name or what the filter does--></tertiary>
+    <!-- this tertiary is
     necessary to get entries in Index one above the other instead of side by
     side (and not only page number in PDF)-->
-    </tertiary>
   </indexterm>
-  <indexterm><primary><!-- Filter name --></primary></indexterm>
+  <indexterm><primary><!-- filter name --></primary></indexterm>
 
   <!-- This section gives an overview of what the filter does -->
   <sect3>
@@ -27,12 +22,12 @@
 
     <!-- First show a double of images to show the effect the filter creates -->
     <figure>
-      <title>Example for the <quote><!-- Filter name --></quote></title>
+      <title>Example for the <quote><!-- filter name --></quote></title>
       <!-- original image first -->
       <mediaobject>
         <imageobject>
           <imagedata format="JPG"
-            fileref="../images/filters/examples/original_image.jpg" />
+            fileref="images/filters/examples/original_image.jpg" />
         </imageobject>
         <caption>
           <para>Original image</para>
@@ -43,11 +38,11 @@
       <mediaobject>
         <imageobject>
           <imagedata format="JPG"
-            fileref="../images/filters/examples/image_with_filter_applied.jpg" />
+            fileref="images/filters/examples/image_with_filter_applied.jpg" />
         </imageobject>
 
         <caption>
-          <para><quote><!-- Filter name en --></quote> applied</para>
+          <para><quote><!-- filter name --></quote> applied</para>
         </caption>
       </mediaobject>
     </figure>
@@ -71,9 +66,9 @@
     <para>
       This filter is found in the image window menu under
       <menuchoice>
-        <guimenu><accel>F</accel>ilters</guimenu>
-        <guisubmenu><accel></accel><!-- filter category --></guisubmenu>
-        <guimenuitem><accel></accel><!-- Filter name en --></guimenuitem>
+        <guimenu>Filters</guimenu>
+        <guisubmenu><!-- filter category --></guisubmenu>
+        <guimenuitem><!-- filter name --></guimenuitem>
       </menuchoice>.
     </para>
   </sect3>
@@ -86,7 +81,7 @@
   <sect3>
     <title>Options</title>
 
-    <para lang="en">
+    <para>
       <!--
         Describe how the filter options are organized in general.
         This part is optional, but helps if the filter options dialog is a bit
@@ -106,14 +101,15 @@
 
       <figure>
         <title>
-          <quote><!-- Filter name en --></quote> <!-- tab name --> options tab
+          <quote><!-- filter name --></quote> <!-- tab name --> options tab
         </title>
 
         <mediaobject>
           <imageobject>
             <imagedata format="PNG"
-              fileref="../images/filters/options-filter-tab-name.png" />
+              fileref="images/filters/category/(submenu)/name-tab.png" />
           </imageobject>
+          <!-- or: images/filters/category/(submenu)/name-tab-options.png" -->
         </mediaobject>
       </figure>
 
@@ -142,13 +138,14 @@
       Otherwise remove content down to the end of the level 3 section.
     -->
     <figure>
-      <title><quote><!-- Filter name --></quote> options</title>
+      <title><quote><!-- filter name --></quote> options</title>
 
       <mediaobject>
         <imageobject>
           <imagedata format="PNG"
-            fileref="../images/filters/options-filter-name.png" />
+            fileref="images/filters/category/(submenu)/name.png" />
         </imageobject>
+        <!-- or: images/filters/category/(submenu)/name-tab-options.png" -->
       </mediaobject>
     </figure>
 
diff --git a/docs/templates/tool_template.xml b/docs/templates/tool_template.xml
index 36896cf..ab41a57 100644
--- a/docs/templates/tool_template.xml
+++ b/docs/templates/tool_template.xml
@@ -1,13 +1,8 @@
-<?xml version='1.0' encoding='UTF-8'?>
-
+<?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-          "http://www.docbook.org/xml/4.3/docbookx.dtd";>
+                       "http://www.docbook.org/xml/4.3/docbookx.dtd";>
 
-<!-- section history:
-  yyyy-mm-dd author: description of the change
--->
 <sect2 id="gimp-tool-toolname">
-
   <title><!-- tool name --></title>
 
   <indexterm>
@@ -22,8 +17,9 @@
 
     <mediaobject>
       <imageobject>
-        <imagedata fileref="../images/toolbox/tool-name.png"
-          format="PNG" />
+        <!-- TODO: create a (logical & consistent) naming scheme for tool images -->
+        <imagedata format="PNG"
+          fileref="images/toolbox/tool-name.png"/>
       </imageobject>
     </mediaobject>
   </figure>
@@ -61,7 +57,7 @@
           <guiicon>
             <inlinemediaobject>
               <imageobject>
-                <imagedata fileref="../images/toolbox/stock-tool-name-22.png" />
+                <imagedata fileref="images/toolbox/stock-tool-name-22.png" />
               </imageobject>
             </inlinemediaobject>
           </guiicon>
@@ -87,7 +83,7 @@
         <term><keycap>Ctrl</keycap></term>
 
         <listitem>
-          <para><!-- TODO: en describe how the key works --></para>
+          <para><!-- describe how the key works --></para>
         </listitem>
       </varlistentry>
 
@@ -96,7 +92,7 @@
         <term><keycap>Shift</keycap></term>
 
         <listitem>
-          <para><!-- TODO: en describe how the key works --></para>
+          <para><!-- describe how the key works --></para>
         </listitem>
       </varlistentry>
 
@@ -105,7 +101,7 @@
         <term><keycap></keycap></term>
 
         <listitem>
-          <para><!-- TODO: en describe how the key works --></para>
+          <para><!-- describe how the key works --></para>
         </listitem>
       </varlistentry>
     </variablelist>
@@ -122,8 +118,9 @@
 
       <mediaobject>
         <imageobject>
-          <imagedata fileref="../images/toolbox/tool-options-name.png"
-            format="PNG" />
+          <!-- TODO: create a (logical & consistent) naming scheme for tool images -->
+          <imagedata format="PNG"
+            fileref="images/toolbox/tool-options-name.png"/>
         </imageobject>
       </mediaobject>
     </figure>
@@ -134,7 +131,9 @@
       <guiicon>
         <inlinemediaobject>
           <imageobject>
-            <imagedata fileref="../images/toolbox/tool-name.png" />
+            <!-- TODO: create a (logical & consistent) naming scheme for tool images -->
+            <imagedata format="PNG"
+              fileref="images/toolbox/tool-name.png" />
           </imageobject>
         </inlinemediaobject>
       </guiicon>
diff --git a/docs/templates/tutorial_template.xml b/docs/templates/tutorial_template.xml
index 26527d2..d5dcc9b 100644
--- a/docs/templates/tutorial_template.xml
+++ b/docs/templates/tutorial_template.xml
@@ -1,12 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-
 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
                 "http://www.docbook.org/xml/4.3/docbookx.dtd";>
-<!-- section history:
-  yyyy-mm-dd author: description of the change
--->
-<sect1 id="gimp-tutorial-help-id">
 
+<sect1 id="gimp-tutorial-help-id">
   <title><!-- tutorial name --></title>
 
   <indexterm>
@@ -29,7 +25,7 @@
 
       <mediaobject>
         <imageobject>
-          <imagedata fileref="../images/tutorials/name.png"
+          <imagedata fileref="images/tutorials/name.png"
             format="PNG" />
         </imageobject>
       </mediaobject>
@@ -45,13 +41,11 @@
         <title>Preparations</title>
 
         <figure>
-          <title>
-            <phrase><!-- visualize the step --></phrase>
-          </title>
+          <title><!-- visualize the step --></title>
 
           <mediaobject>
             <imageobject>
-              <imagedata fileref="../images/tutorials/name.png"
+              <imagedata fileref="images/tutorials/name.png"
                 format="PNG" />
             </imageobject>
           </mediaobject>
@@ -82,7 +76,7 @@
         <mediaobject>
           <imageobject>
             <imagedata
-              fileref="../images/tutorials/example1.png"
+              fileref="images/tutorials/example1.png"
               format="PNG" />
           </imageobject>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]