Difference between revisions of "Training Video:Export Plugin Bazaar Package"
(→Video) |
m (→Video: Added Resources level 2 header) |
||
| (20 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:EPrints_3_Plugins]] [[Category:Howto]] [[Category:Training_Video]] [[Category:EPrints_Bazaar]] | + | [[Category:EPrints_3_Plugins]] |
| + | [[Category:Howto]] | ||
| + | [[Category:Training_Video|Export Plugin Bazaar Package]] | ||
| + | [[Category:EPrints_Bazaar]] | ||
==Introduction== | ==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== | |
| − | ==Notes== | + | * 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==== | ||
| + | |||
| + | * [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] | ||
| + | |||
| + | ====The Video==== | ||
| + | |||
| + | <youtube>JdZ8YCWLOJk</youtube> | ||
| + | |||
| + | ====Notes, Errata and Additional Information==== | ||
| + | |||
| + | * EPrints 3.3.14 | ||
| + | * Ubuntu | ||
| + | * Vim text editor | ||
| + | |||
| + | ==Test Yourself== | ||
| + | |||
| + | 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] | ||
| + | |||
| + | ==More Reading== | ||
| + | |||
| + | [http://www.eprints.org/software/training/programming/api_techniques.pdf More about the API to make your export plugin more useful] | ||
| + | |||
| + | [[Create Export Plugins|Many more examples of export plugins]] | ||
| + | |||
| + | [[How to write plugins]] | ||
| + | |||
| + | [[Instructions for local plugins]] | ||
| + | |||
| + | [[Tips to write plugins]] | ||
| + | |||
| + | [[:Category:Plugins|Category page with many examples of export plugins]] | ||
Latest revision as of 12:31, 19 November 2015
Contents
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
- 0:00 - create a new ASCII Citation based “hello” export plugin
- 3:20 - move plugin to /lib/plugins /folder
- 5:10 - disable “hello” plugin in /lib/ as a globally enabled plugin
- 6:00 - enable “hello” plugin in /lib/ as a locally enabled plugin
- 8:00 - create Bazaar package
- 12:30 - install new Bazaar package on another repository and test it
- 14:15 - create icon with Bazaar icon builder
- 15:45 - move created icon to /lib/static/images/?
- 17:05 - install Wordle Generator Bazaar package to confirm image path
- 18:00 - move the icon image to /lib/static/images/epm/
- 19:00 - publish completed Bazaar package to Bazaar.org
- 19:40 - create new version of the ‘hello’ Bazaar package
The Video
Notes, Errata and Additional Information
- EPrints 3.3.14
- Ubuntu
- Vim text editor
Test Yourself
Plugin Exercises (includes other kinds of plugins):
More Reading
More about the API to make your export plugin more useful
Many more examples of export plugins
