GNOME.org
 

[gedit] docs - revised plugins-install and snippets documentation

commit cb2449d63a63d516533032645ed762161cc014be
Author: Jim Campbell <jwcampbell gmail com>
Date:   Fri Nov 18 19:48:30 2011 -0600

    docs - revised plugins-install and snippets documentation

 help/C/gedit-plugins-install.page  |   77 ++++++++++++++++++++---------------
 help/C/gedit-plugins-snippets.page |   27 ++++++------
 2 files changed, 57 insertions(+), 47 deletions(-)
---
diff --git a/help/C/gedit-plugins-install.page b/help/C/gedit-plugins-install.page
index c145f84..39ce396 100644
--- a/help/C/gedit-plugins-install.page
+++ b/help/C/gedit-plugins-install.page
@@ -4,7 +4,7 @@
 
   <info>
     <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
-    <revision pkgversion="3.2" version="1.0" date="2011-08-17" status="candidate"/>
+    <revision pkgversion="3.4" version="1.0" date="2011-11-18" status="candidate"/>
     <credit type="author">
       <name>Jim Campbell</name>
       <email>jwcampbell gmail com</email>
@@ -15,41 +15,52 @@
       <name>Daniel Neel</name>
       <email>dneelyep gmail com</email>
     </credit>
-    <desc>Some gedit plugins need to be manually installed. Here is how to install them.</desc>
+    <desc>How to install third-party plugins</desc>
   </info>
 
   <title>Additional gedit plugins</title>
 
-  <p>Installing third-party plugins gives you extra functionality that is not included by default in <app>gedit</app>. An online list of third-party plugins is maintained <link href="http://live.gnome.org/Gedit/Plugins#third_party";>here</link>.</p>
-
-  <section id="gedit-plugins-install-download">
-    <title>Obtain</title>
-    <p>The first step to install a plugin in <app>gedit</app> is to obtain the plugin. Third-party plugins will often be obtained by downloading them from the plugin's web site. Refer to the plugin's documentation for further information on obtaining the plugin - instructions will vary depending on the plugin.</p>
-  </section>
-
-  <section id="gedit-plugins-install-install">
-    <title>Install</title>
-    <!-- Are all plugins released as tarballs? If so, this section should focus on extracting the tarball into the proper directory. If not, it should focus on copying the files into the proper directory, to avoid confusion. Or maybe it would be better to focus solely on copying the files into the directory, as this applies for both a tarball and any other set of files. -->
-    <p>After you have obtained the plugin you wish to install, you will need to install it.</p>
-    <steps>
-      <title>Installing a Plugin</title>
-      <item><p>Locate the plugin files to be installed.</p></item>
-      <item>
-        <p>Install the plugin files:</p>
-        <list>
-          <item><p>Copy the plugin into <file>/home/<var>username</var>/.local/share/gedit/plugins</file></p></item>
-        </list>
-      </item>
-    </steps>
-    <p>After you have moved the plugin files into the correct directory, the plugin will appear in the Preferences menu (<guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Plugins</gui></guiseq>). From there, the plugin needs to be enabled to be used.</p>
-
-    <note style="tip">
-      <p>You will need to have hidden files displayed to view the <file>.local</file> directory. To display hidden files, click <guiseq><gui>View</gui><gui>Show Hidden Files</gui></guiseq> or press <keyseq><key>Ctrl</key><key>H</key></keyseq>.</p>
-    </note>
-
-    <note style="important">
-      <p>If the directory <file>.local/share/gedit/plugins/</file> is not present on your system, you will need to create it.</p>
-    </note>
-  </section>
+  <p>Installing third-party plugins gives you extra functionality that isn't 
+  available in default <app>gedit</app> plugins, or even the extra plugins that 
+  are part of the <app>gedit-plugins</app> package. An online list of 
+  third-party plugins is 
+  <link href="http://live.gnome.org/Gedit/Plugins#third_party";>kept here</link>.
+  </p>
+  
+  <p>Installing a third-party plugin involves downloading the plugin, placing 
+  the plugin files in the right directory, and activating the plugin.</p>
+  
+  <steps>
+    <item><p>You can usually download a plugin from the plugin's website, but 
+    may need to use a revision-control program like <app>git</app>, <app>
+    bazaar</app>, or <app>subversion</app> to copy a plugin's software 
+    repository from the internet. Refer to the plugin's documentation for 
+    information on getting the plugin.</p></item>
+    <item><p>Place the plugin files into the 
+    <file>/home/<var>username</var>/.local/share/gedit/plugins</file> directory.
+    </p>
+    <p>Of course, replace the word <var>username</var> with your own username.
+    </p></item>
+    <item><p>After you have placed the plugin files into the correct directory, 
+    the plugin will appear in the Preferences menu. Select <guiseq><gui>Edit
+    </gui><gui>Preferences</gui><gui>Plugins</gui><gui>[Name of Plugin]</gui>
+    </guiseq> to enable the plugin.</p></item>
+    <item><p>Click <gui>Close</gui>.</p></item>
+  </steps>
+  
+  <p>After you have enabled the plugin, it should be available for you to use.
+  </p>
+  
+  <note style="tip">
+    <p>The <file>.local</file> directory is hidden by default. To view it and 
+    other hidden files, select <guiseq><gui>View</gui><gui>Show Hidden 
+    Files</gui></guiseq>, or press <keyseq><key>Ctrl</key><key>H</key></keyseq>.
+    </p>
+  </note>
 
+  <note style="tip">
+    <p>If the directory <file>.local/share/gedit/plugins/</file> is not 
+    present on your system, you will need to create it.</p>
+  </note>
+  
 </page>
diff --git a/help/C/gedit-plugins-snippets.page b/help/C/gedit-plugins-snippets.page
index a44ab0a..5d2d3a0 100644
--- a/help/C/gedit-plugins-snippets.page
+++ b/help/C/gedit-plugins-snippets.page
@@ -4,9 +4,9 @@
 
 <info>
   <link type="guide" xref="gedit-plugin-guide#gedit-default-plugins"/>
-  <revision pkgversion="3.4" date="2010-12-5" status="incomplete"/>
+  <revision pkgversion="3.4" date="2010-12-5" status="draft"/>
   
-  <comment><p>As of 11/11/11 this document is still a work-in-progress. 
+  <comment><p>As of 11/18/11 this document is still a work-in-progress. 
   Translators, please do not attempt to translate this document yet, as it 
   will likely go through a couple of iterations. Thank you for being awesome.
   </p></comment>
@@ -27,10 +27,9 @@
 
   <p><app>Snippets</app> provide a convenient way of inserting repetitive 
   portions of code into your files. For example, an HTML snippet for the 
-  <code>img</code> tag would insert the appropriate opening and closing tags, 
-  as well as fixed places where you can enter information such as the path to 
-  the image, the image's alt-text, a description, and the image's height and 
-  width. This can help you complete basic coding tasks more quickly.</p>
+  <code><![CDATA[<img>]]></code> tag would insert the opening and closing 
+  portions of the tag, as well as fixed places where you can enter image 
+  attributes. This can make writing code easier and faster.</p>
   
   <p>To enable the <app>Snippets</app> plugin, select <guiseq><gui>Edit</gui>
   <gui>Preferences</gui><gui>Plugins</gui><gui>Snippets</gui></guiseq>.</p>
@@ -43,9 +42,10 @@
       <list>
         <item><p>Make sure the syntax is set appropriately.</p>
         <p>The status bar at the bottom of the <app>gedit</app> window will 
-        show the current language setting. <app>Gedit</app> will normally 
-        detect the language or syntax of the file that you're using, but 
-        sometimes you may need to set it.</p></item>
+        show the current language setting, and the language setting is what 
+        allows gedit to insert the proper snippets. <app>Gedit</app> will 
+        normally detect the language or syntax of the file that you're using, 
+        but sometimes you may need to set it.</p></item>
       </list>
         
       <figure>
@@ -56,16 +56,15 @@
       </figure>
       
       <list>
-        <item><p>Study the default snippets.</p>       
+        <item><p>Review the default snippets.</p>       
         <p>Select <guiseq><gui>Tools</gui><gui>Manage Snippets</gui></guiseq>.
         Review the snippets that are available for your language or syntax. 
         Find some basic snippets that you think might be useful for you.</p>
         </item>
         <item><p>Try using some of the snippets.</p>
-        <p>Type the snippet text, and then press the <key>Tab</key> key. The 
-        code should auto-complete for you. For example, if you set the syntax 
-        to <em>HTML</em>, type <code>head</code>, and press the <key>Tab</key> 
-        key, you should see something like this:</p></item>
+        <p>For example, if you set the syntax to <em>HTML</em>, type <code>head
+        </code>, and press the <key>Tab</key> key, you should see something 
+        like this:</p></item>
       </list>
       
         <code>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]