HybridDog/geany
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add documentation for several options in the preferences dialog (patch from Robert McGinley, thanks).

Browse Source 
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@2471 ea778897-0a13-0410-b9d1-a72fbfd435f5
This commit is contained in:
Enrico Tröger 2008-04-11 15:32:48 +00:00
parent 0a39c31f92
commit f4e0652922
4 changed files with 1064 additions and 234 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
ChangeLog
View File

@ -1,7 +1,14 @@
2008-04-11 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
* THANKS, doc/geany.txt, doc/geany.html:
Add documentation for several options in the preferences dialog
(patch from Robert McGinley, thanks).
2008-04-10 Frank Lanitz <frank(at)frank(dot)uvena(dot)de>
* src/filetypes.c: Make another string translatable. Thanks to Adrovane
Kade for reporting.
Kade for reporting.
2008-04-10 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>

1
THANKS
View File

@ -43,6 +43,7 @@ Yura Siamashka <yurand2(at)gmail(dot)com> - many patches
Daniel Richard G. <skunk(at)iskunk(dot)org> - some patches
Pierre Joye <pierre(dot)php(at)gmail(dot)com> - Win32 process spawning patch
Matti Mårds <mamaar(at)gmail(dot)com> - create PHP tags script
Robert McGinley <mcginleyr1(at)gmail(dot)com> - Documentation improvements
Translators:
------------

877
doc/geany.html
View File

File diff suppressed because it is too large Load Diff

411
doc/geany.txt
View File

@ -1213,6 +1213,51 @@ General tab in preferences dialog
.. image:: ./images/pref_dialog_gen.png
Startup
```````
Load files from the last session
On opening geany immediately begin using the same files you had open the
last time you had Geany open.
Load virtual terminal support
Load the modules for creating a terminal in the tabs.
Enable plugin support
Allow plugins to be used in Geany.
Shutdown
````````
Save window position and geometry
Save the current position and size of geany so next time you open Geany
its in the same location
Confirm Exit
Have a dialog pop up to confirm that you really want to shutdown Geany.
Projects
````````
Use project-based session files
Save your current session as a project. You will be able to resume different
projects automatically opening the files you had open when you closed that
project.
Miscellaneous
`````````````
Beep on errors when compilation has finished
Have the computer make a beeping sound when compilation of your program
has completed or any errors occurred.
Switch status message list at new message
Suppress status message in the status bar
Autofocus widgets (focus follows mouse)
Always wrap search and hide the find dialog
Use current word under the cursor for Find dialogs
Use the currently selected word when you open one of the Search dialogs.
Interface tab in preferences dialog
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -1227,14 +1272,129 @@ combination to move between tabs, the order is determined by the tab
order, not alphabetical as shown in the documents list (regardless
whether or not editor tabs are visible).
Sidebar
```````
Show symbol list
Shows the list of functions, variables, and other information in the
current file (tab) you are editing.
Show documents list
Shows all the files you have open currently. This can be used to navigate
files instead of using the tabular interface.
Show full path name in documents list
Show the full directory path of the files you are editing in the
Documents list.
Fonts
`````
Editor
Change the font used in the editing widget of your files.
Symbol list
Change the font used in the listing of symbols in the Symbols sidebar tab.
Message window
Change the font used to display messages in the the Message window/tab.
Editor tabs
```````````
Show editor tabs
All open files have a tab so you can switch between them using a tab interface
instead of having to use the Documents window.
Show close buttons
Each tab has its own close button so you can easily close open documents without
having to select then file close them.
Placement of new file tabs
When you open a new file create its tab to the left or right of all existing tabs.
Tab positions
`````````````
Editor
Set the positioning of the editor's tabs to the right, left, top, or bottom
of the editing window.
Sidebar
Set the positioning of the sidebar's tabs to the right, left, top, or bottom
of the sidebar window.
Message window
Set the positioning of the message window's tabs to the right, left, top, or
bottom of the message window.
Miscellaneous
`````````````
Show status bar
Show the status bar at the bottom of the Geany window. Gives information about
the file you are editing like the line and column you are on, whether any
modifications were done, the file encoding, the filetype and other information.
Toolbar tab in preferences dialog
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Toolbar tab in preferences dialog
Effects the toolbar underneath the menu.
.. image:: ./images/pref_dialog_toolbar.png
Toolbar
```````
Show Toolbar
Remove the toolbar entirely from the window or show it.
Items
`````
Show file operation buttons
Show the buttons to open new file, open an existing file, save a file,
save all files.
Show Redo and Undo buttons
Show the undo change redo change buttons.
Show Back and Forward buttons
Show the buttons to move forward and backwards through tabs.
Show Compile and Run buttons
Show the buttons to run or compile a file.
Show Color Chooser button
Show the button to choose the color of the text you are typing.
Show Zoom In and Zoom Out buttons
Show the buttons to zoom in closer to a document or zoom out.
Show Increase and Decrease Indentation buttons
Show the buttons to make all indentations larger or smaller.
Show Search field
Show the search text area so that you do not have to Ctrl+F or go into
the search menu.
Show Go to Line field
Show the goto text area so you do not have to use the command keys or the menu.
Show Quit button
Show a button so that you can quit geany.
Appearance
``````````
Icon Style
Select the icon style by using icons and text, only the images (icons only),
or only the text.
Icon size
Select the size of the icons you see (large or small).
Display tab in preferences dialog
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -1244,6 +1404,40 @@ This is for visual elements displayed in the editor window.
.. image:: ./images/pref_dialog_display.png
Display
```````
Show indendation guides
Show vertical lines to show where you have hit tabs so you can more easily
line up text.
Show whitespaces
Mark all tabs or large sets of spaces with "-->" to highlight where exactly
are which kinds of whitespace.
Show line endings
Inserts a symbol everywhere that the return/enter key has been pressed.
Long line marker
````````````````
Type
Line
Print a vertical line in the editor window at the given cursor position.
Background
The background colour of characters after the given cursor position changed
to the color set below. (This is recommended if you use proportional fonts)
Disabled
Don't show a long line marker at all.
Long line marker
The long line marker is a thin vertical line in the editor. It helps to mark
long lines, or as a hint when to break the line. Set this value to a value
greater than zero to specify the column where it should appear.
Long line marker color
Set the color of the long line marker.
Editor tab in preferences dialog
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -1255,6 +1449,70 @@ Line wrapping refers to the display of the text in the
editor. (Currently, there is no setting to have Geany automatically
insert newlines into your document while you type.)
Indentation
```````````
Type
Decide whether to use tabs or spaces when you hit the tab button.
Tab width
The space width of a tab. Example when you hit tab it is the size
of hitting the space bar 4 times.
Auto-indent mode
The type of auto indentation you wish to follow, for example indent
to match braces or to match the last line.
Features
````````
Line wrapping
Should long lines be wrapped around to the next line or should they be
allowed to keep typeing on the current line and get as long as you wish.
Enable "smart" home key
When you hit the home key on your keyboard it goes to the beginning of
text on the line not the very, very beginning of the line.
Disable Drag and Drop
Do not allow the dragging and droping of selected text in the documents.
Enable folding
Allow ares of a document to be be collapsed for easier navigation/editing.
Fold/Unfold all children of a fold point
When a parent is folded should all the children in it also be folded and
when it is unfolded all the children are unfolded also.
Use indicators to show compile errors
When there are compile erros use red squiggles to indicate them in the
editor area.
Newline strip trailing spaces
When you hit the enter/return key remove the random white space at the end
of the line you are leaving.
Completions
```````````
Snippet Completion
Help finish your code by allowing the editor to try and figure out what your
typing.
XML tag autocompletion
When you open an XML tag automatically generate its completion tag.
Automatic symbol completion
When you start to type a symbol look for the full string and allow it to be
found for you.
Characters to type for completion
Number of characters before the autocompletion looks for a match to what you
are typing.
Rows of symbol completion list
The number of symbols shown in the autocompletion.
Files tab in preferences dialog
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -1263,6 +1521,37 @@ Files tab in preferences dialog
.. image:: ./images/pref_dialog_files.png
New files
`````````
Default encoding (new files)
The type of file encoding you wish to use on files you are creating.
Used fixed encoding when opening files
Assume all files you are opening are using the following type of encoding.
Default encoding (existing files)
Opens all files with the specified encoding instead of auto-detecting it.
Use this option when Geany continuously opens your files with a wrong encoding.
Saving files
````````````
Ensure newline at file end
If there is no newline at the end of your file when you save then it is added.
Strip trailing spaces
Remove the trailing spaces on a file when you save it.
Replace tabs by space
Replace all tabs in a document with spaces.
Miscellaneous
`````````````
Recent files list length
The total length allowed of the recently used files list.
Tools tab in preferences dialog
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -1271,14 +1560,62 @@ Tools tab in preferences dialog
.. image:: ./images/pref_dialog_tools.png
Tool paths
``````````
Make
The location of the make executable.
Terminal
The location of your terminal executable.
Browser
The location of your web browser executable.
Grep
The location of the grep executable.
.. note::
For Windows users: at time of writing it is recommended to use the
grep.exe from the UnxUtils project
(http://sourceforge.net/projects/unxutils). The grep.exe from the
Mingw project for instance doesn't work with Geany at the moment.
Commands
````````
Context action
When you perform a context action the executable that is launched.
You can use the "%s" wildcard to pass the current word below the cursor
to the specified command.
Template tab in preferences dialog
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Template tab in preferences dialog
This data will be used to create the header for files created using the
existing templates that geany has. For changes made here to take effect
a restart of geany is required.
.. image:: ./images/pref_dialog_templ.png
Template data
`````````````
Developer
The name of the developer who will be creating files.
Initials
The initials of the developer.
Mail address
The email address of the developer.
Company
The company the developer is working for.
Initial version
The intial version of files you will be creating.
Keybinding tab in preferences dialog
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -1301,6 +1638,29 @@ Printing tab in preferences dialog
.. image:: ./images/pref_dialog_printing.png
Use external command for printing
Use a system command to print your file out.
Use native GTK printing
Let GTK handle your print request.
Print line numbers
Print the line numbers on the left of your paper.
Print page number
Print the page number in the bottom right of your paper.
Print page header
Print a header on every page that is sent to printer.
Use base name of the printed file
The header does not use the entire path only the filename.
Date format
How the date should be printed on the paper. You can use the same
format specifiers as in the ANSI C function strftime(). For details
please see http://man.cx/strftime.
VTE tab in preferences dialog
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -1309,6 +1669,53 @@ VTE tab in preferences dialog
.. image:: ./images/pref_dialog_vte.png
Terminal widget
```````````````
Terminal font
Select the font that will be used in the terminal emulation.
Foreground color
Select the font color.
Background color
Select the background color of the terminal.
Scrollback lines
The number of lines buffered so that you can scroll though the history.
Terminal emulation
Controls how the terminal emulator should behave.
Do not change this value unless you know exactly what you are doing.
At time of writing only "xterm" is supported. For further details refer
to the documentation of the libvte package.
Shell
The location of the shell on your system.
Scroll on keystroke
Scroll when a specific keystroke is used.
Scroll on output
Scroll the output down.
Override Geany keybindings
Allows the VTE to receive keyboard shortcuts (apart from focus commands).
Disable menu shortcut key (F10 by default)
Disable the menu shortcut when you are in the virtual terminal.
Follow path of the current file
The path of the terminal changes the the path of the current file.
Execute programs in VTE
You are able to execute programs in the virtual terminal.
Don't use run script
Don't use the simple run script which is usually used to display
the exit status of the executed program.
This can be useful if you already have a program running in the VTE
like a Python console (e.g. ipython). Use this with care.
Project Management