Revision: 407
Author: eht16
Date: 2006-06-04 06:46:34 -0700 (Sun, 04 Jun 2006)
ViewCVS: http://svn.sourceforge.net/geany/?rev=407&view=rev
Log Message:
-----------
forgot it the last time
Added Paths:
-----------
trunk/doc/images/pref_dialog_keys.jpg
Added: trunk/doc/images/pref_dialog_keys.jpg
===================================================================
(Binary files differ)
Property changes on: trunk/doc/images/pref_dialog_keys.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
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(a)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.
Revision: 402
Author: ntrel
Date: 2006-06-03 13:46:23 -0700 (Sat, 03 Jun 2006)
ViewCVS: http://svn.sourceforge.net/geany/?rev=402&view=rev
Log Message:
-----------
Added Build System section
Modified Paths:
--------------
trunk/ChangeLog
trunk/doc/geany.docbook
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2006-06-03 17:14:09 UTC (rev 401)
+++ trunk/ChangeLog 2006-06-03 20:46:23 UTC (rev 402)
@@ -8,6 +8,7 @@
2006-06-03 Nick Treleaven <nick.treleaven(a)btinternet.com>
* doc/geany.docbook: More minor corrections/rewording.
+ Added Build System section.
2006-06-02 Enrico Troeger <enrico.troeger(a)uvena.de>
Modified: trunk/doc/geany.docbook
===================================================================
--- trunk/doc/geany.docbook 2006-06-03 17:14:09 UTC (rev 401)
+++ trunk/doc/geany.docbook 2006-06-03 20:46:23 UTC (rev 402)
@@ -623,6 +623,113 @@
</para>
</section>
</section>
+ <section id="buildsystem">
+ <title>Build System</title>
+ <para>
+ <application>&app;</application> has an integrated build system. When you compile,
+ link, syntax check or otherwise process a source file, the output will be captured
+ in the Compiler notebook tab of the messages window (assuming you have it visible).
+ If there are any warnings or errors with line numbers shown in the Compiler output tab,
+ you can double click on them and <application>&app;</application> will switch to
+ the relevant source file (if it is open) and mark the line number so the problem
+ can be corrected.
+ </para>
+ <para>
+ Depending on the current file's filetype, the Build menu will contain the following
+ items:
+ <itemizedlist>
+ <listitem><para>Compile</para></listitem>
+ <listitem><para>Build</para></listitem>
+ <listitem><para>Build with "make"</para></listitem>
+ <listitem><para>Build with make (custom target)</para></listitem>
+ <listitem><para>Execute</para></listitem>
+ <listitem><para>Set Includes and Arguments</para></listitem>
+ </itemizedlist>
+ </para>
+ <section>
+ <title>Compile</title>
+ <para>
+ By default, the Compile command is setup to build binary object files for
+ compilable languages such as C and C++.
+ </para>
+ <para>
+ Java will be compiled to
+ class file bytecode. Interpreted languages such as Perl, Python, Ruby will
+ compile to bytecode if the language supports it, or will run a syntax check,
+ or failing that will run the file in the language interpreter.
+ </para>
+ </section>
+ <section>
+ <title>Build</title>
+ <para>
+ For compilable languages such as C and C++, the Build command will link the
+ current source file's equivalent object file into an executable. If the object
+ file does not exist, the source will be compiled and linked in one step,
+ producing just the executable binary.
+ </para>
+ <para>
+ Interpreted languages do not use the Build command.
+ </para>
+ </section>
+ <section>
+ <title>Build with "make"</title>
+ <para>
+ This effectively runs "make all" in the same directory as the current file.
+ The Make tool path must be correctly set in the Tools tab of the Preferences
+ dialog.
+ </para>
+ </section>
+ <section>
+ <title>Build with make (custom target)</title>
+ <para>
+ This is identical to running 'Build with "make"' but you will be prompted
+ for the make target name to be passed to the Make tool. For example,
+ typing 'clean' in the dialog prompt will run "make clean" (but using the
+ full path to the Make tool set in Preferences).
+ </para>
+ </section>
+ <section>
+ <title>Execute</title>
+ <para>
+ Execute will run the corresponding executable file, shell script or interpreted
+ script in a terminal window. Note that the Terminal tool path must be correctly
+ set in the Tools tab of the Preferences dialog - you can use any terminal
+ program that runs a Bourne compatible shell.
+ After your program or script has finished executing, you will be prompted to
+ press the return key. This allows you to review any text output from the program.
+ </para>
+ </section>
+ <section>
+ <title>Set Includes and Arguments</title>
+ <para>
+ By default the Compile and Build commands invoke the compiler and linker with
+ only the basic arguments needed by all programs.
+ Using Set Includes and Arguments you can add any include
+ paths and compile flags for the compiler, any library names and paths for the
+ linker, and any arguments you want to use when running Execute. Note that if
+ you are using the Build command to compile and link in one step, you will need
+ to set both the compiler arguments and the linker arguments in the linker
+ command setting.
+ </para>
+ <para>
+ These settings are not saved when <application>&app;</application> is shut
+ down. See below for how to set permanent arguments.
+ </para>
+ <para>
+ If you need complex settings for your build system, or several different
+ settings, then writing a Makefile and using 'Build with "make"' is recommended.
+ </para>
+ </section>
+ <section>
+ <title>File type configuration settings</title>
+ <para>
+ You can set the commands to run for compiling, building or executing
+ by opening the relevant <filename>filetypes.*</filename> configuration file,
+ and checking the build_settings section. See <xref linkend="filetypes"/> for more
+ information.
+ </para>
+ </section>
+ </section>
<section id="keybindings">
<title>Keybindings</title>
<para>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
Revision: 401
Author: eht16
Date: 2006-06-03 10:14:09 -0700 (Sat, 03 Jun 2006)
ViewCVS: http://svn.sourceforge.net/geany/?rev=401&view=rev
Log Message:
-----------
Added documentation for filetype definition files and definable keyboard shortcuts.
Modified Paths:
--------------
trunk/ChangeLog
trunk/doc/geany.docbook
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2006-06-03 17:06:53 UTC (rev 400)
+++ trunk/ChangeLog 2006-06-03 17:14:09 UTC (rev 401)
@@ -1,6 +1,8 @@
2006-06-03 Enrico Troeger <enrico.troeger(a)uvena.de>
* src/sci_cb.c: Fixed bug in auto completion of constructs.
+ * doc/geany.docbook: Added documentation for filetype definition files
+ and definable keyboard shortcuts.
2006-06-03 Nick Treleaven <nick.treleaven(a)btinternet.com>
Modified: trunk/doc/geany.docbook
===================================================================
--- trunk/doc/geany.docbook 2006-06-03 17:06:53 UTC (rev 400)
+++ trunk/doc/geany.docbook 2006-06-03 17:14:09 UTC (rev 401)
@@ -845,11 +845,291 @@
</table>
</para>
</section>
- <section>
- <title>File types</title>
+ <section id="filetypes">
+ <title>Filetype definition files</title>
<para>
- should be written
+ All colour definitions and other filetype specific settings are stored in the
+ filetype definition files. Those settings are colours for syntax highlighting,
+ general settings like comment characters or word delimiter characters as well as
+ 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.
+ </para>
+ <para>
+ To change the settings, copy a file from <filename>$prefix/share/geany</filename>
+ to the subdirectory <filename>filedefs</filename> in your configuration directory
+ (usually <filename>~/.geany/</filename>).
+ </para>
+ <para>
+ For example:
+ <screen><prompt>%</prompt> <userinput><command>cp /usr/local/share/geany/filetypes.c /home/username/.geany/filedefs/</command></userinput></screen>
+ Then you can edit the file and the changes are also available after an update of
+ <application>&app;</application> because they reside in your configuration
+ 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>.
+ </para>
+ <section id="filetypes_format">
+ <title>Format</title>
+ <section>
+ <title>Section [styling]</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
+ 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
+ "true" or "false", "false" is assumed.
+ </para>
+ </section>
+ <section>
+ <title>Section [keywords]</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.
+ <important><para>The keywords list must be in one line without line ending
+ characters.</para></important>
+ </para>
+ </section>
+ <section>
+ <title>Section [settings]</title>
+ <para>
+ <table frame="all">
+ <title>General settings</title>
+ <tgroup cols="3">
+ <?dbhtml cellpadding="4" ?>
+ <?dbhtml cellspacing="0" ?>
+ <thead>
+ <row>
+ <entry>Key</entry>
+ <entry>Description</entry>
+ <entry>Example</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>wordchars</entry>
+ <entry>Word delimiting characters. These characters define
+ word boundaries.
+ </entry>
+ <entry>(look at sourcecode)</entry>
+ </row>
+ <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
+ comment_close, otherwise leave it empty.
+ </entry>
+ <entry>comment_open=/*</entry>
+ </row>
+ <row>
+ <entry>comment_close</entry>
+ <entry>If multiline comments are used, this is the character
+ or string to close the comment.
+ </entry>
+ <entry>comment_close=*/</entry>
+ </row>
+ <row>
+ <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>
+ <para>
+ comment_use_indent=true would generate this if a line
+ if 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
+ <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.
+ </para></note>
+ </entry>
+ <entry>comment_use_indent=true</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+ </section>
+ <section>
+ <title>Section [build_settings]</title>
+ <para>
+ <table frame="all">
+ <title>Build settings</title>
+ <tgroup cols="3">
+ <?dbhtml cellpadding="4" ?>
+ <?dbhtml cellspacing="0" ?>
+ <thead>
+ <row>
+ <entry>Key</entry>
+ <entry>Description</entry>
+ <entry>Example</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>compiler</entry>
+ <entry>
+ This item specifies the command to compile source code
+ 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
+ window.
+ <para>You should quote the filename to support also
+ filenames with spaces. The following wildcards for
+ filenames are available:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem><para>
+ %f - complete filename without path
+ </para></listitem>
+ <listitem><para>
+ %e - filename without path and without extension
+ </para></listitem>
+ </itemizedlist>
+ </para>
+ </entry>
+ <entry>compiler=gcc -Wall -c "%f"</entry>
+ </row>
+ <row>
+ <entry>linker</entry>
+ <entry>This item specifies the command to link the file.
+ If the file is not already compiled, it will be
+ 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).
+ </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
+ wildcard if you need the complete filename, e.g.
+ for shell scripts.
+ </entry>
+ <entry>run_cmd="./%e"</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+ </section>
+ </section>
+ <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.
+ </para>
+ <para>
+ <table frame="all">
+ <title>General settings</title>
+ <tgroup cols="3">
+ <?dbhtml cellpadding="4" ?>
+ <?dbhtml cellspacing="0" ?>
+ <thead>
+ <row>
+ <entry>Key</entry>
+ <entry>Description</entry>
+ <entry>Example</entry>
+ </row>
+ </thead>
+ <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>
+ <entry>default=0x000000;0xffffff;false;false</entry>
+ </row>
+ <row>
+ <entry>selection</entry>
+ <entry>The style for colouring selections. Only foreground and
+ background colour are interpreted.
+ </entry>
+ <entry>selection=0xc0c0c0;0x00007F;false;false</entry>
+ </row>
+ <row>
+ <entry>brace_good</entry>
+ <entry>The style for brace highlighting. It is used if 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
+ matching brace was found.
+ </entry>
+ <entry>brace_bad=0x0000ff;0xFFFFFF;true;false</entry>
+ </row>
+ <row>
+ <entry>current_line</entry>
+ <entry>The style for colouring the background of the current
+ line. Only the second argument is interpreted.
+ </entry>
+ <entry>current_line=0x0;0xE5E5E5;false;false</entry>
+ </row>
+ <row>
+ <entry>folding_style</entry>
+ <entry>The style of folding icons. Only first and second
+ arguments are used.
+ <para>
+ Valid values for the first argument areare:
+ <itemizedlist>
+ <listitem><para>
+ 1 - for boxes
+ </para></listitem>
+ <listitem><para>
+ 2 - for circles
+ </para></listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ Valid values for the second argument areare:
+ <itemizedlist>
+ <listitem><para>
+ 1 - for straight lines
+ </para></listitem>
+ <listitem><para>
+ 2 - for curved lines
+ </para></listitem>
+ </itemizedlist>
+ </para>
+ </entry>
+ <entry>folding_style=1;1;false;false</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+ </section>
</section>
<section>
<title>Templates</title>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
Revision: 400
Author: eht16
Date: 2006-06-03 10:06:53 -0700 (Sat, 03 Jun 2006)
ViewCVS: http://svn.sourceforge.net/geany/?rev=400&view=rev
Log Message:
-----------
fixed typos
Modified Paths:
--------------
trunk/data/filetypes.c
Modified: trunk/data/filetypes.c
===================================================================
--- trunk/data/filetypes.c 2006-06-03 15:05:41 UTC (rev 399)
+++ trunk/data/filetypes.c 2006-06-03 17:06:53 UTC (rev 400)
@@ -34,13 +34,13 @@
wordchars=_#&abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789
# if only single comment char is supported like # in this file, leave comment_close blank
-comment_open=/*
-comment_close=*/
+comment_open=//
+comment_close=
# this is an alternative way, so multiline comments are used
#comment_open=/*
#comment_close=*/
-# set to false if a comment character/string should start a column 0 of a line, true uses any
+# set to false if a comment character/string should start at column 0 of a line, true uses any
# indention of the line, e.g. setting to true causes the following on pressing CTRL+d
#command_example();
# setting to false would generate this
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
Revision: 398
Author: ntrel
Date: 2006-06-03 07:20:59 -0700 (Sat, 03 Jun 2006)
ViewCVS: http://svn.sourceforge.net/geany/?rev=398&view=rev
Log Message:
-----------
More minor corrections/rewording
Modified Paths:
--------------
trunk/ChangeLog
trunk/doc/geany.docbook
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2006-06-02 21:29:22 UTC (rev 397)
+++ trunk/ChangeLog 2006-06-03 14:20:59 UTC (rev 398)
@@ -1,3 +1,8 @@
+2006-06-03 Nick Treleaven <nick.treleaven(a)btinternet.com>
+
+ * doc/geany.docbook: More minor corrections/rewording.
+
+
2006-06-02 Enrico Troeger <enrico.troeger(a)uvena.de>
* src/highlighting.c, data/filetypes.css: improved colouring
Modified: trunk/doc/geany.docbook
===================================================================
--- trunk/doc/geany.docbook 2006-06-02 21:29:22 UTC (rev 397)
+++ trunk/doc/geany.docbook 2006-06-03 14:20:59 UTC (rev 398)
@@ -54,8 +54,8 @@
<application>&app;</application> is a small and lightweight Integrated Development Environment.
It was developed to provide a small and fast IDE, which has only a few dependencies from other
packages. Another goal was to be as independent as possible from a special Desktop Environment
- like KDE or GNOME. So it is using only the GTK2 toolkit and therefore you need only the
- GTK2 runtime libraries to run <application>&app;</application>.
+ like KDE or GNOME, so <application>&app;</application> only requires the GTK2 toolkit
+ and therefore you only need the GTK2 runtime libraries installed to run it.
</para>
<para>
The basic features of <application>&app;</application> are:
@@ -66,7 +66,7 @@
<listitem><para>Auto completion of XML and HTML tags</para></listitem>
<listitem><para>Call tips</para></listitem>
<listitem><para>Many supported filetypes like C, Java, PHP, HTML, Python, Perl, Pascal</para></listitem>
- <listitem><para>Symbol lists</para></listitem>
+ <listitem><para>Tag/Symbol lists</para></listitem>
</itemizedlist>
</para>
</section>
@@ -107,8 +107,9 @@
All these files are available at <ulink url="http://www.gtk.org">http://www.gtk.org</ulink>.
</para>
<para>
- Further more you need, of course, a C compiler, for the included Scintilla library a C++
- compiler and the make tool.
+ Furthermore you need, of course, a C compiler and the Make tool; a C++ compiler is
+ also required for the included Scintilla library. The GNU versions of these tools are
+ recommended.
</para>
</section>
<section>
@@ -128,14 +129,14 @@
</screen>
</para>
<para>
- In the case, that your system lacks dynamic linking loader support, you probably want
+ In the case that your system lacks dynamic linking loader support, you probably want
to pass the option --disable-vte to the configure script. This prevents compiling
&app; with dynamic linking loader support to automatically load
<filename>libvte.so.4</filename> if available.
</para>
<para>&app; has been successfully compiled and tested under Debian 3.1 Sarge, Debian 3.2 Etch,
Fedora Core 4, LinuxFromScratch and FreeBSD 6.0. It also compiles under
- <trademark class="trade">Mircosoft Windows</trademark>, but there are lots of changes
+ <trademark class="trade">Microsoft Windows</trademark>, but there are lots of changes
to the makefiles necessary.
</para>
<para>
@@ -157,7 +158,7 @@
<para>
Binary packages for Debian are available at <ulink url="&deburl;">&deburl;/</ulink>.
You can add one of the following lines(depending on your system) to your apt
- <filename>sources.list</filename> to get automatically get the latest version of
+ <filename>sources.list</filename> to automatically get the latest version of
<application>&app;</application>:
</para>
<para>
@@ -170,7 +171,7 @@
<section>
<title>SuSE</title>
<para>
- There are not yet packages for SuSE available.
+ Packages for SuSE are not yet available.
</para>
</section>
<section>
@@ -217,10 +218,10 @@
</para>
</section>
<section id="clo">
- <title>Commandline options</title>
+ <title>Command line options</title>
<para>
<table frame="all">
- <title>Commandline Options</title>
+ <title>Command line Options</title>
<tgroup cols="3">
<?dbhtml cellpadding="4" ?>
<?dbhtml cellspacing="0" ?>
@@ -240,7 +241,7 @@
<entry>-n</entry>
<entry>--no-ctags</entry>
<entry>Do not load auto completion and call tip data.
- Use this option, if you do not want to use them. For more
+ Use this option if you do not want to use them. For more
information see <xref linkend="general_ctags"/>.
</entry>
</row>
@@ -260,7 +261,7 @@
<row>
<entry>-t</entry>
<entry>--no-terminal</entry>
- <entry>Do not load terminal support. Use this option, if you do not
+ <entry>Do not load terminal support. Use this option if you do not
want to load the virtual terminal emulator widget at startup.
If you do not have <filename>libvte.so.4</filename> installed,
then terminal-support is automatically disabled.
@@ -271,7 +272,7 @@
<entry>--vte-lib</entry>
<entry>Specify explicitly the path including filename or only the filename
to the VTE library, e.g. <filename>/usr/lib/libvte.so</filename> or
- <filename>libvte.so</filename>. This option is only needed, when the
+ <filename>libvte.so</filename>. This option is only needed when the
autodetection does not work.
</entry>
</row>
@@ -280,14 +281,14 @@
<entry>--config=directory_name</entry>
<entry>Use an alternate configuration directory. Default
configuration directory is <filename>~/.&app_small;/</filename>
- and there resides <filename>&app_small;.conf</filename> and some
- template files.
+ and there resides <filename>&app_small;.conf</filename> and
+ other configuration files.
</entry>
</row>
<row>
<entry>-d</entry>
<entry>--debug</entry>
- <entry>Runs &app; in debug mode, which means being verbose
+ <entry>Run &app; in debug mode, which means being verbose
and printing lots of information.
</entry>
</row>
@@ -304,7 +305,7 @@
<row>
<entry></entry>
<entry>[files ...]</entry>
- <entry>Opens all given files at startup. This option causes &app; to
+ <entry>Open all given files at startup. This option causes &app; to
ignore loading stored files from the last session (if enabled).
</entry>
</row>
@@ -319,39 +320,39 @@
<section id="general_startup">
<title>Startup</title>
<para>
- At startup, &app; loads the 15 first files from the last time,
+ At startup, &app; loads the first 15 files from the last time
<application>&app;</application> was launched. You can disable this feature in the
preferences dialog(see <xref linkend="confdialog_gen"/>). If you specify some files on
- the commandline, only these files will be opened. But you can find the files from the
- last session in the file menu. There is an item "Recent files". It contains the last
- 15 recently opened files. It may be that &app; not exactly loads 15 files, this depends
- on the compile time option GEANY_SESSION_FILES, the default is 15. For details see
+ the command line, only these files will be opened, but you can find the files from the
+ last session in the file menu under the "Recent files" item. This contains the last
+ 15 recently opened files. It may be that &app; loads not exactly 15 session files, this depends
+ on the compile time option GEANY_SESSION_FILES; the default is 15. For details see
<xref linkend="cto"/>.
</para>
</section>
<section id="general_fifo">
<title>Detection of a running instance</title>
<para>
- &app; detects an already running instance of it and open new files in the running one.
+ &app; detects an already running instance of itself and opens new files in the already running one.
So, you can use &app; like an editor to view and edit files by opening them from other
- programs. If you do not like this for some reason, you can it disable with the appropriate
- commandline option.
+ programs. If you do not like this for some reason, you can disable it with the appropriate
+ command line option.
</para>
<para>
In the case that &app; crashed, you will get a message dialog at the next start,
which asks you whether to delete an existing named pipe. If you are sure that there is
- no other instance of &app; running, you can say Yes and &app; will start as usual.
+ no other instance of &app; is running, you can say Yes and &app; will start as usual.
Otherwise click No and Geany will not start.
</para>
</section>
<section id="general_ctags">
<title>Global C tags</title>
<para>
- If a C file(with extension is c, cpp, h, etc.) is opened, a global tags file is
- loaded once, which contains many function declarations from the glibc and some other
+ If a C file (with extension .c, .cpp, .h, etc.) is opened, a global tags file is
+ loaded once, which contains many function declarations from glibc and some other
libraries, like X, Bonobo, Gnome, GTK, Glib and so on. These declarations are used
for call tips and auto completion. These tags are only useful if you are writing
- C or C++ source code. So if you know, that you do not need these things, you can skip
+ C or C++ source code, so if you know that you do not need these things, you can skip
loading this tag file. To do so, start <application>&app;</application> with the
argument "-n" or "--no-ctags", for more information see <xref linkend="clo"/>.
</para>
@@ -360,30 +361,34 @@
<title>Virtual terminal emulator widget (VTE)</title>
<para>
If you have installed <filename>libvte.so</filename> in your system, it is loaded
- automatically by <application>&app;</application>. Then you have a terminal widget
+ automatically by <application>&app;</application>, and you will have a terminal widget
in the notebook at the bottom.
</para>
<para>
If <application>&app;</application> cannot find <filename>libvte.so</filename> at
startup, the terminal widget will not be loaded. So there is no need to install the
package containing this file in order to run <application>&app;</application>.
- Additionally, you can disable the use of the terminal widget by commandline option,
+ Additionally, you can disable the use of the terminal widget by command line option,
for more information see <xref linkend="clo"/>.
</para>
<para>
You can use this terminal (from now on called VTE) nearly as an usual terminal program
- like xterm. There is a basic clipboard support. You can paste the content
- of the clipboard by pressing the middle mouse button in the VTE (on 2-button mice,
- the middle button can often be simulated by pressing both mouse buttons together) or by
- pressing the right mouse button to open the popup menu and choose Paste.
+ like xterm. There is basic clipboard support. You can paste the contents
+ of the clipboard by pressing the right mouse button to open the popup menu and
+ choosing Paste.
To copy text from the VTE, just select the desired text and then press the
right mouse button and choose Copy from the popup menu.
+ On systems running the X Window System you can paste the last selected text by
+ pressing the middle mouse button in the VTE (on 2-button mice,
+ the middle button can often be simulated by pressing both mouse buttons together).
</para>
<note>
<para>&app; tries to load <filename>libvte.so</filename>. If this fails, it tries to
load <filename>libvte.so.4</filename>. If this fails too, you should check whether
- you installed libvte correctly. Again, &app; runs also without this library.
- But it could be, that the library is called something else than
+ you installed libvte correctly. Again, &app; also runs without this library.
+ </para>
+ <para>
+ It could be, that the library is called something else than
<filename>libvte.so.4</filename> (e.g. on FreeBSD 6.0 it is called
<filename>libvte.so.8</filename>). So please set a link to the correct file (as root).
<screen><prompt>#</prompt> <userinput><command>ln -s /usr/lib/libvte.so.X /usr/lib/libvte.so.4</command></userinput></screen>
@@ -410,7 +415,7 @@
<section>
<title>Search and Replace</title>
<para>
- You can use regular expressions in the search dialog, just by activating the check box(see
+ You can use regular expressions in the search dialog, just by activating the check box (see
the image below). Detailed information about special characters can be found in the
<xref linkend="regexp"/>.
<figure>
@@ -537,10 +542,10 @@
<section id="cto">
<title>Compile time options</title>
<para>
- There are some options which can only changed at compile time. To change these
- options, look into <filename>src/geany.h</filename> to change these settings.
- To find it, look for a block of lines starting with <quote>#define GEANY_*</quote>.
- All definitions which are not listed here, should not be changed.
+ There are some options which can only be changed at compile time. To change these
+ options, edit the file <filename>src/geany.h</filename>.
+ Look for a block of lines starting with <quote>#define GEANY_*</quote>.
+ Any definitions which are not listed here should not be changed.
<table frame="all">
<title>Compile time options</title>
<tgroup cols="3">
@@ -559,7 +564,7 @@
<tbody>
<row>
<entry>GEANY_MAX_OPEN_FILES</entry>
- <entry>The limit how many files can be open at the same time.</entry>
+ <entry>The limit to how many files can be open at the same time.</entry>
<entry>25</entry>
</row>
<row>
@@ -570,23 +575,25 @@
</row>
<row>
<entry>GEANY_WORDCHARS</entry>
- <entry>These characters define the word boundaries.</entry>
+ <entry>These characters define word boundaries.</entry>
<entry>(look at sourcecode)</entry>
</row>
<row>
<entry>GEANY_MAX_AUTOCOMPLETE_WORDS</entry>
- <entry>How many auto complete suggestions should &app; provide.</entry>
+ <entry>How many auto completion suggestions should &app; provide.</entry>
<entry>30</entry>
</row>
<row>
<entry>GEANY_STRING_UNTITLED</entry>
- <entry>A string used as name for new files. Be aware that the string can be translated,
+ <entry>A string used as the default name for new files. Be aware
+ that the string can be translated,
so change it only if you know what you are doing.</entry>
<entry>untitled</entry>
</row>
<row>
<entry>GEANY_CHECK_FILE_DELAY</entry>
- <entry>Time in seconds between a file is checked for changes.</entry>
+ <entry>Time in seconds between checking a file for external
+ changes.</entry>
<entry>30</entry>
</row>
<row>
@@ -619,18 +626,18 @@
<section id="keybindings">
<title>Keybindings</title>
<para>
- For all listed actions you can define own keybindings. Open the preferences dialog
- and selected the desired action and click on change. In the opening dialog you can
+ For all listed actions you can define your own keybindings. Open the preferences
+ dialog, select the desired action and click on change. In the opening dialog you can
press any key combination you want and it will be saved when you press OK.
You can define only one key combination for one action.
</para>
<para>
Some of the default key combinations cannot be changed, e.g. menu_new or menu_open.
- These are set by GTK and should be kept. But you can add a key combination for these
- actions, so for example to execute menu_open by default
- <keycombo><keycap>Ctrl</keycap><keycap>O</keycap></keycombo> is set and you can
- define <keycombo><keycap>Alt</keycap><keycap>O</keycap></keycombo> so, the file open
- dialog is shown by pressing
+ These are set by GTK and should be kept, but you can still add other key
+ combinations for these actions. For example to execute menu_open by default
+ <keycombo><keycap>Ctrl</keycap><keycap>O</keycap></keycombo> is set, but you can
+ also define <keycombo><keycap>Alt</keycap><keycap>O</keycap></keycombo>, so that the
+ file open dialog is shown by pressing either
<keycombo><keycap>Ctrl</keycap><keycap>O</keycap></keycombo> or
<keycombo><keycap>Alt</keycap><keycap>O</keycap></keycombo>.
</para>
@@ -682,11 +689,11 @@
</row>
<row>
<entry>menu_undo</entry>
- <entry>Undos the last action.</entry>
+ <entry>Undoes the last action.</entry>
</row>
<row>
<entry>menu_redo</entry>
- <entry>Redos the last action.</entry>
+ <entry>Redoes the last action.</entry>
</row>
<row>
<entry>menu_preferences</entry>
@@ -718,7 +725,7 @@
</row>
<row>
<entry>menu_messagewindow</entry>
- <entry>Toggles the message window(status and compiler messages) on and off.</entry>
+ <entry>Toggles the message window (status and compiler messages) on and off.</entry>
</row>
<row>
<entry>menu_zoomin</entry>
@@ -730,7 +737,7 @@
</row>
<row>
<entry>menu_replacetabs</entry>
- <entry>Replaces all tabulators with the right amount of spaces.</entry>
+ <entry>Replaces all tabs with the right amount of spaces.</entry>
</row>
<row>
<entry>menu_foldall</entry>
@@ -749,15 +756,15 @@
</row>
<row>
<entry>build_link</entry>
- <entry>Builds(compiles if ncessary and links) the current file.</entry>
+ <entry>Builds (compiles if necessary and links) the current file.</entry>
</row>
<row>
<entry>build_make</entry>
- <entry>Builds the current file with the make tool.</entry>
+ <entry>Builds the current file with the Make tool.</entry>
</row>
<row>
<entry>build_makeowntarget</entry>
- <entry>Builds the current file with the make tool and a given target.</entry>
+ <entry>Builds the current file with the Make tool and a given target.</entry>
</row>
<row>
<entry>build_run</entry>
@@ -823,8 +830,8 @@
</row>
<row>
<entry>edit_macrolist</entry>
- <entry>Shows a list of (in the workspace) available macros and
- variables.
+ <entry>Shows a list of available macros and
+ variables in the workspace.
</entry>
</row>
<row>
@@ -848,12 +855,12 @@
<title>Templates</title>
<para>
<application>&app;</application> supports several templates for file headers, multiline
- comments(frame comments), function descriptions, a typical ChangeLog entry and a short GPL notice.
- To use this templates, just open the edit menu or open the popup menu by right-clicking in the
+ comments (frame comments), function descriptions, a typical ChangeLog entry and a short GPL notice.
+ 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" and insert templates as you want.
</para>
<para>
- Some templates like file header or ChangeLog entry, will always be inserted at the top of the file.
+ Some templates (like file header or ChangeLog entry) will always be inserted at the top of the file.
</para>
<para>
To insert a function description, the cursor must be inside of the function, so that the function
@@ -863,7 +870,7 @@
</para>
<para>
Each template can be customized to your needs. The templates are in the configuration directory, which
- is in <filename>~/.&app_small;/</filename> (see <xref linkend="clo"/> for further information about
+ is in <filename>~/.&app_small;/</filename> (see <xref linkend="clo"/> for further information about the
configuration directory). Just open the desired template with an editor (ideally &app; ;-) ) and edit
the template as your needs. There are some wildcards which will be automatically replaced by
<application>&app;</application> at startup.
@@ -872,16 +879,17 @@
All wildcards must be enclosed by "{" and "}", e.g. {date}.
</para>
<para>
- In the configuration dialog you can find a tab "Templates"(see <xref linkend="confdialog_templ"/>).
+ In the configuration dialog you can find a tab "Templates" (see <xref linkend="confdialog_templ"/>).
You can define the default values which will be inserted in the templates. You should restart
- <application>&app;</application> after made changes, because they are only read at startup.
+ <application>&app;</application> after making changes, because they are only read at startup.
</para>
<para>
Since <application>&app;</application> 0.3 there are also templates for creating new files.
They can be found in <filename>~/.&app_small;/</filename>, too.
- All template files for creating new files begin with template.filetype. followed by the filetype.
+ All template files for creating new files begin with
+ <filename>template.filetype.</filename> followed by the filetype.
At creating a new file with a filetype template, the template for the fileheader is automatically prepended.
- Please note, that the complete behaviour is still under development and will probably be changed in one of
+ Please note that the complete behaviour is still under development and will probably be changed in one of
the next releases. Sorry.
</para>
<para> </para>
@@ -909,7 +917,7 @@
</row>
<row>
<entry>initial</entry>
- <entry>The initials of the developer name, e.g. "ET" for
+ <entry>The developer's initials, e.g. "ET" for
Enrico Troeger or "JFD" for John Foobar Doe.</entry>
<entry>filetypes, file header, function description, ChangeLog entry</entry>
</row>
@@ -920,7 +928,7 @@
</row>
<row>
<entry>company</entry>
- <entry>The company name, the developer is working for.</entry>
+ <entry>The company the developer is working for.</entry>
<entry>filetypes, file header, function description, ChangeLog entry</entry>
</row>
<row>
@@ -966,8 +974,9 @@
</row>
<row>
<entry>functionname</entry>
- <entry>The function name of the function at cursor position. This wildcard will only
- be replaced in the function description template.</entry>
+ <entry>The function name of the function at the cursor position.
+ This wildcard will only be replaced in the function
+ description template.</entry>
<entry>function description</entry>
</row>
</tbody>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.