Re: Patch for gedit character map plugin documentation

[Paul Weaver <ch3pjw bath ac uk>]

Hi Jim,

I'm having a bit of difficulty with the other patches I made
conflicting(?) with the "git pull --rebase" command. I've attached both
of them so that you can get the bulk of the changes (although they've
still got those issues about credits that you mentioned before).

Once I've managed to pull in the new stuff, I'll reformat the titles and
so on, and then go press on with creating a bit more content.

Cheers,
Paul

On Thu, 2011-08-18 at 13:48 -0500, Jim Campbell wrote:
> Hey Paul,

> I was able to get through updating most of them last night, so we
> should be in pretty good shape.  Make sure you do a "git pull
> --rebase" from your gedit directory before making your next set of
> updates. That will ensure that you have the most recent code.
>  
> Also, this is a volunteer project, so no worries about getting busy
> with other things.
>  
> Thanks again,
>  
> Jim

>From 87afc8aea1a64d0a57d7b48aa8d6bc6de3edbff0 Mon Sep 17 00:00:00 2001
From: Paul Weaver <ch3pjw bath ac uk>
Date: Thu, 18 Aug 2011 23:10:16 +0100
Subject: [PATCH] Create content for join or split lines documentation, remove
 stub

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

diff --git a/help/C/gedit-plugins-join-split-lines.page b/help/C/gedit-plugins-join-split-lines.page
new file mode 100644
index 0000000..23a775e
--- /dev/null
+++ b/help/C/gedit-plugins-join-split-lines.page
@@ -0,0 +1,44 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="gedit-plugins-join-split-lines">
+  <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>Join several lines of text, or split long ones</title>
+
+  <comment>
+<!--    <cite date="2011-08-13" href="mailto:jwcampbell gmail com">Jim Campbell</cite>-->
+    <cite date="2011-08-16" 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 Join/Split lines plugin when editing documents.</p>
+  </comment>
+
+  <p>The <app>Join/Split Lines</app> plugin adds shortcuts that enable you to join together adjacent lines of text or split overly long lines into multiple lines. To enable the plugin, select <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Plugins</gui><gui>Join/Split Lines</gui></guiseq>.</p>
+  
+  <section id="joining-lines">
+    <title>Joining Lines</title>
+
+    <p>Once the plugin is enabled, you can join together multiple lines using <guiseq><gui>Edit</gui><gui>Join Lines</gui></guiseq> or <keyseq><key>Ctrl</key><key>J</key></keyseq>. If no text is selected, the current line and the line directly following it will be joined together. If you select a number of lines of text, they will all be joined together to form one line.</p>
+  
+  </section>
+  
+  <section id="splitting-lines">
+  <title>Splitting Lines</title>
+
+  <p>You can split apart long lines into multiple lines using <guiseq><gui>Edit</gui><gui>Split Lines</gui></guiseq> or <keyseq><key>Shift</key><key>Ctrl</key><key>J</key></keyseq>. If no text is selected, the current line will simply be split into multiple lines. If you select multiple lines, they will be split as one continuous block of text.</p>
+  
+  <p>If you select text starting part way through a line, the newly created lines will be indented to match the start of your selection. No splits will be made after the end of your selection.</p>
+  
+    <note style="tip"><p>You can change the maximum length of lines resulting from a split by adjusting the <em>Display right margin at column</em> field in <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>View</gui></guiseq>.</p></note>
+  </section>
+
+</page>
diff --git a/help/C/gedit-plugins-join-split-lines.page.stub b/help/C/gedit-plugins-join-split-lines.page.stub
deleted file mode 100644
index c698a3f..0000000
--- a/help/C/gedit-plugins-join-split-lines.page.stub
+++ /dev/null
@@ -1,32 +0,0 @@
-<page xmlns="http://projectmallard.org/1.0/";
-      type="topic" style="task"
-      id="gedit-plugins-join-split-lines">
-  <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>Join several lines of text, or split long ones</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

>From 492a736d9a51c55eb0880bcc9aa91a16042fb69e Mon Sep 17 00:00:00 2001
From: Paul Weaver <ch3pjw bath ac uk>
Date: Tue, 16 Aug 2011 18:48:18 +0100
Subject: [PATCH] Create contents for code comment plugin documentation,
 remove stub

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

diff --git a/help/C/gedit-plugins-code-comment.page b/help/C/gedit-plugins-code-comment.page
new file mode 100644
index 0000000..951fa8d
--- /dev/null
+++ b/help/C/gedit-plugins-code-comment.page
@@ -0,0 +1,36 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="gedit-plugins-code-comment">
+  <info>
+    <revision version="0.2" date="2011-08-13" status="draft"/>
+    <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
+
+    <credit type="author">
+      <name>Jim Campbell, Paul Weaver</name>
+      <email>jwcampbell gmail com</email>
+      <years>2011</years>
+    </credit>
+
+    <desc></desc>
+  </info>
+
+  <title>Comment-out or uncomment a block of code</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 code comment plugin when editing documents.</p>
+  </comment>
+
+  <p>The <app>Code Comment</app> plugin adds shortcuts that enable you to comment out sections of your documents quickly and easily. To enable the plugin, select <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Plugins</gui><gui>Code Comment</gui></guiseq>.</p>
+  
+<!--  <section id="using-code-comment">-->
+<!--    <title>Using Code Comment</title>-->
+
+    <p>Once the plugin is enabled, you can comment out the current line or multiple lines of your document using <guiseq><gui>Edit</gui><gui>Comment Code</gui></guiseq> or <keyseq><key>Ctrl</key><key>M</key></keyseq>. Similarly, comment symbols can be removed using <guiseq><gui>Edit</gui><gui>Uncomment Code</gui></guiseq> or <keyseq><key>Shift</key><key>Ctrl</key><key>M</key></keyseq>.</p>
+    
+    <note><p>The document format must support comments and be recognised by gedit.</p></note>
+    
+<!--  </section>-->
+
+</page>
diff --git a/help/C/gedit-plugins-code-comment.page.stub b/help/C/gedit-plugins-code-comment.page.stub
deleted file mode 100644
index ccae822..0000000
--- a/help/C/gedit-plugins-code-comment.page.stub
+++ /dev/null
@@ -1,32 +0,0 @@
-<page xmlns="http://projectmallard.org/1.0/";
-      type="topic" style="task"
-      id="gedit-plugins-code-comment">
-  <info>
-    <revision version="0.1" date="2011-08-13" status="stub"/>
-
-    <credit type="author">
-      <name>Jim Campbell</name>
-      <email>jwcampbell gmail com</email>
-      <years>2011</years>
-    </credit>
-
-    <desc></desc>
-  </info>
-
-  <title>Comment-out or uncomment a block of code</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