PopcornOpenVideoAPI: Difference between revisions

Jump to navigation Jump to search
no edit summary
No edit summary
Line 561: Line 561:
</html>
</html>
</pre>
</pre>
== Making a plugin ==
===Document and Direectory Setup===
Create a folder popcorn-js/plugins/PLUGIN_NAME
Create 4 files:
  popcorn.PLUGIN_NAME.html        - The demo file, contains html to run plugin
  popcorn.PLUGIN_NAME.js          - The code file, contains plugin
  popcorn.PLUGIN_NAME.unit.html  - The demo test file, contains html test framework
  popcorn.PLUGIN_NAME.unit.js    - The code test file, contains unit tests
   
===Making the plugin===
Use the patterns from https://gist.github.com/844211#file_popcorn_plugin_patterns.js as a basis for plugin structure. Use pattern 2 unless plugin variables are required. 
Be sure to eliminate dependencies. A plugin should not require jQuery to run. Also the user should not have to add any extra <script> tags or any other HTML in order for the plugin to work.

Navigation menu