README
1.. |(version)| replace:: 0.5
2
3========
4geanydoc
5========
6
7.. contents::
8
9About
10=====
11
12Geanydoc is plugin for Geany IDE that allow execute specified commands on the
13current word at the cursor position. This word is passed as an argument to these commands.
14It allow either place output of these commands in geany buffer \*DOC\* or just
15execute external program. Geanydoc is intended to be used for searching documentation
16API in different sources.
17
18In order to use it you need Geany >= 0.16.
19
20Usage
21=====
22
23geanydoc define 2 keyboard shortcut "Document current word" and "Document interactive"
24First you need to assign key to them in "Edit->Preferences->Keybinding->Doc".
25
26"Document current word" search documentation on the current word near cursor position.
27"Document interactive" search documentation on word you enter in interactive dialog.
28
29Settings
30========
31
32geanydoc allow to execute different commands for different filetypes. Use combobox
33to select type you need.
34
35"Put output in buffer" if you check this checkbox geanydoc will execute command wait for
36it's exit and place it's output in geany buffer. If you have this button unchecked
37geanydoc will simply spawn command and forgot about it.
38
39NOTE: if you have multiple command all commands but last are treated as "Put output in buffer"
40true. This checkbox is used only for last command.
41
42If you specify several commands, second command will be called only if first one didn't return
43something in output.
44
45License
46=======
47
48geanydoc is distributed under the terms of the GNU General Public License
49as published by the Free Software Foundation; either version 3 of the
50License, or (at your option) any later version. A copy of this license
51can be found in the file COPYING included with the source code of this
52program.
53
54Ideas, questions, patches and bug reports
55=========================================
56
57If you add something, or fix a bug, please send a patch (in 'diff -u'
58format) to the geany mailing list or to one of the authors listed bellow.
59
60Coding
61======
62
63Use static functions where possible.
64Try to use GLib types and functions - e.g. g_free instead of free and
65try to use only GLib 2.6 and GTK 2.6 functions.
66
67Style
68=====
69
70The file indent-all.sh contains information about
71the current code style. Run this script before commit.
72
73Download
74========
75
76geanydoc is part of the combined Geany Plugins release.
77For more information and downloads, please visit
78http://plugins.geany.org/
79
80
81Author
82======
83Yura Siamashka yurand2(at)gmail(dot)com
84