source: trunk/gsdl/macros/collect.dm@ 1425

package collector

_imagethispage_ {_iconhcolect_}

# _pagescriptextra_ will be set to the appropriate _***scriptextra_
# macro from within the server
_pagescriptextra_ {}

# this is just like the _gsimage_ macro but it calls the check_submit() javascript
# function instead of linking directly to the page (_1_ argument isn't used)
_gsjimage_ {<a href="javascript:check\_submit('_4_');" onMouseover="roll('_4_',1);" onMouseOut="roll('_4_',0);"><img
name="_4_" src="_2_" onLoad="gbutton(this,'_3_');" border=0 alt="_5_"></a>}

_gsimage_ [v=1] {<a href="#" onClick="check\_submit(_4_);">_5_</a><br>}


#######################################################################
# icons

_iconhcolect_ {<img src="_httpimg_/h_colect.gif" alt="the collector">}
_icongreyarrow_ {<img src="_httpimg_/grarrow.gif">}
_icongreyuparrow_ {<img src="_httpimg_/guarrow.gif">}
_iconstop_ {<img src="_httpimg_/stop.gif" border=0>}

_icongcinfoof_ {<img src="_httpicongcinfoof_" alt="_textinfo_">}
_icongcinfoon_ {<img src="_httpicongcinfoon_" alt="_textinfo_">}
_iconycinfoof_ {<img src="_httpiconycinfoof_" alt="_textinfo_">}
_iconycinfoon_ {<img src="_httpiconycinfoon_" alt="_textinfo_">}
_iconncinfoof_ {<img src="_httpiconncinfoof_" alt="_textinfo_">}
_textinfo_ {collection information}

_icongcsrceof_ {<img src="_httpicongcsrceof_" alt="_textsrce_">}
_icongcsrceon_ {<img src="_httpicongcsrceon_" alt="_textsrce_">}
_iconycsrceof_ {<img src="_httpiconycsrceof_" alt="_textsrce_">}
_iconycsrceon_ {<img src="_httpiconycsrceon_" alt="_textsrce_">}
_iconncsrceof_ {<img src="_httpiconncsrceof_" alt="_textsrce_">}
_textsrce_ {source data}

_icongcconfof_ {<img src="_httpicongcconfof_" alt="_textconf_">}
_icongcconfon_ {<img src="_httpicongcconfon_" alt="_textconf_">}
_iconycconfof_ {<img src="_httpiconycconfof_" alt="_textconf_">}
_iconycconfon_ {<img src="_httpiconycconfon_" alt="_textconf_">}
_iconncconfof_ {<img src="_httpiconncconfof_" alt="_textconf_">}
_textconf_ {configure collection}

_icongcbildof_ {<img src="_httpicongcbildof_" alt="_textbild_">}
_icongcbildon_ {<img src="_httpicongcbildon_" alt="_textbild_">}
_iconycbildof_ {<img src="_httpiconycbildof_" alt="_textbild_">}
_iconycbildon_ {<img src="_httpiconycbildon_" alt="_textbild_">}
_iconncbildof_ {<img src="_httpiconncbildof_" alt="_textbild_">}
_textbild_ {build}

_icongcviewof_ {<img src="_httpicongcviewof_" alt="_textview_">}
_icongcviewon_ {<img src="_httpicongcviewon_" alt="_textview_">}
_iconycviewof_ {<img src="_httpiconycviewof_" alt="_textview_">}
_iconycviewon_ {<img src="_httpiconycviewon_" alt="_textview_">}
_iconncviewof_ {<img src="_httpiconncviewof_" alt="_textview_">}
_textview_ {view}

#######################################################################
# http macros 

_httpinfo_ {_gwcgi_?e=_compressedoptions_&cp=info}
_httpsrce_ {_gwcgi_?e=_compressedoptions_&cp=srce}
_httpconf_ {_gwcgi_?e=_compressedoptions_&cp=conf}
_httpbild_ {_gwcgi_?e=_compressedoptions_&cp=bild}
_httpview_ {_gwcgi_?e=_compressedoptions_&cp=view}

_httpicongcinfoof_ {_httpimg_/gcinfoof.gif}
_httpicongcinfoon_ {_httpimg_/gcinfoon.gif}
_httpiconycinfoof_ {_httpimg_/ycinfoof.gif}
_httpiconycinfoon_ {_httpimg_/ycinfoon.gif}
_httpiconncinfoof_ {_httpimg_/ncinfoof.gif}

_httpicongcsrceof_ {_httpimg_/gcsrceof.gif}
_httpicongcsrceon_ {_httpimg_/gcsrceon.gif}
_httpiconycsrceof_ {_httpimg_/ycsrceof.gif}
_httpiconycsrceon_ {_httpimg_/ycsrceon.gif}
_httpiconncsrceof_ {_httpimg_/ncsrceof.gif}

_httpicongcconfof_ {_httpimg_/gcconfof.gif}
_httpicongcconfon_ {_httpimg_/gcconfon.gif}
_httpiconycconfof_ {_httpimg_/ycconfof.gif}
_httpiconycconfon_ {_httpimg_/ycconfon.gif}
_httpiconncconfof_ {_httpimg_/ncconfof.gif}

_httpicongcbildof_ {_httpimg_/gcbildof.gif}
_httpicongcbildon_ {_httpimg_/gcbildon.gif}
_httpiconycbildof_ {_httpimg_/ycbildof.gif}
_httpiconycbildon_ {_httpimg_/ycbildon.gif}
_httpiconncbildof_ {_httpimg_/ncbildof.gif}

_httpicongcviewof_ {_httpimg_/gcviewof.gif}
_httpicongcviewon_ {_httpimg_/gcviewon.gif}
_httpiconycviewof_ {_httpimg_/ycviewof.gif}
_httpiconycviewon_ {_httpimg_/ycviewon.gif}
_httpiconncviewof_ {_httpimg_/ncviewof.gif}


#######################################################################
# intro page

_introscriptextra_ {}

_introcontent_ {
<form name="collectorform" method=post action="_gwcgi_">
<input type=hidden name="e" value="_decodedcompressedoptions_">

<center>
<table width=_pagewidth_>
<tr><td>
_iconblankbar_
<center>
<h2>The Collector</h2>
<p><i>The pen is mightier than the sword!
<br>Building and distributing information collections carries responsibilities
that you may want to reflect on before you begin.
There are legal issues of copyright: being able to access documents doesn't
mean you can necessarily give them to others.
There are social issues:  collections should respect the customs of the
community out of which the documents arise.
And there are ethical issues.
Be sensitive to the power of information and use it wisely.
</i>
</center>
<p>_iconblankbar_

<p>The Collector helps you to create new collections, modify or add to
existing ones, or delete collections.  To do this you will be guided through a
sequence of Web pages which request the information that is needed.

<p>First, you must decide whether to
<ul>
<input type=radio name=cp value=new checked>
create an entirely new collection 
<br>
<input type=radio name=cp value=existing>
work with an existing one, adding data to it or deleting it.
</ul>
<p>_iconblankbar_

<p>In order to build or modify digital library collections you must sign in.
This is to protect you from others logging in to your computer and altering the
information on it.  Note: for security reasons you will be automatically logged
out once a 30 minute period has elapsed since you logged in.  If this happens,
don't worry! -- you will be invited to log in again and can continue from where
you left off.

<p>Please enter your username and password, and click the button to sign in.

<table><tr><td width=80>Name:</td>
<td><input type="text" name="un" value="" size=10></td>
<td></td></tr>
<tr><td>Password:</td>
<td><input type="password" name="pw" size=10></td>
<td><input type="submit" value="sign in"></td>
</tr>
</table>
<p>_iconblankbar_
</td></tr>
</table></center>

</form>
}


#######################################################################
# Creating a new collection page

_newscriptextra_ {}

_newcontent_ {
<center>
<table width=_pagewidth_>
<tr><td>
_iconblankbar_
<center><h2>Creating a new collection</h2></center>
_iconblankbar_

<p>The sequence of steps needed to create a new digital library collection is:
<table cellspacing=6>
<tr><td width=20 align=right valign=bottom>1.</td>
    <td valign=bottom>_iconncinfoof_</td>
    <td valign=bottom>Specify its name (and associated information)</td></tr>
<tr><td align=right valign=bottom>2.</td>
    <td valign=bottom>_iconncsrceof_</td>
    <td valign=bottom>Specify where the source data comes from</td></tr>
<tr><td align=right valign=bottom>3.</td>
    <td valign=bottom>_iconncconfof_</td>
    <td valign=bottom>Adjust the configuration options (advanced users only)</td></tr>
<tr><td align=right valign=bottom>4.</td>
    <td valign=bottom>_iconncbildof_</td>
    <td valign=bottom>"Build" the collection (see below)</td></tr>
<tr><td align=right valign=bottom>5.</td>
    <td valign=bottom>_iconncviewof_</td>
    <td valign=bottom>Proudly view your handiwork.</td></tr>
</table>

<p>The fourth step is where the computer does all the work.  In the "building"
process the computer makes all the indexes and gathers together any other
information that is required to make things work.  But first you have to
specify the information. 

<p>_iconblankbar_

<p>A diagram appears below that will help you keep track of where you are.  The
green button is the one that you click to carry on in the sequence.  As you go
through the sequence, the buttons will change to yellow.  You can return to a
previous page by clicking on the corresponding yellow button in the diagram.

<p>When you are ready, click the green "collection information" button to
begin creating your new digital library collection!

<p><center>
_collectorbar_
</center>

</td></tr>
</table></center>
}


#######################################################################
# Collection information page

_infoscriptextra_ {
function check\_submit (gotopage) \{
  var form = document.collectorform;
  if (form.bc1fullname.value.match(/^\\s*$/))
  \{
    alert("Collection name must be specified");
    form.bc1fullname.focus();
    return;
  \}
  else if (form.bc1contactemail.value.match(/^\\s*$/))
  \{     
    alert("Email address must be specified");
    form.bc1contactemail.focus();
    return;
  \}
  else if (!form.bc1contactemail.value.match(/^([^@]+)@(.+)$/))
  \{
    alert("Please specify email address in the form: usename@domain");
    form.bc1contactemail.focus();
    return;
  \}
  else if (form.bc1aboutdesc.value.match(/^\\s*$/))
  \{
    alert("Description of collection must be specified");
    form.bc1aboutdesc.focus();
    return;
  \}
  form.cp.value = gotopage;
  form.submit();
\}
}

_infocontent_ {
<form name="collectorform" method=post action="_gwcgi_">
<input type=hidden name="e" value="_decodedcompressedoptions_">
<input type=hidden name="cp" value="_cgiargcp_">
<input type=hidden name="bc1infochanged" value="0">

<center>
<table width=_pagewidth_>
<tr><td>
_iconblankbar_
<center>
<h2>Collection information</h2>
</center>
<p>_iconblankbar_

<p>When creating a new collection you need to enter some preliminary
information about the source data.  This process is structured as a series
of Web pages, overseen by The Collector.  The bar at the bottom of the page
shows you the sequence of pages to be completed.  

<h4>Title for collection:</h4>
<input type="text" name="bc1fullname" value="_cgiargbc1fullname_"
onChange="document.collectorform.bc1infochanged.value=1;") size=72>
<br>
<font color="#909090">
The collection title is a short phrase used throughout the digital library to
identify the content of the collection.  Example titles
include &quot;Computer Science Technical Reports&quot; and &quot;Humanity
Development Library.&quot;
</font>

<h4>Contact email address:</h4>
<input type="text" name="bc1contactemail" value="_cgiargbc1contactemail_"
onChange="document.collectorform.bc1infochanged.value=1;" size=72>
<br>
<font color="#909090">
This email address specifies the first point of contact for the collection.
If the Greenstone software detects a problem, a diagnostic report is
sent to this address.  Enter an email address in its full form:
<tt>name@domain</tt>.
</font>

<h4>About this collection:</h4>
<textarea name="bc1aboutdesc"  cols=72 rows=6 wrap=physical
onChange="document.collectorform.bc1infochanged.value=1;">
_cgiargbc1aboutdesc_
</textarea>
<br>
<font color="#909090">
This is statement describing the principles governing what is included in the
collection.  It appears on the first page when the collection is presented.
</font>

<p>_iconblankbar_

<p>Your position in the sequence is indicated by an arrow underneath--in this
case, the "collection information" stage.  To proceed, click the green "source
data" button.

<p><center>
_collectorbar_
</center>

</td></tr>
</table></center>

</form>
}


#######################################################################
# Source data page

# _fullnamemenu is set from within the server. If it's empty there are
# no valid collections 
_fullnamemenu_ {}

_srcescriptextra_ {
function check\_submit (gotopage) \{
  var form = document.collectorform;

  if (form.bc1inputdir1.value.match(/^\\s*$/) &&
      form.bc1inputdir2.value.match(/^\\s*$/) &&
      form.bc1inputdir3.value.match(/^\\s*$/) &&
      form.bc1inputdir4.value.match(/^\\s*$/))
  \{
    alert("At least one input source must be specified");
    form.bc1inputdir1.focus();
    return;
  \}

  form.cp.value = gotopage;
  form.submit();
\}
}

_srcecontent_ {
<form name="collectorform" method=post action="_gwcgi_">
<input type=hidden name="e" value="_decodedcompressedoptions_">
<input type=hidden name="cp" value="_cgiargcp_">

<center>
<table width=_pagewidth_>
<tr><td>
_iconblankbar_
<center>
<h2>Source data</h2>
</center>
<p>_iconblankbar_

<p>You can either create a completely new collection, or "clone" an existing one
-- that is, base the structure of your new collection on one that exists already.
<ul>
<input type=radio name=bc1clone value=0 _If_("_cgiargbc1clone_" eq "0",checked)><b>Create new collection</b>
<br><font color="#909090">
Create a completely new collection. The collection may contain html documents (.htm, .html), plain text
documents (.txt, .text), or email documents (.email).
</font>
</ul>
<ul>_If_("_fullnamemenu_" eq "",
No collections available for cloning.,_srcemenu_)
</ul>

<h4>Input source:</h4>
<input type=text name="bc1inputdir1" value="_cgiargbc1inputdir1_" size=72>
<br>
<input type=text name="bc1inputdir2" value="_cgiargbc1inputdir2_" size=72>
<br>
<input type=text name="bc1inputdir3" value="_cgiargbc1inputdir3_" size=72>
<br>
<input type=text name="bc1inputdir4" value="_cgiargbc1inputdir4_" size=72>
<br>
<font color="#909090">
These specify where the source data is located.  There are three kinds of
location:
<ul>
<li> a directory name on your computer system (beginning with "file://"),
<li> an address beginning with "http://" for files to be downloaded from the
Web,
<li> an address beginning with "ftp://" for files to be downloaded using FTP
(file transfer protocol).
</ul>
In each case, the collection will include all files of the appropriate type in
the specified directory, in any directories it contains, in any directories
they contain, and so on.  
<p>You can specify up to four different input sources.  If you specify a
filename, just that file will be included.
</font>

<p>_iconblankbar_
<p>Remember, you can always revisit a previous stage by clicking its yellow
button. 

<p><center>
_collectorbar_
</center>

</td></tr>
</table></center>

</form>
}

_srcemenu_ {<input type=radio name=bc1clone value=1 _If_("_cgiargbc1clone_" eq "1",checked)><b>Clone existing collection</b>
<br>_fullnamemenu_<br>
<font color=#909090>
This pull-down menu specifies which collection you want to clone.  The files in
your new collection must be exactly the same type as those used to build
the existing one.
</font>
}


#######################################################################
# Configure collection page

_confscriptextra_ {
var changed = 0;

function check\_submit (gotopage) \{
  var form = document.collectorform;
  form.bc1cfgchanged.value = changed;
  form.cp.value = gotopage;
  form.submit();
\}

function reset\_button () \{
  document.collectorform.reset();
  changed = 0;
\}
}

_confcontent_ {
<form name="collectorform" method=post action="_gwcgi_">
<input type=hidden name="e" value="_decodedcompressedoptions_">
<input type=hidden name="cp" value="_cgiargcp_">
<input type=hidden name="bc1cfgchanged" value="_cgiargbc1cfgchanged_">

<center>
<table width=_pagewidth_>
<tr><td>
_iconblankbar_
<center>
<h2>Configure collection</h2>
</center>
<p>_iconblankbar_

<p>The building and presentation of your collection are controlled by
specifications in a special "configuration file".  Advanced users may want
to alter the configuration settings.

<center><p><b>If you are not an advanced user, just go to the bottom of the
page.</b></center> 

<p>To alter the configuration settings, edit the data that appears below.
If you make a mistake, click on &quot;Reset&quot; to reinstate the
original configuration settings.

<p><textarea name="bc1cfgfile" cols=72 rows=18 wrap=off onChange="changed=1;">
_cfgfile_
</textarea>
<table><tr valign=top>
<td><a href="javascript:reset\_button();">_iconstop_</a></td>
<td><a href="javascript:reset\_button();">Reset</a></td>
</tr></table>

<p><center>
_collectorbar_
</center>

</td></tr>
</table></center>

</form>
}


#######################################################################
# Build page

_bildscriptextra_ {
var changed = 0;

function check\_submit (gotopage) \{
  var form = document.collectorform;
  form.bc1cfgchanged.value = changed;
  form.cp.value = gotopage;
  form.submit();
\}
}

_bildcontent_ {
<form name="collectorform" method=post action="_gwcgi_">
<input type=hidden name="e" value="_decodedcompressedoptions_">
<input type=hidden name="cp" value="_cgiargcp_">

<center>
<table width=_pagewidth_>
<tr><td>
_iconblankbar_
<center>
<h2>Build</h2>
</center>
<p>_iconblankbar_

<p><center>
_collectorbar_
</center>

</td></tr>
</table></center>

</form>
}




#######################################################################
# Error pages
#######################################################################

_mkcolfailcontent_ {
<p>

Greenstone failed to create the directory structure required to create your
new collection. Possible causes are:
<ul>
<li> Greenstone does not have permission to write to the gsdl/collect 
     directory.
}