QUICKSTART

Java - must be installed.  If it is not, obtain it from
http://java.sun.com/j2se/1.4.1/download.html


LINUX (Windows users skip this)

Be sure to have sword libraries and headers installed.
Installation of Sword modules is not required for ModEdit, they are
included in this standalone package.

Then run make in this directory to build the native agent
	(if you have trouble, look in Makefile for anything obvious)

ICU - Is optional, but the default install procedure requires it.
Obtain ICU source from http://oss.software.ibm.com/icu/.  ModEdit can be
installed without ICU (see custom installation below).

Launch ModEdit with the following command:

java -jar ModEdit.jar


WINDOWS (Linux users skip this)

Be sure modedit.exe and swicu20.dll are in this directory.  If not, they may be obtained from:

http://www.crosswire.org/~scribe/modedit.exe
http://www.crosswire.org/~scribe/swicu20.dll


GENERAL

Look in ModEdit.properties (on windows use WordPad) to see if you might
want to change anything.
For example, you may wish to set localKJV=false.  This will allow you
to have everything else local except the actual KJV text, which will be
read/written to the remote server.  This has the advantage of fast responses
while navigating tabs, while still immediately sync'ing your changes to a
verse to the remote server-- no export.zip files need to be emailed.

After working on a section of Scripture, please BE SURE YOUR CURRENT RANGE
is set to what you're responsible for (or better, only what new range you're
submitting).  Then press the Export button (only available if localKJV=true)
Then email the export.zip file that was generated to kjv2003@crosswire.org

Please be sure to only submit what YOU'VE worked on.  You don't want your
submission to overwrite anyone elses hard work.

For example.  If you are responsible for the entire book of Luke, you may
have your range set to 'luke' and export.  This creates an export.zip file
containing the entire book of Luke from your local work.  If you've only
completed Luke, chapters 1 and 2, then you may also set your range to
'luke 1-2', which will cause only these chapters to be exported.  The range
works the same as in sword, so you can be fairly creative on your range
expressions.  Submit exports as often as you'd like.  We'd like to stay on
top of everyone's progress.  A final submission of your entire responsible
range can also be submitted, but we'd still like occational submissions
along the way, just to be sure we're going to make our deadline.


	Thank you and may God guide you as you commit your time to Him.

_______________________________________________________________

More details....


---------------------------------
Custom Installation
---------------------------------
To build ModEdit without ICU support, edit the Makefile to remove
-licui18n -licuuc -lustdio

The make file will now read

modedit: modedit.cpp
	g++ -g -I/usr/include/sword modedit.cpp -o modedit -lsword  -lz
clean:
	rm modedit

---------------------------------
Setup of Local Features
---------------------------------
The file ModEdit.properties is used to set the up your sessions.
Items starting with local - if true this item will run from a local file.
                          - if false this item will run from the crosswire
                            server.  Response time may be slower.
currentRange              - Your assigned range
lastVerse                 - The last verse in your assigned range

proxyHost                 - If you are behind a proxy you may set 
proxyPort                   these values appropriately for your proxy.

userID                    - Assigned by scribe@crosswire.org can be entered
                            in the userID field in the GUI

The most useful thing to set here if you are going to be connected to the 
internet while using ModEdit is local KJV=false.  This will allow you
to have everything else local except the actual KJV text, which will be
read/written to the remote server.  This has the advantage of fast responses
while navigating tabs, while still immediately sync'ing your changes to a
verse to the remote server-- no export.zip files need to be emailed.

-----------------------------------
How to submit your work
-----------------------------------
You can have ModEdit submit your work automatically if you will be connected 
to the internet while editing (see setup of local features).

ModEdit will also work off line.

After working on a section of Scripture, please BE SURE YOUR CURRENT RANGE 
is set to what you're responsible for (or better, only what new range you're 
submitting).  Then press the Export button (only available if localKJV=true)  
Then email the export.zip file that was generated to kjv2003@crosswire.org

Please be sure to only submit what YOU'VE worked on.  You don't want your 
submission to overwrite anyone else's hard work.

For example.  If you are responsible for the entire book of Luke, you may
have your range set to 'Luke' and export.  This create an export.zip file
containing the entire book of Luke from your local work.  If you've only
completed Luke, chapters 1 and 2, then you may also set your range to
'Luke 1-2', which will cause only these chapters to be exported.  The range
works the same as in sword, so you can be fairly creative on your range
expressions.  Submit exports as often as you'd like.  We'd like to stay on
top of everyone's progress.  A final submission of your entire responsible
range can also be submitted, but we'd still like occasional submissions
along the way, just to be sure we're going to make our deadline.

-------------------------------------
ModEdit Usage
-------------------------------------
ModEdit is used to place tags in a text linking it to a second text and a 
lexicon.  These documents will be preloaded by the scribe.

To do anything to a tag put the pointer on it and click the left mouse button.
The tags can be dragged as a pair only.
Movement of either a pair or as a single tag is by arrow keys.
Red tags indicate tag not reviewed.
Yellow tag indicates tag being worked on.
Green tag indicates tag is OK an anchored.  
One tag of a pair must be anchored before the second tag of a pair can be moved.
Anchor a tag with the space bar.

ModEdit can guess at tag location, but a Human must check the guesses.  

Sign and Save button saves your work locally and if connected to the internet 
remotely to the crosswire server.


	Thank you and may God guide you as you commit your time to Him.


