source: trunk/www.guidonia.net/wp/wp-content/plugins/tubematic/readme.txt@ 44

Last change on this file since 44 was 44, checked in by luciano, 15 years ago
File size: 4.9 KB
Line 
1=== TubeMatic ===
2Contributors: redazionegriido
3Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=QRLJTAUPEC98U&lc=IT&item_name=Griido%2eit%20Plugin%20Tubematic&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted
4Tags: RSS, feed, video, YouTube, TubeMatic, Google, API, gdata
5Requires at least: 2.5
6Tested up to: 2.7.1
7Stable tag: trunk
8
9This plugin is made for easily embedding videos into a blog post or page.
10
11== Description ==
12
13TubeMatic is a WordPress plugin that allows you to easily insert Youtube videos into your post or page. The plugin is designed to be small and fast.
14What you need is to specify keywords and/or a channel name. The plugin gets the RSS feed available form YouTube, parses it and makes a video gallery with thumbnails, statistics and links to videos and yt users.
15You don't need to update videos on your posts or pages, TubeMatic automatically makes that for you.
16You also do not need a YouTube API developers ID.
17Required PHP 5 or greater.
18
19== Installation ==
20
21###Updgrading From A Previous Version###
22
23To upgrade from a previous version of this plugin, delete the entire folder and files from the previous version of the plugin and then follow the installation instructions below.
24
25###Installing The Plugin###
26
27Extract all files from the ZIP file, making sure to keep the file structure intact, and then upload it to `/wp-content/plugins/`.
28
29This should result in the following file structure:
30
31`- wp-content
32 - plugins
33 - tubematic
34 | readme.txt
35 | config.php
36 | tubematic.php`
37
38Then just visit your admin area and activate the plugin.
39
40**See Also:** ["Installing Plugins" article on the WP Codex](http://codex.wordpress.org/Managing_Plugins#Installing_Plugins)
41
42== Frequently Asked Questions ==
43
44= How do I use TubeMatic? =
45
46First of all, you need to insert the [tubematic] token into any page or post.
47
48*Use apostrophes ('') to enclose each parameter value.*
49
50The paramaters are as follows:
51
52**type** - this parameter can have one of this value: *uploads* or *category* or *searchfeed*
53Please use:
54*uploads* to get the latest videos from a channel or only the videos that match your keywords
55*category* to search videos in a category
56*freesearch* to search videos starting from keywords
57There isn't a default value.
58
59**query** - this parameter is the name of yt channel (required if use type='category' or type='uploads')
60There isn't a default value.
61
62**limit** - the maximum number of items in the output grid
63The default value is '6'.
64
65**orderby** - this parameter specifies the value that will be used to sort videos in the search result set
66Valid values for this parameter are *updated* or *rating* or *relevance* or *published* or *viewCount*.
67The default value for this parameter is *viewCount*.
68
69**spanrow** - this is the maximum number of columns of the gallery (the gallery is a table with rows and columns)
70The default value for this parameter is '3'.
71
72**keys** - this parameter specifies a search query term.
73YouTube will search all video metadata for videos matching the term.
74Video metadata includes titles, keywords, descriptions, authors' usernames, and categories.
75To search for an exact phrase, enclose the phrase in quotation marks.
76There isn't a default value.
77
78**lr** - this parameter restricts the search to videos that have a title, description or keywords in a specific language.
79Valid values for the lr parameter are ISO 639-1 two-letter language codes (http://www.loc.gov/standards/iso639-2/php/code_list.php).
80You can also use the values zh-Hans for simplified Chinese and zh-Hant for traditional Chinese.
81There isn't a default value.
82
83**showtitle** - *y* or *n* (show video title?)
84The default value for this parameter is 'y'.
85
86**showdate** - *y* or *n* (show date added to YouTube?)
87The default value for this parameter is 'y'.
88
89**showuser** - *y* or *n* (show user byline?)
90The default value for this parameter is 'y'.
91
92**showcount** - *y* or *n* (show views?)
93The default value for this parameter is 'y'.
94
95Here's some samples:
96
97*[tubematic type='uploads' query='seostrategy' limit='3' spanrow='2' showuser='n']*
98
99*[tubematic type='category' query='seo strategy' limit='3' showuser='n' orderby='published']*
100
101*[tubematic type='searchfeed' keys='google maps' limit='5']*
102
103= Plug-in Customization =
104
105Edit the config.php script file to customize the plugin (i.e. translate labels, change date format).
106
107= I love your plugin! Can I donate to you? =
108
109Sure! I do this in my free time and I appreciate all donations that I get. It makes me want to continue to update this plugin. You can find more details on [my donate page](http://www.griido.it/donazione/).
110
111**Also appreciated** a valuable backlink (thematic and PR>=3) to our Griido.it magazine. To share details, please email us to redazione@griido.it.
112
113== ChangeLog ==
114
115**Version 1.0.0**
116
117* Initial release.
118
119[Plugin Homepage](http://www.griido.it/tubematic-plugin-wordpress/ "Plugin Homepage")
Note: See TracBrowser for help on using the repository browser.