Changeset 6097
- Timestamp:
- 2003-12-02T17:27:24+13:00 (20 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/gli/classes/xml/import.xml
r4687 r6097 1 1 <?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?)> 13 14 ]> 15 14 16 <Info> 15 17 <Name>import.pl</Name> … … 18 20 <Option> 19 21 <Name>archivedir</Name> 20 <Desc> Where the converted material ends up</Desc>22 <Desc>{import.achivedir}</Desc> 21 23 <Type>string</Type> 22 24 <Required>no</Required> 23 25 </Option> 24 < !--<Option hide="true">26 <Option> 25 27 <Name>collectdir</Name> 26 <Desc>Collection directory </Desc>28 <Desc>Collection directory.</Desc> 27 29 <Type>string</Type> 28 30 <Required>no</Required> 29 31 <Default>/research/jmt12/gsdl/collect</Default> 30 </Option> -->32 </Option> 31 33 <Option> 32 34 <Name>debug</Name> 33 <Desc>Print imported text to STDOUT </Desc>35 <Desc>Print imported text to STDOUT.</Desc> 34 36 <Type>flag</Type> 35 37 <Required>no</Required> … … 37 39 <Option> 38 40 <Name>faillog</Name> 39 <Desc>Fail log filename. This log receives the filenames of any 40 files which fail to be processed (defaults to <collectdir>/colname/etc/fail.log)</Desc> 41 <Desc>Fail log filename. This log receives the filenames of any files which fail to be processed.</Desc> 41 42 <Type>string</Type> 42 43 <Required>no</Required> 43 <Default><collectdir >/colname/etc/fail.log</Default>44 <Default><collectdir>/colname/etc/fail.log</Default> 44 45 </Option> 45 46 <Option> 46 47 <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> 48 49 <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> 49 57 <Required>no</Required> 50 58 </Option> 51 59 <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> 57 63 <Required>no</Required> 58 64 </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>-->65 65 <Option> 66 66 <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> 69 68 <Type>flag</Type> 70 69 <Required>no</Required> … … 72 71 <Option> 73 72 <Name>maxdocs</Name> 74 <Desc>Maximum number of documents to import </Desc>73 <Desc>Maximum number of documents to import.</Desc> 75 74 <Type>int</Type> 76 75 <Required>no</Required> … … 78 77 <Option> 79 78 <Name>OIDtype</Name> 80 <Desc>The method to use when generating unique identifiers for 81 each document. "hash" (the default) hashes the 82 contents of the file and so will be the same every time the 83 collection is imported. "incremental" is a simple 84 document count and so will be significantly faster than 85 "hash". 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> 88 80 <Type>enum</Type> 89 81 <Required>no</Required> … … 91 83 <Value> 92 84 <Name>hash</Name> 85 <Desc>Hashes the contents of the file. Document identifier will be the same every time the collection is imported.</Desc> 93 86 </Value> 94 87 <Value> 95 88 <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> 96 90 </Value> 97 91 </List> 92 <Default>hash</Default> 98 93 </Option> 99 94 <Option> 100 95 <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> 102 97 <Type>string</Type> 103 98 <Required>no</Required> 99 <Default>STDERR</Default> 104 100 </Option> 105 101 <Option> 106 102 <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> 109 104 <Type>flag</Type> 110 105 <Required>no</Required> … … 112 107 <Option> 113 108 <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 > 1.</Desc> 116 110 <Type>string</Type> 117 111 <Required>no</Required> … … 119 113 <Option> 120 114 <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> 123 116 <Type>string</Type> 124 117 <Required>no</Required> 118 <Default>STDERR</Default> 125 119 </Option> 126 120 <Option> 127 121 <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> 131 123 <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> 132 132 <Required>no</Required> 133 133 </Option> 134 134 </Arguments> 135 135 </Info> 136
Note:
See TracChangeset
for help on using the changeset viewer.