Editing My First Bazaar Package (section)

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


== Add an Icon ==

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

OR

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==

Create the directory to contain the ''Screen'' plugin you're going to package:

 $ mkdir -p lib/plugins/EPrints/Plugin/Screen/

Create the screen plugin using your preferred text editor and add the sample content below:

 $ gedit lib/plugins/EPrints/Plugin/Screen/Hello.pm

<source lang="perl">
 package EPrints::Plugin::Screen::Hello;
 
 @ISA = ( 'EPrints::Plugin::Screen' );
 
 use strict;
 # Make the plug-in
 sub new
 {
    my( $class, %params ) = @_;
 
    my $self = $class->SUPER::new(%params);
 
    # Where the button to access the screen appears if anywhere, and what priority
    $self->{appears} = [
       {
           place => "admin_actions",
           position => 1247,
       },
    ];
 
    return $self;
 }
 
 # Anyone can see this screen
 sub can_be_viewed { 1 }
 
 # What to display
 sub render
 {
    my( $self ) = @_;
  
    # Get the current repository object (so we can access the users, eprints information about things in this repository)
  
    my $repository = $self->{repository};
  
    # Create an XML element to return to our screen
  
    my $frag = $repository->xml->create_document_fragment();
 
    # Fill the fragment with stuff
  
    $frag->appendChild($repository->xml->create_text_node( "Hello, World!" ));
  
    return $frag;
 }
 
 1;
</source>

==hello_world.pl==

Create the package directory that will contain the package's configuration file:

 $ mkdir -p lib/epm/hello_world/cfg/cfg.d

Create a configuration file that enables the plugin - this file is copied into the repository when the package is enabled:

 $ gedit lib/epm/hello_world/cfg/cfg.d/hello_world.pl

 $c->{plugins}{"Screen::Hello"}{params}{disable} = 0;

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

Tip: Any files you add below '''cfg/''' and are tracked by the EPM will be added to the repository when the EPM is enabled.


== Commit changes ==

After adding new files its important to record the changes

Add all new files
 git add . 

Commit them with a message

 git commit -a -m "Added new Screen and its configuration. Also included new image"