[duedates-ulaula commit] r98 - wiki
codesite...@google.com
Date: Mon Dec 8 01:56:32 2008
New Revision: 98
Modified:
wiki/UserGuide.wiki
Log:
Edited wiki page through web user interface.
Modified: wiki/UserGuide.wiki
==============================================================================
--- wiki/UserGuide.wiki (original)
+++ wiki/UserGuide.wiki Mon Dec 8 01:56:32 2008
@@ -1,21 +1,33 @@
#summary User guide for downloading and running DueDates-ulaula jar file.
+#labels Featured
== Introduction ==
-DueDates is a web application that is capable of obtaining information for
users namely borrowing items (books, DVD, VHS, etc.) from the University of
Hawaii Library and Hawaii State Library. To set up all the environment
variables for this application please refer to the
[http://code.google.com/p/duedates-ulaula/wiki/DeveloperGuide Developer
Guide].
+Due Dates is a simple web application capable of obtaining information for
users about their borrowed items (books, DVD, VHS, etc.) from the
University of Hawaii Library and Hawaii State Library. The system is able
the query multiple libraries at once, as well as set up regular updates and
reports via email. Never pay a late fee again!
+As this version of Due Dates 2.0 is not yet on a server, you will need to
run it off your personal computer. Thus your computer needs to have extra
some components installed.
----------------------------------------------------------------------
+----
+==System Requirements==
+(when running the application off your personal computer)
+ * [http://www.java.com/en/ Java 1.5] or greater.
+ * [http://java.sun.com/products/javamail/ JavaMail 1.4.1].
+ * Internet Connection.
+===Download/Installation of Due Dates components===
+ # Download DueDates-ulaula.jar and save it to a local directory such
as 'c:\DueDates\'
+ # Download the JavaMail 1.4.1 libraries from
[http://java.sun.com/products/javamail/]
+ * Copy the mail.jar file to your systems java lib/ext directory:
+ ||*OS* ||*Typical lib/ext location* ||
+ ||Mac ||
/System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home/lib/ext
||
+ ||PC ||C:\Java\jre1.5.0_7\lib\ext ||
+ * If you are using Java 5, you must also install
[http://java.sun.com/products/javabeans/jaf/index.jsp JavaBeans Activation
Framework 1.1]. You will then need to copy activation.jar from the
JavaBeans Activation Framework library into the same lib/ext directory.
+===JAVA===
-== DueDates-ulaula Usage ==
-
-=JAVA=
-
-To be able to download the JAR file you to have a Java Runtime
Environment. So to check if you have a Java installed or to know what
version of Java you have, below are the following steps:
+To be able to run the Due Dates JAR file you to have Java installed on
your machine. To check your computers current version of Java, follow these
steps:
*1.* Click *Start* (located on the bottom left hand side of your Desktop).
@@ -30,6 +42,29 @@
*4.* If Java is not installed, download the JRE from this website:
http://java.sun.com/javase/downloads/index.jsp
+----
+== Setting up your XML file ==
+Since the Due Dates system is not running on a server, there is no central
database of users. So, users need to specify their library credentials
within an xml file located in ~/.duedates called duedates.xml. The file
should look similar to this sample xml file:
+
+{{{
+ <SmtpServer>mail.hawaii.edu</SmtpServer>
+ <Users>
+ <User name="Tyler Wolff" email="wo...@hawaii.edu" password="password">
+ <Library name="University of Hawaii" username="johnson"
password="password" />
+ <Library name="Hawaii State Library" username="3290398383"
password="password" />
+ </User>
+ <User name="Shaoxuan Zhang" email="s...@hawaii.edu" password="password">
+ <Library name="University of Hawaii" username="shaoxuan"
password="password" />
+ </User>
+ </Users>
+</DueDates>
+}}}
+
+In addition, you must specify a schema file for this XML file. For your
convenience, just simply place this
[http://code.google.com/p/duedates-ulaula/files/duedates.xsd duedates.xsd]
in the ~/.duedates directory.
+
+----
+== DueDates-ulaula Usage ==
+
The followings are the steps for installing and running DueDates.
*1.* Download
[http://duedates-purple.googlecode.com/files/DueDates-ulaula.jar
DueDates.jar]
@@ -47,5 +82,8 @@
http://groups.google.com/group/duedates-ulaula-discuss/web/duedates-ulaulajar.png
+----
+
After that it will take you to the Login Page
+
http://groups.google.com/group/duedates-ulaula-discuss/web/due%20Dates2.0.png