My First Bazaar Package - Revision history

Th.lauke@arcor.de: links updated

2019-08-06T09:53:20Z

links updated

Kgoetz: mention gitaar

2018-10-10T05:17:04Z

mention gitaar

Kgoetz: fix heading

2018-09-26T03:55:47Z

fix heading

Kgoetz: attempt to merge

2018-09-26T03:55:21Z

attempt to merge

Dct05r: Re-Ordered instructions

2012-08-03T09:15:34Z

Re-Ordered instructions

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

2012-08-03T09:13:22Z

‎Step 1 - Create a blank package

Pm705 at 12:53, 2 August 2012

2012-08-02T12:53:31Z

Pm705 at 12:52, 2 August 2012

2012-08-02T12:52:55Z

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

2012-05-18T15:22:54Z

‎Step 5 - Adding the missing phrases

Tdb01r: /* Hello.pm */

2012-05-18T15:22:29Z

‎Hello.pm

@@ Line 52: / Line 52: @@
 == 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
-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.
 ==Hello.pm==

← 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).

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

@@ Line 2: / Line 2: @@
 In this tutorial you will create a "Hello, World" Screen and package it as a Bazaar Package (.epm).
 =Requirements=
@@ Line 7: / Line 13: @@
 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 - Create a blank package=
+If using Git, you need to have it installed on your server.
 In ''Admin'' &rarr; ''System Tools'' &rarr; ''EPrints Bazaar'', select the ''Developer Tools'' tab.
@@ Line 19: / Line 28: @@
 If you make a mistake you can click ''Edit'' on the ''Developer Tools'' tab to re-edit the package.
-=Step 2 - Add an Icon=
+The GUI will create the lib/epm/hello_world directory tree for you.
-OR
+= Add blank EPM to Git =
-Download the hello_world icon from http://bazaar.eprints.org/images/hello_world.png
+This step is performed on your Eprints server.
-Once you have this icon, name it hello_world.png and move it into the lib/static/images/epm/ directory.
+Initialise and configure your git repository
-=Step 3 - Develop your package contents=
+= Develop your package contents=
 You will need to be in the root directory of your EPrints installation (typically /opt/eprints3).
 ''gedit'' is the Gnome Text editor but you can use any editor that is capable of creating text files.
 ==Hello.pm==
@@ Line 110: / Line 134: @@
 '''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 - Build the Package=
+Tip: Any files you add below '''cfg/''' and are tracked by the EPM will be added to the repository when the EPM is enabled.
 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:
+At the bottom of the screen (the ''Files'' selector) you need to add the files you created above:
 * epm/hello_world/cfg/cfg.d/hello_world.pl
@@ Line 120: / Line 159: @@
 * 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.
@@ Line 127: / Line 179: @@
 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 6 - Adding the missing phrases=
@@ Line 132: / Line 185: @@
 As EPrints is designed to be multi-language, phrases should be used instead of embedded text.
-In this section we add the phrase file to define a name a description for our screen.
+In this section we add the phrase file to define a title and a description for our screen.
 Create the English language directory that will contain the package's English language phrase file:
@@ Line 156: / Line 209: @@
 </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 is the phrases of which we have created 3.
 Note that 2 of these (the top 2) will get used instantly by our package however the 3rd needs to be added to the render method of our screen.
@@ Line 167: / Line 220: @@
 For some hints on loading and manipulating EPrints see [[Manipulating eprints in 3.2]].
-'''Don't Forget''' to add the phrase file to your bazaar package using the developer tools tab.
+'''Don't Forget''' to add the phrase file to your bazaar package using the developer tools tab and commit them to git!
 '''WARNING: if your package overrides any existing EPrints phrases then your overrides will be applied to ALL repositories even if they have not enabled your package. In this case you would add your override phrases to a separate file - eg. lib/epm/hello_world/cfg/lang/en/phrases/hello_world_overrides.xml - this file will then only be considered when a repository enables your package.
 [[Category:EPrints_Bazaar]]

@@ Line 27: / Line 27: @@
 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).
-=Step 4 - Enable and test the package=
+=Step 4 - Build 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.
@@ 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'''.
-=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.

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

@@ Line 137: / Line 137: @@
   $ gedit lib/lang/en/phrases/hello_world.xml
    <?xml version="1.0" encoding="iso-8859-1" standalone="no" ?>
    <!DOCTYPE phrases SYSTEM "entities.dtd">
@@ Line 148: / Line 149: @@
    </epp:phrases>
 Don't worry too much about the wrapping here, the important thing are the phrases of which we have created 3.

@@ Line 23: / Line 23: @@
   $ gedit lib/plugins/EPrints/Plugin/Screen/Hello.pm
   package EPrints::Plugin::Screen::Hello;
@@ Line 70: / Line 71: @@
 ;
 ==hello_world.pl==