ThumbsUp

From IThemes Codex
(Difference between revisions)
Jump to: navigation, search
(F.A.Q.)
 
Line 1: Line 1:
'''Release date:''' April 21, 2011 (stable)
+
__NOTOC__
  
== Description ==
+
[[File:Thumbsup300.png|Thumbsup300.png|300px|link=|right]]
  
 
ThumbsUp is a commercial WordPress plugin that allows users to up/down vote a group of items.  ThumbsUp can be displayed on a post, page, widget area, or manually via a template tag.
 
ThumbsUp is a commercial WordPress plugin that allows users to up/down vote a group of items.  ThumbsUp can be displayed on a post, page, widget area, or manually via a template tag.
  
[[File:Thumbsup_black.png]]
+
<div class="exchange-home-list">
 +
==Server Requirements and Recommendations== __NOEDITSECTION__
 +
*[[Server_Requirements_and_Recommendations_Overview|Overview]]
 +
*[[Server_Requirements_and_Recommendations|Server Requirements and Recommendations]]
 +
</div>
  
== Server Requirements & Recommendations ==
+
<div class="exchange-home-list">
 +
==Shortcode== __NOEDITSECTION__
 +
*[[ThumbsUp_Shortcode_Attributes|Shortcode Attributes]]
 +
</div>
  
Server configuration is a very complex topic and varies wildly between hosts, server operating systems, and even the personal preference of the server administrator. Below are the bare minimum requirements for the plugin along with the recommended setup to get the most out of this plugin. You may use [[ServerBuddy]] to help you determine how your server compares to our minimum requirements & recommendations.
+
<div class="exchange-home-list">
 +
==Advanced== __NOEDITSECTION__
 +
*[[ThumbsUp_Template_Tag|Template Tag]]
 +
*[[ThumbsUp_Advanced_CSS_Override|Advanced CSS Override]]
 +
</div>
  
===Server Requirements & Recommendations===
+
<div class="exchange-home-list">
''Requirements for functionality:''
+
==Additional Resources== __NOEDITSECTION__
* PHP 5.2+
+
*[http://ithemes.com/purchase/backupbuddy/ Purchase BackupBuddy]
** [http://wordpress.org/news/2010/07/eol-for-php4-and-mysql4/ WordPress v3.2 will require PHP 5.2+ (early 2011)]
+
*[http://ithemes.com/tutorials/ iThemes Tutorials]
* mySQL 4.x+
+
*[http://ithemes.com/ iThemes.com]
** [http://wordpress.org/news/2010/07/eol-for-php4-and-mysql4/ WordPress v3.2 will require mySQL 5.0.15+ (early 2011)]
+
*[http://ithemes.com/forum/ Support Forums]
* WordPress 3.0+
+
</div>
  
==Shortcode Attributes==
+
<br />
 
+
[[:Plugins|← Back to Plugin Codex Home]]
'''Shortcode Attributes for [thumbsup]'''
+
 
+
* show_stats - Whether to show the stats or not (default 1)
+
* group_id  - The ID of the voting group you would like to display.
+
* thumb_width    - Default is 200. The Width dimension for displaying image thumbnails.
+
* thumb_height  - Default is 200. The Height dimension for displaying image thumbnails.
+
* video_max_height - Default is 300. The maximum height for an embedded video
+
* video_max_width - Default is 300. The maximum width for an embedded video
+
* show_item_title - Default is true. Whether to show the title for each item
+
* show_group_title - Default is true. Whether to display the title for the voting group
+
* show_group_desc - Default is false. Whether to display the description for the voting group
+
* show_image_caption - Default is false. Whether to display the caption for an image
+
* show_image_desc - Default is false. Whether to display the description for an image
+
* orderby - Default is 'menu_order' - Which parameter to order by (rating, date, menu_order, rand)
+
* order - Default is 'DESC'. The order to retrieve the items.
+
 
+
'''Example Shortcode for Videos'''
+
 
+
[thumbsup  group_id="2813" orderby="rating" order="DESC" show_group_title="1" show_group_desc="0" show_item_title="1" video_max_height="600" video_max_width="600" ]
+
 
+
'''Example Shortcode for Images'''
+
 
+
[thumbsup  group_id="2806" orderby="rand" order="ASC" show_group_title="1" show_group_desc="0" show_item_title="1" thumb_height="500" thumb_width="500" show_image_caption="1" show_image_desc="0" ]
+
 
+
'''Example Shortcode for Topics'''
+
 
+
[thumbsup  group_id="2818" orderby="rand" order="ASC" show_group_title="1" show_group_desc="0" show_item_title="1" ]
+
 
+
==Template Tag==
+
You can manually include a ThumbsUp item manually if you know the Voting Group ID.
+
 
+
The arguments are as follows:
+
<pre class="brush:php">
+
/**
+
* pb_thumbsup_display()
+
* Insert a voting group
+
*
+
*
+
* The defaults for the parameter $args are:
+
* is_widget - If the code is being executed in a widget area (shrinks down the icon size) (default false)
+
* show_stats - Whether to show the stats or not (default true)
+
* group_id  - The ID of the voting group you would like to display.
+
* thumb_width    - Default is 200. The Width dimension for displaying image thumbnails.
+
* thumb_height  - Default is 200. The Height dimension for displaying image thumbnails.
+
* video_max_height - Default is 300. The maximum height for an embedded video
+
* video_max_width - Default is 300. The maximum width for an embedded video
+
* show_item_title - Default is true. Whether to show the title for each item
+
* show_group_title - Default is true. Whether to display the title for the voting group
+
* show_group_desc - Default is false. Whether to display the description for the voting group
+
* show_image_caption - Default is false. Whether to display the caption for an image
+
* show_image_desc - Default is false. Whether to display the description for an image
+
* orderby - Default is 'menu_order' - Which parameter to order by (rating, date, menu_order, rand)
+
* order - Default is 'DESC'. The order to retrieve the items.
+
*
+
* @uses $wpdb
+
*
+
* @param array $args Elements that make up a voting group to insert.
+
* @return int|WP_Error WP_Error on failure.  HTML string on success.
+
*/
+
</pre>
+
 
+
The following shows how to use the '''pb_thumbsup_display''' template tag to show a voting group of images.
+
 
+
<pre class="brush:php">
+
<?php
+
$args = array(
+
'group_id' => 2806,
+
'thumb_width' => 500,
+
'thumb_height' => 500,
+
'show_item_title' => false,
+
'show_image_caption' => true,
+
'show_group_title' => false,
+
'orderby' => 'rating',
+
'order' => 'DESC'
+
);
+
$display = pb_thumbsup_display( $args );
+
if ( !is_wp_error( $display ) ) echo $display;
+
?>
+
</pre>
+
 
+
==Videos and Tutorials==
+
 
+
For detailed videos and tutorials, please visit our [http://pluginbuddy.com/purchase/thumbsup/ ThumbsUp page].
+
 
+
==F.A.Q.==
+
'''What features are planned for future versions?'''
+
 
+
 
+
* Allow users to submit their own topics and set up a moderation system so the admin can approve them.
+
* Allow an option to show only the top rated voting group items (e.g., the top 10).
+
* More thumbs-up icon sets and style options.
+
* Allow votes from only logged-in users.
+
* Hide stats
+
* Do ThumbsUp or ThumbsDown only
+
 
+
==Advanced CSS Override==
+
 
+
Advanced users may want to disable the ThumbsUp CSS to better integrate the plugin into their theme.
+
 
+
The plugin's CSS may be disabled in the ThumbsUp settings page in the WordPress admin area.
+
 
+
Listed below is the structure for displaying the ThumbsUp Items.
+
 
+
<pre class='brush:php'>
+
div.pb_thumbsup_container /* or div.pb_thumbsup_widget_container for widgets */
+
div.pb_thumbsup_item
+
    div.pb_thumbsup_media
+
        /* MEDIA GOES HERE */
+
        /* end div.pb_thumbsup_media */
+
        div.pb_thumbsup_vote
+
        div.pb_thumbsup_vote_icons, div.pb_thumbsup_light /* Can also be  div.pb_thumbsup_dark */
+
            a.pb_thumbsup_icon, a.pb_thumbsup_selected /* .pb_thumbsup_selected is present if the icon has been selected */
+
                a.pb_thumbsdown_icon, a.pb_thumbsdown_selected /* .pb_thumbsdown_selected is present if the icon has been selected */
+
div.pb_thumbsup_vote_stats, div.pb_thumbsup_display_stats
+
                span.plus
+
                    span.minus
+
/* end div.pb_thumbsup_vote_stats */
+
/* end div.pb_thumbsup_vote_icons */
+
div.pb_thumbsup_loading_gif
+
            /* end div.pb_thumbsup_loading_gif */
+
/* end div.thumbsup_vote */
+
/* end div.pb_thumbsup_item */
+
   
+
    /* MORE ITEMS */
+
   
+
/* end div.pb_thumbsup_container */
+
             
+
</pre>
+
==Additional Resources==
+
# [http://pluginbuddy.com/purchase/backupbuddy/ Purchase BackupBuddy]
+
 
+
# [http://pluginbuddy.com/tutorials/ PluginBuddy Tutorials]
+
# [http://pluginbuddy.com/ PluginBuddy.com]
+
# [http://pluginbuddy.com/support/ Support Forums]
+
 
+
[[Category:PluginBuddy]]
+

Latest revision as of 18:09, July 19, 2013


Thumbsup300.png

ThumbsUp is a commercial WordPress plugin that allows users to up/down vote a group of items. ThumbsUp can be displayed on a post, page, widget area, or manually via a template tag.

Server Requirements and Recommendations


← Back to Plugin Codex Home

Personal tools
Namespaces
Variants
Actions
iThemes Codex
Codex Navigation
Toolbox