The SIPB jEdit Locker - Maintainers

Purpose

The default jEdit settings on Athena were choosen to improve the functionality of jEdit on Athena. Default settings are automatically applied when jEdit starts up.

This document describes the various places that store jEdit configuration information, and how that information is applied to jEdit.

Startup Sequence

When jEdit starts up, the following steps occur:

  1. The /mit/jedit/arch/java/versions/${version}/jars/ directory is read. All plugins in this directory (*.jar) are loaded. All plugins loaded are listed in the Plugins menu.
  2. The /mit/jedit/arch/java/versions/${version}/macros/ directory is read. All macros in this directory (*.bsh) are listed under the Macros menu.
  3. The /mit/jedit/arch/java/versions/${version}/modes/catalog file is read. All edit modes specified by this file (.xml) are made availible for syntax highlighting.
  4. The /mit/jedit/arch/java/versions/${version}/properties/ directory is read. All properties files (*.props) are loaded, and the configuration settings within are applied to jEdit. Some of the files in this directory are actually symlinks to system-wide properties files stored in /mit/jedit/arch/share/config/properties/.
  5. The /mit/jedit/arch/java/versions/${version}/startup/ directory is read. All beanshell scripts in this directory (*.bsh) are parsed, and any configuration settings made by the scripts are applied. Some of the files in this directory are actually symlinks to system-wide startup scripts stored in /mit/jedit/arch/share/config/startup/.

System-Wide Settings

System wide settings are stored under the /mit/jedit/arch/share/config/ directory. The subdirectories of this directory contain the different types of configuration information.

Properties Files

System-wide properties files are stored in the /mit/jedit/arch/share/config/properties/ directory. Current properties files include:

Logic.props
Specifies jEdit's font and color settings, including the colors used in Syntax Highlighting.
jedit.props
Specifies the default configuration for jEdit, including UI and Buffer settings.
plugins.props
Specifies jEdit's font and color settings, including the colors used in Syntax Highlighting.

Startup Scripts

System-wide startup scripts are stored in the /mit/jedit/arch/share/config/startup/ directory. Currently there are no system wide startup scripts.

Tools

For jEdit to pickup the configuration information, the various subdirectories mentioned in the Startup Sequence section must contain the appropriate symlinks to the system wide configuration information.

setcfg.sh
This tool should be run whenever a new jEdit binary is added to the locker. This tool creates the symlinks pointing to the system-wide properties files. For this to work, the jEdit binary directories must be in the java .build directory, and the directory names must begin with jedit.

Copyright © 2006 Charles Dominguez.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.

Last revised: $Date: 2006-04-21 22:11:06 -0400 (Fri, 21 Apr 2006) $
Version: $Revision: 1 $