Branch: refs/heads/master Author: Colomban Wendling ban@herbesfolles.org Committer: Colomban Wendling ban@herbesfolles.org Date: Fri, 16 Nov 2012 23:12:08 UTC Commit: 86471b8bcf300312035b041a807d4933345931df https://github.com/geany/geany-plugins/commit/86471b8bcf300312035b041a807d49...

Log Message: ----------- Fix various list-related reStructuredText typos

Modified Paths: -------------- README.template addons/README codenav/README debugger/README devhelp/README geanyprj/README geanyvc/README gproject/README markdown/README spellcheck/README treebrowser/README

Modified: README.template 10 files changed, 5 insertions(+), 5 deletions(-) =================================================================== @@ -17,9 +17,9 @@ General information about what a plugin is all about. Features --------

- * list of features a plugin exposes - * list of features a plugin exposes - * list of features a plugin exposes +* list of features a plugin exposes +* list of features a plugin exposes +* list of features a plugin exposes

Usage ----- @@ -31,8 +31,8 @@ configuration, known bugs etc. Requirements ------------

- * first - * second +* first +* second

Contact developers ------------------

Modified: addons/README 22 files changed, 11 insertions(+), 11 deletions(-) =================================================================== @@ -18,15 +18,15 @@ plugin but might still useful for people. Features --------

- * Toolbar button with a list of open files - * Open and Copy URI found in a document command - * Task list in a message window - * Bookmark list in a sidebar - * Status icon in the notification area - * Highlighting all occurrences of a word when double-clicking it - * Strip trailing blank lines when saving - * XMLtagging - * Enclose selected text with characters +* Toolbar button with a list of open files +* Open and Copy URI found in a document command +* Task list in a message window +* Bookmark list in a sidebar +* Status icon in the notification area +* Highlighting all occurrences of a word when double-clicking it +* Strip trailing blank lines when saving +* XMLtagging +* Enclose selected text with characters

Usage ----- @@ -94,8 +94,8 @@ selected text in brackets). Requirements ------------

- * GTK >= 2.8.0 - * Geany >= 0.21 +* GTK >= 2.8.0 +* Geany >= 0.21

Contact developers ------------------

Modified: codenav/README 6 files changed, 3 insertions(+), 3 deletions(-) =================================================================== @@ -11,8 +11,8 @@ This plugin adds some facilities for navigating in the code. Features --------

- * switch between header and implementation - * go to a file by typing its name +* switch between header and implementation +* go to a file by typing its name

Usage ----- @@ -24,7 +24,7 @@ change the keyboard shortcuts in Geany's preferences dialog. Requirements ------------

- * GTK >= 2.8.0 +* GTK >= 2.8.0

Contact developers ------------------

Modified: debugger/README 30 files changed, 15 insertions(+), 15 deletions(-) =================================================================== @@ -19,18 +19,18 @@ so the other backends support is planned as well. Features --------

- * Debugger panel - * Setting target, environment variables and command line arguments - * Breakpoints - * Watches, autos - * Debug terminal - * Debugger messages window - * Threads and stack info - * Switching frames in the stack trace window - * Variables calltips while debugging - * Saving debug session data in a Geany project (can be switched through settings) - * Double or single panel modes - * Hotkeys +* Debugger panel +* Setting target, environment variables and command line arguments +* Breakpoints +* Watches, autos +* Debug terminal +* Debugger messages window +* Threads and stack info +* Switching frames in the stack trace window +* Variables calltips while debugging +* Saving debug session data in a Geany project (can be switched through settings) +* Double or single panel modes +* Hotkeys

Usage ----- @@ -48,9 +48,9 @@ watch item containing the corresponding expression. Requirements ------------

- * Geany >= 0.21 - * GTK 2 - * POSIX API +* Geany >= 0.21 +* GTK 2 +* POSIX API

Contact developers ------------------

Modified: devhelp/README 12 files changed, 6 insertions(+), 6 deletions(-) =================================================================== @@ -22,9 +22,9 @@ be viewed with Devhelp. Features --------

- * search in Devhelp - * search in 'man' pages - * search in Google Code Search +* search in Devhelp +* search in 'man' pages +* search in Google Code Search

Usage ----- @@ -104,9 +104,9 @@ activated, will perform the same searches as described above. Requirements ------------

- * GTK >= 2.16 - * libwebkitgtk >= 1.1.18 - * libdevhelp 1.0 >= 2.30.1 or libdevhelp 2.0 >= 2.32.0 +* GTK >= 2.16 +* libwebkitgtk >= 1.1.18 +* libdevhelp 1.0 >= 2.30.1 or libdevhelp 2.0 >= 2.32.0

Contact developers ------------------

Modified: geanyprj/README 10 files changed, 5 insertions(+), 5 deletions(-) =================================================================== @@ -59,11 +59,11 @@ selected type. If it is unchecked you should manually select files you want to b

Type - This is type of files that needed to be parsed by tagmanager.

- * All - All files that is known to Geany - * C/C++ - This match any C or C++ files (.c, .cpp, .cxx, .h etc.) - * C - This match only C files (.c, .h) - * Python - This match python files (.py) - * None - This doesn't match any files +* All - All files that is known to Geany +* C/C++ - This match any C or C++ files (.c, .cpp, .cxx, .h etc.) +* C - This match only C files (.c, .h) +* Python - This match python files (.py) +* None - This doesn't match any files

Example of usage

Modified: geanyvc/README 62 files changed, 31 insertions(+), 31 deletions(-) =================================================================== @@ -23,38 +23,38 @@ Features *Bazaar, GIT, Mercurial, Subversion, SVK* ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- * diff file - * diff directory - * diff base directory - * blame - * log file - * log directory - * log base directory - * status - * revert file - * revert directory - * revert base directory - * show unmodified original file - * add file - * remove file - * update - * commit +* diff file +* diff directory +* diff base directory +* blame +* log file +* log directory +* log base directory +* status +* revert file +* revert directory +* revert base directory +* show unmodified original file +* add file +* remove file +* update +* commit

*CVS* ^^^^^

- * diff file - * diff directory - * diff base directory - * log file - * log directory - * log base directory - * status - * revert file - * revert directory - * revert base directory - * update - * commit +* diff file +* diff directory +* diff base directory +* log file +* log directory +* log base directory +* status +* revert file +* revert directory +* revert base directory +* update +* commit

Usage ----- @@ -116,9 +116,9 @@ recommended to activate e.g. svk only if you want to use it. Requirements ------------

- * GTK >= 2.8.0 - * gtkspell >=2.0 for a spell checking - * Geany >= 0.19 +* GTK >= 2.8.0 +* gtkspell >=2.0 for a spell checking +* Geany >= 0.19

Contact developers ------------------

Modified: gproject/README 128 files changed, 64 insertions(+), 64 deletions(-) =================================================================== @@ -8,9 +8,9 @@ About =====

GProject is an extension of Geany's project management displaying a tree of files -belonging to the project in the sidebar. In addition, it enables quick swapping -between header and source files, searching project files by name and more. The plugin -was created with big projects in mind so everything works fast enough even with +belonging to the project in the sidebar. In addition, it enables quick swapping +between header and source files, searching project files by name and more. The plugin +was created with big projects in mind so everything works fast enough even with projects consisting of hundreds of thousands of files.

Why was it created? @@ -20,15 +20,15 @@ A project in Geany is completely file-agnostic when it comes to the question of what files are stored in the project. In principle the information that Geany stores for every project is:

- * project's base directory - * build settings - * list of open files +* project's base directory +* build settings +* list of open files

This approach is fine for smaller projects where most of the project files are stored in a single directory but doesn't work very well with projects consisting of many deeply nested directories containing thousands of files. For such projects an expandable tree showing the project files is a better alternative making it much -easier to to navigate between different project directories. +easier to to navigate between different project directories.

Why are files belonging to a project defined by patterns? --------------------------------------------------------- @@ -38,8 +38,8 @@ of thousands files and many developers working on them. Files are created, delet and moved quite frequently and after each change the project has to be updated manually. Instead, GProject defines a list of files belonging to the project implicitly using:

- * project's base directory - * a list of glob-like patterns +* project's base directory +* a list of glob-like patterns

Every file under the base directory matching the patterns is included into the project and updating the file list is as simple as pressing the refresh button. @@ -50,20 +50,20 @@ What are the differences between GProject and GeanyPrj? There is another project-management Geany plugin - GeanyPrj. GProject and GeanyPrj differ in several aspects:

- * GProject is an extension of Geany's project so every Geany project is a GProject - at the same time and vice versa. On the other hand, GeanyPrj project is a separate - project so if you want to set build properties for a GeanyPrj project, you have to - set up a second Geany project in parallel. - * Because GeanyPrj is a separate project management plugin, it can do some things that - GProject cannot - in particular, it can manage several projects in parallel. - If you need to switch between several projects, GeanyPrj might be a better option - for you. Alternatively, you can open several Geany instances for different projects - to work on several projects in parallel using GProject. - * GProject displays full tree in the sidebar while GeanyPrj displays only two-level - tree (full directory name as a parent and a list of files under the directory). - * GProject has configurable patterns while patterns in GeanyPrj are hard-coded - * GProject offers header/source swapping - * GProject offers finding project files by name +* GProject is an extension of Geany's project so every Geany project is a GProject + at the same time and vice versa. On the other hand, GeanyPrj project is a separate + project so if you want to set build properties for a GeanyPrj project, you have to + set up a second Geany project in parallel. +* Because GeanyPrj is a separate project management plugin, it can do some things that + GProject cannot - in particular, it can manage several projects in parallel. + If you need to switch between several projects, GeanyPrj might be a better option + for you. Alternatively, you can open several Geany instances for different projects + to work on several projects in parallel using GProject. +* GProject displays full tree in the sidebar while GeanyPrj displays only two-level + tree (full directory name as a parent and a list of files under the directory). +* GProject has configurable patterns while patterns in GeanyPrj are hard-coded +* GProject offers header/source swapping +* GProject offers finding project files by name

Usage ===== @@ -72,16 +72,16 @@ Project configuration ---------------------

Upon project creation, you should define the list of file patterns under the -Project->Properties Project tab. For instance, for a typical open source C project, -use patterns "*.c *h *.am *.ac" to see the source files together with -automake and autoconf files. After closing the dialog, the files matching the patterns -should appear in the sidebar under the Project tab (unless the GProject plugin +Project->Properties Project tab. For instance, for a typical open source C project, +use patterns "*.c *h *.am *.ac" to see the source files together with +automake and autoconf files. After closing the dialog, the files matching the patterns +should appear in the sidebar under the Project tab (unless the GProject plugin was loaded after the project - see Known Issues for more details).

Additional settings is available from the GProject tab under the Project properties dialog. You can define patterns to distinguish between header and source files for C-like languages. This information is used for header/source swapping and also for -giving different icons to headers and sources in the sidebar (therefore, this settings +giving different icons to headers and sources in the sidebar (therefore, this settings can be also used for other types of languages if you want to give different file types different icons).

@@ -100,35 +100,35 @@ The sidebar contains a tree of files belonging to the project. Directories can b by double-clicking them; the same action is used to open files. When a sidebar item is right-clicked, a context menu appears:

- * Expand all - recursively expands all the subdirectories of the given directory - * Find in files - opens the Find in files dialog and sets the search directory - to the clicked directory - * Find file - opens the Find file dialog and sets the search directory to the - clicked directory +* Expand all - recursively expands all the subdirectories of the given directory +* Find in files - opens the Find in files dialog and sets the search directory + to the clicked directory +* Find file - opens the Find file dialog and sets the search directory to the + clicked directory

The following actions can be invoked from the sidebar's toolbar:

- * Reload all - reloads the project file tree. This is useful when files were added or - removed from the project. - * Expand all - recursively expands all the directories - * Collapse all - recursively collapses all the directories - * Follow active editor - automatically selects the current file in the sidebar - when the user switches to another file. It auto-expands the tree to reveal the selected - file. +* Reload all - reloads the project file tree. This is useful when files were added or + removed from the project. +* Expand all - recursively expands all the directories +* Collapse all - recursively collapses all the directories +* Follow active editor - automatically selects the current file in the sidebar + when the user switches to another file. It auto-expands the tree to reveal the selected + file.

Project menu entries --------------------

GProject adds some extra entries under the Project menu:

- * Find in Project Files - opens the Find in files dialog and sets the search directory - to the base directory of the project - * Find Project File - opens the Find file dialog and sets the search directory to the - base directory of the project - * Swap Header/Source - if the current file matches one of the source patterns from - the properties, it opens a project file with the same base name (without extension) - matching header patterns (and vice versa). If the files are already open, it - just switches the document tabs. Nothing happens if no matching file is found. +* Find in Project Files - opens the Find in files dialog and sets the search directory + to the base directory of the project +* Find Project File - opens the Find file dialog and sets the search directory to the + base directory of the project +* Swap Header/Source - if the current file matches one of the source patterns from + the properties, it opens a project file with the same base name (without extension) + matching header patterns (and vice versa). If the files are already open, it + just switches the document tabs. Nothing happens if no matching file is found.

Each of these entries can be assigned a key binding under Edit->Preferences->Keybindings.

@@ -136,35 +136,35 @@ Find file dialog ----------------

The Find file dialog can be invoked either from the Project menu or from the -sidebar's context menu. Searches are performed recursively, starting from the +sidebar's context menu. Searches are performed recursively, starting from the "Search inside" directory. All files having the searched string as a substring of their -name are displayed in the Messages window. Clicking the file name opens the file. +name are displayed in the Messages window. Clicking the file name opens the file. The following search properties are configurable:

- * Case sensitive - specifies whether the searches should be case-sensitive - * Search in full path - when not checked, the search is performed in the file - name only (excluding path); when checked, the search is performed in the full path +* Case sensitive - specifies whether the searches should be case-sensitive +* Search in full path - when not checked, the search is performed in the file + name only (excluding path); when checked, the search is performed in the full path

Editor context menu -------------------

GProject adds an extra entry into the context menu of the editor:

- * Open Selected File (GProject) - contrary to the Open Selected File entry present - in Geany it also searches for the file in project files +* Open Selected File (GProject) - contrary to the Open Selected File entry present + in Geany it also searches for the file in project files

Known issues ============

- * When the plugin is loaded from the Plugin Manager for the first time and a project - is already open, no files are displayed in the sidebar. The workaround is to - reload the project in this case. The issue is caused by Geany only passing the project - configuration file to a plugin when the project is loaded, which isn't the case when - the plugin is loaded. - * There might be some issues with UTF8 file names - the testing has been very - limited. - * GProject hasn't been tested under Windows so probably not everything works there. - Patches are welcome. +* When the plugin is loaded from the Plugin Manager for the first time and a project + is already open, no files are displayed in the sidebar. The workaround is to + reload the project in this case. The issue is caused by Geany only passing the project + configuration file to a plugin when the project is loaded, which isn't the case when + the plugin is loaded. +* There might be some issues with UTF8 file names - the testing has been very + limited. +* GProject hasn't been tested under Windows so probably not everything works there. + Patches are welcome.

License =======

Modified: markdown/README 12 files changed, 6 insertions(+), 6 deletions(-) =================================================================== @@ -19,10 +19,10 @@ and inserted into an HTML template and loaded into a Features --------

- * Allows placing the preview in the sidebar or message window areas - * Updates the preview on-the-fly as you type, automatically. - * Allows simple customization of fonts and colours and complete control - with custom template files. +* Allows placing the preview in the sidebar or message window areas +* Updates the preview on-the-fly as you type, automatically. +* Allows simple customization of fonts and colours and complete control + with custom template files.

Usage ----- @@ -146,8 +146,8 @@ Requirements

The plugin depends on the following libraries:

- * `GTK+ http://www.gtk.org`_ 2.16 or greater - * `WebKitGTK+ http://webkitgtk.org`_ 1.1.18 or greater +* `GTK+ http://www.gtk.org`_ 2.16 or greater +* `WebKitGTK+ http://webkitgtk.org`_ 1.1.18 or greater

License -------

Modified: spellcheck/README 70 files changed, 35 insertions(+), 35 deletions(-) =================================================================== @@ -21,9 +21,9 @@ which can be used for the spell check. Features --------

- * Check spelling while typing - * Highlight spelling mistakes - * Editor-menu integration +* Check spelling while typing +* Highlight spelling mistakes +* Editor-menu integration

Usage @@ -44,50 +44,50 @@ http://extensions.services.openoffice.org/en/dictionaries. Be sure to download the "Spelling" archives from this site. The downloaded archive should contain one or more .dic and .aff files.

-Instructions:: +Instructions:

- 1. Download the archive you want to use - 2. The downloaded archive with the extension .oxt is actually a ZIP - archive, so extract it as usual (e.g. with 7-Zip or another ZIP - unpacker). Extract the contents into a folder of your choice, - e.g. C:\dictionaries - 3. Then open to the Spell Check plugin preferences dialog in Geany and - choose the folder you just created. You may need to restart Geany - and then the installed dictionaries should be available +1. Download the archive you want to use +2. The downloaded archive with the extension .oxt is actually a ZIP + archive, so extract it as usual (e.g. with 7-Zip or another ZIP + unpacker). Extract the contents into a folder of your choice, + e.g. C:\dictionaries +3. Then open to the Spell Check plugin preferences dialog in Geany and + choose the folder you just created. You may need to restart Geany + and then the installed dictionaries should be available

Known issues ------------ - * Spell checking with some languages like Hindi might be incorrect, i.e. some - words are incorrectly marked as correctly spelled or marked incorrectly - as misspelled. - * Crashes of Geany when loading the Spell Check plugin after it was unloaded. - This can happen when you are using a dictionary from the Zemberek provider - of Enchant (mostly Turkish dictionaries). - It can also happen when you tried to use a non-existing - dictionary and the Zemberek provider is installed on your system. - To avoid these crashes you have the following options: - - * Do not load the plugin after it was unloaded, restart Geany first - * Do not use any of the dictionaries provided by the Zemberek provider - * Update your Enchant version at least to 1.4.3 (once it is released) - * Uninstall the Zemberek provider +* Spell checking with some languages like Hindi might be incorrect, i.e. some + words are incorrectly marked as correctly spelled or marked incorrectly + as misspelled. +* Crashes of Geany when loading the Spell Check plugin after it was unloaded. + This can happen when you are using a dictionary from the Zemberek provider + of Enchant (mostly Turkish dictionaries). + It can also happen when you tried to use a non-existing + dictionary and the Zemberek provider is installed on your system. + To avoid these crashes you have the following options: + + * Do not load the plugin after it was unloaded, restart Geany first + * Do not use any of the dictionaries provided by the Zemberek provider + * Update your Enchant version at least to 1.4.3 (once it is released) + * Uninstall the Zemberek provider

Background: - These crashes are all related to the Zemberek provider in Enchant. - In version 1.4.2 and prior of Enchant, this provider/backend always - claimed to support any given invalid dictionary name and so it was - active and caused these crashes on load after unload of the plugin. - This provider is DBus-based and uses the GObject type - registration system which is not really capable of being unloaded and - loaded again. + These crashes are all related to the Zemberek provider in Enchant. + In version 1.4.2 and prior of Enchant, this provider/backend always + claimed to support any given invalid dictionary name and so it was + active and caused these crashes on load after unload of the plugin. + This provider is DBus-based and uses the GObject type + registration system which is not really capable of being unloaded and + loaded again.

Requirements ------------

- * GTK >= 2.8.0 - * Geany >= 0.21 +* GTK >= 2.8.0 +* Geany >= 0.21

Ideas, questions, patches and bug reports

Modified: treebrowser/README 18 files changed, 9 insertions(+), 9 deletions(-) =================================================================== @@ -23,19 +23,19 @@ features than the file browser plugin delivered with Geany itself. Features ========

- * Project following - * Basic filesystem functionality - * GTK bookmarks support - * Keybindings - * Filterable list - * Show content-type icons +* Project following +* Basic filesystem functionality +* GTK bookmarks support +* Keybindings +* Filterable list +* Show content-type icons

Requirements ============ - * GTK >= 2.8.0 - * GIO >= 2.0 (optional) - * Geany >= 0.17 +* GTK >= 2.8.0 +* GIO >= 2.0 (optional) +* Geany >= 0.17

Usage

-------------- This E-Mail was brought to you by github_commit_mail.py (Source: TBD).