[gedit] drafted the plugins-tag-list page and added the gedit-side-pane3 image for use in that page.



commit ee5678dfa4780d75cafc4f9ca00b356ebe995e03
Author: Jim Campbell <jwcampbell gmail com>
Date:   Fri Mar 11 13:48:52 2011 -0600

    drafted the plugins-tag-list page and added the gedit-side-pane3 image for use in that page.

 help/C/figures/gedit-side-pane3.png |  Bin 0 -> 2866 bytes
 help/C/gedit-plugins-tag-list.page  |   49 ++++++++++++++++++++++++++++++++--
 2 files changed, 46 insertions(+), 3 deletions(-)
---
diff --git a/help/C/figures/gedit-side-pane3.png b/help/C/figures/gedit-side-pane3.png
new file mode 100644
index 0000000..bc71a15
Binary files /dev/null and b/help/C/figures/gedit-side-pane3.png differ
diff --git a/help/C/gedit-plugins-tag-list.page b/help/C/gedit-plugins-tag-list.page
index 6804f4d..9dc6632 100644
--- a/help/C/gedit-plugins-tag-list.page
+++ b/help/C/gedit-plugins-tag-list.page
@@ -4,14 +4,57 @@
 
 <info>
   <link type="guide" xref="gedit-plugin-guide#gedit-default-plugins"/>
-  <desc>*Provides a method to easily insert into a document commonly used tags/strings without having to type them.</desc>
-  <revision pkgversion="3.0" version="0.1" date="2010-12-5" status="stub"/>
+  <revision pkgversion="3.0" version="0.9" date="2011-03-10" status="draft"/>
   <credit type="author">
     <name>Daniel Neel</name>
     <email>dneelyep gmail com</email>
   </credit>
+  <credit type="author">
+    <name>Jim Campbell</name>
+    <email>jwcampbell gmail com</email>
+  </credit>
 </info>
 
-<title>*Tag list</title>
+<title>Automatically insert tags, strings and special characters into a document</title>
+  <p>The <app>Tag List</app> plugin allows you to insert common tags and special characters from a list in the side pane. By default, the plugin can insert tags and special characters for HTML, XHTML, XSLT, XUL and LaTeX.</p>
+
+  <section id="using-tag-list">
+    <title>Using the Tag List plugin</title>
+
+      <p>To use the <app>Tag List</app> plugin, you will need to enable the plugin, and then activate the tag-list portion of the side pane.</p>
+
+    <section id="enable-tag-list-plugin">
+        <title>Enabling the Plugin</title>
+<p>You can activate the plugin by selecting <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Plugins</gui><gui>Tag List</gui></guiseq>. Once you have activated the plugin, access it by selecting <guiseq><gui>View</gui><gui>Side Pane</gui></guiseq>, or by pressing <key>F9</key>.</p>
+
+<p>The side pane initially shows a list of open documents, so to view and use the <app>tag list</app>, you will need to click on the tab showing the "plus" icon at the bottom of the side pane. The icon will look similar to this:</p>
+
+    <p>
+      <media type="image" mime="image/png" src="figures/gedit-side-pane3.png"/>
+    </p>
+    </section>
+    <section id="inserting-tags">
+      <title>Inserting Tags and Special Characters</title>
+
+  <p>The <app>tag list</app> uses a drop-down menu to let you choose from the different types of tags. For example, one tag option is <gui>HTML - Tags</gui>.</p>
+
+  <p>To start inserting tags, complete the following:</p>
+
+<list type="numbered">
+<item><p>Move the cursor to where you will want to insert the tag or special character.</p></item>
+<item><p>Select the desired tag type from the drop-down menu at the top of the side pane.</p></item>
+<item><p>Scroll through the list to find the desired tag or character.</p></item>
+<item><p>Double-click on the tag in the tag list.</p></item>
+</list>
+
+<p>The tag or special character you've chosen will then be displayed in your document.</p>
+    </section>
+  </section>
+<section id="tag-list-tips">
+  <title>Tag List Tips</title>
+<note style="tip"><p>You can also insert a tag by pressing <key>Return</key> or <keyseq><key>Shift</key><key>Return</key></keyseq>.</p> 
+ <p>Pressing the <key>Return</key> key will insert the tag at the cursor position, and then return focus to the document. Pressing <keyseq><key>Shift</key><key>Return</key></keyseq> will insert the tag at the cursor position, but will keep the focus on the <app>tag-list</app>.</p></note>
 
+<note style="tip"><p>You can see a preview of what text will be inserted for each tag and special character by clicking on the word the <gui>Preview</gui> at the bottom of the side pane.</p></note>
+  </section>
 </page>



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