summaryrefslogtreecommitdiffstats
path: root/modules/hebrew-wlc/source/WLC2XML/WLC2XML.Instructions.html
blob: c227e6be6c0d5d58ac8b7c8826c773cc5c140ec1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
<HTML>
<HEAD>
<TITLE>WLC2XML Ooperating instructions</TITLE>
</HEAD>
<body>
<p align="right">31 May 2004</p>
<h2>WLC2XML operating instructions</h2>
<b><tt>WLC2XML</tt></b> is a Java program which converts Westminister Hebrew Institute text files of the Westminister Leningrad Codex (WLC) into XML files. This page describes how to produce the site from an updated WLC text file. 
<p/>
Because <b><tt>WLC2XML</tt></b> is a Java application, Java must be installed on the system.  Only the Java Runtime Environment (JRE) is needed.  To install the JRE, go to 
<a href="http://java.sun.com"><b><tt>http://java.sun.com</tt></a></b>.  Look for a download of <b><tt>J2SE X.X.X SDK</tt></b>, the Java 2 Platform, Standard Edition, where X.X.X is the current version. For <b><tt>WLC2XML</tt></b> the version should be 1.4+. <b><tt>WLC2XML</tt></b> is contained in the Java Archive (JAR) file <b><tt>WLC2XML.jar</tt></b> which is contained in the <b><tt>Tanach.zip</tt></b> file provided at the site.
<p/>
The program will request three inputs:
<ol>
<li>The name and location of the WLC input text file.<p/>
    A typical name for a WLC input file is <b><tt>wlc20040305.txt</tt></b>. The usual
    first two lines are:
<pre>
gn1:1 B.:/R")$I73YT B.FRF74) ):ELOHI92YM )"71T HA/$.FMA73YIM W:/)"71T HF/)F75REC00
gn1:2 W:/HF/)F81REC HFY:TF71H TO33HW.03 WF/BO80HW. W:/XO73$EK: (AL-P.:N"74Y ...</pre></li>
<li>The date to be associated with the WLC input text file.<p/>
    With the usual naming convention for the WLC input file, the preceding example file
    is dated 5 March 2004.  This is the date that should be given to the program.  The requested date 
    usually isn't the current date.<p/></li>
<li>The location of the output <i>directory</i> to contain the resulting XML files.  <p/>The program will
produce 40 XML files, 39 "book" files and 1 "index" file in the output directory.<p/>
The program doesn't output the 11 "supporting
files" necessary for the site.  They must be provided by the user if the output directory is to contain a complete site. 
<blockquote>The easiest way to do this is to
un-zip the <i>previous</i> <b><tt>Tanach.zip</tt></b> file into the output directory <i>before running the program</i>. <b><tt>WLC2XML</tt></b> will overwrite the old index and book files. Because <b><tt>WLC2XML.jar</tt></b> is included in the zip file, the program may then  be run from the output directory.
</blockquote>
</p>
</ol>
<p/>
To run the program, open a command window in a directory containing <b><tt>WLC2XML.jar</tt></b>
and type:
<blockquote>
<b><tt>java -jar WLC2XML.jar</tt></b>
<p/>
In some systems <b><tt>WLC2XML.jar</tt></b> may be run by clicking on the file's icon. <i>Although
the program could be run this way, the error messages to the system output may not be visible and the operator may miss critical error messages.</i>
</blockquote>
With good luck a popup window should appear identifying the program.   If not, check that the Java JRE
is installed.  Be ready to write down error messages that might appear in the command window and press
"OK".
<ol>
<li>Select the input WLC text <i>file</i> using the file-choosing window labelled "Give the input file."
and press "Set".<p/></li>
<li>Enter the date of the input file into the text field of the window labelled 
"Give the date of this file" and press "Set". Use an attractive date format because this date
is prominently displayed on many pages.<p/></li>
<li>Select the output </i>directory</i> using the file-choosing window labelled "Set the output directory."
and press "Set".<p/></li>
<li>With luck sequence of label lines and a succession of outputs of the form
<blockquote>
Genesis.xml has been written.
...
</blockquote>
will appear in the command window. <i>Errors may also be written at this time and they should be very carefully noted.</i><p/>
<li>Eventually, a window will appear saying "The 40 output files have been written normally. ...".  <i>The appearance of this window doesn't mean that no errors have occurred.</i>  It only indicates that the program hasn't crashed.<p/>
If the 11 "supporting files" were previously placed in the output directory, push "OK" to see the index.<p/>
</li>
<li>A "Normal end." window will appear. Although this completes the running of the program, two other actions are needed to keep the site complete:<p/>
<ol>
<li>Update the <b><tt>Tanach.Version.html</tt></b> file to reflect the update.<p/></li>
<li>Zip all 51 files in the output directory into <b><tt>Tanach.zip</tt></b> and place
<b><tt>Tanach.zip</tt></b> into the output directory.<p/></li>
</ol>
<p/>
</ol>

Good luck!
<p/>
<p align="right"><a href="mailto:mail@cvkimball.com">Chris Kimball</a></br>
                <b><tt>kimball@ntplx.net</tt></b></p>
<hr>

</body>
</html>