Editing API:bin/import subjects

<!-- Pod2Wiki=_preamble_ 
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
 -->{{API}}{{Pod2Wiki}}{{API:Source|file=bin/import_subjects|package_name=bin/import_subjects}}[[Category:API|BIN/IMPORT_SUBJECTS]][[Category:API:bin/import_subjects|BIN/IMPORT_SUBJECTS]][[Category:API:bin/import_subjects|BIN/IMPORT_SUBJECTS]]<div><!-- Edit below this comment -->


<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
==NAME==
'''import_subjects''' - rebuild an EPrint repository subjects list from the contents of a file

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_synopsis -->
==SYNOPSIS==
'''import_subjects''' <em>repository_id</em> ['''options'''] [<em>subjectfile</em>]

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_description -->
==DESCRIPTION==
Import a set of subjects into an EPrints repository. The subjects are the heirarchical tree of options for "subject" type metadata fields in an eprint repository. 

Use the staff admin subject editor for little tweaks. Use this command for the initial setup or bulk editing subjects. Use the exporter to dump the current subjects if you (an administrator) have edited them online.

This script should also be run after '''create_tables'''.

Without the '''--force''' option, this script asks for confirmation before actually erasing anything.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_arguments -->
==ARGUMENTS==
* <em>repository_id</em> 
: The ID of the EPrint repository to use.

* <em>subjectfile</em>
: This is the file to import the subjects from. If you do not specify it then the system will use "subjects" from the given repository cfg directory. 

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_options -->
==OPTIONS==
* '''--xml'''
: Import XML format instead of flat text.

* '''--help'''
: Print a brief help message and exit.

* '''--man'''
: Print the full manual page and then exit.

* '''--quiet'''
: Be vewwy vewwy quiet. This option will supress all output unless an error occurs.

* '''--verbose'''
: Explain in detail what is going on. May be repeated for greater effect.

* '''--version'''
: Output version information and exit.

* '''--nopurge'''
: Do not purge the existing records from the subject table before importing this file. Rather than do this, it's probably easier to export the current subjects as XML, then combine in your new file and reimport it.

* '''--force'''
: Don't ask before making the changes.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_file_format -->
==FILE FORMAT==
There are two different file formats excepted, the default colon seperated file and XML in the eprints export format. 

The colon seperated ASCII is easier to edit, but is more limited. It is not  intended for UTF-8 encoded characters and can only specify subject names in the default language. 

The XML format can contain any unicode characters and also allows multiple languages for the names of subjects. You may wish to dump the current subjects out of eprints as XML. Edit it. Then re-import it. The downside is that this format is far more verbose.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_the_ascii_default_format -->
===The ASCII Default Format===
This is the default format. 

Comments may be placed on lines begining with a hash (#)

Each (non-comment) line of the file should be in the following format:

<em>subjectid</em>:<em>name</em>:<em>parents</em>:<em>depositable</em>

eg.

blgc-bphy:Biophysics:blgc,phys:1

Please see the main documentation for the meaning of these fields.

* '''subjectid''' 
: An ASCII string which is a unique ID for this subject.

* '''name''' 
: The name of this subject, in the default language of the repository.

* '''parents''' 
: A comma seperated list of the parents of this subject. Be careful not to cause loops. The top level subject id is ROOT and should not be imported as it always exists.

* '''depositable''' 
: A boolean value ( 1 or 0 ) which indicates if this subject may have eprints associated with it. 

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_the_xml_file_format -->
===The XML File Format===
This is the standard eprints export format. It looks like this:

<pre>  &lt;eprintsdata&gt;
    &lt;record&gt;
      &lt;field name="subjectid"&gt;phys&lt;/field&gt;
      &lt;field name="name"&gt;&lt;lang id="en"&gt;Physical Sciences &amp;amp; Mathematics&lt;/lang&gt;&lt;/field&gt;
      &lt;field name="parents"&gt;subjects&lt;/field&gt;
      &lt;field name="depositable"&gt;FALSE!/field!
    &lt;/record&gt;
    .
    .
    .
  &lt;/eprintsdata&gt;</pre>

The fields have the same meaning as described for the ASCII format, with the following variations. The name field can (and should) have a name for each language supported by the repository. Multiple parents are indicated by multiple <code>&lt;lt</code>field name="parents&lt;gt&gt;&gt; elements. Depositable should be either TRUE or FALSE.

<pre></pre>

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_copyright -->
==COPYRIGHT==
Copyright 2000-2011 University of Southampton.

This file is part of EPrints http://www.eprints.org/.

EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with EPrints.  If not, see http://www.gnu.org/licenses/.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=_postamble_ -->
<!-- Edit below this comment -->