Standard Tutorial for Setting Up a Database-stored Document Set

This tutorial shows you how to:

  • set up a (free!) Java SDK on your machine,

  • set up a (free!) web server on your machine,

  • set up a database to store your HTML-based documentation,

  • use a Java program I wrote to move your HTML-based documentation into the database, and

  • set up files to extract and display the content in your database.

I would recommend that you choose a small document set that you already have in HTML-based format for this project. If you do not have anything that will work, you can feel free to work with the demo project that I created for this tutorial. If you download the demo project, extract it to a “shallow” directory (you will be typing its path later, more than once), and keep its directory structure.

The following is a list of various files and programs you need to download to go through this tutorial.

File/Program

Size

URL

Java SDK

37MB http://java.sun.com/j2se/1.4/download.html

Tomcat web server

2.4MB http://jakarta.apache.org/builds/jakarta-tomcat/release/v3.2.4/bin/jakarta-tomcat-3.2.4.zip

MS-Access database (optional—you may also create a database with another DBMS; the schema is provided in this tutorial)

77Kb http://jsp.davidcastro.com/winwriters/winwriters.mdb

Java program to load database

6Kb http://jsp.davidcastro.com/winwriters/loader.class

Java program source code (optional)

11Kb http://jsp.davidcastro.com/winwriters/loader.java

Servlet

2Kb http://jsp.davidcastro.com/winwriters/centralServlet.class

Servlet source code (optional)

2Kb http://jsp.davidcastro.com/winwriters/centralServlet.java

web.xml (right-click the link and choose Save Target As or the equivalent for your browser)

1Kb http://jsp.davidcastro.com/winwriters/web.xml

Demo HTML project (optional)

19Kb http://jsp.davidcastro.com/winwriters/demoproject.zip

Note:

While this tutorial uses a Microsoft Access database by default, you do not need to have the Microsoft Access program installed on your machine. The drivers required to use Access come with Windows.

Once you have set up the HTML files that you will be using, and have downloaded the files and programs listed above, you’re ready to move on to setting up the Java SDK on your machine.

Continue