From 067f3e1232b9b00c36f830f31dbf8ff13d7b0404 Mon Sep 17 00:00:00 2001 From: Nick Treleaven Date: Sat, 3 Jun 2006 21:41:15 +0000 Subject: [PATCH] Some corrections to the Filetypes section git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@403 ea778897-0a13-0410-b9d1-a72fbfd435f5 --- ChangeLog | 1 + doc/geany.docbook | 76 ++++++++++++++++++++++++----------------------- 2 files changed, 40 insertions(+), 37 deletions(-) diff --git a/ChangeLog b/ChangeLog index 82949381..06e1619d 100644 --- a/ChangeLog +++ b/ChangeLog @@ -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 diff --git a/doc/geany.docbook b/doc/geany.docbook index c301bb03..fbc53431 100644 --- a/doc/geany.docbook +++ b/doc/geany.docbook @@ -961,14 +961,15 @@ compiler and linker settings. - The files can be found in $prefix/share/geany and are called - filetypes.$ext. Where $prefix is the path where - &app; is installed, commonly - /usr/localfilename>, and $ext is the name of the filetype. - There is for every filetype a corresponding defintion file. There is one exception: - filetypes.common - 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 + $prefix/share/geany and are called + filetypes.$ext, where $prefix is the path where + &app; is installed (commonly + /usr/local) and $ext is the name of the filetype. + For every filetype there is a corresponding definition file. There is one exception: + filetypes.common - 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. To change the settings, copy a file from $prefix/share/geany @@ -983,19 +984,19 @@ directory. Alternatively, you can create a file ~/.geany/filedefs/filetypes.X and add only these settings you want to change. All missing settings will be read from the corresponding global - defintion file in $prefix/share/geany. + definition file in $prefix/share/geany.
Format
- Section [styling] + [styling] Section In this section the colours for syntax highlighting are defined. The format is always: key=forground_colour;background_colour;bold;italic - 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 @@
- Section [keywords] + [keywords] Section 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. The keywords list must be in one line without line ending characters.
- Section [settings] + [settings] Section General settings @@ -1038,7 +1039,7 @@ comment_open 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. comment_open=/* @@ -1054,20 +1055,20 @@ comment_use_indent 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. - Comment indention + it uses any indentation of the line. + Comment indentation comment_use_indent=true would generate this if a line - if commented(e.g. with + is commented (e.g. with CtrlD) #command_example(); comment_use_indent=false would generate this if a line - if commented(e.g. with + is commented (e.g. with CtrlD) #command_example(); - This setting works only for single line comments. + This setting only works for single line comments. comment_use_indent=true @@ -1078,7 +1079,7 @@
- Section [build_settings] + [build_settings] Section
Build settings @@ -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. - You should quote the filename to support also + You should quote the filename to also support filenames with spaces. The following wildcards for filenames are available: @@ -1126,16 +1127,17 @@ compiled while linking. The -o option is automatically added by &app;. 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). linker=gcc -Wall "%f" run_cmd - 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 + 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. @@ -1150,8 +1152,8 @@
Special file filetypes.common There is a special filetype definition file called - filetypes.common. In this file are some general none - filetype-specific settings defined. + filetypes.common. This file defines some general + non-filetype-specific settings.
@@ -1169,9 +1171,9 @@ default - The default style for text(e.g. for files without - filetype). For the detailed format, please see above - "Section [styling]". + The default style for text (e.g. for files without + filetype). For the detailed format, please see the above + "[styling] Section". default=0x000000;0xffffff;false;false @@ -1184,14 +1186,14 @@ brace_good - The style for brace highlighting. It is used if a + The style for brace highlighting when a matching brace was found. brace_good=0xff0000;0xFFFFFF;true;false brace_bad - The style for brace highlighting. It is used if no + The style for brace highlighting when no matching brace was found. brace_bad=0x0000ff;0xFFFFFF;true;false @@ -1208,7 +1210,7 @@ The style of folding icons. Only first and second arguments are used. - Valid values for the first argument areare: + Valid values for the first argument are: 1 - for boxes @@ -1219,7 +1221,7 @@ - Valid values for the second argument areare: + Valid values for the second argument are: 1 - for straight lines