===================
EditorScheme Plugin
===================

:Author: Ollie Rutherfurd
:Version: 0.5
:Copyright: Permission is granted to copy, distribute and/or 
			modify this document under the terms of the GNU 
			Free Documentation License, Version 1.1 or any 
			later version published by the Free Software Foundation; 
			with no "Invariant Sections", "Front-Cover Texts" or 
			"Back-Cover Texts", each as defined in the license. 
			A copy of the license can be found in the file 
			COPYING.DOC.txt included with jEdit.

.. $Id: users-guide.txt,v 1.2 2003/11/14 15:34:54 orutherfurd Exp $

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

Usage
=====

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

Creating Schemes
----------------

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.

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.

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`.

.. |READ_ONLY|  image:: icons/readonly.gif
.. |NORMAL|     image:: icons/normal.gif

``(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 Ollie Rutherfurd at <oliver@jedit.org>. It would be really nice 
to have schemes from different jEdit users.

Requirements
============

EditorScheme requires:

* JDK 1.1
* jEdit 4.2pre2

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
http://sourceforge.net/bugs/?group_id=588.

You may also e-mail:

* Ollie Rutherfurd <oliver@jedit.org>;
* or jEdit-users mailing-list <jedit-users@lists.sourceforge.net>;
* or jEdit-devel mailing-list <jedit-devel@lists.sourceforge.net>.

Change log
==========

* 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.

.. :wrap=hard:noTabs=true:lineSeparator=\n:maxLineLen=68:folding=none:
