Changeset 6097


Ignore:
Timestamp:
2003-12-02T17:27:24+13:00 (20 years ago)
Author:
jmt12
Message:

Revised default import arguments to include one range example

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/gli/classes/xml/import.xml

    r4687 r6097  
    11<?xml version="1.0" encoding="UTF-8"?>
    2 <!DOCTYPE Info [<!ELEMENT Info (Name,Desc,Arguments)>
    3 <!ELEMENT Arguments (Option*)>
    4 <!ELEMENT Option (Name,Desc,Type,Required,Default?,List?)>
    5 <!ATTLIST Option hide CDATA ''>
    6 <!ELEMENT Name (#PCDATA)>
    7 <!ELEMENT Desc (#PCDATA)>
    8 <!ELEMENT Type (#PCDATA)>
    9 <!ELEMENT Required (#PCDATA)>
    10 <!ELEMENT Default (#PCDATA)>
    11 <!ELEMENT List (Value*)>
    12 <!ELEMENT Value (Name,Desc?)>
     2<!DOCTYPE Info [
     3  <!ELEMENT Info      (Name, Desc, Arguments)>
     4  <!ELEMENT Arguments (Option*)>
     5  <!ELEMENT Option    (Name, Desc, Type, Required, Range, Default?, List?)>
     6  <!ELEMENT Name      (#PCDATA)>
     7  <!ELEMENT Desc      (#PCDATA)>
     8  <!ELEMENT Type      (#PCDATA)>
     9  <!ELEMENT Required  (#PCDATA)>
     10  <!ELEMENT Range     (#PCDATA)>
     11  <!ELEMENT Default   (#PCDATA)>
     12  <!ELEMENT List      (Value*)>
     13  <!ELEMENT Value     (Name, Desc?)>
    1314]>
     15
    1416<Info>
    1517  <Name>import.pl</Name>
     
    1820    <Option>
    1921      <Name>archivedir</Name>
    20       <Desc>Where the converted material ends up</Desc>
     22      <Desc>{import.achivedir}</Desc>
    2123      <Type>string</Type>
    2224      <Required>no</Required>
    2325    </Option>
    24     <!--<Option hide="true">
     26    <Option>
    2527      <Name>collectdir</Name>
    26       <Desc>Collection directory</Desc>
     28      <Desc>Collection directory.</Desc>
    2729      <Type>string</Type>
    2830      <Required>no</Required>
    2931      <Default>/research/jmt12/gsdl/collect</Default>
    30     </Option>-->
     32    </Option>
    3133    <Option>
    3234      <Name>debug</Name>
    33       <Desc>Print imported text to STDOUT</Desc>
     35      <Desc>Print imported text to STDOUT.</Desc>
    3436      <Type>flag</Type>
    3537      <Required>no</Required>
     
    3739    <Option>
    3840      <Name>faillog</Name>
    39       <Desc>Fail log filename. This log receives the filenames of any
    40         files which fail to be processed (defaults to &lt;collectdir&gt;/colname/etc/fail.log)</Desc>
     41      <Desc>Fail log filename. This log receives the filenames of any files which fail to be processed.</Desc>
    4142      <Type>string</Type>
    4243      <Required>no</Required>
    43       <Default>&lt;collectdir>/colname/etc/fail.log</Default>
     44      <Default>&lt;collectdir&gt;/colname/etc/fail.log</Default>
    4445    </Option>
    4546    <Option>
    4647      <Name>groupsize</Name>
    47       <Desc>Number of import documents to group into one XML file</Desc>
     48      <Desc>Number of import documents to group into one XML file.</Desc>
    4849      <Type>int</Type>
     50      <Required>no</Required>
     51      <Default>1</Default>
     52    </Option>
     53    <Option>
     54      <Name>gzip</Name>
     55      <Desc>Use gzip to compress resulting xml documents (don't forget to include ZIPPlug in your plugin list when building from compressed documents).</Desc>
     56      <Type>flag</Type>
    4957      <Required>no</Required>
    5058    </Option>
    5159    <Option>
    52       <Name>gzip</Name>
    53       <Desc>Use gzip to compress resulting xml documents (don't forget
    54         to include ZIPPlug in your plugin list when building from
    55         compressed documents)</Desc>
    56       <Type>flag</Type>
     60      <Name>importdir</Name>
     61      <Desc>Where the original material lives.</Desc>
     62      <Type>string</Type>
    5763      <Required>no</Required>
    5864    </Option>
    59     <!--<Option hide="true">
    60       <Name>importdir</Name>
    61       <Desc>Where the original material lives</Desc>
    62       <Type>string</Type>
    63       <Required>no</Required>
    64     </Option>-->
    6565    <Option>
    6666      <Name>keepold</Name>
    67       <Desc>Will not destroy the current contents of the archives
    68         directory (the default)</Desc>
     67      <Desc>Will not destroy the current contents of the archives directory (the default).</Desc>
    6968      <Type>flag</Type>
    7069      <Required>no</Required>
     
    7271    <Option>
    7372      <Name>maxdocs</Name>
    74       <Desc>Maximum number of documents to import</Desc>
     73      <Desc>Maximum number of documents to import.</Desc>
    7574      <Type>int</Type>
    7675      <Required>no</Required>
     
    7877    <Option>
    7978      <Name>OIDtype</Name>
    80       <Desc>The method to use when generating unique identifiers for
    81         each document. &quot;hash&quot; (the default) hashes the
    82         contents of the file and so will be the same every time the
    83         collection is imported. &quot;incremental&quot; is a simple
    84         document count and so will be significantly faster than
    85         &quot;hash&quot;. It is not guaranteed to always assign the same
    86         identifier to a given document though and does not allow further
    87         documents to be added to existing xml archives</Desc>
     79      <Desc>The method to use when generating unique identifiers for each document.</Desc>
    8880      <Type>enum</Type>
    8981      <Required>no</Required>
     
    9183        <Value>
    9284          <Name>hash</Name>
     85          <Desc>Hashes the contents of the file. Document identifier will be the same every time the collection is imported.</Desc>
    9386        </Value>
    9487        <Value>
    9588          <Name>incremental</Name>
     89          <Desc>A simple document count that is significantly faster than "hash". It is not guaranteed to always assign the same identifier to a given document though and does not allow further documents to be added to existing xml archives.</Desc>
    9690        </Value>
    9791      </List>
     92      <Default>hash</Default>
    9893    </Option>
    9994    <Option>
    10095      <Name>out</Name>
    101       <Desc>Filename or handle to print output status to. The default is STDERR</Desc>
     96      <Desc>Filename or handle to print output status to.</Desc>
    10297      <Type>string</Type>
    10398      <Required>no</Required>
     99      <Default>STDERR</Default>
    104100    </Option>
    105101    <Option>
    106102      <Name>removeold</Name>
    107       <Desc>Will remove the old contents of the archives directory --
    108         use with care</Desc>
     103      <Desc>Will remove the old contents of the archives directory -- use with care.</Desc>
    109104      <Type>flag</Type>
    110105      <Required>no</Required>
     
    112107    <Option>
    113108      <Name>sortmeta</Name>
    114       <Desc>Sort documents alphabetically by metadata for building. This
    115         will be disabled if groupsize > 1</Desc>
     109      <Desc>Sort documents alphabetically by metadata for building. This will be disabled if groupsize &gt; 1.</Desc>
    116110      <Type>string</Type>
    117111      <Required>no</Required>
     
    119113    <Option>
    120114      <Name>statsfile</Name>
    121       <Desc>Filename or handle to print import statistics to. The
    122         default is STDERR</Desc>
     115      <Desc>Filename or handle to print import statistics to.</Desc>
    123116      <Type>string</Type>
    124117      <Required>no</Required>
     118      <Default>STDERR</Default>
    125119    </Option>
    126120    <Option>
    127121      <Name>verbosity</Name>
    128       <Desc>A number between zero and three that controls how much
    129         information about the process is printed to the standard error
    130         stream; 0 gives a little, 3 gives lots</Desc>
     122      <Desc>Controls the quantity of output. 0=none, 3=lots.</Desc>
    131123      <Type>int</Type>
     124      <Required>no</Required>
     125      <Range>0,3</Range>
     126      <Default>2</Default>
     127    </Option>
     128    <Option>
     129      <Name>language</Name>
     130      <Desc>Language to display option descriptions in (eg. 'en_US' specifies American English). Requires translations of the option descriptions to exist in the perllib/strings_language-code.rb file.</Desc>
     131      <Type>string</Type>
    132132      <Required>no</Required>
    133133    </Option>
    134134  </Arguments>
    135135</Info>
     136
Note: See TracChangeset for help on using the changeset viewer.