README
1Addons
2======
3
4.. image:: http://plugins.geany.org/images/plugins/addons/addonssmall.png
5 :width: 400
6 :alt: Demonstration of the Addons plugin (Tasks, Bookmark List, Occurrence Highlighting, ...)
7 :align: right
8 :target: http://plugins.geany.org/images/plugins/addons/addonsb.png
9
10.. contents::
11
12About
13-----
14
15This plugin adds various small addons to Geany which aren't worth an own
16plugin but might still useful for people.
17
18Features
19--------
20
21* Toolbar button with a list of open files
22* Open and Copy URI found in a document command
23* Task list in a message window
24* Bookmark list in a sidebar
25* Status icon in the notification area
26* Highlighting all occurrences of a word when double-clicking it
27* Strip trailing blank lines when saving
28* XMLtagging
29* Enclose selected text with characters
30* Show colorized calltip on hovering over a color value
31* Open Color Chooser on double clicking on a color value
32
33Usage
34-----
35
36*Document list*
37^^^^^^^^^^^^^^^
38This addon places a new item in the toolbar and when clicked offers a menu
39listing all open files plus the 'Close All' and 'Close Other Documents' menu
40items. This can be useful to quickly access open files and switch to them.
41
42*Open and Copy URI*
43^^^^^^^^^^^^^^^^^^^
44Adds 'Open URI' and 'Copy URI' menu items to the editor menu when the word under
45the cursor looks like a URI. 'Open URI' uses the browser command configured in
46Geany to open it.
47
48*Tasks*
49^^^^^^^
50The tasks plugin goes through a file being edited and picks out lines with
51configurable keywords (e.g. "TODO" or "FIXME") in them. It collects the text
52after those words and puts them in a new "Tasks" tab in the message window.
53Clicking on a task in that tab takes you to the line in the file where the
54task was defined.
55
56*Systray*
57^^^^^^^^^
58Adds a status icon to the notification area (systray) and provides
59a simple popup menu with some basic actions. It can also be used to
60quickly show and hide the Geany main window.
61
62*Bookmark list*
63^^^^^^^^^^^^^^^
64Add a list of defined bookmarks (line markers) to the sidebar.
65This list contains all bookmarks defined in the current file
66for faster overview and access.
67
68*Mark Word*
69^^^^^^^^^^^
70When double-clicking a word, all occurrences of this word are searched
71and then highlighted (similar to Geany's 'Mark All' Find option).
72
73*Strip trailing blank lines*
74^^^^^^^^^^^^^^^^^^^^^^^^^^^^
75This addon removes excessive trailing blank lines from the document when it is
76saved. If you have 'Ensure new line at file end' option checked in Preferences,
77one trailing newline will be left.
78
79*XML tagging*
80^^^^^^^^^^^^^
81XML tagging allows to easy tag a selected text, by checking for a
82selection, offering a little dialog for inserting a tag and
83replacing a selection.
84
85*Enclosing selected text*
86^^^^^^^^^^^^^^^^^^^^^^^^^
87Provides two methods for enclosing selected text in characters. If the 'Enclose
88selection automatically' option is checked in Preferences, selected text will
89be surrounded when certain characters are pressed (e.g. highlight a string and
90press ", the string will be surrounded in double quotes). Also allows you to
91define up to eight of your own opening and closing character pairs, which can
92then be linked to a keybinding (e.g. set [ and ] to be Enclose Pair 1 and the
93keybinding to ctrl+[ , highlight some text and press ctrl+[ to surround the
94selected text in brackets).
95
96*Copy File Path*
97^^^^^^^^^^^^^^^^
98Simple extension to easily copy the full path of the current file
99to the clipboard for further use.
100The action can be triggered by a keyboard shortcut as well as by
101a menu item in the Tools menu.
102
103*Show colorized calltip on hovering over a color value*
104^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
105This extension will show a calltip if the mouse is hovered over a color
106value like #fff or #ffffff. The calltip background color represents the
107color value over which the mouse is hovered. The preferences option "Show
108a calltip when hovering over a color value" is used to enable or disable
109the extension.
110
111Append `-DLARGE_COLOR_TIP` to `CFLAGS` for a large color calltip or
112`-DXLARGE_COLOR_TIP` for an extra-large color calltip.
113
114*Open Color Chooser on double clicking on a color value*
115^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
116This extension will open the Color Chooser if the user double clicks on
117a color value like #fff or #ffffff. The preferences option "Open Color
118Chooser when double-clicking a color value" is used to enable or disable
119the extension.
120
121Requirements
122------------
123
124* GTK >= 2.8.0
125* Geany >= 0.21
126
127Contact developers
128------------------
129
130#geany IRC channel on FreeNode
131
132
