SF.net SVN: geany-plugins:[1513] trunk/geany-plugins/geanygendoc

[colombanw at users.sourceforge.net]

Revision: 1513
          http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1513&view=rev
Author:   colombanw
Date:     2010-08-17 00:34:33 +0000 (Tue, 17 Aug 2010)

Log Message:
-----------
GeanyGenDoc: Improve a bit manual's introduction

Add a small sentence in the introduction to guide the user in her
read.

Modified Paths:
--------------
    trunk/geany-plugins/geanygendoc/ChangeLog
    trunk/geany-plugins/geanygendoc/docs/manual.html
    trunk/geany-plugins/geanygendoc/docs/manual.rst

Modified: trunk/geany-plugins/geanygendoc/ChangeLog
===================================================================
--- trunk/geany-plugins/geanygendoc/ChangeLog	2010-08-17 00:34:11 UTC (rev 1512)
+++ trunk/geany-plugins/geanygendoc/ChangeLog	2010-08-17 00:34:33 UTC (rev 1513)
@@ -7,6 +7,8 @@
   * docs/manual.rst, docs/manual.html:
     Move "User interface in Geany" part on the top of the manual. This part is
     probably the first new users would look at, then move it to the top.
+  * docs/manual.rst, docs/manual.html:
+    Add a small sentence in the introduction to guide the user in her read.
 
 
 2010-06-14  Colomban Wendling  <ban(at)herbesfolles(dot)org>

Modified: trunk/geany-plugins/geanygendoc/docs/manual.html
===================================================================
--- trunk/geany-plugins/geanygendoc/docs/manual.html	2010-08-17 00:34:11 UTC (rev 1512)
+++ trunk/geany-plugins/geanygendoc/docs/manual.html	2010-08-17 00:34:33 UTC (rev 1513)
@@ -95,6 +95,9 @@
 plug-in for Geany as you might have noticed; but what is it meant to do?
 Basically, it generates and inserts text chunks, particularly from document's
 symbols. Its goal is to ease writing documentation for the good.</p>
+<p>If you are impatient, you will probably want to discover the <a class="reference internal" href="#user-interface-in-geany">user interface in
+Geany</a> first; but if you have the time to discover the tool, take a look at the
+<a class="reference internal" href="#design">design</a> and learn how GeanyGenDoc works and how you can take the most of it.</p>
 <div class="contents topic" id="contents">
 <p class="topic-title first">Contents</p>
 <ul class="simple">

Modified: trunk/geany-plugins/geanygendoc/docs/manual.rst
===================================================================
--- trunk/geany-plugins/geanygendoc/docs/manual.rst	2010-08-17 00:34:11 UTC (rev 1512)
+++ trunk/geany-plugins/geanygendoc/docs/manual.rst	2010-08-17 00:34:33 UTC (rev 1513)
@@ -14,7 +14,11 @@
 Basically, it generates and inserts text chunks, particularly from document's
 symbols. Its goal is to ease writing documentation for the good.
 
+If you are impatient, you will probably want to discover the `user interface in
+Geany`_ first; but if you have the time to discover the tool, take a look at the
+`design`_ and learn how GeanyGenDoc works and how you can take the most of it.
 
+
 .. contents::
 
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.