1
1
Gedit Source Code Browser
2
2
=========================
3
3
4
- A source code class and function browser plugin for Gedit 3.
4
+ ![ No Maintenance Intended] ( http://unmaintained.tech/badge.svg )
5
+
6
+ A source code class and function browser plugin for Gedit 3.
5
7
6
8
* Author: Micah Carrick
7
9
8
10
This plugin will add a new tab to the side pane in the Gedit text editor which
9
- shows symbols (functions, classes, variables, etc.) for the active document.
10
- Clicking a symbol in the list wil jump to the line on which that symbol is
11
+ shows symbols (functions, classes, variables, etc.) for the active document.
12
+ Clicking a symbol in the list wil jump to the line on which that symbol is
11
13
defined.
12
14
13
15
See the [ ctags supported languages] ( http://ctags.sourceforge.net/languages.html )
@@ -17,26 +19,26 @@ for a list of the 41 programming languages supported by this plugin.
17
19
Requirements
18
20
------------
19
21
20
- This plugins is for Gedit 3 and is ** not compatible with Gedit 2.x** .
22
+ This plugins is for Gedit 3 and is ** not compatible with Gedit 2.x** .
21
23
22
- The Gedit Source Code Browser plugin uses
24
+ The Gedit Source Code Browser plugin uses
23
25
[ Exuberant Ctags] ( http://ctags.sourceforge.net/ ) to parse symbols
24
26
out of source code. Exuberant Ctags is avaialable in the software repository for
25
27
many distributions. To make sure you have ctags correctly installed, issue
26
28
the following command:
27
29
28
30
ctags --version
29
-
31
+
30
32
Make sure that you see * Exuberant* Ctags in the version output.
31
33
32
34
33
35
Installation
34
36
------------
35
37
36
- 1 . Download this repository by clicking the Downloads button at the top of the
38
+ 1 . Download this repository by clicking the Downloads button at the top of the
37
39
github page or issue the following command in a terminal:
38
40
39
- git clone git://github.com/Quixotix /gedit-source-code-browser.git
41
+ git clone git://github.com/MicahCarrick /gedit-source-code-browser.git
40
42
41
43
2 . Copy the file ` sourcecodebrowser.plugin ` and the folder ` sourcecodebrowser ` to
42
44
` ~/.local/share/gedit/plugins/ ` .
@@ -45,33 +47,33 @@ Installation
45
47
46
48
4 . Activate the plugin in Gedit by choosing 'Edit > Preferences', the selecting
47
49
the 'Plugins' tab, and checking the box next to 'Soucre Code Browser'.
48
-
50
+
49
51
5 . (Optional) If you want to enable the configuration dialog you need to compile
50
52
the settings schema. You must do this as root.
51
53
52
54
cd /home/< ; YOUR USER NAME> ; /.local/share/gedit/plugins/sourcecodebrowser/data/
53
-
55
+
54
56
cp org.gnome.gedit.plugins.sourcecodebrowser.gschema.xml /usr/share/glib-2.0/schemas/
55
-
57
+
56
58
glib-compile-schemas /usr/share/glib-2.0/schemas/
57
59
58
60
Screenshots
59
61
-----------
60
62
61
- ![ Python code in Source Code Browser] ( http://www.micahcarrick.com/images/gedit-source-code-browser/python .png)
63
+ ![ Python code in Source Code Browser] ( screenshot .png)
62
64
63
65
64
66
Known Issues
65
67
------------
66
68
67
69
* CSS is not supported. This issue is about ctags and not this plugin. You can
68
- [ extend ctags] ( http://ctags.sourceforge.net/EXTENDING.html ) to add support for
69
- any language you like. Many people have provided their fixes to on internet
70
+ [ extend ctags] ( http://ctags.sourceforge.net/EXTENDING.html ) to add support for
71
+ any language you like. Many people have provided their fixes to on internet
70
72
such as this [ patch for CSS support] ( http://scie.nti.st/2006/12/22/how-to-add-css-support-to-ctags ) .
71
-
73
+
72
74
* PHP is supported, however, PHP5 classes are not well supported. This is again
73
75
an issue with ctags. There are numerous fixes to be found onn the internet
74
- such as these
76
+ such as these
75
77
[ patches for better PHP5 support] ( http://www.jejik.com/articles/2008/11/patching_exuberant-ctags_for_better_php5_support_in_vim/ ) .
76
78
77
79
@@ -81,27 +83,27 @@ License
81
83
Copyright (c) 2011, Micah Carrick
82
84
All rights reserved.
83
85
84
- Redistribution and use in source and binary forms, with or without modification,
86
+ Redistribution and use in source and binary forms, with or without modification,
85
87
are permitted provided that the following conditions are met:
86
88
87
- * Redistributions of source code must retain the above copyright notice, this
89
+ * Redistributions of source code must retain the above copyright notice, this
88
90
list of conditions and the following disclaimer.
89
-
90
- * Redistributions in binary form must reproduce the above copyright notice,
91
- this list of conditions and the following disclaimer in the documentation
91
+
92
+ * Redistributions in binary form must reproduce the above copyright notice,
93
+ this list of conditions and the following disclaimer in the documentation
92
94
and/or other materials provided with the distribution.
93
-
94
- * Neither the name of Micah Carrick nor the names of its
95
- contributors may be used to endorse or promote products derived from this
95
+
96
+ * Neither the name of Micah Carrick nor the names of its
97
+ contributors may be used to endorse or promote products derived from this
96
98
software without specific prior written permission.
97
99
98
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
99
- ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
100
- WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
101
- DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
102
- ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
103
- (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
104
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
105
- ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
106
- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
100
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
101
+ ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
102
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
103
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
104
+ ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
105
+ (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
106
+ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
107
+ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
108
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
107
109
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0 commit comments