Jump to content
Wiki Home
EPrints Home
Bazaar
Files
Main menu
Main menu
move to sidebar
hide
Navigation
Front Page
EPrints 3 Manual
EPrints Training Course
EPrints Glossary
Installing EPrints
How-to Configure EPrints
EPrints 3.2+ API
EPrints 3 Reference
EPrints Plugins
Wiki
All categories
Recent changes
Main Page
Help
EPrints Documentation
Search
Search
Appearance
Log in
Request account
Personal tools
Log in
Request account
Pages for logged out editors
learn more
Contributions
Talk
Editing
Contribute: Plugins/ExportPluginsHelloOld
(section)
Page
Discussion
British English
Read
Edit
View history
Tools
Tools
move to sidebar
hide
Actions
Read
Edit
View history
General
What links here
Related changes
Special pages
Page information
Appearance
move to sidebar
hide
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
== Constructor == After the implicit class reference, a hash of options is given. <pre> my ($class, %opts) = @_; </pre> We create a new export plugin by calling the Eprints::Plugin::Export constructor <pre> my $self = $class->SUPER::new(%opts); </pre> Now we set a number of fields to register our new plugin. This is the name that will appear in the export dropdown menu. The name should therefore be short and descriptive. <pre> $self->{name} = 'Hello, World!'; </pre> The accept field is a list containing the types of objects this plugin can deal with. In this case lists of eprints and individual eprints. <pre> $self->{accept} = [ 'dataobj/eprint', 'list/eprint' ]; </pre> The visible field denotes the class of user which will be able to see the plugin. For most export plugins the value 'all' will be required, allowing all users to see and use the plugin. A value of 'staff' would make the plugin visible only to repository staff. <pre> $self->{visible} = 'all'; </pre> The suffix field contains the extension of files exported by the plugin. The mimetype field defines the [http://en.wikipedia.org/wiki/MIME MIME] type of the files exported by the plugin You can also specify file encoding, for example 'text/plain; charset=utf-8' to specify plain text, encoded using UTF-8.[http://en.wikipedia.org/wiki/UTF-8 UTF-8] is a Unicode character encoding capable of expressing characters from a large number of character sets and so is usually preferable to [http://en.wikipedia.org/wiki/ASCII ASCII] <pre> $self->{suffix} = '.txt'; $self->{mimetype} = 'text/plain; charset=utf-8'; </pre> We then return our plugin reference. <pre> return $self; </pre>
Summary:
Please note that all contributions to EPrints Documentation may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see
EPrints Documentation:Copyrights
for details).
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)