jEdit 2.6 User's Guide

Slava Pestov

Legal Notice

jEdit is released under the GNU General Public License. A copy of the GPL is available in the COPYING.txt file supplied with jEdit.


Table of Contents
1. General Information
2. Conventions Used in This Manual
Menu Items
Keyboard Shortcuts
3. Basic Features
Starting jEdit
Opening Files
Creating New Files
The Caret
Selecting Text
Entering and Deleting Text
Undo and Redo
The Clipboard
Saving Files
Autosave and Backups
Line Separator Characters
When Another Application Modifies the File
Printing Files
Working With Views
The Gutter
Closing Files and Exiting jEdit
4. Advanced Features
Editor Sessions
Working With Words
Working With Lines
Working With Paragraphs
Markers
Registers
Text Registers
Position Registers
File Name Registers
Abbreviations
Macros
Macro Files
Recording Macros
Temporary Macros
Prompting for Input
Macro File Syntax
Some Sample Macros
The jEdit Command Line
5. Edit Modes
Mode Selection
Syntax Highlighting
Installing New Edit Modes
Writing Edit Modes
An XML Primer
The Preamble
The MODE Tag
The PROPS Tag
The RULES Tag
TERMINATE rule
WHITESPACE rule
SPAN rule
EOL_SPAN rule
MARK_PREVIOUS rule
MARK_FOLLOWING rule
SEQ rule
KEYWORDS rule
Token Types
6. Source Code Editing
Bracket Matching
Tabbing and Indentation
Changing the Tab Width
Soft Tabs
Indentation-Related Commands
Automatic Indent
Commenting Out Code
7. Search and Replace
The Search and Replace Dialog Box
The HyperSearch Dialog Box
Searching in Multiple Files
Quick Search
8. Virtual File Systems
The VFS Browser
The FTP Filesystem
The URL Filesystem
Multithreaded I/O
9. Customizing jEdit
The Buffer Options Dialog Box
Buffer-Local Properties
The Global Options Dialog Box
The General Pane
The Editor Pane
The Text Area Pane
The Colors & Styles Pane
The Docking Pane
The Context Menu Pane
The Tool Bar Pane
The Shortcut Editing Panes
The Abbreviations Pane
The Printing Pane
The VFS Browser Pane
The jEdit Settings Directory
10. Installing and Using Plugins
The Plugin Manager
Updating Plugins
Installing Plugins
Using Plugins
11. Developing Plugins
General Structure of a Plugin
The EditPlugin Class
Plugin Properties
Plugin Documentation
Plugin Dependencies
Plugin Actions
The Plugins Menu
The Global Options Dialog Box
Useful UI Methods
Canned Dialog Boxes
Saving Window Geometry
Improved Dialog Box Key Handling
The Activity Log
The EditBus
BufferUpdate Message
EditorExiting Message
EditorStarted Message
EditPaneUpdate Message
MacrosChanged Message
PropertiesChanged Message
RegistersChanged Message
SearchSettingsChanged Message
ViewUpdate Message
Developing Virtual File Systems
Input/Output Basics
Buffer Loading and Saving
The VFSManager Class
The VFS Class
Advanced Topics
A. The Activity Log
B. History Text Fields
C. Command Line Usage
D. The Edit Server
Background Mode
E. Regular Expressions
F. Glob Patterns
Index