Revision: 403 Author: ntrel Date: 2006-06-03 14:41:15 -0700 (Sat, 03 Jun 2006) ViewCVS: http://svn.sourceforge.net/geany/?rev=403&view=rev
Log Message: ----------- Some corrections to the Filetypes section
Modified Paths: -------------- trunk/ChangeLog trunk/doc/geany.docbook Modified: trunk/ChangeLog =================================================================== --- trunk/ChangeLog 2006-06-03 20:46:23 UTC (rev 402) +++ trunk/ChangeLog 2006-06-03 21:41:15 UTC (rev 403) @@ -9,6 +9,7 @@
* doc/geany.docbook: More minor corrections/rewording. Added Build System section. + Some corrections to the Filetypes section.
2006-06-02 Enrico Troeger enrico.troeger@uvena.de
Modified: trunk/doc/geany.docbook =================================================================== --- trunk/doc/geany.docbook 2006-06-03 20:46:23 UTC (rev 402) +++ trunk/doc/geany.docbook 2006-06-03 21:41:15 UTC (rev 403) @@ -961,14 +961,15 @@ compiler and linker settings. </para> <para> - The files can be found in <filename>$prefix/share/geany</filename> and are called - <filename>filetypes.$ext</filename>. Where $prefix is the path where - <application>&app;</application> is installed, commonly - <filename>/usr/local</filename>filename>, and $ext is the name of the filetype. - There is for every filetype a corresponding defintion file. There is one exception: - <filename>filetypes.common</filename> - in this file are general settings, which - are specific to a certain filetype. It is not recommend to edit this files, because - while updating Geany the will be overridden. + The system-wide configuration files can be found in + <filename>$prefix/share/geany</filename> and are called + <filename>filetypes.$ext</filename>, where $prefix is the path where + <application>&app;</application> is installed (commonly + <filename>/usr/local</filename>) and $ext is the name of the filetype. + For every filetype there is a corresponding definition file. There is one exception: + <filename>filetypes.common</filename> - this file is for general settings, which + are not specific to a certain filetype. It is not recommended to edit the + system-wide files, because they will be overridden when Geany is updated. </para> <para> To change the settings, copy a file from <filename>$prefix/share/geany</filename> @@ -983,19 +984,19 @@ directory. Alternatively, you can create a file <filename>~/.geany/filedefs/filetypes.X</filename> and add only these settings you want to change. All missing settings will be read from the corresponding global - defintion file in <filename>$prefix/share/geany</filename>. + definition file in <filename>$prefix/share/geany</filename>. </para> <section id="filetypes_format"> <title>Format</title> <section> - <title>Section [styling]</title> + <title>[styling] Section</title> <para> In this section the colours for syntax highlighting are defined. The format is always: <constant>key=forground_colour;background_colour;bold;italic</constant> </para> <para> - Colours have to be specified as RGB hex values introduced by 0x. For + Colours have to be specified as RGB hex values prefixed by 0x. For example red is 0xff0000, blue is 0x0000ff. The values are case-insensitive, but it is a good idea to use small letters. Bold and italic are flags and should only be "true" or "false". If their value is something other than @@ -1003,17 +1004,17 @@ </para> </section> <section> - <title>Section [keywords]</title> + <title>[keywords] Section</title> <para> 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 only could add or remove keywords to/from the list. + not work. You can only add or remove keywords to/from an existing list. <important><para>The keywords list must be in one line without line ending characters.</para></important> </para> </section> <section> - <title>Section [settings]</title> + <title>[settings] Section</title> <para> <table frame="all"> <title>General settings</title> @@ -1038,7 +1039,7 @@ <row> <entry>comment_open</entry> <entry>A character or string which is used to comment code. - If you want to use multiline comments, set also + If you want to use multiline comments, also set comment_close, otherwise leave it empty. </entry> <entry>comment_open=/*</entry> @@ -1054,20 +1055,20 @@ <entry>comment_use_indent</entry> <entry>Set this to false if a comment character or string should start at column 0 of a line. If set to true - it uses any indention of the line. - <para><example><title>Comment indention</title> + it uses any indentation of the line. + <para><example><title>Comment indentation</title> <para> comment_use_indent=true would generate this if a line - if commented(e.g. with + is commented (e.g. with <keycombo><keycap>Ctrl</keycap><keycap>D</keycap></keycombo>) <programlisting> #command_example();</programlisting> comment_use_indent=false would generate this if a line - if commented(e.g. with + is commented (e.g. with <keycombo><keycap>Ctrl</keycap><keycap>D</keycap></keycombo>) <programlisting>#command_example();</programlisting> </para></example></para> <note><para> - This setting works only for single line comments. + This setting only works for single line comments. </para></note> </entry> <entry>comment_use_indent=true</entry> @@ -1078,7 +1079,7 @@ </para> </section> <section> - <title>Section [build_settings]</title> + <title>[build_settings] Section</title> <para> <table frame="all"> <title>Build settings</title> @@ -1100,9 +1101,9 @@ files. But it is also possible to use it with interpreted languages like Perl or Python. With these filetypes you can use this option as a kind of syntax - parser, which does his output in the compiler message + parser, which sends output to the compiler message window. - <para>You should quote the filename to support also + <para>You should quote the filename to also support filenames with spaces. The following wildcards for filenames are available: </para> @@ -1126,16 +1127,17 @@ compiled while linking. The -o option is automatically added by <application>&app;</application>. This item works - well with the gcc, but may be problemtic with other - compilers(resp. linker). + well with GNU gcc, but may be problematic with other + compilers (esp. with the linker). </entry> <entry>linker=gcc -Wall "%f"</entry> </row> <row> <entry>run_cmd</entry> - <entry>Use this item to execute your file. It has to been - built. Use the %e wildcard to have only the name of - the executable(i.e. without extension) or use the %f + <entry>Use this item to execute your file. It has to have been + built already. + Use the %e wildcard to have only the name of + the executable (i.e. without extension) or use the %f wildcard if you need the complete filename, e.g. for shell scripts. </entry> @@ -1150,8 +1152,8 @@ <section id="filetypes_common"> <title>Special file filetypes.common</title> <para>There is a special filetype definition file called - <filename>filetypes.common</filename>. In this file are some general none - filetype-specific settings defined. + <filename>filetypes.common</filename>. This file defines some general + non-filetype-specific settings. </para> <para> <table frame="all"> @@ -1169,9 +1171,9 @@ <tbody> <row> <entry>default</entry> - <entry>The default style for text(e.g. for files without - filetype). For the detailed format, please see above - "Section [styling]". + <entry>The default style for text (e.g. for files without + filetype). For the detailed format, please see the above + "[styling] Section". </entry> <entry>default=0x000000;0xffffff;false;false</entry> </row> @@ -1184,14 +1186,14 @@ </row> <row> <entry>brace_good</entry> - <entry>The style for brace highlighting. It is used if a + <entry>The style for brace highlighting when a matching brace was found. </entry> <entry>brace_good=0xff0000;0xFFFFFF;true;false</entry> </row> <row> <entry>brace_bad</entry> - <entry>The style for brace highlighting. It is used if no + <entry>The style for brace highlighting when no matching brace was found. </entry> <entry>brace_bad=0x0000ff;0xFFFFFF;true;false</entry> @@ -1208,7 +1210,7 @@ <entry>The style of folding icons. Only first and second arguments are used. <para> - Valid values for the first argument areare: + Valid values for the first argument are: <itemizedlist> <listitem><para> 1 - for boxes @@ -1219,7 +1221,7 @@ </itemizedlist> </para> <para> - Valid values for the second argument areare: + Valid values for the second argument are: <itemizedlist> <listitem><para> 1 - for straight lines
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.