SF.net SVN: geany:[4282] trunk/doc

ntrel at users.sourceforge.net ntrel at xxxxx
Thu Oct 1 16:26:50 UTC 2009


Revision: 4282
          http://geany.svn.sourceforge.net/geany/?rev=4282&view=rev
Author:   ntrel
Date:     2009-10-01 16:26:44 +0000 (Thu, 01 Oct 2009)

Log Message:
-----------
Update file templates section, minor edits.

Modified Paths:
--------------
    trunk/doc/geany.html
    trunk/doc/geany.txt

Modified: trunk/doc/geany.html
===================================================================
--- trunk/doc/geany.html	2009-10-01 16:10:33 UTC (rev 4281)
+++ trunk/doc/geany.html	2009-10-01 16:26:44 UTC (rev 4282)
@@ -4566,7 +4566,7 @@
 <li>Function description</li>
 <li>Short GPL notice</li>
 <li>Short BSD notice</li>
-<li>Filetype template</li>
+<li>File templates</li>
 </ul>
 <p>To use these templates, just open the Edit menu or open the popup menu
 by right-clicking in the editor widget, and choose "Insert Comments"
@@ -4595,28 +4595,34 @@
 <p>File templates are templates used as the basis of a new file. To
 use them, choose the <em>New (with Template)</em> menu item from the <em>File</em>
 menu.</p>
-<p>By default, templates are created for some filetypes. Custom file
-templates can be added by creating the appropriate template file and
-restarting Geany. You can also edit the default filetype templates.</p>
-<p>The file's contents are just the text to place in the document,
-except for the optional <tt class="docutils literal"><span class="pre">{fileheader}</span></tt> template wildcard. This can
-be placed anywhere, but is usually on the first line of the file,
-followed by a blank line.</p>
+<p>By default, file templates are installed for some filetypes. Custom
+file templates can be added by creating the appropriate template file
+and restarting Geany. You can also edit the default file templates.</p>
+<p>The file's contents are just the text to place in the document, with
+optional template wildcards like <tt class="docutils literal"><span class="pre">{fileheader}</span></tt>. The fileheader
+wildcard can be placed anywhere, but it's usually put on the first
+line of the file, followed by a blank line.</p>
 <div class="section">
 <h4><a class="toc-backref" href="#id192" id="custom-file-templates" name="custom-file-templates">Custom file templates</a></h4>
-<p>These are read from the <tt class="docutils literal"><span class="pre">$prefix/share/geany/templates/files</span></tt>
-directory (see <a class="reference" href="#installation-prefix">Installation prefix</a>) and the
-<tt class="docutils literal"><span class="pre">~/.config/geany/templates/files</span></tt> directory (created the first time
-Geany is started). The filetype to use is detected from the template
-file's extension, if any. For example, creating a file <tt class="docutils literal"><span class="pre">main.c</span></tt>
-would add a menu item which created a new document with the filetype
-set to 'C'.</p>
+<p>These are read from the following directories:</p>
+<ul class="simple">
+<li><tt class="docutils literal"><span class="pre">$prefix/share/geany/templates/files</span></tt> (see <a class="reference" href="#installation-prefix">Installation prefix</a>)</li>
+<li><tt class="docutils literal"><span class="pre">~/.config/geany/templates/files</span></tt> (created the first time
+Geany is started).</li>
+</ul>
+<p>The filetype to use is detected from the template file's extension, if
+any. For example, creating a file <tt class="docutils literal"><span class="pre">module.c</span></tt> would add a menu item
+which created a new document with the filetype set to 'C'.</p>
 <p>The template file is read from disk when the corresponding menu item is
 clicked, so you don't need to restart Geany after editing a custom file
 template, only after adding a new one.</p>
 </div>
 <div class="section">
 <h4><a class="toc-backref" href="#id193" id="filetype-templates" name="filetype-templates">Filetype templates</a></h4>
+<div class="note">
+<p class="first admonition-title">Note</p>
+<p class="last">It's recommended to use custom file templates instead.</p>
+</div>
 <p>Filetype template files are read from the <tt class="docutils literal"><span class="pre">~/.config/geany/templates</span></tt>
 directory, and are named "filetype." followed by the filetype
 name, e.g. "filetype.python", "filetype.sh", etc. If you are
@@ -5708,7 +5714,7 @@
 <div class="footer">
 <hr class="footer" />
 <a class="reference" href="geany.txt">View document source</a>.
-Generated on: 2009-09-30 14:52 UTC.
+Generated on: 2009-10-01 16:22 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	2009-10-01 16:10:33 UTC (rev 4281)
+++ trunk/doc/geany.txt	2009-10-01 16:26:44 UTC (rev 4282)
@@ -3952,7 +3952,7 @@
 * Function description
 * Short GPL notice
 * Short BSD notice
-* Filetype template
+* File templates
 
 To use these templates, just open the Edit menu or open the popup menu
 by right-clicking in the editor widget, and choose "Insert Comments"
@@ -3990,26 +3990,28 @@
 use them, choose the *New (with Template)* menu item from the *File*
 menu.
 
-By default, templates are created for some filetypes. Custom file
-templates can be added by creating the appropriate template file and
-restarting Geany. You can also edit the default filetype templates.
+By default, file templates are installed for some filetypes. Custom
+file templates can be added by creating the appropriate template file
+and restarting Geany. You can also edit the default file templates.
 
-The file's contents are just the text to place in the document,
-except for the optional ``{fileheader}`` template wildcard. This can
-be placed anywhere, but is usually on the first line of the file,
-followed by a blank line.
+The file's contents are just the text to place in the document, with
+optional template wildcards like ``{fileheader}``. The fileheader
+wildcard can be placed anywhere, but it's usually put on the first
+line of the file, followed by a blank line.
 
 Custom file templates
 `````````````````````
 
-These are read from the ``$prefix/share/geany/templates/files``
-directory (see `Installation prefix`_) and the
-``~/.config/geany/templates/files`` directory (created the first time
-Geany is started). The filetype to use is detected from the template
-file's extension, if any. For example, creating a file ``main.c``
-would add a menu item which created a new document with the filetype
-set to 'C'.
+These are read from the following directories:
 
+* ``$prefix/share/geany/templates/files`` (see `Installation prefix`_)
+* ``~/.config/geany/templates/files`` (created the first time
+  Geany is started).
+
+The filetype to use is detected from the template file's extension, if
+any. For example, creating a file ``module.c`` would add a menu item
+which created a new document with the filetype set to 'C'.
+
 The template file is read from disk when the corresponding menu item is
 clicked, so you don't need to restart Geany after editing a custom file
 template, only after adding a new one.
@@ -4017,6 +4019,9 @@
 Filetype templates
 ``````````````````
 
+.. note::
+    It's recommended to use custom file templates instead.
+
 Filetype template files are read from the ``~/.config/geany/templates``
 directory, and are named "filetype." followed by the filetype
 name, e.g. "filetype.python", "filetype.sh", etc. If you are


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



More information about the Commits mailing list