EditorScheme Plugin

Ollie Rutherfurd


Table of Contents

Summary

EditorScheme lets one easily switch between predefined color & style combinations for jEdit's TextArea and a number of jEdit's Plugins.

EditorScheme support setting colors & styles for the following plugins:

  • Console Plugin

  • ErrorList Plugin

  • JDiff Plugin

  • TaskList Plugin

  • WhiteSpace Plugin

EditorScheme also supports coloring the messages in the jEdit Activity Log, which plugin developers will find handy.

Usage

EditorScheme lets you can create new schemes, switch between existing schemes, and update existing schemes.

Creating Schemes

The old way, still works: To create a new scheme, select Plugins -> Editor Scheme Selector. Press New to create a scheme based on the current settings. The scheme file will be saved in the schemes directory in your jEdit settings directory. Edit by hand. You can open the your schemes easily from within jEdit by going to the menu Utilities -> Settings Directory -> schemes.

The new way: Use the Editor Scheme Editor dockable. To create a new scheme, select an existing scheme, then press the New button. Give your new scheme a name in the dialog that appears. Use the various tabs to adjust the colors. Press the Save button when done.

Switching Schemes

To switch schemes, select Plugins -> Editor Scheme Selector. On the left, is a a list of available schemes, and on the right you can select which sets of properties to set when applying a scheme. Select the scheme in the list box to apply it.

Alternatively, use the scheme selector dropdown in the Editor Scheme Editor dockable window.

To revert to the settings you had when you first opened the dialog, select (Initial Settings).

Updating Schemes

To update a scheme, select Plugins -> Editor Scheme Selector. On the left is a list of available schemes, and on the right you can select which sets of properties to update. Schemes with a lock icon (READ_ONLY) are read-only and cannot be updated. All the schemes provided with EditorScheme are read-only. Schemes with a diamond icon (NORMAL) can be updated. Choose the scheme you wish to update and select Update.

Alternatively, you can use the Editor Scheme Editor to make adjustments to existing schemes. You can only change normal schemes, not the read-only schemes. If you'd like to adjust a read-only scheme, just make a new scheme based on that read-only scheme, then adjust your new scheme.

(Initial Settings) are the settings from when you opened the Editor Scheme Selector dialog, and will not change as you switch between schemes in the dialog.

Submitting Schemes

To submit schemes for inclusion with EditorScheme, please send them to the jEdit users mailing list or add them to the "Plugin Patches" bug tracker https://sourceforge.net/tracker/?group_id=588&atid=997937 . It would be really nice to have schemes from different jEdit users.

The schemes that you've created are in a "schemes" directory within the jEdit settings directory.

Requirements

EditorScheme requires:

  • JDK 1.5

  • jEdit 4.5

License

The source code is distributed under the GPL. Please see http://www.fsf.org/copyleft/gpl.html.

Feedback

The preferred way to send bug reports or feature requests is to use the Sourceforge Bug Tracker at https://sourceforge.net/tracker/?group_id=588&atid=565475.

You may also e-mail:

Change log

  • Version 1.7, Matthieu Casanova. Requires jEdit 4.5, Java 1.5

    • Added Monokai scheme

  • Version 1.6, danson. Requires jEdit 4.5, Java 1.5

    • Added Solarized-light color scheme from Bernat. See http://ethanschoonover.com/solarized for more details.

  • Version 1.5, danson. Requires jEdit 4.5, Java 1.5

    • Alan Ezust updated the docbook xsd to bring this document up to date.

    • Matthieu Casanova added the Solarized color scheme. See http://ethanschoonover.com/solarized for more details.

    • Fixed an issue with handling of the initial scheme so it works better now.

    • Made the dialog for choosing the scheme modal so it can be used by the Look and Feel plugin, which makes it a little easier to pick the colors to go with the selected look and feel.

  • Version 1.4, danson. Requires jEdit 4.3.2, Java 1.5

    • Added the scheme editor dockable so that it is easier to adjust schemes (tracker 3096955).

    • Added support for the selection area background color (tracker 3043127).

  • Version 1.3, danson. Requires jEdit 4.3.2, Java 1.5

    • Added properties to be able to set colors for Activity log. Currently only Zenburn scheme uses these.

    • Cleaned up all deprecation warnings.

    • Code clean up based on PMD recommendations.

  • Version 1.2, Requires jEdit 4.3pre15, Java 1.5

    • Added console.caretColor property to scheme, kpouer

    • Updated for jEdit 4.3pre15, danson

    • Updated docs, danson

    • Updates to Zenburn theme for JDiff highlight colors, danson

  • Version 1.1, Requires jEdit 4.2pre2

    • Added danson and zenburn schemes, submitted by Dale Anson.

  • Version 1.0, Requires jEdit 4.2pre2

    • Added DarkBrine scheme, submitted by Matt Gilbert.

  • Version 0.5, Requires jEdit 4.2pre2

    • Updated for jEdit 4.2pre2 deferred loading API.

    • Added support for new token types introduced in 4.2pre1: COMMENT3, COMMENT4, LITERAL3, LITERAL4, and KEYWORD4.

    • Added view.status.background, view.status.foreground, view.status.memory.foreground, view.status.memory.background.

    • EditorScheme Selector to be a menu item, instead of a sub-menu of Editor Scheme.

    • Added jEdit 4.2 & BradMace schemes.

    • Removed Gray, jEdit 3.2, High Constrast, & Light Blue schemes.

    • xml.tag-highlight-color -> view.structureHighlightColor.

    • view.bracketHighlightColor -> view.structureHighlightColor.

  • Version 0.4.2, Requires jEdit 3.2

    • Added support for foldLine property and updated existing schemes.

    • Fixed bug that prevented one from creating new schemes until the EditorScheme Selector dialog has been displayed at least once.

    • Added "ColdFusion", submitted by Joshua Miller.

    • Added "Erich's Scheme", a scheme submitted by Erich Schifferl.

    • Added "IDEA", submitted by Marius Scurtescu.

    • Added "Active" & "Bright", 2 schemes I created.

  • Version 0.4.1, Requires jEdit 3.2

    • Removed New Scheme action. Creating schemes can now be done in the EditorScheme Selector dialog.

    • Modified Update behavior in EditorScheme Selector, to use the current settings instead of (Initial Settings).

    • EditorScheme Selector dialog bugfixes.

  • Version 0.4

    • Code moved to editorscheme package.

    • Switched to ant & docbook/xsl.

    • Properties can be applied in sets.

    • New schemes added.

  • Version 0.3.1

    • Updated to use actions.xml.

    • Added a couple schemes.

  • Version 0.3

    • Fixed jdk1.1 compatability bug.

    • Added more properties (Console, Error-List, jDiff, White-Space).

    • Added a couple schemes, added props to a couple.

  • Version 0.2

    • removed Java 2 specific methods.

    • provided schemes loaded from jar.

    • Schemes can be updated from current properties.

    • minor UI tweaks (read-only vs 'normal' schemes).

    • couple schemes added.

  • Version 0.1

    • Initial release.