install.html 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
  2. "http://www.w3.org/TR/html4/loose.dtd">
  3. <html lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  6. <title>Audio plugin</title>
  7. <link href="styles.css" rel="stylesheet" type="text/css">
  8. </head>
  9. <body>
  10. <h1>Audio Plugin for CKEditor</h1>
  11. <h2>Introduction</h2>
  12. <p>This is a plugin to create HTML5 &lt;audio&gt; elements in <a href="http://www.ckeditor.com">CKEditor</a>.</p>
  13. <h3 id="contact">Author:</h3>
  14. <p><a href="https://www.beeznest.com">BeezNest Latino S.A.C</a></p>
  15. <h3>Version history: </h3>
  16. <ol>
  17. <li>1.0: 14-November-2014. First version.</li>
  18. </ol>
  19. <h2>Installation</h2>
  20. <h3>1. Copying the files</h3>
  21. <p>Extract the contents of the zip in you plugins directory, so it ends up like
  22. this<br>
  23. </p>
  24. <pre id="--install">
  25. ckeditor\
  26. ...
  27. images\
  28. lang\
  29. plugins\
  30. ...
  31. audio\
  32. plugin.js
  33. dialogs\
  34. audio.js
  35. docs\
  36. install.html
  37. styles.css
  38. images\
  39. icon.png
  40. placeholder.png
  41. ...
  42. skins\
  43. themes\
  44. </pre>
  45. <h3>2. Adding it to CKEditor</h3>
  46. <p>Now add the plugin in your <em>config.js</em> or custom js configuration
  47. file:
  48. <code>config.extraPlugins='audio'; </code>
  49. </p>
  50. <h3>3. Add it to your toolbar</h3>
  51. <p>In your toolbar configuration, add a new 'Audio' item in the place where you want the button to show up.</p>
  52. <h3>4. Configure server browser for video</h3>
  53. <p>You can use the <code>config.filebrowserVideoBrowseUrl</code> entry to specify a url so the file browser shows just audio elements (as long as your configure properly your file browser).</p>
  54. <h3>5. Use it</h3>
  55. <p>Now empty the cache of your browser and reload the editor, the new button should show up and you can add &lt;audio&gt; elements into the content.</p>
  56. <h2>Final notes</h2>
  57. <p>This plugin has been coded for CKEditor 4.4.5. It might be possible to backport it for older versions, but I don't think that it's worth the effort as sooner
  58. or later those installs will (or should) be upgraded to the current version.</p>
  59. <p>Please, note that only newer browsers support the Audio element, in older ones a simple text linking to the source videos is provided, you might want to
  60. use some javascript or css to customize the final behavior of these elements.</p>
  61. <h2>Disclaimers</h2>
  62. <p>CKEditor is &copy; CKSource.com</p>
  63. </body>
  64. </html>