Repository files navigation

A source code class and function browser plugin for Gedit 3.

This plugin will add a new tab to the side pane in the Gedit text editor whichshows symbols (functions, classes, variables, etc.) for the active document.Clicking a symbol in the list wil jump to the line on which that symbol isdefined.

See thectags supported languagesfor a list of the 41 programming languages supported by this plugin.

This plugins is for Gedit 3 and isnot compatible with Gedit 2.x.

The Gedit Source Code Browser plugin usesExuberant Ctags to parse symbolsout of source code. Exuberant Ctags is avaialable in the software repository formany distributions. To make sure you have ctags correctly installed, issuethe following command:

ctags --version

Make sure that you seeExuberant Ctags in the version output.

Note: some distributions (including Debian, Ubuntu and other derivatives)offer the plugin already packaged, in which case you can install it via yourpackage manager, and jump to point 3 below.

1. Download this repository by clicking the Downloads button at the top of thegithub page or issue the following command in a terminal:

   git clonegit@github.com:GeditSourceCodePlugin/gedit-source-code-browser.git

2. Copy the filesourcecodebrowser.plugin and the foldersourcecodebrowser to~/.local/share/gedit/plugins/.

3. Restart Gedit.

4. Activate the plugin in Gedit by choosing 'Edit > Preferences', the selectingthe 'Plugins' tab, and checking the box next to 'Soucre Code Browser'.

5. (Optional) If you want to enable the configuration dialog you need to compilethe settings schema. You must do this as root.

   cd /home/<YOUR USER NAME>/.local/share/gedit/plugins/sourcecodebrowser/data/

   cp org.gnome.gedit.plugins.sourcecodebrowser.gschema.xml /usr/share/glib-2.0/schemas/

   glib-compile-schemas /usr/share/glib-2.0/schemas/

• CSS is not supported. This issue is about ctags and not this plugin. You canextend ctags to add support forany language you like. Many people have provided their fixes to on internetsuch as thispatch for CSS support.

• PHP is supported, however, PHP5 classes are not well supported. This is againan issue with ctags. There are numerous fixes to be found onn the internetsuch as thesepatches for better PHP5 support.

Copyright (c) 2011, Micah CarrickAll rights reserved.

Redistribution and use in source and binary forms, with or without modification,are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, thislist of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice,this list of conditions and the following disclaimer in the documentationand/or other materials provided with the distribution.

• Neither the name of Micah Carrick nor the names of itscontributors may be used to endorse or promote products derived from thissoftware without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" ANDANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AREDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FORANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ONANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THISSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.