[jsword-svn] r1079 - trunk/jsword-web/src/web
dmsmith at crosswire.org
dmsmith at crosswire.org
Sun Apr 9 13:24:50 MST 2006
Author: dmsmith
Date: 2006-04-09 13:24:40 -0700 (Sun, 09 Apr 2006)
New Revision: 1079
Modified:
trunk/jsword-web/src/web/Eclipse.html
trunk/jsword-web/src/web/change.html
trunk/jsword-web/src/web/devt.html
trunk/jsword-web/src/web/index.html
trunk/jsword-web/src/web/maillists.html
trunk/jsword-web/src/web/news.html
trunk/jsword-web/src/web/svn.html
trunk/jsword-web/src/web/writingcode.html
Log:
Updating the website.
Modified: trunk/jsword-web/src/web/Eclipse.html
===================================================================
--- trunk/jsword-web/src/web/Eclipse.html 2006-04-09 16:38:21 UTC (rev 1078)
+++ trunk/jsword-web/src/web/Eclipse.html 2006-04-09 20:24:40 UTC (rev 1079)
@@ -11,7 +11,7 @@
JSword and Bible Desktop are being actively developed in Eclipse.
While this is not an endorsement of Eclipse, you will find project
files for Eclipse that will speed your ability to develop JSword.
- You may use any other mean of developing JSword, but we may not be
+ You may use any other means of developing JSword, but we may not be
able to provide guidance.
</p>
<p>
@@ -32,7 +32,7 @@
<p>
We develop under 1.4.2, but routinely test against 1.5. We will move to 1.5
when it is well supported on all the platforms to which we deploy. Currently
- these are Windows, Mac and Linux.
+ these are Windows, Mac and Linux. At this time MacOS 10.3 does not support Java 1.5.
</p>
<h2>Obtain and install Eclipse 3.1</h2>
@@ -58,54 +58,11 @@
Either rename the <q>eclipse</q> directory, delete it or choose a different Eclipse location.
For example, you might use <code>/usr/java</code> on linux and <code>c:\java</code> on Windows.
It will create the Eclipse installation in that directory. For Windows, just unzip
- it to the c:\java directory. For linux, in the /usr/java directory, run
- <code>gtar zxvf eclipse-SDK-3.1-linux-gtk.tar.gz</code>.
+ it to the c:\java directory. For linux, if possible, use Eclipse that comes with the distribution.
+ For linux distributions that do not provide Eclipse, in the /usr/java directory,
+ run <code>gtar zxvf eclipse-SDK-3.1-linux-gtk.tar.gz</code>.
</p>
-<h2>Launching Eclipse 3.1 under Linux</h2>
-<p>
- If you choose to use Eclipse that comes with Fedora Core 4, you can disregard these
- instructions. That build will install a launcher on one of the menus.
-</p>
-<p>
- Perhaps the best way to run Eclipse from inside the Gnome desktop is to create a
- Launcher for it. This is not an endorsement of the Gnome desktop. I don't have any
- experience with KDE. Perhaps someone can provide instructions on how to do that.
-</p>
-<ol>
- <li>Assuming that you installed Java as instructed above, you can use
- <code>-vm /usr/bin/java.</code> I strongly recommend that you explicitly
- tell Eclipse which Java to run. Please note, you can independently tell
- Eclipse which Java to use to compile code with.</li>
- <li>By default, Java caps memory usage to too low a value. You will need to increase
- it to 512M, with <code>-vmargs -Xmx512M</code></li>
- <li>The icon for the program is <code>/usr/java/eclipse/icon.xpm</code></li>
-</ol>
-You can create a <q>Launcher</q> that will be in a Gnome panel of your choice by:
-<ol>
- <li>Right click on the panel in which you want to create the <q>Launcher</q></li>
- <li>Choose <q>Add to Panel...</q>.
- <a href="images/linux/addpanel.png">[Image]</a></li>
- <li>Choose <q>Custom Application Launcher</q>
- <a href="images/linux/choosecustom.png">[Image]</a></li>
- <li>In the dialog fill in the following values:
- <a href="images/linux/createlauncher.png">[Image]</a>
- <table>
- <tr>
- <td><strong>Name:</strong></td>
- <td>JSword Eclipse</td>
- </tr>
- <tr>
- <td><strong>Command:</strong></td>
- <td>/usr/java/eclipse/eclipse -vm /usr/bin/java -vmargs -Xmx512M</td>
- </tr>
- <tr>
- <td colspan="2">Click on the icon and enter /usr/java/eclipse/icon.xpm</td>
- </tr>
- </table>
- </li>
-</ol>
-
<h2>Setting up the JSword projects in Eclipse</h2>
<h3>Setup an Eclipse Workspace</h3>
@@ -171,7 +128,8 @@
You can read more about these standards <a href="writingcode.html">here</a>.
</p>
<p>
- If you want to know how to setup Eclipse to use the same compiler settings
+ We have saved per project settings for Eclipse 3.1. If you use an earlier version
+ and you want to know how to setup Eclipse to use the same compiler settings
as we do then the following screenshots (from an earlier version of Eclipse)
ought to help:
</p>
@@ -193,24 +151,25 @@
It is about as close as we can get to our formatting standards, but it is
not exact. For this reason, we do not let Eclipse reformat the entire file.
</p>
+
<h3>Working under the Java Perspective</h3>
<p>
Eclipse provides several perspectives under which you can develop code.
My personal rut is the Java Perspective. This can be added in the same manner
- that the CVS Repository Exploring Perspective was added.
+ that the SVN Repository Exploring Perspective was added.
</p>
<h3>Working under the Team Synchronization Perspective</h3>
<p>
This can be added in the same manner that the
- <q>CVS Repository Exploring Perspective</q> was added.
- To initially connect this perspective to the CVS Repository, click on the
+ <q>SVN Repository Exploring Perspective</q> was added.
+ To initially connect this perspective to the SVN Repository, click on the
<q>Synchronize...</q> button. Click on the <q>Next</q> button and then
the <q>Finish</q> button.
</p>
<p>
When you make changes to any of the projects, this perspective will track the changes.
- Also, you can click the same button, now labelled <q>Sychronize CVS (Workspace)</q>
+ Also, you can click the same button, now labelled <q>Sychronize SVN (Workspace)</q>
to get the latest changes from the repository.
</p>
<p>
Modified: trunk/jsword-web/src/web/change.html
===================================================================
--- trunk/jsword-web/src/web/change.html 2006-04-09 16:38:21 UTC (rev 1078)
+++ trunk/jsword-web/src/web/change.html 2006-04-09 20:24:40 UTC (rev 1079)
@@ -87,7 +87,7 @@
</li>
<li><strong>Version 0.98</strong> - THE THIRD BETA - Splitting Bible Desktop
- from the J-Sword Core, and creating projects like jsword-web, common and
+ from the JSword Core, and creating projects like jsword-web, common and
bibledesktop-web in support. Removal of JAXB for JDOM and lots of work
trimming things down to size and simplifying.</li>
Modified: trunk/jsword-web/src/web/devt.html
===================================================================
--- trunk/jsword-web/src/web/devt.html 2006-04-09 16:38:21 UTC (rev 1078)
+++ trunk/jsword-web/src/web/devt.html 2006-04-09 20:24:40 UTC (rev 1079)
@@ -7,12 +7,45 @@
</head>
<body>
+<h1>Getting Involved</h1>
+<p>
+ We can use your help, whether it is programming, web development, documentation, providing feedback or getting the word out.
+</p>
-<h1>Documentation</h1>
-<h2>Source Documentation</h2>
+<h2>Mailing Lists</h2>
<p>
- The <a href="writingcode.html">introduction</a> document describes the aims of the project, and has a list of the contributors,
- and some comments on contributing code. The high level design comes in the form of an <a href="java2html/org/crosswire/jsword/examples/APIExamples.java.html">API
+ The first thing you need to do is join the jsword-devel <a href="mailinglists.html">mailing list</a>.
+ Everything that we do is openly discussed here.
+</p>
+
+<h2>Get a Development Environment</h2>
+<p>
+ At a minimum you will need Subversion (aka SVN) and a programmer's text editor. But to make things nicer,
+ we recommend getting a SVN client and also a programmer's IDE. While there are many to choose from and they
+ differ among OSes and you are welcomed to use whatever you wish, we use Eclipse as our IDE and with subclipse,
+ an Eclipse plugin, as our SVN client. We can provide help if you use Eclipse, but if you use something else
+ we might not be able to help. You can get instructions on how to set up Eclipse <a href="Eclipse.html">here</a>.
+</p>
+
+<h2>Get the Source Code</h2>
+<p>
+ We use Subversion for our source code control. Unless you have used SVN before, you may be surprised how
+ it works. The <a href="http://svnbook.red-bean.com/">Subversion Book</a> makes good bedtime reading and
+ provides the best explanation of how it works. In a nutshell, you "checkout" the code, which merely
+ gets you a local copy of the code. You don't need any password to do this and you can use your web
+ browser to browse the repository. For detailed instructions see our pages on <a href="svn.html">svn</a>
+ and <a href="Eclipse.html">Eclipse</a>.
+</p>
+
+<h2>Understanding the Code</h2>
+<p>
+ Before you can effectively make changes to the code, you need to understand it. Below outlines where you
+ can get this information.
+</p>
+
+<h3>Source Documentation</h3>
+<p>
+ The high level design comes in the form of an <a href="java2html/org/crosswire/jsword/examples/APIExamples.java.html">API
Primer</a> which describes how to go about reading and formatting data from JSword, using Bibles, Commentaries and Dictionaries
(it comes with some decent <a href="api/org/crosswire/jsword/examples/APIExamples.html">JavaDoc</a> too). There is also a <a href="design.html">design
statement</a> that explains some of the top level design choices. It explains how the Book and Bible interfaces are arranged
@@ -20,24 +53,24 @@
</p>
<p>
- On a lower level, the <a href="api/org/crosswire/common/config/package-summary.html">Config</a> sub-system doesn't have
- any dependencies on JSword itself (like the whole of the 'common' tree), and <a href="api/org/crosswire/common/config/package-summary.html">Config</a> is
- particularly likely to be useful to other projects, so it has some separate documentation.
-</p>
-
-<p>
There is also the obligatory <a href="api">JavaDoc</a> tree. Most of the source is fairly well documented,
so the JavaDoc ought actually to be useful! There is also a web version of the <a href="java2html">Java Source</a> converted
to the web by <a href="http://www.java2html.com">Java2HTML</a>.
</p>
<p>
- We use <a href="osisCore.1.1.html">OSIS</a> as a standard for XML format Bible data. From the <a href="http://www.bibletechnologies.net">OSIS
+ We use OSIS 2.1 as a standard for XML format Bible data. From the <a href="http://www.bibletechnologies.net">OSIS
website</a>: The Open Scriptural Information Standard (OSIS) is an XML based markup of the Bible, commentaries and related
texts that will facilitate interoperability across natural language boundaries and computer hardware and software for
publication, linking, reference and accessibility.
</p>
+<h2>Making Changes to Code</h2>
+<p>
+ The <a href="writingcode.html">introduction</a> document describes the aims of the project, and has
+ some comments on contributing code.
+</p>
+
<h2>Test Results</h2>
<p>
We are run unit tests automatically on a nightly basis. The unit tests are run with the help of <a href="http://www.junit.org">JUnit</a> and
Modified: trunk/jsword-web/src/web/index.html
===================================================================
--- trunk/jsword-web/src/web/index.html 2006-04-09 16:38:21 UTC (rev 1078)
+++ trunk/jsword-web/src/web/index.html 2006-04-09 20:24:40 UTC (rev 1079)
@@ -7,9 +7,9 @@
</head>
<body>
-<h1>J-Sword</h1>
+<h1>JSword</h1>
<p>
- The J-Sword Project is a group of programs that work together to bring Bible
+ The JSword Project is a group of programs that work together to bring Bible
study to a wide range of people using the Java platform. It includes Bible
Desktop, a desktop based Bible study tool.
</p>
@@ -22,7 +22,7 @@
</p>
<p>
- The software produced by the J-Sword project is open source software so it is
+ The software produced by the JSword project is open source software so it is
freely available to anyone.
It is licensed under the <a href="api/gnu/lgpl/License.html">LGPL</a> for
the libraries and <a href="api/gnu/gpl/License.html">GPL</a> for the
@@ -30,10 +30,10 @@
</p>
<p>
- There are several components to the J-Sword project, the most commonly used is
- Bible Desktop. There is also a simple web interface that is part of the
- JSword-Web sub-project. The core API is called J-Sword and there is a generic
- library of useful utilities called common.
+ There are several components to the JSword project, the most commonly used is
+ Bible Desktop. <!-- There is also a simple web interface that is part of the
+ JSword-Web sub-project. -->The core API is called JSword and there are two generic
+ libraries of useful utilities called common and common-swing.
</p>
<h2>How to find out more</h2>
@@ -42,8 +42,8 @@
is available on the <a href="/bibledesktop/download.html">Bible Desktop
download page</a>.<br/>
There are also binary and source downloads available from the
- <a href="download.jsp">J-Sword download page</a>.
- You can download Sword modules from <a href="/sword">here</a>
+ <a href="download.jsp">JSword download page</a>.
+ You can download Sword modules from <a href="/sword">here</a>.
There is a page of <a href="/bibledesktop/screenshot.html">screenshots</a> showing what
BibleDesktop looks like (a program built with JSword), and a page of recent <a href="news.html">news</a>.
and there is a list of the <a href="change.html">changes</a> that
Modified: trunk/jsword-web/src/web/maillists.html
===================================================================
--- trunk/jsword-web/src/web/maillists.html 2006-04-09 16:38:21 UTC (rev 1078)
+++ trunk/jsword-web/src/web/maillists.html 2006-04-09 20:24:40 UTC (rev 1079)
@@ -3,14 +3,14 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
- <title>J-Sword - Getting Involved</title>
+ <title>JSword - Getting Involved</title>
</head>
<body>
<h1>Mailing Lists</h1>
<p>
- There are a number of J-Sword / Bible Desktop related mailing lists hosted at
+ There are a number of JSword / Bible Desktop related mailing lists hosted at
Crosswire. Mail to all of them is restricted to subscribers to reduce spam.
</p>
@@ -48,7 +48,7 @@
[<a href="/mailman/listinfo/jsword-devel">Subscribe</a>]
[<a href="/pipermail/jsword-devel">Archives</a>]
</td>
- <td>A medium volume list for discussion amongst the various J-Sword project developers.</td>
+ <td>A medium volume list for discussion amongst the various JSword project developers.</td>
<td>
jsword-devel at crosswire dot org
</td>
Modified: trunk/jsword-web/src/web/news.html
===================================================================
--- trunk/jsword-web/src/web/news.html 2006-04-09 16:38:21 UTC (rev 1078)
+++ trunk/jsword-web/src/web/news.html 2006-04-09 20:24:40 UTC (rev 1079)
@@ -37,7 +37,7 @@
has been the replacement of the indexing with Lucene, an open source project.</p>
<h3>18 Aug 2004</h3>
-<p>Bible Desktop is born! We are just finishing a huge job of splitting J-Sword
+<p>Bible Desktop is born! We are just finishing a huge job of splitting JSword
into component projects, the websites are deparate CVS modules as is Bible
Desktop, the Common library, Bible Mapper and the Support data.</p>
@@ -51,9 +51,9 @@
have finished sorting out the grey areas.</p>
<h3>05 Apr 2004</h3>
-<p>J-Sword 0.9.7 has just landed. It includes many many bug fixes, mostly
+<p>JSword 0.9.7 has just landed. It includes many many bug fixes, mostly
thanks to DM. This will be the last release where the Swing GUI is bundled
-with the rest of J-Sword, the intention is to split things out a bit from here</p>
+with the rest of JSword, the intention is to split things out a bit from here</p>
<h3>20 Mar 2004</h3>
<p>Check out the new WebStart installation. Much improved.</p>
Modified: trunk/jsword-web/src/web/svn.html
===================================================================
--- trunk/jsword-web/src/web/svn.html 2006-04-09 16:38:21 UTC (rev 1078)
+++ trunk/jsword-web/src/web/svn.html 2006-04-09 20:24:40 UTC (rev 1079)
@@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
- <title>JSword - Getting Involved</title>
+ <title>JSword - SVN</title>
</head>
<body>
@@ -14,14 +14,35 @@
Our source code is managed with Subversion, aka SVN. SVN is hosted at crosswire. The SVN root is:<br />
<code>https://crosswire.org/svn/jsword</code><br />
Anyone can access the code without a password and can be browsed at this url.<br/>
- The project to checkout is <code>jsword</code>, so if you are using the command line you would
- do something like this<br />
- <code>svn checkout https://crosswire.org/svn/jsword/trunk/jsword jsword</code>.<br />
- You will need to repeat this for each of bibledesktop, common and common-swing.
- There is also <code>jsword-support</code>, containing 3rd-party QA tools<br/>
- <code>jsword-web</code> contains the code for the JSword website and
- bibledesktop-web houses the website for BibleDesktop.
+ Our development is done in <code>trunk</code> and each release is tagged under <code>tags</code>.
+ We have not used <code>branches</code> for development.
</p>
+<p>We have broken up JSword into projects. These are:</p>
+<ol>
+ <li><strong>common</strong> - A set of base, general purpose, common utilities.</li>
+ <li><strong>jsword</strong> - This is the core Sword api. The basic provisions of this project are:
+ <ul>
+ <li>Read Sword modules, extracting passages as requested.</li>
+ <li>Convert passages in Sword Modules into OSIS.</li>
+ <li>Run xslt on OSIS.</li>
+ <li>Build Lucene indexes for a Sword Modules.</li>
+ <li>and ....</li>
+ </ul>
+ </li>
+ <li><strong>common-swing</strong> - Like common but specific to swing.</li>
+ <li><strong>bibledesktop</strong> - The GUI that exposes JSword functionality.</li>
+ <li><strong>jsword-web</strong> - The code and html for the <a href="/jsword">JSword website</a>. This project also contains the ant build.xml file that is used for nightly builds.</li>
+ <li><strong>bibledesktop-web</strong> - The code and html for the <a href="/bibledesktop">BibleDesktop website</a>.</li>
+ <li><strong>jsword-support</strong> - Quality Assurance tools that we use before checking in code and that we run nightly.</li>
+ <li><strong>jsword-limbo</strong> - Code that we could not part with. It is either code that we no longer use or code that we were thinking of using.</li>
+ <li><strong>biblemapper</strong> - Provides an analytical view of a Bible. Currently this is not used.</li>
+ <li><strong>javatar</strong> - 3rd party code that we could not use directly via Java WebStart. It is here only to build a jar that works with WebStart</li>
+</ol>
+<p>To get started you will need the first two projects, and to do BibleDesktop development you also need the next two projects.
+ For each of the projects you wish to use, cd to the directory you wish to check out and then do a SVN checkout following this form:<br/>
+ The project to checkout is <code>jsword</code>, so if you are using the command line you would
+ <code>svn checkout https://crosswire.org/svn/jsword/trunk/jsword jsword</code>.<br />
+</p>
<p>
For detailed instruction on how to use Eclipse as a SVN client see:
<a href="Eclipse.html">Using Eclipse with JSword</a>
Modified: trunk/jsword-web/src/web/writingcode.html
===================================================================
--- trunk/jsword-web/src/web/writingcode.html 2006-04-09 16:38:21 UTC (rev 1078)
+++ trunk/jsword-web/src/web/writingcode.html 2006-04-09 20:24:40 UTC (rev 1079)
@@ -10,14 +10,14 @@
<h2>Aims</h2>
<ul>
<li>
- J-Sword should be a Bible study library with which to build various front-ends.
+ JSword should be a Bible study library with which to build various front-ends.
Front-ends could include Applets, stand-alone Swing/AWT/SWT GUIs, server-side
processing for JSP/Servlets, and more advanced projects like link mappers
and translations.
</li>
<li>
It should help Bible study through various optional front-ends that are
- shipped with J-Sword or separately.
+ shipped with JSword or separately.
</li>
<li>
It should be easliy contributed-to, and easily used.
More information about the jsword-svn
mailing list