QuickNotepad

John Gellene

jgellene@nyc.rr.com

Revision History
Revision 1.0June 28, 2001

Table of Contents
Introduction
Operation
Toolbar buttons
Options
Legal notices
Feedback

Introduction

This plugin provides a dockable "scratch pad" for writing and displaying notes, to do lists or similar items as unformatted text. The text is automatically saved upon closing the plugin or exiting jEdit. It can also be saved manually. The user can change the file to be displayed during the current editing session. The path of the default notepad file can be changed as a user option. Finally, the text file can be copied to a new, untitled jEdit buffer so that it can be edited by the main program.

The jEdit Plugin Guide details the development and design of QuickNotepad. It is a simple but functional dockable plugin that incorporates the basic elements of the jEdit plugin architecture.

QuickNotepad is designed to operate with JDK 1.2 or greater and jEdit3.1 or greater. The EditBus plugin is also required.


Operation

When QuickNotepad is activated, it loads and displays the file stored in its properties as unformatted text. The text can be edited using the keyboard and mouse. The text area component recognizes the following basic editing shortcuts:

 CutCtrl-x
 CopyCtrl-c
 PasteCtrl-v
 Select AllCtrl-a

QuickNotepad ignores function keys and other combination key presses. They are hamdled by the main application.and are handled by jEdit.


Toolbar buttons

Three buttons above the text area provide file management operations:

These operations are listed in the menu which appears for QuickNotepad under the Plugins heading. They can also be made the subject of keyboard shortcuts in the Plugin Shortcuts pane of jEdit's options dialog.

One other operation is available as a keyboard shortcut. Bring QuickNotepad to front activates the plugin and makes visible if it is currently hidden in a docking window.


Options

There are three options which can be set using the pane for QuickNotepad in the Plugin Shortcuts section of the general options dialog:


Legal notices

The toolbar button icons are taken from the Sun Java Look and Feel icon collection. The license for these items may be found in the ICONS.LICENSE.txt file in the jEdit distribution.

The QuickNotepad plugin is released under the GNU General Public License (either version 2 or any later version, at the user's option). A copy of the GPL is available in the COPYING.txt file in the jEdit distribution.

The QuickNotepad plugin comes with ABSOLUTELY NO WARRANTY OF ANY KIND; see section 11 and 12 of the GPL for details.

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 is included in the file COPYING.DOC.txt included with the jEdit distribution.


Feedback

Comments, bug reports and other feedback may be sent to the author or the jEdit-users mailing list.