My First Bazaar Package - Revision history

Th.lauke@arcor.de: links updated

2019-08-06T09:53:20Z

links updated

← Older revision		Revision as of 09:53, 6 August 2019
Line 52:		Line 52:
	== Add an Icon ==		== Add an Icon ==

	Create an ~~Icon~~, using ~~the icon builder at~~ http://bazaar.eprints.org		Create an icon, e.g. using [http://bazaar.eprints.org/223/ Bazaar's icon builder].

	OR		OR

	Download the hello_world icon from ~~http~~://bazaar.eprints.org/images/~~hello_world~~.png		Download the hello_world icon from [https://bazaar.eprints.org/393/1/static/images/epm/Hello.png Bazaar].

	Once you have this icon, name it hello_world.png and move it into lib/epm/hello_world/lib/static/images/epm/ directory.		Once you have this icon, name it hello_world.png and move it into lib/epm/hello_world/lib/static/images/epm/ directory.


	==Hello.pm==		==Hello.pm==

Kgoetz: mention gitaar

2018-10-10T05:17:04Z

mention gitaar

← Older revision		Revision as of 05:17, 10 October 2018
Line 6:		Line 6:

	Tracking files in Git is more complex but allows easier development. All of your package's files are placed under a directory tree then Sym-linked into the correct locations in EPrints. The [[API:tools/epm]] tool provides a ''link_lib'' option that makes this easier to achieve, as long as you follow the directory layout described below.		Tracking files in Git is more complex but allows easier development. All of your package's files are placed under a directory tree then Sym-linked into the correct locations in EPrints. The [[API:tools/epm]] tool provides a ''link_lib'' option that makes this easier to achieve, as long as you follow the directory layout described below.
			As an alternative to using the web for building/customising your package you can try [https://github.com/eprintsug/gitaar Gitaar], a tool for building the epmi metadata file and EPM suitable for sharing.

	'''Warning!''' do not edit files and then enable/disable or install/uninstall an EPM. The EPM will detect the changed files and either create backups or refuse to work. You must edit the EPM and do ''Save and Return'' to re-scan the EPM's files (in Admin → EPrints Bazaar, Developer Tools).		'''Warning!''' do not edit files and then enable/disable or install/uninstall an EPM. The EPM will detect the changed files and either create backups or refuse to work. You must edit the EPM and do ''Save and Return'' to re-scan the EPM's files (in Admin → EPrints Bazaar, Developer Tools).

Kgoetz: fix heading

2018-09-26T03:55:47Z

fix heading

← Older revision		Revision as of 03:55, 26 September 2018
Line 181:		Line 181:


	=~~Step 6 -~~ Adding the missing phrases=		= Adding the missing phrases=

	As EPrints is designed to be multi-language, phrases should be used instead of embedded text.		As EPrints is designed to be multi-language, phrases should be used instead of embedded text.

Kgoetz: attempt to merge

2018-09-26T03:55:21Z

attempt to merge

Show changes

Dct05r: Re-Ordered instructions

2012-08-03T09:15:34Z

Re-Ordered instructions

← Older revision		Revision as of 09:15, 3 August 2012
Line 27:		Line 27:
	Download the hello_world icon from http://bazaar.eprints.org/images/hello_world.png		Download the hello_world icon from http://bazaar.eprints.org/images/hello_world.png

	Once you have this icon, name it hello_world.png and move it into the lib/static/images/~~epms~~/ directory.		Once you have this icon, name it hello_world.png and move it into the lib/static/images/epm/ directory.


Line 110:		Line 110:
	'''NOTE All plugins in lib/plugins are disabled by default (see EPrints::PluginFactory::new) UNLESS you explicitly set the disable property in the plugin (and it doesn't make sense to set disable = 0 in the plugin because that would make it visible to all of your repositories even if they hadn't explicitly enabled your bazaar package).		'''NOTE All plugins in lib/plugins are disabled by default (see EPrints::PluginFactory::new) UNLESS you explicitly set the disable property in the plugin (and it doesn't make sense to set disable = 0 in the plugin because that would make it visible to all of your repositories even if they hadn't explicitly enabled your bazaar package).

	=Step 4 - Enable and test the package=		=Step 4 - Build the Package=

			Re-Edit your EPM in the "Developer Tools" section of the Bazaar Store.

			At the bottom of the screen (the ''Files'' selector) you need to add the two files you created above:

			* epm/hello_world/cfg/cfg.d/hello_world.pl
			* plugins/EPrints/Plugin/Screen/Hello.pm
			* static/images/epm/hello_world.png

			=Step 5 - Enable and test the package=

	On the EPrints Bazaar ''Installed'' tab click ''Enable'' for the '''hello_world''' package. After a short time you should see a repository configuration reloaded message.		On the EPrints Bazaar ''Installed'' tab click ''Enable'' for the '''hello_world''' package. After a short time you should see a repository configuration reloaded message.
Line 118:		Line 128:
	You can now use ''Uninstall'' to completely remove the package and the source files created. A copy of the package will be saved in '''var/cache/epm/hello_world-1.0.0.epm'''.		You can now use ''Uninstall'' to completely remove the package and the source files created. A copy of the package will be saved in '''var/cache/epm/hello_world-1.0.0.epm'''.

	=Step 5 - Adding the missing phrases=		=Step 6 - Adding the missing phrases=

	As EPrints is designed to be multi-language, phrases should be used instead of embedded text.		As EPrints is designed to be multi-language, phrases should be used instead of embedded text.

Dct05r: /* Step 1 - Create a blank package */

2012-08-03T09:13:22Z

Step 1 - Create a blank package

← Older revision		Revision as of 09:13, 3 August 2012
Line 14:		Line 14:

	You can fill out the metadata if you wish but at this stage you are only required to have a ''version'', which defaults to "1.0.0".		You can fill out the metadata if you wish but at this stage you are only required to have a ''version'', which defaults to "1.0.0".

	~~At the bottom of the screen (the ''Files'' selector) you need to add the two files you created above:~~

	* epm/hello_world/cfg/cfg.d/hello_world.pl
	* plugins/EPrints/Plugin/Screen/Hello.pm
	* static/images/epm/hello_world.png

	Click ''Save and Return'' to return to the EPrints Bazaar screen.		Click ''Save and Return'' to return to the EPrints Bazaar screen.

Pm705 at 12:53, 2 August 2012

2012-08-02T12:53:31Z

@@ Line 7: / Line 7: @@
 You will need a working EPrints installation on which you have an administrator account. You will need to have access to the command line to create the files for the package.
-=Step 1 - Add an Icon=
+=Step 1 - Create a blank package=
 In ''Admin'' &rarr; ''System Tools'' &rarr; ''EPrints Bazaar'', select the ''Developer Tools'' tab.
@@ Line 34: / Line 24: @@
 If you make a mistake you can click ''Edit'' on the ''Developer Tools'' tab to re-edit the package.
 =Step 3 - Develop your package contents=

Pm705 at 12:52, 2 August 2012

2012-08-02T12:52:55Z

@@ Line 7: / Line 7: @@
 You will need a working EPrints installation on which you have an administrator account. You will need to have access to the command line to create the files for the package.
-=Step 1 - Develop your package contents=
+=Step 1 - Add an Icon=
 You will need to be in the root directory of your EPrints installation (typically /opt/eprints3).
@@ Line 86: / Line 114: @@
 '''NOTE All plugins in lib/plugins are disabled by default (see EPrints::PluginFactory::new) UNLESS you explicitly set the disable property in the plugin (and it doesn't make sense to set disable = 0 in the plugin because that would make it visible to all of your repositories even if they hadn't explicitly enabled your bazaar package).
 =Step 4 - Enable and test the package=

Tdb01r: /* Step 5 - Adding the missing phrases */

2012-05-18T15:22:54Z

Step 5 - Adding the missing phrases

← Older revision		Revision as of 15:22, 18 May 2012
Line 137:		Line 137:
	$ gedit lib/lang/en/phrases/hello_world.xml		$ gedit lib/lang/en/phrases/hello_world.xml

			<source lang="xml">
	<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>		<?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>
	<!DOCTYPE phrases SYSTEM "entities.dtd">		<!DOCTYPE phrases SYSTEM "entities.dtd">
Line 148:		Line 149:

	</epp:phrases>		</epp:phrases>
			</source>

	Don't worry too much about the wrapping here, the important thing are the phrases of which we have created 3.		Don't worry too much about the wrapping here, the important thing are the phrases of which we have created 3.

Tdb01r: /* Hello.pm */

2012-05-18T15:22:29Z

Hello.pm

← Older revision		Revision as of 15:22, 18 May 2012
Line 23:		Line 23:
	$ gedit lib/plugins/EPrints/Plugin/Screen/Hello.pm		$ gedit lib/plugins/EPrints/Plugin/Screen/Hello.pm

			<source lang="perl">
	package EPrints::Plugin::Screen::Hello;		package EPrints::Plugin::Screen::Hello;

Line 70:		Line 71:

	1;		1;
			</source>

	==hello_world.pl==		==hello_world.pl==