Revision: 1777 http://geany.svn.sourceforge.net/geany/?rev=1777&view=rev Author: ntrel Date: 2007-08-09 05:46:21 -0700 (Thu, 09 Aug 2007)
Log Message: ----------- Move 'About this document' section to end of Introduction. Update 'Contributing to this document' section.
Modified Paths: -------------- trunk/doc/geany.html trunk/doc/geany.txt
Modified: trunk/doc/geany.html =================================================================== --- trunk/doc/geany.html 2007-08-09 12:33:37 UTC (rev 1776) +++ trunk/doc/geany.html 2007-08-09 12:46:21 UTC (rev 1777) @@ -3,10 +3,10 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.4.1: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" /> <title>Geany</title> <meta name="authors" content="Enrico Tröger Nick Treleaven Frank Lanitz" /> -<meta name="date" content="2007-05-31" /> +<meta name="date" content="2007-08-09" /> <style type="text/css">
/* @@ -14,7 +14,7 @@ :Contact: enrico(dot)troeger(at)uvena(dot)de :Copyright: This stylesheet has been placed in the public domain.
-Stylesheet for use with Docutils based on a version of John Gabriele. +Stylesheet for Geany's documentation based on a version of John Gabriele. */
/*@import url(html4css1.css);*/ @@ -133,7 +133,7 @@ <br />Nick Treleaven <br />Frank Lanitz</td></tr> <tr><th class="docinfo-name">Date:</th> -<td>2007-05-31</td></tr> +<td>2007-08-09</td></tr> <tr><th class="docinfo-name">Version:</th> <td>0.12</td></tr> </tbody> @@ -149,9 +149,9 @@ <ul class="simple"> <li><a class="reference" href="#introduction" id="id2" name="id2">Introduction</a><ul> <li><a class="reference" href="#about-geany" id="id3" name="id3">About Geany</a></li> -<li><a class="reference" href="#about-this-document" id="id4" name="id4">About this document</a></li> -<li><a class="reference" href="#where-to-get-it" id="id5" name="id5">Where to get it</a></li> -<li><a class="reference" href="#license" id="id6" name="id6">License</a></li> +<li><a class="reference" href="#where-to-get-it" id="id4" name="id4">Where to get it</a></li> +<li><a class="reference" href="#license" id="id5" name="id5">License</a></li> +<li><a class="reference" href="#about-this-document" id="id6" name="id6">About this document</a></li> </ul> </li> <li><a class="reference" href="#installation" id="id7" name="id7">Installation</a><ul> @@ -320,17 +320,12 @@ </ul> </div> <div class="section"> -<h2><a class="toc-backref" href="#id4" id="about-this-document" name="about-this-document">About this document</a></h2> -<p>This documentation is available in various formats like HTML, text and -PDF. The latest version is always available at <a class="reference" href="http://geany.uvena.de">http://geany.uvena.de</a>.</p> -</div> -<div class="section"> -<h2><a class="toc-backref" href="#id5" id="where-to-get-it" name="where-to-get-it">Where to get it</a></h2> +<h2><a class="toc-backref" href="#id4" id="where-to-get-it" name="where-to-get-it">Where to get it</a></h2> <p>You can obtain Geany from <a class="reference" href="http://geany.uvena.de">http://geany.uvena.de</a> or perhaps also from your distributor.</p> </div> <div class="section"> -<h2><a class="toc-backref" href="#id6" id="license" name="license">License</a></h2> +<h2><a class="toc-backref" href="#id5" id="license" name="license">License</a></h2> <p>Geany is distributed under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. A copy of this @@ -340,7 +335,13 @@ <tt class="docutils literal"><span class="pre">scintilla/</span></tt>) has its own license, which can be found in the chapter, <a class="reference" href="#license-for-scintilla-and-scite">License for Scintilla and SciTE</a>.</p> </div> +<div class="section"> +<h2><a class="toc-backref" href="#id6" id="about-this-document" name="about-this-document">About this document</a></h2> +<p>This documentation is available in various formats like HTML, text and +PDF. The latest version is always available at <a class="reference" href="http://geany.uvena.de">http://geany.uvena.de</a>.</p> +<p>If you want to contribute to it, see <a class="reference" href="#contributing-to-this-document">Contributing to this document</a>.</p> </div> +</div> <div class="section"> <h1><a class="toc-backref" href="#id7" id="installation" name="installation">Installation</a></h1> <div class="section"> @@ -2202,21 +2203,21 @@ <div class="section"> <h1><a class="toc-backref" href="#id94" id="contributing-to-this-document" name="contributing-to-this-document">Contributing to this document</a></h1> <p>This document (<tt class="docutils literal"><span class="pre">geany.txt</span></tt>) is written in <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> -(or "reST"). The source file for it is located in Geany's "doc" +(or "reST"). The source file for it is located in Geany's <tt class="docutils literal"><span class="pre">doc</span></tt> subdirectory. If you intend on making changes, you should grab the source right from SVN to make sure you've got the newest version. After -editing the file, to build the html docs to see how your changes -look, run "make doc" in the subdirectory "doc" of Geany's source -directory. Your updated HTML docs will end up in the <tt class="docutils literal"><span class="pre">./html</span></tt> -directory. To generate a PDF file, use the command "make pdf" which -should generate a file called geany-0.12.pdf.</p> +editing the file, to build the HTML document to see how your changes +look, run "<tt class="docutils literal"><span class="pre">make</span> <span class="pre">doc</span></tt>" in the subdirectory <tt class="docutils literal"><span class="pre">doc</span></tt> of Geany's source +directory. This regenerates the <tt class="docutils literal"><span class="pre">geany.html</span></tt> file. To generate a PDF +file, use the command "<tt class="docutils literal"><span class="pre">make</span> <span class="pre">pdf</span></tt>" which should generate a file called +geany-0.12.pdf.</p> <p>After you are happy with your changes, create a patch:</p> <pre class="literal-block"> % svn diff geany.txt > foo.patch </pre> <p>and then submit that file to the mailing list for review.</p> <p>Note, you will need the Python docutils software package installed -to build the docs. The package is named "python-docutils" on Debian +to build the docs. The package is named <tt class="docutils literal"><span class="pre">python-docutils</span></tt> on Debian and Fedora systems.</p> </div> <div class="section"> @@ -2854,7 +2855,7 @@ <div class="footer"> <hr class="footer" /> <a class="reference" href="geany.txt">View document source</a>. -Generated on: 2007-08-09 09:53 UTC. +Generated on: 2007-08-09 12:40 UTC. Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
</div>
Modified: trunk/doc/geany.txt =================================================================== --- trunk/doc/geany.txt 2007-08-09 12:33:37 UTC (rev 1776) +++ trunk/doc/geany.txt 2007-08-09 12:46:21 UTC (rev 1777) @@ -54,14 +54,6 @@
-About this document -------------------- - -This documentation is available in various formats like HTML, text and -PDF. The latest version is always available at http://geany.uvena.de. - - - Where to get it ---------------
@@ -85,7 +77,17 @@
+About this document +-------------------
+This documentation is available in various formats like HTML, text and +PDF. The latest version is always available at http://geany.uvena.de. + +If you want to contribute to it, see `Contributing to this document`_. + + + + Installation ============
@@ -2013,14 +2015,14 @@ =============================
This document (``geany.txt``) is written in `reStructuredText`__ -(or "reST"). The source file for it is located in Geany's "doc" +(or "reST"). The source file for it is located in Geany's ``doc`` subdirectory. If you intend on making changes, you should grab the source right from SVN to make sure you've got the newest version. After -editing the file, to build the html docs to see how your changes -look, run "make doc" in the subdirectory "doc" of Geany's source -directory. Your updated HTML docs will end up in the ``./html`` -directory. To generate a PDF file, use the command "make pdf" which -should generate a file called geany-|(version)|.pdf. +editing the file, to build the HTML document to see how your changes +look, run "``make doc``" in the subdirectory ``doc`` of Geany's source +directory. This regenerates the ``geany.html`` file. To generate a PDF +file, use the command "``make pdf``" which should generate a file called +geany-|(version)|.pdf.
__ http://docutils.sourceforge.net/rst.html
@@ -2031,7 +2033,7 @@ and then submit that file to the mailing list for review.
Note, you will need the Python docutils software package installed -to build the docs. The package is named "python-docutils" on Debian +to build the docs. The package is named ``python-docutils`` on Debian and Fedora systems.
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.