Add oembed

[perso/Immae/Projets/packagist/piedsjaloux-ckeditor-component.git] / release / plugins / Audio / docs / install.html
diff --git a/release/plugins/Audio/docs/install.html b/release/plugins/Audio/docs/install.html

new file mode 100644 (file)

index 0000000..3fbf30e
--- /dev/null
+++ b/release/plugins/Audio/docs/install.html
@@ -0,0 +1,69 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"\r
+       "http://www.w3.org/TR/html4/loose.dtd">\r
+<html lang="en">\r
+<head>\r
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r
+<title>Audio plugin</title>\r
+<link href="styles.css" rel="stylesheet" type="text/css">\r
+</head>\r
+\r
+<body>\r
+<h1>Audio Plugin for CKEditor</h1>\r
+\r
+<h2>Introduction</h2>\r
+<p>This is a plugin to create HTML5 &lt;audio&gt; elements in <a href="http://www.ckeditor.com">CKEditor</a>.</p>\r
+<h3>Version history: </h3>\r
+<ol>\r
+  <li>1.0: 10-July-2015. First version.</li>\r
+</ol>\r
+\r
+<h2>Installation</h2>\r
+<h3>1. Copying the files</h3>\r
+<p>Extract the contents of the zip in you plugins directory, so it ends up like\r
+    this<br>\r
+    <!--<img src="installation.png" alt="Screenshot of installation" width="311" height="346" longdesc="#install">-->\r
+    </p>\r
+<pre id="--install">\r
+ckeditor\\r
+       ...\r
+       images\\r
+       lang\\r
+       plugins\\r
+               ...\r
+               audio\\r
+                       plugin.js\r
+                       dialogs\\r
+                               audio.js\r
+                       docs\\r
+                               install.html\r
+                       images\\r
+                               icon.png\r
+                               placeholder.png\r
+               ...\r
+       skins\\r
+       themes\\r
+</pre>\r
+<h3>2. Adding it to CKEditor</h3>\r
+<p>Now add the plugin in your <em>config.js</em> or custom js configuration\r
+file:\r
+<code>config.extraPlugins='audio'; </code>\r
+</p>\r
+\r
+<h3>3. Add it to your toolbar</h3>\r
+<p>In your toolbar configuration, add a new 'Audio' item in the place where you want the button to show up.</p>\r
+\r
+<h3>4. Configure server browser for audio</h3>\r
+<p>You can use the <code>config.filebrowserAudioBrowseUrl</code> entry to specify a url so the file browser shows just audio elements (as long as your configure properly your file browser).</p>\r
+\r
+<h3>5. Use it</h3>\r
+<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>\r
+\r
+<h2>Final notes</h2>\r
+<p>Please, note that only newer browsers support the Audio element, in older ones a simple text linking to the source audios is provided, you might want to\r
+use some javascript or css to customize the final behavior of these elements.</p>\r
+\r
+\r
+<h2>Disclaimers</h2>\r
+<p>CKEditor is  &copy; CKSource.com</p>\r
+</body>\r
+</html>\r