Document toolbar enhancements
authorColin Clark <cclark@mcb.net>
Sun, 1 May 2016 16:44:01 +0000 (17:44 +0100)
committerColin Clark <cclark@mcb.net>
Sun, 1 May 2016 16:44:01 +0000 (17:44 +0100)
Update help file to describe how to put additional icons on the toolbar.

Requires re-work.

doc/docbook/GuideReference.xml
doc/docbook/GuideReferenceToolbar.xml [new file with mode: 0644]

index 66e3897..58702ca 100644 (file)
@@ -7,5 +7,6 @@
 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceKeyboardShortcuts.xml"/>
 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceThumbnails.xml"/>
 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceManagement.xml"/>
+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceToolbar.xml"/>
 
   <para/></chapter>
diff --git a/doc/docbook/GuideReferenceToolbar.xml b/doc/docbook/GuideReferenceToolbar.xml
new file mode 100644 (file)
index 0000000..cbe4e76
--- /dev/null
@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="utf-8"?>
+<section id="GuideReferenceToolbar">
+    <title>
+      Toolbar
+    </title>
+    <para/><section id="AddingIconsToToolbar"><title>How to set up new toolbar icons
+    </title>
+    <para>This section describes how to put additional icons on the toolbar.<para/>The functions these icons may initiate are as described in <link linkend="GuideImageManagementExternalEditing">External Editors</link>.
+    </para>
+    <para>
+      Edit the toolbar section of the file geeqierc.xml to include a reference to the new icon:</para>
+    <para><programlisting>
+    &lt;toolitem action = "new_icon_1.desktop" /&gt;
+    </programlisting></para><para>
+      Create a corresponding desktop file as described in <link linkend="GuideImageManagementExternalEditing">External Editors</link>.
+    </para>
+    <para/>
+    <para>Within the desktop file it is recommended that two additional items are included:</para>
+    <para><programlisting>Icon=new_icon_1.png</programlisting></para>
+    <para>The icon displayed. If an icon is not defined, it is likely that the display of the entire toolbar will be distorted by additional text.</para>
+    <para><programlisting>Comment=descriptive text</programlisting></para>
+    <para>The tooltip text displayed when the mouse is hovered over the icon.</para>
+    </section>
+</section>