[gedit] completed solid draft of the plugins-modelines page



commit 85e7ff87caf4cd4e3fde79502a0dece4c84351f5
Author: Jim Campbell <jwcampbell gmail com>
Date:   Sun Feb 27 12:50:22 2011 -0600

    completed solid draft of the plugins-modelines page

 help/C/gedit-plugins-modelines.page |   48 ++++++++++++++++++++++++++--------
 1 files changed, 36 insertions(+), 12 deletions(-)
---
diff --git a/help/C/gedit-plugins-modelines.page b/help/C/gedit-plugins-modelines.page
index 3c30b7d..cda68f6 100644
--- a/help/C/gedit-plugins-modelines.page
+++ b/help/C/gedit-plugins-modelines.page
@@ -15,43 +15,67 @@
   </credit>
 </info>
 
-<title>Emacs, Kate and Vim-style modelines support for gedit.</title>
+<title>Emacs, Kate and Vim-style modelines support for gedit</title>
 
-<p>The <app>Modelines</app> plugin analyzes the lines of text at the start and end of a file, and then applies a set of document preferences.  The <app>Modelines</app> plugin supports a subset of the options used by the <app>Emacs</app>, <app>Kate</app> and <app>Vim</app> text editors.</p>
+<p>The <app>Modelines</app> plugin allows <app>gedit</app> to analyze the lines of text at the start and end of a file, and then apply a set of document preferences to the file. The <app>Modelines</app> plugin supports a subset of the options used by the <app>Emacs</app>, <app>Kate</app> and <app>Vim</app> text editors.</p>
 
-<p>You can set the following preferences with modelines:</p>
+<p>To enable the <app>Modelines</app> plugin, select <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Plugins</gui><gui>Modelines</gui></guiseq>.</p>
+
+<section id="modelines-general">
+<title>General Modeline Options</title>
+<p>The following options can be set using <app>gedit</app> modelines:</p>
 <list>
 <item><p>Tab width</p></item>
 <item><p>Indent width</p></item>
-<item><p>Insert spaces instead of tabs</p></item>
+<item><p>Inserting spaces instead of tabs</p></item>
 <item><p>Text Wrapping</p></item>
 <item><p>Right margin width</p></item>
 </list>
 
 <note><p>Preferences set using modelines take precedence over the ones specified in the preference dialog.</p></note>
+</section>
 
 <section id="modelines-emacs">
-<title>Emacs Modelines:</title>
+<title>Emacs Modelines</title>
 
-<p>The first two lines of a document are scanned for <app>Emacs</app> modelines, and <app>gedit</app> supports the following modeline options:</p>
+<p>The first two lines of a document are scanned for <app>Emacs</app> modelines, and <app>gedit</app> supports the following <app>Emacs</app> modeline options:</p>
 <list>
 <item><p>Tab-width</p></item>
 <item><p>Indent-offset</p></item>
 <item><p>Indent-tabs-mode</p></item>
 <item><p>Text auto-wrap</p></item>
 </list>
-<p>For more information on <app>Emacs</app> modelines, visit the GNU Emacs Manual.</p>
+<p>For more information on <app>Emacs</app> modelines, visit the <link href="http://www.gnu.org/software/emacs/manual/emacs.html";>GNU Emacs Manual</link>.</p>
 </section>
 
 <section id="modelines-kate">
-<title>Kate Modelines:</title>
+<title>Kate Modelines</title>
 
-<p>The first and last ten lines a document are scanned for Kate modelines.
+<p>The first and last ten lines a document are scanned for <app>Kate</app> modelines, and <app>gedit</app> supports the following <app>Kate</app> modeline options:</p>
 
-The Kate options for tab-width, indent-width, space-indent, word-wrap and word-wrap-column are supported. For more information, visit the Kate website.
+<list>
+<item><p>tab-width</p></item>
+<item><p>indent-width</p></item>
+<item><p>space-indent</p></item>
+<item><p>word-wrap</p></item>
+<item><p>word-wrap-column</p></item>
+</list>
 
-The first and last three lines a document are scanned for Vim modelines.
+<p>For more information about <app>Kate</app> modelines, visit the <link href="http://kate-editor.org/";>Kate website</link>.</p>
+</section>
+
+<section id="modelines-vim">
+<title>Vim Modelines</title>
+<p>The first and last three lines a document are scanned for <app>Vim</app> modelines, and <app>gedit</app> supports the following <app>Vim</app> modeline options:</p>
+
+<list>
+<item><p>et (expandtab)</p></item>
+<item><p>ts (tabstop)</p></item>
+<item><p>sw (shiftwidth)</p></item>
+<item><p>wrap</p></item>
+<item><p>textwidth</p></item>
+</list>
 
-The Vim options for et, expandtab, ts, tabstop, sw, shiftwidth, wrap, and textwidth are supported. For more information, visit the Vim website.</p>
+<p>For more information on <app>Vim</app> modelines, visit the <link href="http://www.vim.org/";>Vim website</link>.</p>
 </section>
 </page>



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