Scribe version 1.3 Readme.txt

Preface
-------
Thank you for downloading Scribe. This program is written entirely in Java using the SDK 1.4.2 JVM. It has been tested on Windows 2000/XP, Mac OS X, and Linux Red Hat 9.0.
The program is open source, under the GNU General Public License. The initial goal of this program was mainly so I could learn more about building Java GUIs,
but Scribe is serviceable as a mix of the Windows programs Notepad/Wordpad. I wrote the program for myself and only recently released it,
so keep this in mind if something seems non-standard.
Email any suggestions, ideas, bugs, etc. to magic_jar@hotmail.com.
Visit http://www.angelfire.com/linux/magic-jar/index.html for the latest version.

Future Possibilities
--------------------

I doubt there will be a "final" version of Scribe, since there always seems to be something to add. Below are some ideas for future expansion of the Scribe program.
Printing: Currently the Hard Copy option is disabled, but eventually it would be added to allow the current document to print to the default local printer.
Right-Click Menu: When the user right-clicks on the main text area, a menu containing common functions would be displayed.
Tabbed Documents: Multiple documents could be open, each with a separate tab for ease of switching. New functionality (such as Close Tab) would need to be implemented.
Format Supported: Word processing support for common formats (.rtf and .html) so they display more than pure text.
Autosaving: If the current document has been saved previously, then it could autosave every X number of seconds.
Recent Documents: Maintain an X long list of recently opened documents for quick access.
Streamline: Cleans all empty whitespace to the right of the text, perhaps an automatic option as well.

Usage
-----

>The user needs to have a Java Virtual Machine (JVM) installed. Without a properly configured JVM, the user will get various error messages upon running Scribe.
>Scribe can be run by double-clicking on the .jar file or by accessing it from the command line. Type java -jar Scribe.jar from the command line to activate it in a similar method to
double-clicking. The .jar file can also be extracted (recommended) to allow for easy editing of source code or access to the overlay used. Some computers will support right-clicking and
choosing "Extract Here", while others will require the command line. Type jar -xf Scribe.jar from the command line to extract all the files within the .jar. The .jar file contains the
files listed below:
        *.java (Scribe, Run, Overlay)
        *.class (Scribe, Run, Overlay)
        Changelog.txt
        License.txt
        Readme.txt
        Icon.gif
>Upon closing the program, the pure text file User.cfg will be updated with any user changes. It will be loaded upon initializing Scribe, so any changes the user makes
(such as Style or Canvas attributes) will reload everytime.

Changing the Overlay
--------------------

To change the overlay the user simply replaces the Overlay.class file with their desired scheme. At the next startup of Scribe the colors within Overlay.class will be used.
The default scheme is titled Parchment, and is a basic brown scheme. If the Overlay.class has been written according to the standards of the default Parchment overlay,
then the user can select Detail -> Overlay to see the name, author, and description.

General Features
----------------

The main document area has fairly similar functionality to that of a normal text area. There are a few minor differences based on the system used, but nothing to cause irritation.
All the usual Edit commands are utilized by hotkey only instead of by menu. This means the standard shortcut of Ctrl+C will still copy the selected text, Ctrl+A will still select
all the text, etc. Some specific functions follow.
Drag and Drop Text: Selected text can be dragged and dropped at any previously used location within a document.
Hotkeys: All common functions have a hotkey combination tied to them for quick usage.
Status Bar: The status bar at the bottom of the window will maintain a record of the last user action.
Command Button: Located on the far left of the status bar, this small unmarked button will attempt to execute the current text in the status field.
Line Numbering: To the far right on the status bar is a field containing the current line the cursor is on.

Specific Menu Functions
-----------------------

System
|-Create: Close the current document (without saving) and create a new document called Unsaved Document.
|-Save: Save the current document. If this is the first time a save occurred, the user will be prompted for a filename and location.
|-Save As: Resave the current document under a different filename and location.
|-Load: Creates a file chooser dialog so the user can choose a file to load. No file filter is used.
|-Hard Copy: This feature is currently disabled. In the future it will print the document to the default printer.
|-Quit: Leave the program after a confirmation prompt. The current document is not saved on exit.

Function
|-Search: Look for a case sensitive user search key. The search begins at the current cursor position and goes downwards. If the word is found, the Replace button can be pressed,
which prompts the user for a word to replace the currently selected one. If the word is not found, the search does not restart from the top of the current document.
|-Clear All: Deletes all text in the current document without a prompt, but maintains the filename and location.
|-Goto Line: Move to the start of a specific line within the bounds of the document.
|-Remove Line: Remove the entire line the cursor is currently at, and move the cursor to the start of the empty line.

Preferences
|-Style: Change the font face, size, and type. The list of fonts available is generated based on those available on the current computer. The font size must be within the range of 0-1000,
and only digits can be entered.
|-Canvas: Change the color attributes. The background, text, highlight, selected, and cursor colors can be changed. Any changes are superficial and do not affect the current document in
any way (ie. the colors you choose won't show up on other computers). Pressing the appropriately named button for a color attribute will create the system default color chooser dialog.
|-Directory: Change the default directory for file choosers (Save, Save As, Load) to initially open in.
|-Word Wrap: Turn word wrap on or off. The word wrap style used is full word.
|-Autoclean: Turn auto garbage collection on or off. If activated, the garbage collector will run whenever the JVM is at half memory or below. The program may run slightly slower overall
but will consume less memory.

Report
|-Count: Display the count of all characters (including spaces and special characters) and words in the current document.
|-Time Lapse: Display the time lapse since the program initialized and the current document was opened.
|-Virtual Machine: Display the Java Virtual Machine memory usage information, and allow the user to run the garbage collector.

Detail
|-Help: Create a dialog displaying this file (Readme.txt).
|-About: Author information, version compile date information, license used, and dedication.
|-Overlay: Information about the current overlay used, including name, description, and author.
|-License: Create a dialog displaying the file License.txt, which contains the details of the GNU General Public License.
