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

From EPrints Documentation
Jump to: navigation, search
(Index)
(Index)
Line 32: Line 32:
 
'''Note: following links in the index will take you to the video on YouTube'''
 
'''Note: following links in the index will take you to the video on YouTube'''
  
* <span class="plainlinks">[http://www.youtube.com/watch?v=JdZ8YCWLOJk 0:00]</span> - create a new ASCII Citation based “hello” export plugin
+
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk 0:00 - create a new ASCII Citation based “hello” export plugin]
* <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&t=200 3:20 - move plugin to /lib/plugins /folder]
* <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
+
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=310 5:10 - disable “hello” plugin in /lib/ as a globally enabled plugin]
* <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
+
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=360 6:00 - enable “hello” plugin in /lib/ as a locally enabled plugin]
* <span class="plainlinks">[http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=480 8:00]</span> - create Bazaar package
+
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=480 8:00 - create Bazaar package]
* <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
+
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=750 12:30 - install new Bazaar package on another repository and test it]
* <span class="plainlinks">[http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=855 14:15]</span> - create icon with Bazaar icon builder
+
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=855 14:15 - create icon with Bazaar icon builder]
* <span class="plainlinks">[http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=945 15:45]</span> - move created icon to /lib/static/images/?
+
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=945 15:45 - move created icon to /lib/static/images/?]
* <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.youtube.com/watch?v=JdZ8YCWLOJk&t=1025 17:05 - install Wordle Generator Bazaar package to confirm image path]
* <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.youtube.com/watch?v=JdZ8YCWLOJk&t=1080 18:00 - move the icon image to /lib/static/images/epm/]
* <span class="plainlinks">[http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=1140 19:00]</span> - publish completed Bazaar package to Bazaar.org
+
* [http://www.youtube.com/watch?v=JdZ8YCWLOJk&t=1140 19:00 - publish completed Bazaar package to Bazaar.org]
* <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.youtube.com/watch?v=JdZ8YCWLOJk&t=1180 19:40 - create new version of the ‘hello’ Bazaar package]
  
 
===The Video===
 
===The Video===

Revision as of 11:57, 18 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 will need to know

  • 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)

Video

Index

Note: following links in the index will take you to the video on YouTube

The Video

Notes, Errata and Additional Information

Versions

This video was created using EPrints 3.3.13 on Ubuntu. Files are edited using Vim.

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