Difference between revisions of "API:bin/export"

From EPrints Documentation
Jump to: navigation, search
(pointing out to useful list of available plugins)
 
(One intermediate revision by one other user not shown)
Line 8: Line 8:
 
'''export''' - export some or all items in a dataset using an output plugin.
 
'''export''' - export some or all items in a dataset using an output plugin.
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
 
 
<!-- Pod2Wiki=head_synopsis -->
 
<!-- Pod2Wiki=head_synopsis -->
 
==SYNOPSIS==
 
==SYNOPSIS==
Line 21: Line 18:
 
'''export''' <em>repository_id</em> ['''options'''] <em>dataset</em> <em>plugin</em> [<em>objectid</em>] [<em>objectid...</em>]
 
'''export''' <em>repository_id</em> ['''options'''] <em>dataset</em> <em>plugin</em> [<em>objectid</em>] [<em>objectid...</em>]
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
 
 
<!-- Pod2Wiki=head_description -->
 
<!-- Pod2Wiki=head_description -->
 
==DESCRIPTION==
 
==DESCRIPTION==
Line 36: Line 30:
 
To get the plugin to export a single item use --single. This may not always return a complete file. For example it may be missing the &lt;?xml header, depending on the plugin.
 
To get the plugin to export a single item use --single. This may not always return a complete file. For example it may be missing the &lt;?xml header, depending on the plugin.
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
bin/export <REPOSITORYID> eprint --verbose
−
<span style='display:none'>User Comments</span>
+
presents a list of all available export plugins (as well as missing perl modules causing some deactivations).
 +
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
 
 
<!-- Pod2Wiki=head_arguments -->
 
<!-- Pod2Wiki=head_arguments -->
 +
 
==ARGUMENTS==
 
==ARGUMENTS==
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* <em>repository_id</em>  
−
<span style='display:none'>User Comments</span>
+
: The ID of the EPrint repository to use.
−
<!-- Edit below this comment -->
 
  
 +
* <em>dataset</em>
 +
: The name of the dataset to export, such as "archive", "subject" or "user".
  
−
<!-- Pod2Wiki= -->
+
* <em>plugin</em>
−
</div>
+
: The id of the output plugin to use. This should not include the leading "Export::". Examples: BibTeX, XML.
−
<!-- Pod2Wiki=item_i_repository_id -->
 
−
===<em>repository_id</em> ===
 
  
−
The ID of the EPrint repository to use.
+
: If this is ommited or an invalid plugin is requested, then 'export' will list all plugins compatible with the dataset and exit.
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* <em>objectid</em>
−
<span style='display:none'>User Comments</span>
+
: If this is set then just output the single, specified item or items.
−
<!-- Edit below this comment -->
 
  
−
 
−
<!-- Pod2Wiki= -->
 
−
</div>
 
−
<!-- Pod2Wiki=item_i_dataset -->
 
−
===<em>dataset</em>===
 
−
 
−
The name of the dataset to export, such as "archive", "subject" or "user".
 
−
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
 
−
<!-- Pod2Wiki=item_i_plugin -->
 
−
===<em>plugin</em>===
 
−
 
−
The id of the output plugin to use. This should not include the leading "Export::". Examples: BibTeX, XML.
 
−
 
−
If this is ommited or an invalid plugin is requested, then 'export' will list all plugins compatible with the dataset and exit.
 
−
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
−
 
−
 
−
<!-- Pod2Wiki= -->
 
−
</div>
 
−
<!-- Pod2Wiki=item_i_objectid -->
 
−
===<em>objectid</em>===
 
−
 
−
If this is set then just output the single, specified item or items.
 
−
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
−
 
−
 
−
<!-- Pod2Wiki= -->
 
−
</div>
 
 
<!-- Pod2Wiki=head_options -->
 
<!-- Pod2Wiki=head_options -->
 
==OPTIONS==
 
==OPTIONS==
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* '''--argument key=value'''
−
<span style='display:none'>User Comments</span>
+
: Add an argument to the export plugin. May be repeated. Effects depend on te export plugin.
−
<!-- Edit below this comment -->
 
  
 +
* '''--help'''
 +
: Print a brief help message and exit.
  
−
<!-- Pod2Wiki= -->
+
* '''--man'''
−
</div>
+
: Print the full manual page and then exit.
−
<!-- Pod2Wiki=item_b_arg_key_value -->
 
−
==='''--arg key=value'''===
 
  
−
Add an argument to the export plugin. May be repeated. Effects depend on te export plugin.
+
* '''--quiet'''
 +
: Be vewwy vewwy quiet. This option will supress all output unless an error occurs.
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* '''--verbose'''
−
<span style='display:none'>User Comments</span>
+
: Explain in detail what is going on. May be repeated for greater effect.
−
<!-- Edit below this comment -->
 
  
 +
: Shows why a plugin is disabled.
  
−
<!-- Pod2Wiki= -->
+
* '''--version'''
−
</div>
+
: Output version information and exit.
−
<!-- Pod2Wiki=item_b_help -->
 
−
==='''--help'''===
 
  
−
Print a brief help message and exit.
+
<pre>
 +
 
 +
</pre>
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
+
<!-- Pod2Wiki=head_copyright -->
−
<!-- Pod2Wiki=item_b_man -->
+
==COPYRIGHT==
−
==='''--man'''===
+
Copyright 2000-2011 University of Southampton.
−
 
 
−
Print the full manual page and then exit.
 
−
 
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
−
 
 
−
 
 
−
<!-- Pod2Wiki= -->
 
−
</div>
 
−
<!-- Pod2Wiki=item_b_quiet -->
 
−
==='''--quiet'''===
 
−
 
 
−
Be vewwy vewwy quiet. This option will supress all output unless an error occurs.
 
−
 
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
−
 
 
−
 
 
−
<!-- Pod2Wiki= -->
 
−
</div>
 
−
<!-- Pod2Wiki=item_b_verbose -->
 
−
==='''--verbose'''===
 
−
 
 
−
Explain in detail what is going on. May be repeated for greater effect.
 
  
−
Shows why a plugin is disabled.
+
This file is part of EPrints http://www.eprints.org/.
−
 
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
  
 +
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.
  
−
<!-- Pod2Wiki= -->
+
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.
−
</div>
 
−
<!-- Pod2Wiki=item_b_version -->
 
−
==='''--version'''===
 
  
−
Output version information and exit.
+
You should have received a copy of the GNU General Public License along with EPrints.  If not, see http://www.gnu.org/licenses/.
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
+
<!-- Pod2Wiki=_postamble_ -->
−
<!-- Pod2Wiki=head_copyright -->
 
−
==COPYRIGHT==
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
−
 
−
 
−
<!-- Pod2Wiki= -->
 
−
</div>
 
−
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->
 

Latest revision as of 13:49, 29 January 2015

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

API: Core API

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki


NAME

export - export some or all items in a dataset using an output plugin.


SYNOPSIS

export repository_id [options] dataset

export repository_id [options] dataset plugin [objectid] [objectid...]


DESCRIPTION

This command outputs a dataset in the selected format. The formats available depend on what Export plugins have been installed.

Some plugins only operate on lists (e.g. RSS), others only operate on single objects only. Some plugins act slightly differently in single-item only mode. For example, outputing a list of eprints as XML gives a number of <eprint> elements in an outer <eprints> element.

To get the plugin to export a single item use --single. This may not always return a complete file. For example it may be missing the <?xml header, depending on the plugin. 

bin/export <REPOSITORYID> eprint --verbose

presents a list of all available export plugins (as well as missing perl modules causing some deactivations).



ARGUMENTS

  • repository_id
The ID of the EPrint repository to use.
  • dataset
The name of the dataset to export, such as "archive", "subject" or "user".
  • plugin
The id of the output plugin to use. This should not include the leading "Export::". Examples: BibTeX, XML.
If this is ommited or an invalid plugin is requested, then 'export' will list all plugins compatible with the dataset and exit.
  • objectid
If this is set then just output the single, specified item or items.


OPTIONS

  • --argument key=value
Add an argument to the export plugin. May be repeated. Effects depend on te export plugin.
  • --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.
Shows why a plugin is disabled.
  • --version
Output version information and exit.


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/.



Retrieved from ‘https://wiki.eprints.org/w/index.php?title=API:bin/export&oldid=11123’