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
EPM Specification
(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!
==The EPM Spec File== The EPM Spec file contains a series of ":" separated keypairs, each on it's own line. Unless otherwise specified, ALL the fields detailed here are required. If a package wishes to add it's own configuration variables these should be added to the package's own configuration file and not the EPM spec. The spec file should be called package_name ("package") in the spec file, e.g. (test_package.spec). Example Spec file: package: test_package version: 0.0.1 title: Test Package description: This is a simple test screen plugin creator: Dave Tarrant <davetaz@foo.bar.org> creator: Creator 2 <c2@foo.bar.org> configuration_file: Admin::TestScreen icon: icon.png license: GPLv2 category: example category: input_output optional_key: key value ===package=== * A globally unique package identifier, used for management of the package versions, upgrades and local over rides. * The main EPM repository will be files.eprints.org and this can be searched to find if your package_name exists. Alternatively files should tell you when you try and submit the package. ===package_url (optional)=== * An official url for the package. ===version=== * A semantic version complient version number (major release . minor release . bugfix release) * See http://semver.org/ for more details ===title=== * The title/name of the package. * A pretty string. ===description=== * Description of the package. * A pretty string. ===creator=== * A creator listed as follows: Dave Tarrant <foo@bar.com> * More than one creator can be specified by adding additional creator lines. ===icon=== * The icon file which should be within the root directory of the package ===category=== * The category of the plug-in, again multiple categories can be specified. * More can be found on these at http://bazaar.eprints.org (or via the store into which the package is being submitted). ===configuration_file (not required)=== * A Screen or Config File in cfg/cfg.d. If a cfg/cfg.d config file is listed (e.g. cfg/cfg.d/myscreen.pl), then the EPM Manager will re-direct the user to the built in editor for editing this config file. If a screen is specified (as per the example above) then the user will be re-directed to this screen when they press the configure button against the installed package.
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)