source: trunk/gli/classes/xml/buildcol.xml@ 4939

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE Info [<!ELEMENT Info (Name,Desc,Arguments)>
<!ELEMENT Arguments (Option*)>
<!ELEMENT Option (Name,Desc,Type,Required,Default?,List?)>
<!ATTLIST Option hide CDATA ''>
<!ELEMENT Name (#PCDATA)>
<!ELEMENT Desc (#PCDATA)>
<!ELEMENT Type (#PCDATA)>
<!ELEMENT Required (#PCDATA)>
<!ELEMENT Default (#PCDATA)>
<!ELEMENT List (Value*)>
<!ELEMENT Value (Name,Desc?)>
]>
<Info>
  <Name>buildcol.pl</Name>
  <Desc>PERL script used to build a greenstone collection from GML documents.</Desc>
  <Arguments>
    <Option>
      <Name>archivedir</Name>
      <Desc>Where the archives live</Desc>
      <Type>string</Type>
      <Required>no</Required>
    </Option>
    <Option>
      <Name>verbosity</Name>
      <Desc>0=none, 3=lots</Desc>
      <Type>int</Type>
      <Required>no</Required>
    </Option>
    <!--<Option hide="true">
      <Name>builddir</Name>
      <Desc>Where to put the built indexes</Desc>
      <Type>string</Type>
      <Required>no</Required>
    </Option>-->
    <Option>
      <Name>maxdocs</Name>
      <Desc>Maximum number of documents to build</Desc>
      <Type>int</Type>
      <Required>no</Required>
    </Option>
    <Option>
      <Name>debug</Name>
      <Desc>Print output to STDOUT</Desc>
      <Type>flag</Type>
      <Required>no</Required>
    </Option>
    <Option>
      <Name>mode</Name>
      <Desc/>
      <Type>enum</Type>
      <Required>no</Required>
      <List>
        <Value>
          <Name>all</Name>
        </Value>
        <Value>
          <Name>compress_text</Name>
        </Value>
        <Value>
          <Name>build_index</Name>
        </Value>
        <Value>
          <Name>infodb</Name>
        </Value>
      </List>
    </Option>
    <Option>
      <Name>index</Name>
      <Desc>Index to build (will build all in config file if not set)</Desc>
      <Type>string</Type>
      <Required>no</Required>
    </Option>
    <Option>
      <Name>keepold</Name>
      <Desc>will not destroy the current contents of the building directory</Desc>
      <Type>flag</Type>
      <Required>no</Required>
    </Option>
    <Option>
      <Name>no_text</Name>
      <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>
      <Type>flag</Type>
      <Required>no</Required>
    </Option>
    <Option>
      <Name>allclassifications</Name>
      <Desc>Don't remove empty classifications</Desc>
      <Type>flag</Type>
      <Required>no</Required>
    </Option>
    <Option>
      <Name>create_images</Name>
      <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>
      <Type>flag</Type>
      <Required>no</Required>
    </Option>
    <!--<Option hide="true">
      <Name>collectdir</Name>
      <Desc>Collection directory</Desc>
      <Type>string</Type>
      <Required>no</Required>
    </Option>-->
    <Option>
      <Name>out</Name>
      <Desc>Filename or handle to print output status to. The default is STDERR</Desc>
      <Type>string</Type>
      <Required>no</Required>
    </Option>
    <Option>
      <Name>buildtype</Name>
      <Desc>This will override the config file setting. (default is mg)</Desc>
      <Type>enum</Type>
      <Required>no</Required>
      <List>
        <Value>
          <Name>mg</Name>
        </Value>
        <Value>
          <Name>mgpp</Name>
        </Value>
      </List>
    </Option>
    <Option>
      <Name>no_strip_html</Name>
      <Desc>Do not strip the html tags from the indexed text (only used
        for mgpp collections)</Desc>
      <Type>flag</Type>
      <Required>no</Required>
    </Option>
    <Option>
      <Name>faillog</Name>
      <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>
      <Type>string</Type>
      <Required>no</Required>
    </Option>
  </Arguments>
</Info>