| 131808ed |
1 | === danixland-asciinema === |
| 2 | |
| 3 | Contributors: danixland |
| 4 | Donate link: http://danixland.net |
| 5 | Tags: asciinema, shortcode, video |
| 6 | Requires at least: 3.0.1 |
| 7 | Tested up to: 4.4 |
| 8 | Stable tag: 0.1 |
| 9 | License: GPLv2 or later |
| 10 | |
| 11 | This plugin adds a shortcode that displays a video from <a href="https://asciinema.org">asciinema.org</a>. |
| 12 | |
| 13 | == Description == |
| 14 | |
| 15 | danixland-asciinema is a plugin that adds a new shortcode to be used whenever you want to embed a video from asciinema.org. |
| 16 | |
| 17 | As stated on their website, asciinema (formerly ascii.io) is a free and open source solution for recording terminal sessions and sharing them on the web. |
| 18 | It aims to be a "go to" place for every command-line user who wants to share their skills with others. Or putting it differently, it's a place to show off your geekiness. |
| 19 | |
| 20 | I decided to make this plugin because I was looking for a good and easy way to share a video from asciinema and I'm too lazy to dwelve into oEmbed :-D |
| 21 | |
| 22 | == Installation == |
| 23 | |
| 24 | Installing danixland-asciinema is straightforward and requires just a few seconds: |
| 25 | |
| 26 | If you use the **"Add New Plugin"** pane from your dashboard just install it and activate it, nothing to configure here, just go ahead and use it. |
| 27 | Otherwise follow these steps: |
| 28 | |
| 29 | 1. Download the latest version of the plugin. |
| 30 | 1. If using the "Install Plugins->Upload" section on the WordPress admin area just upload the zip file, otherwise unpack the zip file and upload the **"danixland-asciinema"** directory inside the "wp-content/plugins" directory of your WordPress installation using your favourite ftp client. |
| 31 | 1. Activate the plugin through the 'Plugins' menu in WordPress and you're ready to go!! |
| 32 | |
| 33 | == Frequently Asked Questions == |
| 34 | |
| 35 | = What are the options that I can use with the shortcode? = |
| 36 | |
| 37 | The most important option is the "video" which you can assign to the number of the video you want to embed, let's say you want to embed `https://asciinema.org/a/14829` the shortcode whould be `[asciinema video=14829]` |
| 38 | The full list of options is: |
| 39 | |
| 40 | * video |
| 41 | * time |
| 42 | * autoplay |
| 43 | * loop |
| 44 | * speed |
| 45 | * theme |
| 46 | |
| 47 | You can read about their usage [on the website](https://asciinema.org/docs/embedding). |
| 48 | |
| 49 | = I'm stuck with your plugin and don't seem to be able to customize it/make it work, can you help me? = |
| 50 | |
| 51 | Of course, you can ask for help on [the forums](http://wordpress.org/support/) or write a comment on the main article for this plugin on [my site](http://danixland.net/?p=3525), I'll reply ASAP ;) |
| 52 | |
| 53 | = I'd like this plugin to be translated in my language, can you do this for me? = |
| 54 | |
| 55 | This plugin doesn't output any text other than the video code, so it doesn't provide/need a translation ;) |
| 56 | |
| 57 | ####If you have any other questions feel free to ask |
| 58 | |
| 59 | == Screenshots == |
| 60 | |
| 61 | 1. The shortcode with few options as seen in the admin area of the website |
| 62 | 2. A sample video displayed in single view with the TwentyFifteen theme |
| 63 | |
| 64 | == Changelog == |
| 65 | |
| 66 | = 0.1 = |
| 67 | * This is the first version of the plugin. |
| 68 | |
| 69 | == Upgrade Notice == |
| 70 | |
| 71 | Thank you Mario! But our princess is in another castle! |
| 72 | |
| 73 | == ToDo list == |
| 74 | |
| 75 | List is actually empty, but I'm open to suggestions. |
| 76 | |
