EPM Specification - Revision history

Kgoetz: iiiits typo time!

2018-09-12T00:11:40Z

iiiits typo time!

2018-09-12T00:01:26Z

mention EPData XML Representation

2018-09-11T23:56:39Z

Change category Developer to Contribute; add eprints bazaar

2018-08-30T06:33:14Z

adding categories

2011-03-24T18:06:43Z

2010-12-10T10:51:23Z

2010-12-10T10:44:33Z

2010-06-07T15:15:44Z

2010-06-07T13:41:29Z

‎The EPM Spec File

2010-06-07T10:04:36Z

@@ Line 2: / Line 2: @@
 [[Category:Plugins]]
 [[Category:Bazaar Package]]
-[[Category:Eprints Bazaar]]
+[[Category:EPrints Bazaar]]
 =The EPM Specification=

← Older revision		Revision as of 00:01, 12 September 2018
Line 97:		Line 97:
	* Get sword working for submission of EPMs		* Get sword working for submission of EPMs
	* Write an upload handler for EPM files which extracts the metadata and icon. If invalid or data missing this should throw an error back to the client, both in the interface and via sword.		* Write an upload handler for EPM files which extracts the metadata and icon. If invalid or data missing this should throw an error back to the client, both in the interface and via sword.
		+	* Link [[EPData XML Representation]] at an appropriate place; it appears to be what EPM spec is based on

@@ Line 1: / Line 1: @@
-[[Category:Developer]]
+[[Category:Contribute]]
 [[Category:Plugins]]
 [[Category:Bazaar Package]]
 =The EPM Specification=

@@ Line 20: / Line 20: @@
    title: Test Package
    description: This is a simple test screen plugin
-   creator: Dave Tarrant <davetaz@foo.bar.org>, Creator 2 <c2@foo.bar.org>
+   creator: Dave Tarrant <davetaz@foo.bar.org>
    configuration_file: Admin::TestScreen
    icon: icon.png
    license: GPLv2
    optional_key: key value
 ===package===
@@ Line 48: / Line 52: @@
 * A creator listed as follows:
    Dave Tarrant <foo@bar.com>
-* More than one creator can be specified in this way (comma separated)
+* 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
 ===configuration_file (not required)===

@@ Line 17: / Line 17: @@
 Example Spec file:
    package: test_package
-   version: 0.4
+   version: 0.0.1
    title: Test Package
    description: This is a simple test screen plugin
@@ Line 34: / Line 34: @@
 ===version===
-* A decimal only separated package version!
+* A semantic version complient version number (major release . minor release . bugfix release)
-* One recommendataion is to use the revision number of the tag/trunk checkout.
+* See http://semver.org/ for more details
 ===title===

@@ Line 28: / Line 28: @@
 * 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.
 ===version===
@@ Line 41: / Line 44: @@
 * A pretty string.
-===creator_name===
+===creator===
-* Creator name/names, comma separated.
+* A creator listed as follows:
+  Dave Tarrant <foo@bar.com>
-===creator_email===
+* More than one creator can be specified in this way.
 ===icon===

@@ Line 11: / Line 11: @@
 ==The EPM Spec File==
-The EPM Spec file contains a series of ":" separated keypairs, each on it's own line. 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 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).
@@ Line 46: / Line 46: @@
 ===creator_email===
 * Creator email/emails, comma separated.
 ===icon===
 * The icon file which should be within the root directory of the package
 =The EPM Package Structure=

← Older revision		Revision as of 10:04, 7 June 2010
Line 64:		Line 64:

	In this only test_package.spec and icon.png are required, all the rest of the files are installed if possible.		In this only test_package.spec and icon.png are required, all the rest of the files are installed if possible.
		+
		+	=Bundling an EPM=
		+
		+	* Compress the directory structure shown above into a zip file
		+	* Change the extenstion on this zip file to .epm
		+
		+	=Submitting an EPM=
		+
		+	This can either be done via the web interface of your chosen EPM repository, or via the submit to EPM repository button which can be accessed on the "Local Packages" tab of the EPrints Bazaar admin GUI.
		+
		+	If you have filled in all the metadata then there is no need to fill this in again via the web interface as it will be extracted from the spec file automatically.
		+
		+	=TODO=
		+	* Finalise the specification for an EPM repository.
		+	* Get sword working for submission of EPMs
		+	* Write an upload handler for EPM files which extracts the metadata and icon. If invalid or data missing this should throw an error back to the client, both in the interface and via sword.