Changeset 4687


Ignore:
Timestamp:
2003-06-16T12:06:45+12:00 (21 years ago)
Author:
jmt12
Message:

Commented out the 'hidden' arguments. It was easier, but at some stage we'll have to make BuildOptions honour the hide argument and buildcol.pl and import.pl produce them

Location:
trunk/gli/classes/xml
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/gli/classes/xml/buildcol.xml

    r4588 r4687  
    11<?xml version="1.0" encoding="UTF-8"?>
    2 <!DOCTYPE Info [
    3   <!ELEMENT Info      (Name, Desc, Arguments)>
    4   <!ELEMENT Arguments (Option*)>
    5   <!ELEMENT Option    (Name, Desc, Type, Required, Default?, List?)>
    6   <!ATTLIST Option
    7             hide      CDATA  "">
    8   <!ELEMENT Name      (#PCDATA)>
    9   <!ELEMENT Desc      (#PCDATA)>
    10   <!ELEMENT Type      (#PCDATA)>
    11   <!ELEMENT Required  (#PCDATA)>
    12   <!ELEMENT Default   (#PCDATA)>
    13   <!ELEMENT List      (Value*)>
    14   <!ELEMENT Value     (Name, Desc?)>
     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?)>
    1513]>
    16 
    1714<Info>
    1815  <Name>buildcol.pl</Name>
    … …  
    3128      <Required>no</Required>
    3229    </Option>
    33     <Option hide="true">
     30    <!--<Option hide="true">
    3431      <Name>builddir</Name>
    3532      <Desc>Where to put the built indexes</Desc>
    3633      <Type>string</Type>
    3734      <Required>no</Required>
    38     </Option>
     35    </Option>-->
    3936    <Option>
    4037      <Name>maxdocs</Name>
    … …  
    5148    <Option>
    5249      <Name>mode</Name>
    53       <Desc></Desc>
     50      <Desc/>
    5451      <Type>enum</Type>
    5552      <Required>no</Required>
    … …  
    8380    <Option>
    8481      <Name>no_text</Name>
    85       <Desc>Don't store compressed text. This option is useful for minimizing the size of the built indexes if you intend always to display the original documents at run time (i.e. you won't be able to retrieve the compressed text version)</Desc>
     82      <Desc>Don't store compressed text. This option is useful for
     83        minimizing the size of the built indexes if you intend always to
     84        display the original documents at run time (i.e. you won't be
     85        able to retrieve the compressed text version)</Desc>
    8686      <Type>flag</Type>
    8787      <Required>no</Required>
    … …  
    9595    <Option>
    9696      <Name>create_images</Name>
    97       <Desc>Attempt to create default images for new collection. This relies on the Gimp being installed along with relevant perl modules to allow scripting from perl</Desc>
     97      <Desc>Attempt to create default images for new collection. This
     98        relies on the Gimp being installed along with relevant perl
     99        modules to allow scripting from perl</Desc>
    98100      <Type>flag</Type>
    99101      <Required>no</Required>
    100102    </Option>
    101     <Option hide="true">
     103    <!--<Option hide="true">
    102104      <Name>collectdir</Name>
    103105      <Desc>Collection directory</Desc>
    104106      <Type>string</Type>
    105107      <Required>no</Required>
    106     </Option>
     108    </Option>-->
    107109    <Option>
    108110      <Name>out</Name>
    … …  
    127129    <Option>
    128130      <Name>no_strip_html</Name>
    129       <Desc>Do not strip the html tags from the indexed text (only used for mgpp collections)</Desc>
     131      <Desc>Do not strip the html tags from the indexed text (only used
     132        for mgpp collections)</Desc>
    130133      <Type>flag</Type>
    131134      <Required>no</Required>
    … …  
    133136    <Option>
    134137      <Name>faillog</Name>
    135       <Desc>Fail log filename. This log receives the filenames of any files which fail to be processed (defaults. to &lt;collectdir&gt;/colname/etc/fail.log)</Desc>
     138      <Desc>Fail log filename. This log receives the filenames of any
     139        files which fail to be processed (defaults. to &lt;collectdir&gt;/colname/etc/fail.log)</Desc>
    136140      <Type>string</Type>
    137141      <Required>no</Required>

  • trunk/gli/classes/xml/import.xml

    r4588 r4687  
    11<?xml version="1.0" encoding="UTF-8"?>
    2 <!DOCTYPE Info [
    3   <!ELEMENT Info      (Name, Desc, Arguments)>
    4   <!ELEMENT Arguments (Option*)>
    5   <!ELEMENT Option    (Name, Desc, Type, Required, Default?, List?)>
    6   <!ATTLIST Option
    7             hide      CDATA  "">
    8   <!ELEMENT Name      (#PCDATA)>
    9   <!ELEMENT Desc      (#PCDATA)>
    10   <!ELEMENT Type      (#PCDATA)>
    11   <!ELEMENT Required  (#PCDATA)>
    12   <!ELEMENT Default   (#PCDATA)>
    13   <!ELEMENT List      (Value*)>
    14   <!ELEMENT Value     (Name, Desc?)>
     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?)>
    1513]>
    16 
    1714<Info>
    1815  <Name>import.pl</Name>
    … …  
    2522      <Required>no</Required>
    2623    </Option>
    27     <Option hide="true">
     24    <!--<Option hide="true">
    2825      <Name>collectdir</Name>
    2926      <Desc>Collection directory</Desc>
    … …  
    3128      <Required>no</Required>
    3229      <Default>/research/jmt12/gsdl/collect</Default>
    33     </Option>
     30    </Option>-->
    3431    <Option>
    3532      <Name>debug</Name>
    … …  
    4037    <Option>
    4138      <Name>faillog</Name>
    42       <Desc>Fail log filename. This log receives the filenames of any files which fail to be processed (defaults to &lt;collectdir&gt;/colname/etc/fail.log)</Desc>
     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>
    4341      <Type>string</Type>
    4442      <Required>no</Required>
    45       <Default>&lt;collectdir&gt;/colname/etc/fail.log</Default>
     43      <Default>&lt;collectdir>/colname/etc/fail.log</Default>
    4644    </Option>
    4745    <Option>
    … …  
    5351    <Option>
    5452      <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>
     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>
    5656      <Type>flag</Type>
    5757      <Required>no</Required>
    5858    </Option>
    59     <Option hide="true">
     59    <!--<Option hide="true">
    6060      <Name>importdir</Name>
    6161      <Desc>Where the original material lives</Desc>
    6262      <Type>string</Type>
    6363      <Required>no</Required>
    64     </Option>
     64    </Option>-->
    6565    <Option>
    6666      <Name>keepold</Name>
    67       <Desc>Will not destroy the current contents of the archives directory (the default)</Desc>
     67      <Desc>Will not destroy the current contents of the archives
     68        directory (the default)</Desc>
    6869      <Type>flag</Type>
    6970      <Required>no</Required>
    … …  
    7778    <Option>
    7879      <Name>OIDtype</Name>
    79       <Desc>The method to use when generating unique identifiers for each document. "hash" (the default) hashes the contents of the file and so will be the same every time the collection is imported. "incremental" is a simple document count and so will be 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>
     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>
    8088      <Type>enum</Type>
    8189      <Required>no</Required>
    … …  
    97105    <Option>
    98106      <Name>removeold</Name>
    99       <Desc>Will remove the old contents of the archives directory -- use with care</Desc>
     107      <Desc>Will remove the old contents of the archives directory --
     108        use with care</Desc>
    100109      <Type>flag</Type>
    101110      <Required>no</Required>
    … …  
    103112    <Option>
    104113      <Name>sortmeta</Name>
    105       <Desc>Sort documents alphabetically by metadata for building. This will be disabled if groupsize > 1</Desc>
     114      <Desc>Sort documents alphabetically by metadata for building. This
     115        will be disabled if groupsize > 1</Desc>
    106116      <Type>string</Type>
    107117      <Required>no</Required>
    … …  
    109119    <Option>
    110120      <Name>statsfile</Name>
    111       <Desc>Filename or handle to print import statistics to. The default is STDERR</Desc>
     121      <Desc>Filename or handle to print import statistics to. The
     122        default is STDERR</Desc>
    112123      <Type>string</Type>
    113124      <Required>no</Required>
    … …  
    115126    <Option>
    116127      <Name>verbosity</Name>
    117       <Desc>A number between zero and three that controls how much information about the process is printed to the standard error stream; 0 gives a little, 3 gives lots</Desc>
     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>
    118131      <Type>int</Type>
    119132      <Required>no</Required>
Note: See TracChangeset for help on using the changeset viewer.