gedit - Plugins

Please do not use the GUI editor to edit this page. It changes the layout of the page.

This page contains an overview of the available, requested and third party plugins for gedit. If you have developed a plugin yourself you can list it here in the third party section. Additional to the plugins available in gedit by default there is a separate gedit-plugins package containing useful plugins that are (most of the time) too specific to be distributed with gedit itself.

See that this page is for plugins developed for gedit 3. If you developed a plugin for an older version you can list it in gedit 2 plugins.

Shipped plugins

The following plugins are shipped with gedit:

• Change case: Changes the case of selected text.

• Check update: Check for latest version of gedit (Win32 and OS X only).

• Document Statistics: Analyses the current document and reports the number of words, lines, characters and non-space characters in it.

• External tools: Execute external commands and shell scripts. (More)

• File Browser: A file browser plugin allowing to easily access your file system (includes remote mounts, creating new files/directories, monitor directories for changes, etc.). (More)

• Insert Date/Time: Inserts current date and time at the cursor position.

• Modelines: Emacs, Kate and Vim-style modelines support for gedit.

• Python console: Interactive Python console standing in the bottom panel.

• Quick open: Quickly open files.

• Snippets: Insert often used pieces of text in a fast way. (More)

• Sort: Sorts a document or selected text.

• Spell: Checks the spelling of the current document.

Plugins in gedit-plugins package

See also the plugins provided by the gedit-plugins package.

Third party plugins

Plugins developed by third parties. To install one of these, you need to download the files and put them in your ~/.local/share/gedit/plugins/ directory (which may need to be created). They need to be in that exact directory; subdirectories are not scanned for plugins.

• Advanced Find / Replace

  • Advanced find / replace functions for gedit. Find / replace in documents. Download: http://code.google.com/p/advanced-find/

• Clientside

  • Perform lint, minify, and formatting on CSS and Javascript. Download: https://github.com/trentrichardson/Gedit-Clientside-Plugin

• Control Your Tabs

  • Switch between tabs using Ctrl+Tab / Ctrl+Shift+Tab (most recently used order) and Ctrl+PageUp / Ctrl+PageDown (tabbar order). Download: https://github.com/jefferyto/gedit-control-your-tabs

• Django Project

  • Adds GUI interfaces for django-admin.py and manage.py commands within gedit and simplifies working with Django projects. Download: https://github.com/Quixotix/gedit-django-project

• Duplicate Line

  • A remake of the Advanced Editing plugin from gedit 2, with only duplicate line and delete to end of line capabilities. Files: duplicate_line.plugin and duplicate_line.py

• Favorites

  • A plugin for gedit 3 that allows you to save and organize your favorite documents for quick access. Download: https://github.com/Quixotix/gedit-favorites

• FocusAutoSave

  • Save all documents when the window loses focus. Download: https://github.com/kassoulet/gedit-focus-autosave

• Gedit Developer Plugins

  • A collection of plugins

  • Screenshots: http://curtis.hovey.name/gallery/Sinzui/gdp-2-26-1/

  • Download: https://launchpad.net/gdp

    • GDP Bazaar Integration: integrates bzr-gtk to show status, tags,

      • annotations, visualize, commit, merge, and push. Open files changed in
      • the branch.

    • GDP Find and Replace: Find and replace in multiple files. Open files and

      • jump to the line from the results pane. Directories and file types can be
      • specified. Regular expressions are supported.

    • GDP Format: Check and format text and code. Format paragraphs, lists, and

      • imports. Reformat test using regular expressions. Check the syntax and
      • style of Python, XML, and plain text. Check and reformat Python
      • doctests.

    • GDP Syntax Completer:

      • Use `<Alt>+/ to activate the completer window

      • to see a list of matching words in the document. Complete Python symbols
      • from imports and those defined in the module.

• gedit-markdown

  • Syntax highlighting, snippets, external tool, color scheme and embedded HTML preview for Markdown. Download: http://www.jpfleury.net/en/software/gedit-markdown.php More: Gedit/MarkdownSupport

• Imitation (sequel to Multi-edit)

  • Edit a document in multiple places simultaneously, with virtual text cursors. Also includes column editing. Designed to aid repetitive programming tasks. Project page: http://codetree.com.au/projects/imitation/

• Indent Lines

  • Indent lines with Ctrl+t. Download: http://yuix.org/web-development/ubuntu-11-10-oneiric-ocelot-gedit-indent-lines-plugin/184

• Line Ending Style

  • Quickly see what the line ending style is and change it if needed. Download: https://github.com/dtrebbien/gedit-line-ending-style-plugin

• Line Spacing

  • Adjust Line Spacing. Download: https://github.com/rcvalle/gedit-3-linespacing

• Msgid Diff

  • This plugin is useful when editing po files and when one wants to compare old and new msgids, when old msgids are kept in the file with --previous option of msgmerge. It launches Meld (must be installed) to show the diff. Download: https://gitorious.org/msgiddiff/

• Open URI Context Menu

  • Adds context menu item to open/browse an URI at the pointer position. Download: http://www.jpfleury.net/en/software/open-uri-context-menu.php

• Pair character autocompletion

  • Automatically insert brackets, quotes, and parenthesis. Download: http://code.google.com/p/gedit-pair-char-autocomplete/

• Pylint 2

  • Analyze Python source code with Pylint. Project Page: https://launchpad.net/gedit-pylint-2. The project is part of Gedit BC Developer Plugins. The plugin is a fork of Pylint plugin.

• Python Profiler

  • Profiling Python programs from within gedit. The statistics is displayed in the bottom panel. It is also possible to profile the gedit plugins. Project page: https://launchpad.net/gedit-pyprofiler. The project is part of Gedit BC Developer Plugins.

• Python Tracebacks

  • Simple navigation to the source of Python exceptions. Project page: https://launchpad.net/gedit-python-traceback. The project is part of Gedit BC Developer Plugins.

• Reflow plugin

  • Allow to reformat paragraphs, just like emacs <alt>-q. Project page: https://github.com/guillaumechereau/gedit-reflow-plugin.

• Regular Expression Plugin

  • For search and replace in documents using regular expressions. This is a straight port of the original gedit 2 plugin. Info: http://halfhourhacks.blogspot.com/2008/03/gedit-regular-expression-plugin.html Download: regex_replace-gedit3.tar.gz

• Restore Tabs

  • Upon starting gedit, this plugin will try restore all open documents from the last gedit window that was closed. Download: https://github.com/Quixotix/gedit-restore-tabs

• Smart Highlighting

  • Highlight occurrences of current selected text. More: http://code.google.com/p/smart-highlighting-gedit/

• Source Code Browser

  • A source code class and function browser based on Exuberant Ctags. Download: https://github.com/Quixotix/gedit-source-code-browser

• Tabs extend

  • Extend tabs for include some features, e.g., Close others tabs, Undo Close tab, Middle mouse button close tab. More: http://code.google.com/p/gedit-tabsextend/ Download: http://code.google.com/p/gedit-tabsextend/downloads/list Source: http://github.com/nuxlli/gedit-tasextend/

• TextMate style autocompletion

  • Autocompletes the current word using other words in the same document. Tapping Escape cycles through the available completions. Download: http://code.google.com/p/gedit-tm-autocomplete/

• Text Wrap

  • A remake of the Text Wrap plugin from gedit 2. I changed the name to toggletextwrap because it seems textwrap is already in the name space somehow. Files: toggletextwrap.plugin and toggletextwrap.py

• Trailsave

  • Strip trailing whitespace on save. Download: https://github.com/jonleighton/gedit-trailsave

• White Space

  • Show Whitespace Characters. This plugin uses the Pango with Cairo to draw characters using the font description of the first iterator of the buffer (i.e. the same Font set in gedit Preferences). The plugin currently has the following non-exclusive options: Show Spaces; Show Leading Spaces; Show Trailing Spaces; Show Internal Spaces; Show Tab Characters; Show Newline Characters. This allows for great flexibility in settings compared to the original DrawSpaces plugin (currently part of GtkSourceView), such as showing only trailing spaces (Show Spaces + Show Trailing Spaces) or showing only internal tab characters (Show Internal Spaces + Show Tab Characters). Download: https://github.com/rcvalle/gedit-3-whitespace

Third party plugins under development

Below follows a list of third party plugins that still need some development:

• Bazaar Panel

  • This Bazaar plugin provides diffs, revision history and more in the bottom panel. Project page: https://launchpad.net/gedit-bzr-panel The gedit 3 version is available from the Bazaar branch: https://code.launchpad.net/~barcc/gedit-bzr-panel/trunk. The project is part of Gedit BC Developer Plugins.

• Gedit File Search

  • Search for a string in all files in a directory and its subdirectories. Project Page: http://oliver.github.com/gedit-file-search/. A gedit 3 version is available on a separate branch: see https://github.com/oliver/gedit-file-search/issues/13 and https://github.com/adam-yorba/gedit-file-search/tree/gedit-3

• LaTeX plugin

  • A plugin to assist you in composing and compiling LaTeX documents and managing BibTeX bibliographies. Assigned to: MichaelZeising More: Gedit/LaTeXPlugin

• Project manager

  • Searches for directories that seams to be projects and show them in the side panel. Open file and show folder in the context menu. This plugin is in an early development state. Project page: https://launchpad.net/gedit-projects. The project is part of Gedit BC Developer Plugins.

• WebKit panel

  • Add Webkit in a panel to easily display the html file being edited. A mini python server can be run to display your dynamic pages. Html5, Css3 supported. The native webkit debugging tool (like firebug) is also present. Download: http://code.google.com/p/gedit-webkit-panel-plugin/

Requested plugins

Useful plugins that have not yet been written:

• Auto-indent wrapped line (smart line wrapping)

  • Automatically indent any line longer than the screen width in such a way that a wrapped line would be at the same level (have the same indentation) as the first row. Bug report: gnomebug:559132

• Automatic code-completion

  • Automatic complete symbols, in particular for C (or automatic ctags generation?).

• Background that helps navigating the code

  • A plugin could paint the background for each function in different colour and put the function name in a subtle way. Something like http://bugs.kde.org/attachment.cgi?id=13723 (this would be a very nifty feature).

• Bird's-eye view

  • A small code overview like http://1dan.org/gedit-plugins/textmap/

• Code autoformat

  • Automatically apply a chosen coding style while typing. A plugin that lets the user select a coding style (or even pull it from the mode line if possible). While typing the style is applied automatically, e.g., with gtk's style if (foo) { would automatically put the { in the next line and indent appropriately. Not to be confused with templates (e.g., as in Eclipse), no characters should be inserted automatically. What to autoformat:

  • do, for, if, while

  • argument lists
  • space between function name and left parenthesis

  • add more here...

  • Bug report: gnomebug:107044

• Common refactorings

  • Add some common refactoring for programmers: extract method, pull method, replace with constant, etc.

• Diff

  • It could be handy to use gedit to compare different versions of a file, or similar files. Comment: RoryMcCann meld is a Gnome diff GUI. Rather than reimplementing meld in gedit, closer gedit/meld intergration would be better.

• Filling-text in current paragraph

  • Add a "Fill-text in current paragraph" command like the Meta-Q command in GNU Emacs. Bug report: gnomebug:149081

• Git integration

  • A Git plugin with basic SCM commands. Download for gedit 2: Portuguese plugin

• Grammar checking

  • Provide integration with LanguageTool for grammar checking like this Thunderbird addon does. See also this.

• Insert file

  • Insert a file in the active document at the cursor position. Bug report: gnomebug:154621

• MatchIt

  • A plugin like the MatchIt plugin for vim. Example: highligth start and end XML tag.

• Pair character autocompletion

  • Implement some of Scribes' source-code-oriented features. Examples: pressing ( inserts a ) after the cursor; selecting text and pressing ' inserts the character after and before the selected text (rather than replacing it). Bug report: gnomebug:654218 Download: http://code.google.com/p/gedit-pair-char-autocomplete/

• Perl debugger integration

  • Add debugging capabilities (including space to store environment variables) to make gedit a lightweight IDE.

• Plugin Selector

  • A plugin to determine whether other plugins should be activated or not. For example, with filenames *.tex you could enable the LaTeX plugin, but for other file types you don't need the plugin.

• Python debugger integration

  • Add Python debugging capabilities to make gedit a nice Python IDE.

• Python Unit testing support

  • Integrate Python's default unit testing framework pyunit.

• Quick Switch Editor

  • Easily switch between opened tabs with CTRL+E as in Eclipse.

• Reload current page

  • A plugin that detects if the document has been altered by a third party program, and offers to reload it.

• SDI

  • A proper SDI interface, where each document gets its own window. The plugin should also hide the tab, as it will just be wasting vertical real estate and confuse users. Bug report: gnomebug:105196 Assigned to: JesseVanDenKieboom: I've implemented this as part of the core since implementing it through a plugin would require a lot of workarounds and dirty hacks. You can find my work in the sdi_mdi cvs/svn branch.

• Shell script plugin

  • Provide a monitored scripts folder (just like nautilus), redirecting stdout to the gedit document. Bug report: gnomebug:313834 Download for gedit 2: http://jannone.org/shellscript/

• Split pane

  • Add multiple views of the current document, editable simultaneously (and kept synchronized).

• Track Changes

  • Track any changes to current documents. See Notepad++ 5.4.2.

• Visual markup

  • When I'm working I want to mark something I wrote as being suspicious, so I want a way to make it visually stand out from the rest. For instance, a red background color. If I just want to visually separate one paragraph from the seemingly endless black and white, i might want to give it a yellow background color. This doesn't need to affect printing, it would just help the writing, and in a similar way as syntax coloring does.

  • Also wouldn't it be super cool if I could select a block of code and sort-of hide it? So that it doesn't distract me from what I'm working on.

• Wiki

  • A plugin that allows editing in wiki style. More: Gedit/WikiPlugin

• XML helper

  • Makes editing of XML files faster. Bug report: gnomebug:163014 More: Gedit/XMLHelperPlugin

Howto install plugins

Copy files to .local/share/gedit/plugins/ or /usr/lib/gedit/plugins/, if you want a system wide install.

Howto write plugins

Plugins can be written in both C and Python. The recommended language is Python, because it's very easy to write plugins in very little code Compared to C. Although Python is the best choice most of the time, when a plugin depends on a C library it must be written in C.

• C plugin howto

• Python plugin howto

• Writing Plugins for gedit 3 with Python