SF.net SVN: geany:[5644] trunk
ntrel at users.sourceforge.net
ntrel at xxxxx
Tue Mar 29 13:51:50 UTC 2011
Revision: 5644
http://geany.svn.sourceforge.net/geany/?rev=5644&view=rev
Author: ntrel
Date: 2011-03-29 13:51:50 +0000 (Tue, 29 Mar 2011)
Log Message:
-----------
Add #filenames subsection for filetype definition files explaining
the filename extensions and special cases.
Modified Paths:
--------------
trunk/ChangeLog
trunk/doc/geany.html
trunk/doc/geany.txt
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2011-03-29 13:26:39 UTC (rev 5643)
+++ trunk/ChangeLog 2011-03-29 13:51:50 UTC (rev 5644)
@@ -3,6 +3,9 @@
* doc/geany.txt, doc/geany.html:
Add #reading-styles-from-another-filetype subsection, based on
patch by Matthew Brush (thanks).
+ * doc/geany.txt, doc/geany.html:
+ Add #filenames subsection for filetype definition files explaining
+ the filename extensions and special cases.
2011-03-28 Colomban Wendling <colomban(at)geany(dot)org>
Modified: trunk/doc/geany.html
===================================================================
--- trunk/doc/geany.html 2011-03-29 13:26:39 UTC (rev 5643)
+++ trunk/doc/geany.html 2011-03-29 13:51:50 UTC (rev 5644)
@@ -6,7 +6,7 @@
<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="2011-03-27" />
+<meta name="date" content="2011-03-29" />
<style type="text/css">
/*
@@ -139,7 +139,7 @@
<br />Nick Treleaven
<br />Frank Lanitz</td></tr>
<tr><th class="docinfo-name">Date:</th>
-<td>2011-03-27</td></tr>
+<td>2011-03-29</td></tr>
<tr><th class="docinfo-name">Version:</th>
<td>0.21</td></tr>
</tbody>
@@ -410,104 +410,105 @@
<li><a class="reference" href="#tools-menu-items" id="id175" name="id175">Tools menu items</a></li>
<li><a class="reference" href="#global-configuration-file" id="id176" name="id176">Global configuration file</a></li>
<li><a class="reference" href="#filetype-definition-files" id="id177" name="id177">Filetype definition files</a><ul>
-<li><a class="reference" href="#system-files" id="id178" name="id178">System files</a></li>
-<li><a class="reference" href="#user-files" id="id179" name="id179">User files</a></li>
-<li><a class="reference" href="#custom-filetypes" id="id180" name="id180">Custom filetypes</a><ul>
-<li><a class="reference" href="#creating-a-custom-filetype-from-an-existing-filetype" id="id181" name="id181">Creating a custom filetype from an existing filetype</a></li>
+<li><a class="reference" href="#filenames" id="id178" name="id178">Filenames</a></li>
+<li><a class="reference" href="#system-files" id="id179" name="id179">System files</a></li>
+<li><a class="reference" href="#user-files" id="id180" name="id180">User files</a></li>
+<li><a class="reference" href="#custom-filetypes" id="id181" name="id181">Custom filetypes</a><ul>
+<li><a class="reference" href="#creating-a-custom-filetype-from-an-existing-filetype" id="id182" name="id182">Creating a custom filetype from an existing filetype</a></li>
</ul>
</li>
-<li><a class="reference" href="#filetype-configuration" id="id182" name="id182">Filetype configuration</a><ul>
-<li><a class="reference" href="#styling-section" id="id183" name="id183">[styling] Section</a><ul>
-<li><a class="reference" href="#using-a-named-style" id="id184" name="id184">Using a named style</a></li>
-<li><a class="reference" href="#reading-styles-from-another-filetype" id="id185" name="id185">Reading styles from another filetype</a></li>
+<li><a class="reference" href="#filetype-configuration" id="id183" name="id183">Filetype configuration</a><ul>
+<li><a class="reference" href="#styling-section" id="id184" name="id184">[styling] Section</a><ul>
+<li><a class="reference" href="#using-a-named-style" id="id185" name="id185">Using a named style</a></li>
+<li><a class="reference" href="#reading-styles-from-another-filetype" id="id186" name="id186">Reading styles from another filetype</a></li>
</ul>
</li>
-<li><a class="reference" href="#keywords-section" id="id186" name="id186">[keywords] Section</a></li>
-<li><a class="reference" href="#lexer-properties-section" id="id187" name="id187">[lexer_properties] Section</a></li>
-<li><a class="reference" href="#settings-section" id="id188" name="id188">[settings] Section</a></li>
-<li><a class="reference" href="#build-settings-section" id="id189" name="id189">[build_settings] Section</a></li>
+<li><a class="reference" href="#keywords-section" id="id187" name="id187">[keywords] Section</a></li>
+<li><a class="reference" href="#lexer-properties-section" id="id188" name="id188">[lexer_properties] Section</a></li>
+<li><a class="reference" href="#settings-section" id="id189" name="id189">[settings] Section</a></li>
+<li><a class="reference" href="#build-settings-section" id="id190" name="id190">[build_settings] Section</a></li>
</ul>
</li>
-<li><a class="reference" href="#special-file-filetypes-common" id="id190" name="id190">Special file filetypes.common</a><ul>
-<li><a class="reference" href="#named-styles-section" id="id191" name="id191">[named_styles] Section</a></li>
-<li><a class="reference" href="#id4" id="id192" name="id192">[styling] Section</a></li>
-<li><a class="reference" href="#id5" id="id193" name="id193">[settings] Section</a></li>
+<li><a class="reference" href="#special-file-filetypes-common" id="id191" name="id191">Special file filetypes.common</a><ul>
+<li><a class="reference" href="#named-styles-section" id="id192" name="id192">[named_styles] Section</a></li>
+<li><a class="reference" href="#id4" id="id193" name="id193">[styling] Section</a></li>
+<li><a class="reference" href="#id5" id="id194" name="id194">[settings] Section</a></li>
</ul>
</li>
</ul>
</li>
-<li><a class="reference" href="#filetype-extensions" id="id194" name="id194">Filetype extensions</a></li>
-<li><a class="reference" href="#preferences-file-format" id="id195" name="id195">Preferences File Format</a><ul>
-<li><a class="reference" href="#hidden-preferences" id="id196" name="id196">Hidden preferences</a></li>
-<li><a class="reference" href="#build-menu-section" id="id197" name="id197">[build-menu] Section</a></li>
+<li><a class="reference" href="#filetype-extensions" id="id195" name="id195">Filetype extensions</a></li>
+<li><a class="reference" href="#preferences-file-format" id="id196" name="id196">Preferences File Format</a><ul>
+<li><a class="reference" href="#hidden-preferences" id="id197" name="id197">Hidden preferences</a></li>
+<li><a class="reference" href="#build-menu-section" id="id198" name="id198">[build-menu] Section</a></li>
</ul>
</li>
-<li><a class="reference" href="#project-file-format" id="id198" name="id198">Project File Format</a><ul>
-<li><a class="reference" href="#build-menu-additions" id="id199" name="id199">[build-menu] Additions</a></li>
+<li><a class="reference" href="#project-file-format" id="id199" name="id199">Project File Format</a><ul>
+<li><a class="reference" href="#build-menu-additions" id="id200" name="id200">[build-menu] Additions</a></li>
</ul>
</li>
-<li><a class="reference" href="#templates" id="id200" name="id200">Templates</a><ul>
-<li><a class="reference" href="#template-meta-data" id="id201" name="id201">Template meta data</a></li>
-<li><a class="reference" href="#file-templates" id="id202" name="id202">File templates</a><ul>
-<li><a class="reference" href="#custom-file-templates" id="id203" name="id203">Custom file templates</a></li>
-<li><a class="reference" href="#filetype-templates" id="id204" name="id204">Filetype templates</a></li>
+<li><a class="reference" href="#templates" id="id201" name="id201">Templates</a><ul>
+<li><a class="reference" href="#template-meta-data" id="id202" name="id202">Template meta data</a></li>
+<li><a class="reference" href="#file-templates" id="id203" name="id203">File templates</a><ul>
+<li><a class="reference" href="#custom-file-templates" id="id204" name="id204">Custom file templates</a></li>
+<li><a class="reference" href="#filetype-templates" id="id205" name="id205">Filetype templates</a></li>
</ul>
</li>
-<li><a class="reference" href="#customizing-templates" id="id205" name="id205">Customizing templates</a><ul>
-<li><a class="reference" href="#template-wildcards" id="id206" name="id206">Template wildcards</a><ul>
-<li><a class="reference" href="#special-command-wildcard" id="id207" name="id207">Special {command:} wildcard</a></li>
+<li><a class="reference" href="#customizing-templates" id="id206" name="id206">Customizing templates</a><ul>
+<li><a class="reference" href="#template-wildcards" id="id207" name="id207">Template wildcards</a><ul>
+<li><a class="reference" href="#special-command-wildcard" id="id208" name="id208">Special {command:} wildcard</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
-<li><a class="reference" href="#customizing-the-toolbar" id="id208" name="id208">Customizing the toolbar</a><ul>
-<li><a class="reference" href="#manually-editing-the-toolbar-layout" id="id209" name="id209">Manually editing the toolbar layout</a></li>
-<li><a class="reference" href="#available-toolbar-elements" id="id210" name="id210">Available toolbar elements</a></li>
+<li><a class="reference" href="#customizing-the-toolbar" id="id209" name="id209">Customizing the toolbar</a><ul>
+<li><a class="reference" href="#manually-editing-the-toolbar-layout" id="id210" name="id210">Manually editing the toolbar layout</a></li>
+<li><a class="reference" href="#available-toolbar-elements" id="id211" name="id211">Available toolbar elements</a></li>
</ul>
</li>
</ul>
</li>
-<li><a class="reference" href="#plugin-documentation" id="id211" name="id211">Plugin documentation</a><ul>
-<li><a class="reference" href="#html-characters" id="id212" name="id212">HTML Characters</a><ul>
-<li><a class="reference" href="#insert-entity-dialog" id="id213" name="id213">Insert entity dialog</a></li>
-<li><a class="reference" href="#replace-special-chars-by-its-entity" id="id214" name="id214">Replace special chars by its entity</a><ul>
-<li><a class="reference" href="#at-typing-time" id="id215" name="id215">At typing time</a></li>
-<li><a class="reference" href="#bulk-replacement" id="id216" name="id216">Bulk replacement</a></li>
+<li><a class="reference" href="#plugin-documentation" id="id212" name="id212">Plugin documentation</a><ul>
+<li><a class="reference" href="#html-characters" id="id213" name="id213">HTML Characters</a><ul>
+<li><a class="reference" href="#insert-entity-dialog" id="id214" name="id214">Insert entity dialog</a></li>
+<li><a class="reference" href="#replace-special-chars-by-its-entity" id="id215" name="id215">Replace special chars by its entity</a><ul>
+<li><a class="reference" href="#at-typing-time" id="id216" name="id216">At typing time</a></li>
+<li><a class="reference" href="#bulk-replacement" id="id217" name="id217">Bulk replacement</a></li>
</ul>
</li>
</ul>
</li>
-<li><a class="reference" href="#save-actions" id="id217" name="id217">Save Actions</a><ul>
-<li><a class="reference" href="#instant-save" id="id218" name="id218">Instant Save</a></li>
-<li><a class="reference" href="#backup-copy" id="id219" name="id219">Backup Copy</a></li>
+<li><a class="reference" href="#save-actions" id="id218" name="id218">Save Actions</a><ul>
+<li><a class="reference" href="#instant-save" id="id219" name="id219">Instant Save</a></li>
+<li><a class="reference" href="#backup-copy" id="id220" name="id220">Backup Copy</a></li>
</ul>
</li>
</ul>
</li>
-<li><a class="reference" href="#contributing-to-this-document" id="id220" name="id220">Contributing to this document</a></li>
-<li><a class="reference" href="#scintilla-keyboard-commands" id="id221" name="id221">Scintilla keyboard commands</a><ul>
-<li><a class="reference" href="#keyboard-commands" id="id222" name="id222">Keyboard commands</a></li>
+<li><a class="reference" href="#contributing-to-this-document" id="id221" name="id221">Contributing to this document</a></li>
+<li><a class="reference" href="#scintilla-keyboard-commands" id="id222" name="id222">Scintilla keyboard commands</a><ul>
+<li><a class="reference" href="#keyboard-commands" id="id223" name="id223">Keyboard commands</a></li>
</ul>
</li>
-<li><a class="reference" href="#tips-and-tricks" id="id223" name="id223">Tips and tricks</a><ul>
-<li><a class="reference" href="#document-notebook" id="id224" name="id224">Document notebook</a></li>
-<li><a class="reference" href="#editor" id="id225" name="id225">Editor</a></li>
-<li><a class="reference" href="#interface" id="id226" name="id226">Interface</a></li>
-<li><a class="reference" href="#gtk-related" id="id227" name="id227">GTK-related</a></li>
+<li><a class="reference" href="#tips-and-tricks" id="id224" name="id224">Tips and tricks</a><ul>
+<li><a class="reference" href="#document-notebook" id="id225" name="id225">Document notebook</a></li>
+<li><a class="reference" href="#editor" id="id226" name="id226">Editor</a></li>
+<li><a class="reference" href="#interface" id="id227" name="id227">Interface</a></li>
+<li><a class="reference" href="#gtk-related" id="id228" name="id228">GTK-related</a></li>
</ul>
</li>
-<li><a class="reference" href="#compile-time-options" id="id228" name="id228">Compile-time options</a><ul>
-<li><a class="reference" href="#src-geany-h" id="id229" name="id229">src/geany.h</a></li>
-<li><a class="reference" href="#project-h" id="id230" name="id230">project.h</a></li>
-<li><a class="reference" href="#editor-h" id="id231" name="id231">editor.h</a></li>
-<li><a class="reference" href="#keyfile-c" id="id232" name="id232">keyfile.c</a></li>
-<li><a class="reference" href="#build-c" id="id233" name="id233">build.c</a></li>
+<li><a class="reference" href="#compile-time-options" id="id229" name="id229">Compile-time options</a><ul>
+<li><a class="reference" href="#src-geany-h" id="id230" name="id230">src/geany.h</a></li>
+<li><a class="reference" href="#project-h" id="id231" name="id231">project.h</a></li>
+<li><a class="reference" href="#editor-h" id="id232" name="id232">editor.h</a></li>
+<li><a class="reference" href="#keyfile-c" id="id233" name="id233">keyfile.c</a></li>
+<li><a class="reference" href="#build-c" id="id234" name="id234">build.c</a></li>
</ul>
</li>
-<li><a class="reference" href="#gnu-general-public-license" id="id234" name="id234">GNU General Public License</a></li>
-<li><a class="reference" href="#license-for-scintilla-and-scite" id="id235" name="id235">License for Scintilla and SciTE</a></li>
+<li><a class="reference" href="#gnu-general-public-license" id="id235" name="id235">GNU General Public License</a></li>
+<li><a class="reference" href="#license-for-scintilla-and-scite" id="id236" name="id236">License for Scintilla and SciTE</a></li>
</ul>
</div>
<div class="section">
@@ -4335,7 +4336,48 @@
word delimiter characters as well as compiler and linker settings.</p>
<p>See also <a class="reference" href="#configuration-file-paths">Configuration file paths</a>.</p>
<div class="section">
-<h3><a class="toc-backref" href="#id178" id="system-files" name="system-files">System files</a></h3>
+<h3><a class="toc-backref" href="#id178" id="filenames" name="filenames">Filenames</a></h3>
+<p>Each filetype has a corresponding filetype definition file. The format
+for built-in filetype <cite>Foo</cite> is:</p>
+<pre class="literal-block">
+filetypes.foo
+</pre>
+<p>The extension is normally just the filetype name in lower case.</p>
+<p>However there are some exceptions:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="63%" />
+<col width="38%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">Filetype</th>
+<th class="head">Extension</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td>C++</td>
+<td>cpp</td>
+</tr>
+<tr><td>C#</td>
+<td>cs</td>
+</tr>
+<tr><td>Make</td>
+<td>makefile</td>
+</tr>
+<tr><td>Matlab/Octave</td>
+<td>matlab</td>
+</tr>
+</tbody>
+</table>
+<p>There is also the <a class="reference" href="#special-file-filetypes-common">special file filetypes.common</a>.</p>
+<p>For <a class="reference" href="#custom-filetypes">custom filetypes</a>, the filename for <cite>Foo</cite> is different:</p>
+<pre class="literal-block">
+filetypes.Foo.conf
+</pre>
+<p>See the link for details.</p>
+</div>
+<div class="section">
+<h3><a class="toc-backref" href="#id179" id="system-files" name="system-files">System files</a></h3>
<p>The system-wide filetype configuration files can be found in the
system configuration path and are called <tt class="docutils literal"><span class="pre">filetypes.$ext</span></tt>,
where $ext is the name of the filetype. For every
@@ -4349,7 +4391,7 @@
</div>
</div>
<div class="section">
-<h3><a class="toc-backref" href="#id179" id="user-files" name="user-files">User files</a></h3>
+<h3><a class="toc-backref" href="#id180" id="user-files" name="user-files">User files</a></h3>
<p>To change the settings, copy a file from the system configuration
path to the subdirectory <tt class="docutils literal"><span class="pre">filedefs</span></tt> in your user configuration
directory. Then you can edit the file and the changes will still be
@@ -4359,7 +4401,7 @@
the corresponding system configuration file.</p>
</div>
<div class="section">
-<h3><a class="toc-backref" href="#id180" id="custom-filetypes" name="custom-filetypes">Custom filetypes</a></h3>
+<h3><a class="toc-backref" href="#id181" id="custom-filetypes" name="custom-filetypes">Custom filetypes</a></h3>
<p>At startup Geany looks for <tt class="docutils literal"><span class="pre">filetypes.*.conf</span></tt> files in the system and
user filetype paths, adding any filetypes found with the name matching
the '<tt class="docutils literal"><span class="pre">*</span></tt>' wildcard - e.g. <tt class="docutils literal"><span class="pre">filetypes.Bar.conf</span></tt>.</p>
@@ -4385,7 +4427,7 @@
</ul>
<p>See <a class="reference" href="#filetype-configuration">Filetype configuration</a> for details on each setting.</p>
<div class="section">
-<h4><a class="toc-backref" href="#id181" id="creating-a-custom-filetype-from-an-existing-filetype" name="creating-a-custom-filetype-from-an-existing-filetype">Creating a custom filetype from an existing filetype</a></h4>
+<h4><a class="toc-backref" href="#id182" id="creating-a-custom-filetype-from-an-existing-filetype" name="creating-a-custom-filetype-from-an-existing-filetype">Creating a custom filetype from an existing filetype</a></h4>
<p>Because most filetype settings will relate to the syntax
highlighting (e.g. styling, keywords, <tt class="docutils literal"><span class="pre">lexer_properties</span></tt>
sections), it is best to copy an existing filetype file that uses
@@ -4406,11 +4448,11 @@
</div>
</div>
<div class="section">
-<h3><a class="toc-backref" href="#id182" id="filetype-configuration" name="filetype-configuration">Filetype configuration</a></h3>
+<h3><a class="toc-backref" href="#id183" id="filetype-configuration" name="filetype-configuration">Filetype configuration</a></h3>
<p>As well as the sections listed below, each filetype file can contain
a [build-menu] section as described in <a class="reference" href="#build-menu-section">[build-menu] Section</a>.</p>
<div class="section">
-<h4><a class="toc-backref" href="#id183" id="styling-section" name="styling-section">[styling] Section</a></h4>
+<h4><a class="toc-backref" href="#id184" id="styling-section" name="styling-section">[styling] Section</a></h4>
<p>In this section the colors for syntax highlighting are defined. The
manual format is:</p>
<ul class="simple">
@@ -4426,7 +4468,7 @@
<p>This makes the key style have red foreground text, default background
color text and bold emphasis.</p>
<div class="section">
-<h5><a class="toc-backref" href="#id184" id="using-a-named-style" name="using-a-named-style">Using a named style</a></h5>
+<h5><a class="toc-backref" href="#id185" id="using-a-named-style" name="using-a-named-style">Using a named style</a></h5>
<p>The second format uses a <em>named style</em> name to reference a style
defined in filetypes.common.</p>
<ul class="simple">
@@ -4444,7 +4486,7 @@
Section</a>.</p>
</div>
<div class="section">
-<h5><a class="toc-backref" href="#id185" id="reading-styles-from-another-filetype" name="reading-styles-from-another-filetype">Reading styles from another filetype</a></h5>
+<h5><a class="toc-backref" href="#id186" id="reading-styles-from-another-filetype" name="reading-styles-from-another-filetype">Reading styles from another filetype</a></h5>
<p>You can automatically copy all of the styles from another filetype
definition file by using the following syntax for the <tt class="docutils literal"><span class="pre">[styling]</span></tt>
group:</p>
@@ -4463,7 +4505,7 @@
</div>
</div>
<div class="section">
-<h4><a class="toc-backref" href="#id186" id="keywords-section" name="keywords-section">[keywords] Section</a></h4>
+<h4><a class="toc-backref" href="#id187" id="keywords-section" name="keywords-section">[keywords] Section</a></h4>
<p>This section contains keys for different keyword lists specific to
the filetype. Some filetypes do not support keywords, so adding a
new key will not work. You can only add or remove keywords to/from
@@ -4474,7 +4516,7 @@
</div>
</div>
<div class="section">
-<h4><a class="toc-backref" href="#id187" id="lexer-properties-section" name="lexer-properties-section">[lexer_properties] Section</a></h4>
+<h4><a class="toc-backref" href="#id188" id="lexer-properties-section" name="lexer-properties-section">[lexer_properties] Section</a></h4>
<p>Here any special properties for the Scintilla lexer can be set in the
format <tt class="docutils literal"><span class="pre">key.name.field=some.value</span></tt>.</p>
<p>Properties Geany uses are listed in the system filetype files. To find
@@ -4484,7 +4526,7 @@
</pre>
</div>
<div class="section">
-<h4><a class="toc-backref" href="#id188" id="settings-section" name="settings-section">[settings] Section</a></h4>
+<h4><a class="toc-backref" href="#id189" id="settings-section" name="settings-section">[settings] Section</a></h4>
<dl class="docutils">
<dt>extension</dt>
<dd><p class="first">This is the default file extension used when saving files, not
@@ -4607,7 +4649,7 @@
</dl>
</div>
<div class="section">
-<h4><a class="toc-backref" href="#id189" id="build-settings-section" name="build-settings-section">[build_settings] Section</a></h4>
+<h4><a class="toc-backref" href="#id190" id="build-settings-section" name="build-settings-section">[build_settings] Section</a></h4>
<p>As of Geany 0.19 this section is supplemented by the <a class="reference" href="#build-menu-section">[build-menu] Section</a>.
Values that are set in the [build-menu] section will override those in this section.</p>
<dl class="docutils">
@@ -4660,7 +4702,7 @@
</div>
</div>
<div class="section">
-<h3><a class="toc-backref" href="#id190" id="special-file-filetypes-common" name="special-file-filetypes-common">Special file filetypes.common</a></h3>
+<h3><a class="toc-backref" href="#id191" id="special-file-filetypes-common" name="special-file-filetypes-common">Special file filetypes.common</a></h3>
<p>There is a special filetype definition file called
filetypes.common. This file defines some general non-filetype-specific
settings.</p>
@@ -4675,7 +4717,7 @@
<p class="last">See the <a class="reference" href="#filetype-configuration">Filetype configuration</a> section for how to define styles.</p>
</div>
<div class="section">
-<h4><a class="toc-backref" href="#id191" id="named-styles-section" name="named-styles-section">[named_styles] Section</a></h4>
+<h4><a class="toc-backref" href="#id192" id="named-styles-section" name="named-styles-section">[named_styles] Section</a></h4>
<p>Named styles declared here can be used in the [styling] section of any
filetypes.* file.</p>
<p>For example:</p>
@@ -4702,7 +4744,7 @@
schemes menu</a>.</p>
</div>
<div class="section">
-<h4><a class="toc-backref" href="#id192" id="id4" name="id4">[styling] Section</a></h4>
+<h4><a class="toc-backref" href="#id193" id="id4" name="id4">[styling] Section</a></h4>
<dl class="docutils">
<dt>default</dt>
<dd><p class="first">This is the default style. It is used for styling files without a
@@ -4886,7 +4928,7 @@
</dl>
</div>
<div class="section">
-<h4><a class="toc-backref" href="#id193" id="id5" name="id5">[settings] Section</a></h4>
+<h4><a class="toc-backref" href="#id194" id="id5" name="id5">[settings] Section</a></h4>
<dl class="docutils">
<dt>whitespace_chars</dt>
<dd><p class="first">Characters to treat as whitespace. These characters are ignored
@@ -4900,7 +4942,7 @@
</div>
</div>
<div class="section">
-<h2><a class="toc-backref" href="#id194" id="filetype-extensions" name="filetype-extensions">Filetype extensions</a></h2>
+<h2><a class="toc-backref" href="#id195" id="filetype-extensions" name="filetype-extensions">Filetype extensions</a></h2>
<p>To change the default filetype extension used when saving a new file,
see <a class="reference" href="#filetype-definition-files">Filetype definition files</a>.</p>
<p>You can override the list of file extensions that Geany uses to detect
@@ -4920,13 +4962,13 @@
</pre>
</div>
<div class="section">
-<h2><a class="toc-backref" href="#id195" id="preferences-file-format" name="preferences-file-format">Preferences File Format</a></h2>
+<h2><a class="toc-backref" href="#id196" id="preferences-file-format" name="preferences-file-format">Preferences File Format</a></h2>
<p>The user preferences file <tt class="docutils literal"><span class="pre">geany.conf</span></tt> holds settings for all the items configured
in the preferences dialog. This file should not be edited while Geany is running
as the file will be overwritten when the preferences in Geany are changed or Geany
is quit.</p>
<div class="section">
-<h3><a class="toc-backref" href="#id196" id="hidden-preferences" name="hidden-preferences">Hidden preferences</a></h3>
+<h3><a class="toc-backref" href="#id197" id="hidden-preferences" name="hidden-preferences">Hidden preferences</a></h3>
<p>There are some rarely used preferences that are not shown in the Preferences
dialog. These can be set by editing the preferences file, then
restarting Geany. Search for the key name, then edit the value. Example:</p>
@@ -5139,7 +5181,7 @@
</table>
</div>
<div class="section">
-<h3><a class="toc-backref" href="#id197" id="build-menu-section" name="build-menu-section">[build-menu] Section</a></h3>
+<h3><a class="toc-backref" href="#id198" id="build-menu-section" name="build-menu-section">[build-menu] Section</a></h3>
<p>The [build-menu] section contains the configuration of the build menu.
This section can occur in filetype, preferences and project files and
always has the format described here. Different menu items are loaded
@@ -5171,11 +5213,11 @@
</div>
</div>
<div class="section">
-<h2><a class="toc-backref" href="#id198" id="project-file-format" name="project-file-format">Project File Format</a></h2>
+<h2><a class="toc-backref" href="#id199" id="project-file-format" name="project-file-format">Project File Format</a></h2>
<p>The project file contains project related settings and possibly a
record of the current session files.</p>
<div class="section">
-<h3><a class="toc-backref" href="#id199" id="build-menu-additions" name="build-menu-additions">[build-menu] Additions</a></h3>
+<h3><a class="toc-backref" href="#id200" id="build-menu-additions" name="build-menu-additions">[build-menu] Additions</a></h3>
<p>The project file also can have extra fields in the [build-menu] section
in addition to those listed in <a class="reference" href="#build-menu-section">[build-menu] Section</a> above.</p>
<p>When filetype menu items are configured for the project they are stored
@@ -5191,7 +5233,7 @@
</div>
</div>
<div class="section">
-<h2><a class="toc-backref" href="#id200" id="templates" name="templates">Templates</a></h2>
+<h2><a class="toc-backref" href="#id201" id="templates" name="templates">Templates</a></h2>
<p>Geany supports the following templates:</p>
<ul class="simple">
<li>ChangeLog entry</li>
@@ -5220,7 +5262,7 @@
also force this by selecting <em>Tools->Reload Configuration</em>.</p>
</div>
<div class="section">
-<h3><a class="toc-backref" href="#id201" id="template-meta-data" name="template-meta-data">Template meta data</a></h3>
+<h3><a class="toc-backref" href="#id202" id="template-meta-data" name="template-meta-data">Template meta data</a></h3>
<p>Meta data can be used with all templates, but by default user set
meta data is only used for the ChangeLog and File header templates.</p>
<p>In the configuration dialog you can find a tab "Templates" (see
@@ -5229,7 +5271,7 @@
<em>Tools->Reload Configuration</em> or restart Geany after making changes.</p>
</div>
<div class="section">
-<h3><a class="toc-backref" href="#id202" id="file-templates" name="file-templates">File templates</a></h3>
+<h3><a class="toc-backref" href="#id203" id="file-templates" name="file-templates">File templates</a></h3>
<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>
@@ -5241,7 +5283,7 @@
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="#id203" id="custom-file-templates" name="custom-file-templates">Custom file templates</a></h4>
+<h4><a class="toc-backref" href="#id204" id="custom-file-templates" name="custom-file-templates">Custom file templates</a></h4>
<p>These are read from <tt class="docutils literal"><span class="pre">templates/files</span></tt> under the <a class="reference" href="#configuration-file-paths">Configuration file
paths</a>.</p>
<p>The filetype to use is detected from the template file's extension, if
@@ -5251,7 +5293,7 @@
clicked.</p>
</div>
<div class="section">
-<h4><a class="toc-backref" href="#id204" id="filetype-templates" name="filetype-templates">Filetype templates</a></h4>
+<h4><a class="toc-backref" href="#id205" 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>
@@ -5267,7 +5309,7 @@
</div>
</div>
<div class="section">
-<h3><a class="toc-backref" href="#id205" id="customizing-templates" name="customizing-templates">Customizing templates</a></h3>
+<h3><a class="toc-backref" href="#id206" id="customizing-templates" name="customizing-templates">Customizing templates</a></h3>
<p>Each template can be customized to your needs. The templates are
stored in the <tt class="docutils literal"><span class="pre">~/.config/geany/templates/</span></tt> directory (see the section called
<a class="reference" href="#command-line-options">Command line options</a> for further information about the configuration
@@ -5275,7 +5317,7 @@
Geany ;-) ) and edit the template to your needs. There are some
wildcards which will be automatically replaced by Geany at startup.</p>
<div class="section">
-<h4><a class="toc-backref" href="#id206" id="template-wildcards" name="template-wildcards">Template wildcards</a></h4>
+<h4><a class="toc-backref" href="#id207" id="template-wildcards" name="template-wildcards">Template wildcards</a></h4>
<p>All wildcards must be enclosed by "{" and "}", e.g. {date}.</p>
<p><strong>Wildcards for character escaping</strong></p>
<table border="1" class="docutils">
@@ -5489,7 +5531,7 @@
</tbody>
</table>
<div class="section">
-<h5><a class="toc-backref" href="#id207" id="special-command-wildcard" name="special-command-wildcard">Special {command:} wildcard</a></h5>
+<h5><a class="toc-backref" href="#id208" id="special-command-wildcard" name="special-command-wildcard">Special {command:} wildcard</a></h5>
<p>The {command:} wildcard is a special one because it can execute
a specified command and put the command's output (stdout) into
the template.</p>
@@ -5524,14 +5566,14 @@
</div>
</div>
<div class="section">
-<h2><a class="toc-backref" href="#id208" id="customizing-the-toolbar" name="customizing-the-toolbar">Customizing the toolbar</a></h2>
+<h2><a class="toc-backref" href="#id209" id="customizing-the-toolbar" name="customizing-the-toolbar">Customizing the toolbar</a></h2>
<p>You can add, remove and reorder the elements in the toolbar by using
the toolbar editor, or by manually editing the configuration file
<tt class="docutils literal"><span class="pre">ui_toolbar.xml</span></tt>.</p>
<p>The toolbar editor can be opened from the preferences editor on the Toolbar tab or
by right-clicking on the toolbar itself and choosing it from the menu.</p>
<div class="section">
-<h3><a class="toc-backref" href="#id209" id="manually-editing-the-toolbar-layout" name="manually-editing-the-toolbar-layout">Manually editing the toolbar layout</a></h3>
+<h3><a class="toc-backref" href="#id210" id="manually-editing-the-toolbar-layout" name="manually-editing-the-toolbar-layout">Manually editing the toolbar layout</a></h3>
<p>To override the system-wide configuration file, copy it to your user
configuration directory (see <a class="reference" href="#configuration-file-paths">Configuration file paths</a>).</p>
<p>For example:</p>
@@ -5553,7 +5595,7 @@
</div>
</div>
<div class="section">
-<h3><a class="toc-backref" href="#id210" id="available-toolbar-elements" name="available-toolbar-elements">Available toolbar elements</a></h3>
+<h3><a class="toc-backref" href="#id211" id="available-toolbar-elements" name="available-toolbar-elements">Available toolbar elements</a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="19%" />
@@ -5667,13 +5709,13 @@
</div>
</div>
<div class="section">
-<h1><a class="toc-backref" href="#id211" id="plugin-documentation" name="plugin-documentation">Plugin documentation</a></h1>
+<h1><a class="toc-backref" href="#id212" id="plugin-documentation" name="plugin-documentation">Plugin documentation</a></h1>
<div class="section">
-<h2><a class="toc-backref" href="#id212" id="html-characters" name="html-characters">HTML Characters</a></h2>
+<h2><a class="toc-backref" href="#id213" id="html-characters" name="html-characters">HTML Characters</a></h2>
<p>The HTML Characters plugin helps when working with special
characters in XML/HTML, e.g. German Umlauts ü and ä.</p>
<div class="section">
-<h3><a class="toc-backref" href="#id213" id="insert-entity-dialog" name="insert-entity-dialog">Insert entity dialog</a></h3>
+<h3><a class="toc-backref" href="#id214" id="insert-entity-dialog" name="insert-entity-dialog">Insert entity dialog</a></h3>
<p>When the plugin is enabled, you can insert special character
entities using <em>Tools->Insert Special HTML Characters</em>.</p>
<p>This opens up a dialog where you can find a huge amount of special
@@ -5685,7 +5727,7 @@
might also like to double click the chosen entity instead.</p>
</div>
<div class="section">
-<h3><a class="toc-backref" href="#id214" id="replace-special-chars-by-its-entity" name="replace-special-chars-by-its-entity">Replace special chars by its entity</a></h3>
+<h3><a class="toc-backref" href="#id215" id="replace-special-chars-by-its-entity" name="replace-special-chars-by-its-entity">Replace special chars by its entity</a></h3>
<p>To help make a XML/HTML document valid the plugin supports
replacement of special chars known by the plugin. Both bulk
replacement and immediate replacement during typing are supported.</p>
@@ -5701,7 +5743,7 @@
</dd>
</dl>
<div class="section">
-<h4><a class="toc-backref" href="#id215" id="at-typing-time" name="at-typing-time">At typing time</a></h4>
+<h4><a class="toc-backref" href="#id216" id="at-typing-time" name="at-typing-time">At typing time</a></h4>
<p>You can activate/deactivate this feature using the <em>Tools->HTML
Replacement->Auto-replace Special Characters</em> menu item. If it's
activated, all special characters (beside the given exceptions from
@@ -5710,7 +5752,7 @@
of this feature.</p>
</div>
<div class="section">
-<h4><a class="toc-backref" href="#id216" id="bulk-replacement" name="bulk-replacement">Bulk replacement</a></h4>
+<h4><a class="toc-backref" href="#id217" id="bulk-replacement" name="bulk-replacement">Bulk replacement</a></h4>
<p>After inserting a huge amount of text, e.g. by using copy & paste, the
plugin allows bulk replacement of all known characters (beside the
mentioned exceptions). You can find the function under the same
@@ -5720,9 +5762,9 @@
</div>
</div>
<div class="section">
-<h2><a class="toc-backref" href="#id217" id="save-actions" name="save-actions">Save Actions</a></h2>
+<h2><a class="toc-backref" href="#id218" id="save-actions" name="save-actions">Save Actions</a></h2>
<div class="section">
-<h3><a class="toc-backref" href="#id218" id="instant-save" name="instant-save">Instant Save</a></h3>
+<h3><a class="toc-backref" href="#id219" id="instant-save" name="instant-save">Instant Save</a></h3>
<p>This plugin sets on every new file (<em>File->New</em> or <em>File->New (with template)</em>)
a randomly chosen filename and set its filetype appropriate to the used template
or when no template was used, to a configurable default filetype.
@@ -5732,7 +5774,7 @@
similar.</p>
</div>
<div class="section">
-<h3><a class="toc-backref" href="#id219" id="backup-copy" name="backup-copy">Backup Copy</a></h3>
+<h3><a class="toc-backref" href="#id220" id="backup-copy" name="backup-copy">Backup Copy</a></h3>
<p>This plugin creates a backup copy of the current file in Geany when it is
saved. You can specify the directory where the backup copy is saved and
you can configure the automatically added extension in the configure dialog
@@ -5743,7 +5785,7 @@
</div>
</div>
<div class="section">
-<h1><a class="toc-backref" href="#id220" id="contributing-to-this-document" name="contributing-to-this-document">Contributing to this document</a></h1>
+<h1><a class="toc-backref" href="#id221" 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 <tt class="docutils literal"><span class="pre">doc</span></tt>
subdirectory. If you intend on making changes, you should grab the
@@ -5763,7 +5805,7 @@
and Fedora systems.</p>
</div>
<div class="section">
-<h1><a class="toc-backref" href="#id221" id="scintilla-keyboard-commands" name="scintilla-keyboard-commands">Scintilla keyboard commands</a></h1>
+<h1><a class="toc-backref" href="#id222" id="scintilla-keyboard-commands" name="scintilla-keyboard-commands">Scintilla keyboard commands</a></h1>
<p>Copyright © 1998, 2006 Neil Hodgson <neilh(at)scintilla(dot)org></p>
<p>This appendix is distributed under the terms of the License for
Scintilla and SciTE. A copy of this license can be found in the file
@@ -5772,7 +5814,7 @@
Scintilla and SciTE</a>.</p>
<p>20 June 2006</p>
<div class="section">
-<h2><a class="toc-backref" href="#id222" id="keyboard-commands" name="keyboard-commands">Keyboard commands</a></h2>
+<h2><a class="toc-backref" href="#id223" id="keyboard-commands" name="keyboard-commands">Keyboard commands</a></h2>
<p>Keyboard commands for Scintilla mostly follow common Windows and GTK+
conventions. All move keys (arrows, page up/down, home and end)
allows to extend or reduce the stream selection when holding the
@@ -5854,9 +5896,9 @@
</div>
</div>
<div class="section">
-<h1><a class="toc-backref" href="#id223" id="tips-and-tricks" name="tips-and-tricks">Tips and tricks</a></h1>
+<h1><a class="toc-backref" href="#id224" id="tips-and-tricks" name="tips-and-tricks">Tips and tricks</a></h1>
<div class="section">
-<h2><a class="toc-backref" href="#id224" id="document-notebook" name="document-notebook">Document notebook</a></h2>
+<h2><a class="toc-backref" href="#id225" id="document-notebook" name="document-notebook">Document notebook</a></h2>
<ul class="simple">
<li>Double-click on empty space in the notebook tab bar to open a
new document.</li>
@@ -5869,7 +5911,7 @@
</ul>
</div>
<div class="section">
-<h2><a class="toc-backref" href="#id225" id="editor" name="editor">Editor</a></h2>
+<h2><a class="toc-backref" href="#id226" id="editor" name="editor">Editor</a></h2>
<ul class="simple">
<li>Alt-scroll wheel moves up/down a page.</li>
<li>Ctrl-scroll wheel zooms in/out.</li>
@@ -5879,13 +5921,13 @@
</ul>
</div>
<div class="section">
-<h2><a class="toc-backref" href="#id226" id="interface" name="interface">Interface</a></h2>
+<h2><a class="toc-backref" href="#id227" id="interface" name="interface">Interface</a></h2>
<ul class="simple">
<li>Double-click on a symbol-list group to expand or compact it.</li>
</ul>
</div>
<div class="section">
-<h2><a class="toc-backref" href="#id227" id="gtk-related" name="gtk-related">GTK-related</a></h2>
+<h2><a class="toc-backref" href="#id228" id="gtk-related" name="gtk-related">GTK-related</a></h2>
<ul class="simple">
<li>Scrolling the mouse wheel over a notebook tab bar will switch
notebook pages.</li>
@@ -5900,7 +5942,7 @@
</div>
</div>
<div class="section">
-<h1><a class="toc-backref" href="#id228" id="compile-time-options" name="compile-time-options">Compile-time options</a></h1>
+<h1><a class="toc-backref" href="#id229" id="compile-time-options" name="compile-time-options">Compile-time options</a></h1>
<p>There are some options which can only be changed at compile time,
and some options which are used as the default for configurable
options. To change these options, edit the appropriate source file
@@ -5912,7 +5954,7 @@
<p class="last">Most users should not need to change these options.</p>
</div>
<div class="section">
-<h2><a class="toc-backref" href="#id229" id="src-geany-h" name="src-geany-h">src/geany.h</a></h2>
+<h2><a class="toc-backref" href="#id230" id="src-geany-h" name="src-geany-h">src/geany.h</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="33%" />
@@ -5969,7 +6011,7 @@
</table>
</div>
<div class="section">
-<h2><a class="toc-backref" href="#id230" id="project-h" name="project-h">project.h</a></h2>
+<h2><a class="toc-backref" href="#id231" id="project-h" name="project-h">project.h</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="33%" />
@@ -5994,7 +6036,7 @@
</table>
</div>
<div class="section">
-<h2><a class="toc-backref" href="#id231" id="editor-h" name="editor-h">editor.h</a></h2>
+<h2><a class="toc-backref" href="#id232" id="editor-h" name="editor-h">editor.h</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="33%" />
@@ -6020,7 +6062,7 @@
</table>
</div>
<div class="section">
-<h2><a class="toc-backref" href="#id232" id="keyfile-c" name="keyfile-c">keyfile.c</a></h2>
+<h2><a class="toc-backref" href="#id233" id="keyfile-c" name="keyfile-c">keyfile.c</a></h2>
<p>These are default settings that can be overridden in the <a class="reference" href="#preferences">Preferences</a> dialog.</p>
<table border="1" class="docutils">
<colgroup>
@@ -6101,7 +6143,7 @@
</table>
</div>
<div class="section">
-<h2><a class="toc-backref" href="#id233" id="build-c" name="build-c">build.c</a></h2>
+<h2><a class="toc-backref" href="#id234" id="build-c" name="build-c">build.c</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="33%" />
@@ -6146,7 +6188,7 @@
</div>
</div>
<div class="section">
-<h1><a class="toc-backref" href="#id234" id="gnu-general-public-license" name="gnu-general-public-license">GNU General Public License</a></h1>
+<h1><a class="toc-backref" href="#id235" id="gnu-general-public-license" name="gnu-general-public-license">GNU General Public License</a></h1>
<pre class="literal-block">
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
@@ -6491,7 +6533,7 @@
</pre>
</div>
<div class="section">
-<h1><a class="toc-backref" href="#id235" id="license-for-scintilla-and-scite" name="license-for-scintilla-and-scite">License for Scintilla and SciTE</a></h1>
+<h1><a class="toc-backref" href="#id236" id="license-for-scintilla-and-scite" name="license-for-scintilla-and-scite">License for Scintilla and SciTE</a></h1>
<p>Copyright 1998-2003 by Neil Hodgson <neilh(at)scintilla(dot)org></p>
<p>All Rights Reserved</p>
<p>Permission to use, copy, modify, and distribute this software and
@@ -6511,7 +6553,7 @@
<div class="footer">
<hr class="footer" />
<a class="reference" href="geany.txt">View document source</a>.
-Generated on: 2011-03-29 13:24 UTC.
+Generated on: 2011-03-29 13:47 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 2011-03-29 13:26:39 UTC (rev 5643)
+++ trunk/doc/geany.txt 2011-03-29 13:51:50 UTC (rev 5644)
@@ -3616,6 +3616,34 @@
See also `Configuration file paths`_.
+Filenames
+^^^^^^^^^
+Each filetype has a corresponding filetype definition file. The format
+for built-in filetype `Foo` is::
+
+ filetypes.foo
+
+The extension is normally just the filetype name in lower case.
+
+However there are some exceptions:
+
+=============== =========
+Filetype Extension
+=============== =========
+C++ cpp
+C# cs
+Make makefile
+Matlab/Octave matlab
+=============== =========
+
+There is also the `special file filetypes.common`_.
+
+For `custom filetypes`_, the filename for `Foo` is different::
+
+ filetypes.Foo.conf
+
+See the link for details.
+
System files
^^^^^^^^^^^^
The system-wide filetype configuration files can be found in the
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