jEdit 5.6 User's Guide
   Next

jEdit 5.6 User's Guide

The jEdit all-volunteer developer team

Legal Notice

Permission is granted to copy, distribute and/or modify this GroIMP Manual / 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.

Revision History
Revision 1.0 - 4.31999-2004Slava
Pestov
Initial HTML document
Revision 3.2 - 4.12001-2002John
Gellene
Initial DocBook version. Initial versions of Plugin Guide and Macro Guide.
Revision 4.3 - 5.62005-2020Alan
Ezust
Maintainer.

Table of Contents

1. GroIMP and jEdit
1.1. jEdit toolbar
1.2. Seraching
I. Using jEdit
2. Conventions
3. Starting jEdit
3.1. Command Line Usage
3.1.1. Miscellaneous Options
3.1.2. Configuration Options
3.1.3. Edit Server Options
3.2. Java Virtual Machine Options
4. jEdit Basics
4.1. Interface Overview
4.2. Multiple Views
4.3. Switching Buffers
4.4. Buffer Sets and closing buffers
4.5. Window Docking Layouts
4.6. The Status Bar
4.7. The Action Bar
5. Working With Files
5.1. Creating New Files
5.2. Opening Files
5.3. Saving Files
5.3.1. Two-Stage Save
5.3.2. Autosave and Crash Recovery
5.3.3. Backups
5.4. Line Separators
5.5. Character Encodings
5.5.1. Commonly Used Encodings
5.6. The File System Browser (FSB)
5.6.1. Navigating the File System
5.6.2. The Tool Bar
5.6.3. The Commands Menu
5.6.4. The Plugins Menu
5.6.5. The Favorites Menu
5.6.6. Keyboard Shortcuts
5.7. Reloading From Disk
5.8. Task Monitor, and background I/O tasks
5.9. Printing
5.10. Closing Files and Exiting jEdit
6. Editing Text
6.1. Moving The Caret
6.2. Selecting Text
6.2.1. Range Selection
6.2.2. Rectangular Selection
6.2.3. Multiple Selection
6.3. Keyboard Focus
6.4. Inserting and Deleting Text
6.5. Undo and Redo
6.6. Working With Words
6.6.1. What's a Word?
6.7. Working With Lines
6.8. Working With Paragraphs
6.9. Wrapping Long Lines
6.9.1. Soft Wrap
6.9.2. Hard Wrap
6.10. Scrolling
6.11. Transferring Text
6.11.1. The Clipboard
6.11.2. Quick Copy
6.11.3. General Register Commands
6.12. Markers
6.13. Search and Replace
6.13.1. Searching For Text
6.13.2. Replacing Text
6.13.3. HyperSearch
6.13.4. Multiple File Search
6.13.5. The Search Bar
7. Editing Source Code
7.1. Edit Modes
7.1.1. Mode Selection
7.1.2. Syntax Highlighting
7.2. Tabbing and Indentation
7.2.1. Soft Tabs
7.2.2. Elastic Tabstops
7.2.3. Automatic Indent
7.3. Commenting Out Code
7.4. Bracket Matching
7.5. Abbreviations
7.5.1. Positional Parameters
7.6. Folding
7.6.1. Collapsing and Expanding Folds
7.6.2. Navigating Around With Folds
7.6.3. Miscellaneous Folding Commands
7.6.4. Narrowing
8. Customizing jEdit
8.1. The Buffer Options Dialog Box
8.2. Buffer-Local Properties
8.3. The Global Options Dialog Box
8.3.1. The General Pane
8.3.2. The Abbreviations Pane
8.3.3. The Appearance Pane
8.3.4. The Context Menu Pane
8.3.5. The Docking Pane
8.3.6. The Editing Pane
8.3.7. The Encodings Pane
8.3.8. The Gutter Pane
8.3.9. The Large Files Pane
8.3.10. The Mouse Pane
8.3.11. The Plugin Manager Pane
8.3.12. The Printing Pane
8.3.13. The Proxy Servers Pane
8.3.14. The Saving and Backup Pane
8.3.15. The Shortcuts Pane
8.3.16. The Status Bar Pane
8.3.17. The Syntax Highlighting Pane
8.3.18. The Text Area Pane
8.3.19. The Tool Bar Pane
8.3.20. The View Pane
8.3.21. The File System Browser Panes
8.4. The jEdit Settings Directory
8.4.1. The jEdit properties file
8.4.2. Site Properties
9. Using Macros
9.1. Recording Macros
9.2. Running Macros
9.3. How jEdit Organizes Macros
10. Installing and Using Plugins
10.1. The Plugin Manager
10.2. Installing and Updating Plugins
10.3. Plugin Sets
A. Keyboard Shortcuts
B. The Activity Log
C. History Text Fields
D. Glob Patterns
E. Regular Expressions
F. Macros Included With jEdit
F.1. C/C++ macros
F.2. Clipboard Macros
F.3. Editing Macros
F.4. File Management Macros
F.5. User Interface Macros
F.6. Java Code Macros
F.7. Miscellaneous Macros
F.8. Property Macros
F.9. Text Macros
II. Writing Edit Modes
11. Mode Definition Syntax
11.1. An XML Primer
11.2. The Preamble and MODE tag
11.3. The PROPS Tag
11.4. The RULES Tag
11.4.1. Highlighting Numbers
11.4.2. Rule Ordering Requirements
11.4.3. Per-Ruleset Properties
11.5. The TERMINATE Tag
11.6. The SPAN Tag
11.7. The SPAN_REGEXP Tag
11.8. The EOL_SPAN Tag
11.9. The EOL_SPAN_REGEXP Tag
11.10. The MARK_PREVIOUS Tag
11.11. The MARK_FOLLOWING Tag
11.12. The SEQ Tag
11.13. The SEQ_REGEXP Tag
11.14. The IMPORT Tag
11.15. The KEYWORDS Tag
11.16. Token Types
11.17. The MATCH_TYPE Attribute
12. Installing Edit Modes
13. Updating Edit Modes
13.1. From jEdit 4.2 to 4.4
III. Writing Macros
14. Macro Basics
14.1. Introducing BeanShell
14.2. Single Execution Macros
14.3. The Mandatory First Example
14.4. Predefined Variables in BeanShell
14.5. Helpful Methods in the Macros Class
14.6. BeanShell Dynamic Typing
14.7. Now For Something Useful
15. A Dialog-Based Macro
15.1. Use of the Macro
15.2. Listing of the Macro
15.3. Analysis of the Macro
15.3.1. Import Statements
15.3.2. Create the Dialog
15.3.3. Create the Text Fields
15.3.4. Create the Buttons
15.3.5. Register the Action Listeners
15.3.6. Make the Dialog Visible
15.3.7. The Action Listener
15.3.8. Get the User's Input
15.3.9. Call jEdit Methods to Manipulate Text
15.3.10. The Main Routine
16. Macro Tips and Techniques
16.1. Getting Input for a Macro
16.1.1. Getting a Single Line of Text
16.1.2. Getting Multiple Data Items
16.1.3. Selecting Input From a List
16.1.4. Using a Single Keypress as Input
16.2. Startup Scripts
16.3. Running Scripts from the Command Line
16.4. Advanced BeanShell Techniques
16.4.1. BeanShell's Convenience Syntax
16.4.2. Special BeanShell Keywords
16.4.3. Implementing Classes and Interfaces
16.5. Debugging Macros
16.5.1. Identifying Exceptions
16.5.2. Using the Activity Log as a Tracing Tool
17. BeanShell Commands
17.1. Output Commands
17.2. File Management Commands
17.3. Component Commands
17.4. Resource Management Commands
17.5. Script Execution Commands
17.6. BeanShell Object Management Commands
17.7. Other Commands
IV. Writing Plugins
18. Introducing the Plugin API
19. Implementing a Simple Plugin
19.1. How Plugins are Loaded
19.2. The QuickNotepadPlugin Class
19.3. The Property Files
19.3.1. Localization Files
19.4. The EditBus
19.5. The Actions.xml Catalog
19.6. The dockables.xml Window Catalog
19.7. The services.xml file
19.8. The QuickNotepad Class
19.9. The QuickNotepadToolBar Class
19.10. The QuickNotepadOptionPane Class
19.11. Plugin Documentation
19.12. The build.xml Ant build file
19.13. Reloading the Plugin
19.14. Tips for debugging plugins
20. Plugin Tips and Techniques
20.1. Utility Classes
20.2. Bundling Additional Class Libraries
20.3. Bundling Additional Non-Java Libraries
20.4. Storing plugin data
20.5. Plugin colors
jEdit Frequently Asked Questions
1. Introduction
2. General Questions
3. Installation Questions
4. Usage Questions
5. Macros
6. Plugin Questions
7. Problems
   Next
   Chapter 1. GroIMP and jEdit