README
1========================
2Geany Numbered Bookmarks
3========================
4
5About
6=====
7
8Geanynumberedbookmarks is a plugin to provide users with 10 numbered bookmarks
9(in addition to the usual bookmarks). It started out as part of the ConText
10feature parity plugin, which was split into individual plugins to better suit
11Geany's ethos of being as light as possible while allowing users to select
12which features they want to add to the core editor. The idea was taken from a
13Text Editor for Windows called ConText.
14
15Normally if you had more than one bookmark, you would have to cycle through them
16until you reached the one you wanted. With this plugin you can go straight to
17the bookmark that you want with a single key combination.
18
19
20Usage
21=====
22
23To set a numbered bookmark press Ctrl+Shift+(a number from 0 to 9). You will
24see a marker appear next to the line number. If you press Ctrl+Shift+(a number)
25on a line that already has that bookmark number then it removes the bookmark,
26otherwise it will move the bookmark there if it was set on a different line,
27or create it if it had not already been set. To move to a previously set
28bookmark press Ctrl+(bookmark number). You can also specify when in the
29bookmarked line the cursor is moved to when you move to a previously set
30bookmark. You can choose to move to the start of the line, the end of the line,
31how far into the line the cursor was when the bookmark was set, or try and keep
32the cursor in the column that you are in at the moment (line length allowing).
33Only the most recently set bookmark on a line will be shown, but you can have
34more than one bookmark per line. This plugin does not interfere with regular
35bookmarks. When a file is saved, Geany will remember the numbered bookmarks and
36make sure that they are set the next time you open the file.
37
38This plugin also will remember the state of folds in a file (open or not) if
39you want it to and re-apply this the next time you open the file.
40
41This plugin will also remember standard non-numbered bookmarks and restore
42these when a file is next reloaded if you want it to.
43
44Configuration
45=============
46
47You can alter the default behaviour of this plugin by selecting Plugin Manager
48under the Tools menu, selecting this plugin, and clicking Preferences.
49You can change:
50
51Remember fold state
52 if this is set then this plugin will remember the state of any folds along
53 with the numbered bookmarks and set them when the file is next loaded.
54Center view when goto bookmark
55 If this is set it will try to make sure that the numbered bookmark that you
56 are going to is in the center of the screen, otherwise it will simply be on
57 the screen somewhere.
58Move to...
59 This allows you to choose where in the bookmarked line the cursor is placed
60 when you move to a bookmarked line.
61Save file settings...
62 This allows you the option of saving the settings of a file (the numbered
63 bookmark positions, folding states, and standard bookmark positions) in
64 either the central settings file for geany plugins, or to a file with the
65 same name but a suffix (by default this is ".gnbs.conf") in the same
66 directory as the file. This allows the user the ability to synchronise the
67 settings for a file along with the file itself across more than one
68 computer. The default suffix can be changed by editing the numbered
69 bookmarks plugin settings file. This will vary from OS to OS but will
70 always be "settings.conf" in a directory called "Geany_Numbered_Bookmarks".
71 On my OS it's
72 ".config/geany/plugins/Geany_Numbered_Bookmarks/settings.conf" in my home
73 directory, but otherwise you'll have to search for it. In the Settings
74 section of the file near the top will be a line
75 "File_Details_Suffix=.gnbs.conf". Simply change this to whatever you would
76 prefer (if geany is running while you edit this file it may over-write your
77 new suffix so best close geany before editing this file).
78Remember normal Bookmarks
79 If this is set then the plugin will remember standard non-numbered
80 bookmarks, and restore them when the file is next loaded.
81
82License
83=======
84
85This plugin is distributed under the terms of the GNU General Public License
86as published by the Free Software Foundation, either version 2 of the
87License, or (at your option) any later version. You should have received a copy
88of the GNU General Public License along with this plugin. If not, see
89<https://www.gnu.org/licenses/>.
90