Difference between revisions of "Training Video:Export Plugin Bazaar Package"

From EPrints Documentation
Jump to: navigation, search
m (Video: Added Resources level 2 header)
 
(12 intermediate revisions by one other user not shown)
Line 16: Line 16:
 
* Sharing the plugin with the EPrints community and keeping it up to date
 
* Sharing the plugin with the EPrints community and keeping it up to date
  
==What you will need to know==
+
==What you should already know==
  
 +
* How to log in to EPrints as an administrator
 
* How to use command line tools:
 
* How to use command line tools:
 
** changing directories
 
** changing directories
Line 26: Line 27:
 
* Familiarity with Perl (the example modifies an existing plugin, so you need to be able to read and modify code following existing structures)
 
* Familiarity with Perl (the example modifies an existing plugin, so you need to be able to read and modify code following existing structures)
  
==Video==
+
==Resources==
 +
===Video===
  
===Index===
+
The video can be found below or on YouTube at: http://youtu.be/JdZ8YCWLOJk
  
<span class="plainlinks">[http://www.youtube.com/watch?v=JdZ8YCWLOJk 0:00]</span> - create a new ASCII Citation based “hello” export plugin
+
====Index====
  
<span class="plainlinks">[http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=200 3:20]</span> - move plugin to /lib/plugins /folder
+
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk 0:00 - create a new ASCII Citation based “hello” export plugin]
 +
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=200 3:20 - move plugin to /lib/plugins /folder]
 +
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=310 5:10 - disable “hello” plugin in /lib/ as a globally enabled plugin]
 +
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=360 6:00 - enable “hello” plugin in /lib/ as a locally enabled plugin]
 +
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=480 8:00 - create Bazaar package]
 +
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=750 12:30 - install new Bazaar package on another repository and test it]
 +
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=855 14:15 - create icon with Bazaar icon builder]
 +
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=945 15:45 - move created icon to /lib/static/images/?]
 +
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=1025 17:05 - install Wordle Generator Bazaar package to confirm image path]
 +
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=1080 18:00 - move the icon image to /lib/static/images/epm/]
 +
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=1140 19:00 - publish completed Bazaar package to Bazaar.org]
 +
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=1180 19:40 - create new version of the ‘hello’ Bazaar package]
  
<span class="plainlinks">[http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=310 5:10]</span> - disable “hello” plugin in /lib/ as a globally enabled plugin
+
====The Video====
  
<span class="plainlinks">[http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=360 6:00]</span> - enable “hello” plugin in /lib/ as a locally enabled plugin
+
<youtube>JdZ8YCWLOJk</youtube>
  
<span class="plainlinks">[http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=480 8:00]</span> - create Bazaar package
+
====Notes, Errata and Additional Information====
  
<span class="plainlinks">[http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=750 12:30]</span> - install new Bazaar package on another repository and test it
+
* EPrints 3.3.14
 +
* Ubuntu
 +
* Vim text editor
  
<span class="plainlinks">[http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=855 14:15]</span> - create icon with Bazaar icon builder
+
==Test Yourself==
  
<span class="plainlinks">[http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=945 15:45]</span> - move created icon to /lib/static/images/?
+
Plugin Exercises (includes other kinds of plugins):
  
<span class="plainlinks">[http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=1025 17:05]</span> - install Wordle Generator Bazaar package to confirm image path
+
[http://www.eprints.org/software/training/programming/plugin_exercises.pdf Instructions]
  
<span class="plainlinks">[http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=1080 18:00]</span> - move the icon image to /lib/static/images/epm/
+
[http://www.eprints.org/software/training/programming/plugin-scripts/ Starter files and examples]
  
<span class="plainlinks">[http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=1140 19:00]</span> - publish completed Bazaar package to Bazaar.org
+
==More Reading==
  
<span class="plainlinks">[http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=1180 19:40]</span> - create new version of the ‘hello’ Bazaar package
+
[http://www.eprints.org/software/training/programming/api_techniques.pdf More about the API to make your export plugin more useful]
  
<youtube>JdZ8YCWLOJk</youtube>
+
[[Create Export Plugins|Many more examples of export plugins]]
  
==Notes, Errata and Additional Information==
+
[[How to write plugins]]
  
===Versions===
+
[[Instructions for local plugins]]
  
This video was created using EPrints 3.3.13 on Ubuntu.  Files are edited using Vim.
+
[[Tips to write plugins]]
  
==Test Yourself==
+
[[:Category:Plugins|Category page with many examples of export plugins]]
 
+
Plugin Exercises (includes other kinds of plugins):
+
 
+
[http://www.eprints.org/software/training/programming/plugin_exercises.pdf Instructions]
+
 
+
[http://www.eprints.org/software/training/programming/plugin-scripts/ Starter files and examples]
+

Latest revision as of 12:31, 19 November 2015


Introduction

This video explains how to create a simple export plugin and wrap it as a bazaar package. Export plugins allow you to present the data in EPrints in any format. Bazaar Packages enable you to share this format with others so your work can be re-used.

What you will learn

  • What an export plugin does, and how to write a simple, text-based example
  • How to ensure your plugin is compatible with different installations of EPrints (single and multiple repository)
  • Testing the plugin
  • Creating associated files and compiling the plugin
  • Sharing the plugin with the EPrints community and keeping it up to date

What you should already know

  • How to log in to EPrints as an administrator
  • How to use command line tools:
    • changing directories
    • listing contents of folders
    • copying, moving and editing text files
    • restarting the web server
    • creating new directories
  • Familiarity with Perl (the example modifies an existing plugin, so you need to be able to read and modify code following existing structures)

Resources

Video

The video can be found below or on YouTube at: http://youtu.be/JdZ8YCWLOJk

Index

The Video

Notes, Errata and Additional Information

  • EPrints 3.3.14
  • Ubuntu
  • Vim text editor

Test Yourself

Plugin Exercises (includes other kinds of plugins):

Instructions

Starter files and examples

More Reading

More about the API to make your export plugin more useful

Many more examples of export plugins

How to write plugins

Instructions for local plugins

Tips to write plugins

Category page with many examples of export plugins