|
1 |
<!--
|
|
2 |
* harvestListEditor.html
|
|
3 |
*
|
|
4 |
* Authors: Duane Costa
|
|
5 |
* Copyright: 2004 Regents of the University of California and the
|
|
6 |
* National Center for Ecological Analysis and Synthesis,
|
|
7 |
* and the University of New Mexico.
|
|
8 |
* For Details: http://www.nceas.ucsb.edu/
|
|
9 |
* Created: 2004 June 11
|
|
10 |
* Version:
|
|
11 |
* File Info: '$ '
|
|
12 |
*
|
|
13 |
*
|
|
14 |
-->
|
|
15 |
<HTML>
|
|
16 |
<HEAD>
|
|
17 |
<TITLE>Harvest List Editor</TITLE>
|
|
18 |
<link rel="stylesheet" type="text/css" href="@docrooturl@default.css">
|
|
19 |
</HEAD>
|
|
20 |
|
|
21 |
<BODY>
|
|
22 |
<table width="100%">
|
|
23 |
<tr>
|
|
24 |
<td class="tablehead" colspan="2">
|
|
25 |
<p class="label">Harvest List Editor</p>
|
|
26 |
</td>
|
|
27 |
<td class="tablehead" colspan="2" align="right">
|
|
28 |
<a href="./harvester.html">Back</a>
|
|
29 |
</td>
|
|
30 |
</tr>
|
|
31 |
</table>
|
|
32 |
|
|
33 |
<h4>Introduction</h4>
|
|
34 |
<p>
|
|
35 |
The Harvest List Editor is a tool that assists in composing and editing a
|
|
36 |
<a href="./harvester.html#HarvestList">Harvest List</a>. The Harvest List
|
|
37 |
editor displays a Harvest List as a table of rows and fields. Each row in
|
|
38 |
the table corresponds to a single <document> element in the
|
|
39 |
corresponding Harvest List XML file, where a <document> represents
|
|
40 |
a single document to be harvested. Each row contains the following fields:
|
|
41 |
<ul>
|
|
42 |
<li>Row #<br>Displays the table row number. This field is used for visual reference only;
|
|
43 |
it is non-editable and its value is not included in the
|
|
44 |
XML file that is generated when the Harvest List is saved to disk.</li>
|
|
45 |
<li>Scope<br>the value of the <scope> element for this document</li>
|
|
46 |
<li>Identifier<br>the value of the <identifier> element for this document</li>
|
|
47 |
<li>Revision<br>the value of the <revision> element for this document</li>
|
|
48 |
<li>Document Type<br>the value of the <documentType> element for this document</li>
|
|
49 |
<li>Document URL<br>the value of the <documentURL> element for this document</li>
|
|
50 |
</ul>
|
|
51 |
</p>
|
|
52 |
<p>For each <document> element to be included in the Harvest List, edit a row in the
|
|
53 |
table, filling
|
|
54 |
in values for each of the five editable fields: Scope, Identifier, Revision,
|
|
55 |
Document Type, and Document URL. When you have finished adding <document>
|
|
56 |
elements to the Harvest List, save the Harvest List to disk. Each of these steps are
|
|
57 |
explained in more detail <a href=#Using>below</a>.</p>
|
|
58 |
|
|
59 |
<h4><a name="Configuring">Configuring the Harvest List Editor</a></h4>
|
|
60 |
<p></p>
|
|
61 |
The Harvest List Editor has a number of settable properties that control its
|
|
62 |
behavior. All configuration information is managed in a single file,
|
|
63 |
<b>.</b>harvestListEditor (note the leading dot character), which should be
|
|
64 |
created using a plain text editor and placed in the user's home directory.
|
|
65 |
To determine the user's home directory, open a system command window or terminal
|
|
66 |
window and typing the following:
|
|
67 |
<ul>
|
|
68 |
<li></li>
|
|
69 |
On Windows:
|
|
70 |
<code><pre>
|
|
71 |
echo %USERPROFILE%
|
|
72 |
</pre></code>
|
|
73 |
</li>
|
|
74 |
<li>
|
|
75 |
On Linux/Unix:
|
|
76 |
<code><pre>
|
|
77 |
echo $HOME
|
|
78 |
</pre></code>
|
|
79 |
</li>
|
|
80 |
</ul>
|
|
81 |
</p>
|
|
82 |
<p>
|
|
83 |
The following table summarizes the properties that can be configured in the
|
|
84 |
.harvestListEditor file. Note that all properties are optional;
|
|
85 |
setting them improves the convenience of using the Harvest List Editor
|
|
86 |
but it is not a requirement.
|
|
87 |
<p>
|
|
88 |
<table border="1">
|
|
89 |
<tr>
|
|
90 |
<td><b>Property</b></td>
|
|
91 |
<td><b>Description</b></td>
|
|
92 |
<td><b>Possible or default value</b></td>
|
|
93 |
</tr>
|
|
94 |
<tr>
|
|
95 |
<td>defaultHarvestList</td>
|
|
96 |
<td>This property determines the location of a Harvest List
|
|
97 |
file that the Harvest List Editor will automatically open for
|
|
98 |
editing on startup. Set this
|
|
99 |
property to the path to the Harvest List file that
|
|
100 |
you expect to edit most frequently.</td>
|
|
101 |
<td>Examples:
|
|
102 |
<br><code>/home/jdoe/public_html/harvestList.xml</code><br>
|
|
103 |
<code>C:/temp/harvestList.xml</code>
|
|
104 |
</td>
|
|
105 |
</tr>
|
|
106 |
<tr>
|
|
107 |
<td>defaultScope</td>
|
|
108 |
<td>Determines the value that is pasted into the "Scope" field
|
|
109 |
of the currently selected row when the "Paste Defaults" button
|
|
110 |
is clicked.</td>
|
|
111 |
<td>Example:<br>xyz_dataset</td>
|
|
112 |
</tr>
|
|
113 |
<tr>
|
|
114 |
<td>defaulIdentifer</td>
|
|
115 |
<td>Determines the value that is pasted into the "Identifier" field
|
|
116 |
of the currently selected row when the "Paste Defaults" button
|
|
117 |
is clicked. This should be a whole number value.</td>
|
|
118 |
<td>Example:<br>1</td>
|
|
119 |
</tr>
|
|
120 |
<tr>
|
|
121 |
<td>defaultRevision</td>
|
|
122 |
<td>Determines the value that is pasted into the "Revision" field
|
|
123 |
of the currently selected row when the "Paste Defaults" button
|
|
124 |
is clicked. This should be a whole number value.</td>
|
|
125 |
<td>Example:<br>1</td>
|
|
126 |
</tr>
|
|
127 |
<tr>
|
|
128 |
<td>defaultDocumentType</td>
|
|
129 |
<td>Determines the value that is pasted into the "Document Type" field
|
|
130 |
of the currently selected row when the "Paste Defaults" button
|
|
131 |
is clicked.</td>
|
|
132 |
<td>A document type specification
|
|
133 |
<br><br>
|
|
134 |
Default:<br> <code>eml://ecoinformatics.org/eml-2.0.0<code>
|
|
135 |
</td>
|
|
136 |
</tr>
|
|
137 |
<tr>
|
|
138 |
<td>defaultDocumentURL</td>
|
|
139 |
<td>Determines the value that is pasted into the "Document URL" field
|
|
140 |
of the currently selected row when the "Paste Defaults" button
|
|
141 |
is clicked. Typically, this value would be set to the portion
|
|
142 |
of the URL that all EML documents at your site share in common.</td>
|
|
143 |
<td>A URL, or partial URL
|
|
144 |
<br><br>
|
|
145 |
Default:<br> <code>http://<code>
|
|
146 |
<br><br>
|
|
147 |
Example:<br> <code>http://somehost.institution.edu/somepath/<code>
|
|
148 |
</td>
|
|
149 |
</tr>
|
|
150 |
</table>
|
|
151 |
</p>
|
|
152 |
The contents of a sample .harvestListEditor configuration file appear below:
|
|
153 |
<pre><code>
|
|
154 |
defaultHarvestList=C:/temp/harvestList.xml
|
|
155 |
defaultScope=demo_document
|
|
156 |
defaultIdentifier=1
|
|
157 |
defaultRevision=1
|
|
158 |
defaultDocumentURL=http://www.lternet.edu/~dcosta/
|
|
159 |
defaultDocumentType=eml://ecoinformatics.org/eml-2.0.0
|
|
160 |
</code></pre>
|
|
161 |
|
|
162 |
<h4><a name=#Running>Running the Harvest List Editor</a></h4>
|
|
163 |
After the Harvest List Editor has been appropriately
|
|
164 |
<a href=#Configuring>configured</a>, it can be run as follows:
|
|
165 |
<ol>
|
|
166 |
<li>Open a system command window or terminal window.</li>
|
|
167 |
<li>Set the METACAT_HOME environment variable to the value of the Metacat
|
|
168 |
installation directory. Some examples follow:
|
|
169 |
<ul>
|
|
170 |
<li>On Windows:
|
|
171 |
<pre>set METACAT_HOME=C:\somePath\metacat</pre></li>
|
|
172 |
<li>On Linux/Unix (bash shell):
|
|
173 |
<pre>export METACAT_HOME=/home/somePath/metacat</pre></li>
|
|
174 |
</ul>
|
|
175 |
<li>cd to the following directory:
|
|
176 |
<ul>
|
|
177 |
<li>On Windows:
|
|
178 |
<pre>cd %METACAT_HOME%\lib\harvester</pre></li>
|
|
179 |
<li>On Linux/Unix:
|
|
180 |
<pre>cd $METACAT_HOME/lib/harvester</pre></li>
|
|
181 |
</ul>
|
|
182 |
<li>Run the appropriate Harvester shell script, as determined by the
|
|
183 |
operating system:
|
|
184 |
<ul>
|
|
185 |
<li>On Windows:
|
|
186 |
<pre>runHarvestListEditor.bat</pre></li>
|
|
187 |
<li>On Linux/Unix:
|
|
188 |
<pre>sh runHarvestListEditor.sh</pre></li>
|
|
189 |
</ul>
|
|
190 |
</li>
|
|
191 |
</ol>
|
|
192 |
<p>The Harvest List Editor application will start executing, automatically
|
|
193 |
opening the default Harvest List for editing if the
|
|
194 |
<code>defaultHarvestList</code>
|
|
195 |
property has been appropriately configured in the
|
|
196 |
<code>.harvestListEditor</code>
|
|
197 |
file in the user's home directory.
|
|
198 |
</p>
|
|
199 |
|
|
200 |
<h4><a name=#Using>Using the Harvest List Editor</a></h4>
|
|
201 |
|
|
202 |
<h5>The File Menu</h5>
|
|
203 |
The File Menu contains the following menu items:
|
|
204 |
<ul>
|
|
205 |
<li><code>New</code>
|
|
206 |
Opens a new (empty) Harvest List file for editing.
|
|
207 |
</li>
|
|
208 |
<li><code>Open...</code>
|
|
209 |
Opens an existing Harvest List file for editing.
|
|
210 |
</li>
|
|
211 |
<li><code>Save</code>
|
|
212 |
Saves the Harvest List file to disk using its current file name.
|
|
213 |
</li>
|
|
214 |
<li><code>Save As...</code>
|
|
215 |
Saves the Harvest List file to disk, prompting for a different file name.
|
|
216 |
</li>
|
|
217 |
<li><code>Validate</code>
|
|
218 |
Validates the currently open Harvest List and issues messages about any errors that are detected.
|
|
219 |
</li>
|
|
220 |
<li><code>Exit</code>
|
|
221 |
Exits the Harvest List Editor.
|
|
222 |
</li>
|
|
223 |
</ul>
|
|
224 |
|
|
225 |
<h5>The Button Pallette</h6>
|
|
226 |
The Harvest List Editor contains the following buttons in the button pallette
|
|
227 |
at the bottom of the editor window:
|
|
228 |
<ul>
|
|
229 |
<li><code>Cut</code>
|
|
230 |
Cut the currently selected row from the table and save the values to the clipboard.
|
|
231 |
</li>
|
|
232 |
<li><code>Copy</code>
|
|
233 |
Copy the values from the currently selected row into the clipboard.
|
|
234 |
</li>
|
|
235 |
<li><code>Paste</code>
|
|
236 |
Paste the values from the clipboard into the currently selected row.
|
|
237 |
</li>
|
|
238 |
<li><code>Paste Defaults</code>
|
|
239 |
Paste the default values into the currently selected row. The default values
|
|
240 |
are specified in the <a href=#Configuring>.harvestListEditor</a> configuration file.
|
|
241 |
</li>
|
|
242 |
</ul>
|
|
243 |
|
|
244 |
<h5>Editing the Harvest List</h5>
|
|
245 |
<p>
|
|
246 |
To edit the Harvest List, enter values for each of the five editable fields
|
|
247 |
(all fields except the "Row #" field) for a given row in the table. Each
|
|
248 |
row in the table corresponds to a single document that you wish to add to
|
|
249 |
the Harvest List.
|
|
250 |
</p>
|
|
251 |
<p>
|
|
252 |
Empty rows in the table are ignored when generating the Harvest List;
|
|
253 |
therefore, "holes" in the table are allowed.
|
|
254 |
For example, rows #1 and #3 may contain values while row #2 may be empty.
|
|
255 |
However, if any one of the editable fields in a row contains a value, then
|
|
256 |
all five of the editable fields should contain values. Partially filled-in
|
|
257 |
rows will cause errors that will result in an invalid Harvest List.
|
|
258 |
</p>
|
|
259 |
<p>
|
|
260 |
You can <code>Cut</code>, <code>Copy</code>, and <code>Paste</code> rows
|
|
261 |
from one location to another by selecting a row
|
|
262 |
and clicking the corresponding button. You can paste the default
|
|
263 |
values into the currently selected row by clicking the
|
|
264 |
<code>Paste Defaults</code> button.
|
|
265 |
Only one row may be selected at any given time: all cut, copy, and paste
|
|
266 |
operations work on only a single row rather than on a range of rows.
|
|
267 |
</p>
|
|
268 |
|
|
269 |
<a href="./harvester.html">Back</a>
|
|
270 |
|
|
271 |
</BODY>
|
|
272 |
</HTML>
|
| 0 |
273 |
|
Add documentation for the Harvest List Editor.
Display the Harvester Registration web form as a HTML table instead of as text.