README
1 Kickshaw - A Menu Editor for Openbox
2
3 Copyright (c) 2010–2018 Marcus Schätzle
4
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License along
16 with Kickshaw. If not, see http://www.gnu.org/licenses/.
17
18
19---
20
21REQUIREMENTS
22
23Dependencies: GTK version 3.93; the code makes use of GNU extensions.
24Kickshaw is not dependent on Openbox; it can be used inside all window
25managers/desktop environments that support GTK applications to create and
26edit menu files. A makefile is included in the source directory. "make"
27and "make install" are sufficient to compile and install this program;
28there is no configure script file which has to be started first.
29
30This is a preview of a possible upcoming GTK 4 version of Kickshaw. It
31still has some quirks that need to be addressed until the first GTK 4
32release, and maybe some time after that. This preview version has so far
33been tested only on one system, and testing will be only intensified at
34the time the release of GTK 4 is imminent. Until then, the maintenance of
35the GTK 3 and 3 versions has priority. It is recommended to use one of
36these versions on a live system.
37
38IMPORTANT NOTES
39
40From version 0.5 on this program has all essential plus some additional
41features. This is the first release considered by the author to be stable
42and bug-free enough, as to his knowledge achieved by own reviewing and
43testing.
44Additional input to enhance the program further is of course
45appreciated, since one author alone has always his own "limited view".
46There are some additional features planned for the future (see the TODO
47file for these), but they rather fall into the "luxury" category;
48priority from now on is a stable and as bug-free as possible program.
49
50Even though the program can cope with whitespace and several tags that
51are nested into each other, the menu xml file has to be syntactically
52correct, or it won't be loaded properly or at all. In this case the
53program gives a detailed error message, if possible.
54
55FEATURES
56
57- Dynamic, context sensitive interface
58- The tree view can be customised (show/hide columns, grid etc.)
59- Context menus
60- Editable cells (dependent on the type of the cell)
61- Support for icons. Changes done outside the program to the image files,
62 for example a replacement of the image file with a new one under the
63 same name, are taken over within a second, and the program will show the
64 new image.
65- (Multirow) Drag and drop
66- The options of an "Execute" action and "startupnotify" option block can
67 be auto-sorted to obtain a constant menu structure
68- Search functionality (incl. processing of regular expressions)
69- Multiple selections (hold ctrl/shift key) can be used for mass deletions
70 or multirow drag and drop
71- Entering an existing Menu ID is prevented
72- The program informs the user if there are missing menu/item labels,
73 invalid icon paths and menus defined outside the root menu that are not
74 included inside the latter. By request the program creates labels for
75 these invisible menus/items, integrates the orphaned menus into the root
76 menu and opens a file chooser dialog so invalid icon paths can be
77 corrected.
78- Deprecated "execute" options are converted to "command" options.
79- Fast and compact, avoidance of overhead (programmed natively in C,
80 only one additional settings file created by the program itself,
81 no use of Glade)
82
83SPECIAL NOTE ABOUT DRAG AND DROP
84
85GTK does not support multirow drag and drop, that's why only one row is
86shown as dragged if mulitple rows have been selected for drag and drop.
87There is a workaround for this, but as good as it works for list views
88it doesn't for tree views, so it wasn't implemented here.
89