This is wordpress’s own plugin repository http://wordpress.org/extend/plugins/ .

Once create your id, you can upload your plugin and share with the world. By the way, the plugin must be GPL compliant.

Anyway, I had a hard time uploading my plugin Hana Flv Player because the necessary instructions are there but not in details missing something here and missing something there.

So here is my explanation. I hope that this will help someone too.

First little bit about readme.txt file. You need to create a readme.txt file.
Make sure you define the Stable tag to indicate the current version.

== Hana Flv Player ===
Contributors: HanaDaddy
Donate link: http://www.neox.net/
Tags: FLV, Flash video
Requires at least: 2.0
Tested up to: 2.5
Stable tag: 1.5

Below is how to show link (<a href=”">). Link text comes first wrapped with [ ] and link URL goes next with ( ).

[Hana and Sarah's blog](http://www.neox.net/)

In order to use <code></code>, use backtick (`). Therefore `THIS IS CODE` will become <code>THIS IS CODE</code>

If you want to add screeshots, you need to define below section in your readme.txt and place the corresponding image in base trunk folder (refer svn section below for trunk folder . This is basically your plugin local folder to work with svn) The image file name should be in format of screenshot-num.jpg. where num is actual sequentially increasing number. (screenshot-1.jpg, screenshot-2.jpg, screenshot-3.jpg…) Each descriptions go into the readme file with the corresponding number. So the screenshot-1.jpg will be shown with the description “Plugin Settings Page” as it was used with number 1.

== Screenshots ==
 
1. Plugin Settings Page.
2. Adding the hana-flv-player tag in an article.
3. Example video working.


First make a request to add your plugin at http://wordpress.org/extend/plugins/add/

You will get email when the request is granted. Now you can upload your plugin using svn command.
This is where you will need to learn basic svn command if you are not familiar with it. Here is the wordpress site howto.
http://wordpress.org/extend/plugins/about/svn/

But then I will summarize for better reference.

Initial first uploading

Create a folder. Check out the repository and copy your plugin files into the trunk subfolder. Then Checkin again.

$ mkdir my-local-dir
 
# Check out the repository
$ svn co http://svn.wp-plugins.org/your-plugin-name my-local-dir
> A	my-local-dir/trunk
> A	my-local-dir/branches
> A	my-local-dir/tags
> Checked out revision 11325.
 
$ cd my-local-dir
 
my-local-dir/$ cp ~/testing/* trunk/
 
my-local-dir/$ svn add trunk/*
> A	trunk/my-plugin.php
> A	trunk/readme.txt
 
my-local-dir/$ svn ci -m "The great plugin first update"
> Adding	trunk/my-plugin.php
> Adding	trunk/readme.txt
> Committed revision 11326.
 
# Now create a new tag subfolder. You MUST create a new tag subfolder 
# if you upgrade it.
my-local-dir/$ svn cp trunk tags/1.0
> A         tags/1.0
 
my-local-dir/$ svn ci -m "tags v1.0 update"
> Adding        tags/1.0/readme.txt
> Adding        tags/1.0/my-plugin.php
> Committed revision 11327.

Upgrading the version.
Remember to update the ‘Stable Tag’ field in trunk/readme.txt beforehand!

#Let's say you have upgraded the plugin. Makesure that you update the tags field in 
#readme.txt with the new version number
$ cd my-local-dir
my-local-dir/$ vi trunk/readme.txt
 
#Check the status of which will be updated
my-local-dir/$ svn stat 
> M      trunk/readme.txt
 
my-local-dir/$ svn ci -m "trunk v1.5 update"
> Adding	 trunk/readme.txt
> Committed revision 11328.
 
# Now create a new tag subfolder. You MUST create a new tag subfolder if you upgrade it.
my-local-dir/$ svn cp trunk tags/1.5
> A         tags/1.5
 
my-local-dir/$ svn ci -m "tags v1.5 update"
> Adding         tags/1.5/readme.txt
> Committed revision 113289.

Some more svn commands example if you want to add a new file or delete existing file.

#delete file
$ svn del trunk/file.php
 
#add file
$ svn add trunk/file.php
 
#Checking status
$ svn stat
 
# checkin command
$ svn ci -m "add or delete files"

readme.txt
So here is my readme.txt file for ‘hana-flv-player’.
Check out the Wordpress Plugin and compare the result side by side.

=== Hana Flv Player ===
Contributors: HanaDaddy
Donate link: http://www.neox.net/
Tags: FLV, Flash video
Requires at least: 2.0
Tested up to: 2.5
Stable tag: 1.5
 
Easyly embed the Flash Video in your Wordpress featuring Flowplayer, OS FLV player, FLV Player Maxi.
 
== Description ==
 
Now you can easily embed the FLV Flash videos in your WordPress Blog. I have packaged the three FLV Flash player, [OS FLV](http://www.osflv.com/) , [FlowPlayer](http://flowplayer.org/), and [FLV Player Maxi](http://flv-player.net/players/maxi/). So you can use them freely without worries even for the commercial purpose unlike the JW player.
 
You can place the specific tag element `[hana-flv-player]` in your wordpress article to show the video. The 'video' attribute is mandatory. There are other optional attributes. Default values for the options can be defined in this pages. See the bottom of the page for the example.
 
`[hana-flv-player 
    video="http://yourwebsite.com/wp-content/plugins/hana-flv-player/babyhana.flv"
    width="400"
    height="320"
    player="3"
    autoplay="false"
    loop="false"
    autorewind="true"
/]`
 
 
Attributes explained:
 
*   video: URL of the flv video file. This is mandatory.
*   width: Width of the Flash player.
*   height: Height of the Flash player.
*   clickurl: If you want to open a website when a user clicks on the video, you can define the target website URL here.
*   player: If set to "1" , OS FLV will be used. If set to "2", FlowPlayer will be used. "3" is for FLV Player Maxi.
*   autoload: If true, the movie will be loaded (downloaded). If false, the starting screen will be blank since no video is downloaded.
*   autoplay: If true, the movie will play automatically when the page is loaded.
*   loop: If Loop is true, the movie will replay itself constantly.
*   autorewind: If AutoRewind is true, the cursor will be reset to the start of the movie when the movie is ended.
*   splashimage: Only works with FlowPlayer and Maxi. When autoload is off, this splash image will be shown in the player. It only supports JPEG images.
 
 
 
Note: Be careful when you use other website's video file as the video source. Since video files are usually large is size they can use up the bandwidth quickly. So you should ask for the owner's permission before using that link to the file.
 
Thank you for using my plugin. -  [HanaDaddy](http://www.neox.net/)
 
 
== Installation ==
 
This section describes how to install the plugin and get it working.
 
1. Download and unzip the zip file. Upload `hana-flv-player` folder with all of its contents to the `/wp-content/plugins/` directory
2. Activate the plugin through the `Plugins` menu in WordPress Admin Interface.
3. Adjust the default settings in the 'Settings' menu in the Admin Interface if you want to.
4. Use `[hana-flv-player video='...'/]` in your blog article.  Attribute `video` is the only mandatory item where you define the video file. It can be full URL or absolute or relatvie path.
 
If you want a quick test and see if it's working fine, goto Hana Flv Player settings admin page and copy the example shown in the bottom and paste in your blog article.
 
== Frequently Asked Questions ==
 
= Can I use FlowPlayer and OS FLV player in my commercial website? =
 
Yes. They are under GPL licese and you are free to use them.
 
= I would like to save my bandwidth as best as possible. What settings would guarantee the minimum usage? =
 
Set autoplay and autoload to false in default setting admin page. You can override default by defining attributes inside the hana flv player tag.
 
 
== Screenshots ==
 
1. Plugin Settings Page.
2. Adding the hana-flv-player tag in an article.
3. Example video working.


Leave a Reply