Patch for gedit color picker plugin documentation



Hi Jim,

I've created content for the gedit color picker plugin help page, and
have attached a patch. Did you get the other patches I sent for the
join/split lines and code comment plugins? I hadn't changed the titles
to the new format in those, sorry!

Regards,
Paul
>From f8f56a0ba5120b4969a50a1efa5d9ab81f6eb967 Mon Sep 17 00:00:00 2001
From: Paul Weaver <ch3pjw bath ac uk>
Date: Wed, 24 Aug 2011 00:36:30 +0100
Subject: [PATCH] Create content for color picker plugin documentation, remove
 stub

This patch creates the content for the color picker gedit plugin documentation
(gedit-plugins-color-picker.page), and removes the pre-existing stub file
(gedit-plugins-color-picker.page.stub).
---
 help/C/gedit-plugins-color-picker.page      |   47 +++++++++++++++++++++++++++
 help/C/gedit-plugins-color-picker.page.stub |   31 -----------------
 2 files changed, 47 insertions(+), 31 deletions(-)
 create mode 100644 help/C/gedit-plugins-color-picker.page
 delete mode 100644 help/C/gedit-plugins-color-picker.page.stub

diff --git a/help/C/gedit-plugins-color-picker.page b/help/C/gedit-plugins-color-picker.page
new file mode 100644
index 0000000..4c35fc0
--- /dev/null
+++ b/help/C/gedit-plugins-color-picker.page
@@ -0,0 +1,47 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="gedit-plugins-color-picker">
+  <info>
+    <revision version="0.2" date="2011-08-24" status="draft"/>
+    <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
+
+    <credit type="author">
+      <name>Jim Campbell</name>
+      <email>jwcampbell gmail com</email>
+    </credit>
+    
+    <credit type="author">
+      <name>Paul Weaver</name>
+      <email>ch3pjw bath ac uk</email>
+    </credit>
+
+    <desc>Insert HTML-style hexadecimal color codes using a graphical dialog</desc>
+  </info>
+
+  <title>Color picker</title>
+
+  <comment>
+    <cite date="2011-08-24" href="mailto:ch3pjw bath ac uk">Paul Weaver</cite>
+    <p>This assumes the reader knows how to use gedit in general. By the end
+       of this page, the reader will be able to use the color picker plugin
+       to insert HTML-style hex color codes into their document.</p>
+  </comment>
+
+  <p>The <app>Color Picker</app> plugin enables you to use a graphical color picker to insert HTML-style hexadecimal color codes (such as '#1e317e') into your documents. To enable this plugin, select <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Plugins</gui><gui>Color Picker</gui></guiseq>.</p>
+  
+  <section id="using-color-picker">
+    <title>Using Color Picker</title>
+    
+    <p>Once the plugin is enabled, you can insert color codes using <guiseq><gui>Tools</gui><gui>Pick Color...</gui></guiseq>.</p>
+    
+    <steps>
+      <item><p>Place the cursor at the point in your document at which you would like your color code.</p></item>
+      <item><p>Open the color picker by selecting <guiseq><gui>Tools</gui><gui>Pick Color...</gui></guiseq>.</p></item>
+      <item><p>Select your desired color by clicking on the color wheel. Alternatively you can select a pre-defined color from the palette or enter HSV or RGB values manually.</p></item>
+      <item><p>Click <gui>Insert</gui> to insert the hexadecimal color code for your chosen color into your document. The value that will be inserted is displayed in the <em>Color name</em> field of the color picker.</p></item>
+    </steps>
+    
+    <note style="tip"><p>You can leave the color picker open whilst you continue to edit your document if you need to insert multiple color codes.</p></note>
+   </section>
+
+</page>
diff --git a/help/C/gedit-plugins-color-picker.page.stub b/help/C/gedit-plugins-color-picker.page.stub
deleted file mode 100644
index 3b8e02b..0000000
--- a/help/C/gedit-plugins-color-picker.page.stub
+++ /dev/null
@@ -1,31 +0,0 @@
-<page xmlns="http://projectmallard.org/1.0/";
-      type="topic" style="task"
-      id="gedit-plugins-color-picker">
-  <info>
-    <revision version="0.1" date="2011-08-13" status="stub"/>
-
-    <credit type="author">
-      <name>Jim Campbell</name>
-      <email>jwcampbell gmail com</email>
-    </credit>
-
-    <desc>Pick a color from a dialog and insert its hexadecimal representation</desc>
-  </info>
-
-  <title>Color picker</title>
-
-  <comment>
-    <cite date="2011-08-13" href="mailto:jwcampbell gmail com">Jim Campbell</cite>
-    <p>This assumes the reader knows how to.... By the end of this page,
-    the reader will be able to....</p>
-  </comment>
-
-  <p>Short introductory text...</p>
-
-  <steps>
-    <item><p>First step...</p></item>
-    <item><p>Second step...</p></item>
-    <item><p>Third step...</p></item>
-  </steps>
-
-</page>
-- 
1.7.6



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]