Patch for gedit character map plugin documentation



Hi Jim,

I've made a page for the character map plugin, and have attached a
patch. Have a read, see what you think, and let me know what needs
changing. I'm not sure I've got all of the document meta info right, and
I'm not quite sure how to list the authors etc. properly.

Thanks,
Paul Weaver
>From 565d901dc48be582ae852df5b64acec80c82df7c Mon Sep 17 00:00:00 2001
From: Paul Weaver <ch3pjw bath ac uk>
Date: Tue, 16 Aug 2011 16:12:14 +0100
Subject: [PATCH] Create contents for character map plugin documentation,
 remove stub

This creates the contents for the character map plugin documentation
(gedit-plugins-character-map.page), and removes the pre-existing stub file
(gedit-plugins-character-map.page.stub).
---
 help/C/gedit-plugins-character-map.page      |   43 ++++++++++++++++++++++++++
 help/C/gedit-plugins-character-map.page.stub |   32 -------------------
 2 files changed, 43 insertions(+), 32 deletions(-)
 create mode 100644 help/C/gedit-plugins-character-map.page
 delete mode 100644 help/C/gedit-plugins-character-map.page.stub

diff --git a/help/C/gedit-plugins-character-map.page b/help/C/gedit-plugins-character-map.page
new file mode 100644
index 0000000..3ae7c29
--- /dev/null
+++ b/help/C/gedit-plugins-character-map.page
@@ -0,0 +1,43 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="gedit-plugins-character-map">
+  <info>
+    <revision version="0.2" date="2011-08-16" status="draft"/>
+    <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
+
+    <credit type="author copyright">
+      <name>Jim Campbell, Paul Weaver</name>
+      <email>jwcampbell gmail com</email>
+      <years>2011</years>
+    </credit>
+
+    <desc></desc>
+  </info>
+
+  <title>Insert special characters just by clicking on them</title>
+
+  <comment>
+    <cite date="2011-08-16" href="mailto:ch3pjw bath ac uk">Paul Weaver</cite>
+<!--    <cite date="2011-08-13" href="mailto:jwcampbell gmail com">Jim Campbell</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 character map plugin to insert characters into their documents.</p>
+  </comment>
+
+  <p>The <app>Character Map</app> plugin enables you to insert characters into your document that you may not be able to type easily using your keyboard. To enable this plugin, select  <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Plugins</gui><gui>Character Map</gui></guiseq>.</p>
+  
+  <section id="using-character-map">
+    <title>Using Character Map</title>
+
+    <p>Once the plugin is enabled, you can add characters from the <em>Character Map</em> tab of the side panel (<guiseq><gui>View</gui><gui>Side Panel</gui></guiseq>).</p>
+   
+  <steps>
+    <item><p>Place the cursor at the point in your document at which you would like your special character.</p></item>
+    <item><p>Select the <em>Character Map</em> tab in the side panel.</p></item>
+    <item><p>If neccessary, choose the character set to which your character belongs from the list at the top of the <em>Character Map</em> tab (e.g., Arabic).</p></item>
+    <item><p>Double click your desired character to insert it.</p></item>
+  </steps>
+  
+    <note style="tip"><p>You must click on the editing view of your document to continue editing normally.</p></note>
+  </section>
+
+</page>
diff --git a/help/C/gedit-plugins-character-map.page.stub b/help/C/gedit-plugins-character-map.page.stub
deleted file mode 100644
index ccc702d..0000000
--- a/help/C/gedit-plugins-character-map.page.stub
+++ /dev/null
@@ -1,32 +0,0 @@
-<page xmlns="http://projectmallard.org/1.0/";
-      type="topic" style="task"
-      id="gedit-plugins-character-map">
-  <info>
-    <revision version="0.1" date="2011-08-13" status="stub"/>
-
-    <credit type="author copyright">
-      <name>Jim Campbell</name>
-      <email>jwcampbell gmail com</email>
-      <years>2011</years>
-    </credit>
-
-    <desc></desc>
-  </info>
-
-  <title>Insert special characters just by clicking on them</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]