WordPress.org
Get WordPress

Plugin Directory

Changeset 390627


Ignore:
Timestamp:
05/29/2011 11:54:57 PM (15 years ago)
Author:
scibuff
Message:

wordpress connect 2.0

Location:
wordpress-connect/trunk
Files:
2 deleted
7 edited

Legend:

Unmodified
Added
Removed

  • wordpress-connect/trunk/readme.txt

    r373066 r390627  
    11=== Plugin Name ===
    2 Contributors: Tomas Vorobjov
     2Contributors: scibuff
    33Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=WFXMBAHD523VW
    4 Tags: Wordpress, Facebook, Social
    5 Requires at least: 2.8
    6 Tested up to: 3.0
    7 Stable tag: 1.09
    8 
    9 This plugin integrates the new Facebook Social Platform tools with Wordpress.
     4URL: http://wp-connect.tomasvorobjov.com
     5Tags: facebook, social, sharing, themes, widget, shortcode, template, tags
     6Requires at least: 3.0
     7Tested up to: 3.2
     8Stable tag: 2.0
     9
     10This plugin integrates the Facebook Social Plugins with Wordpress.
    1011
    1112== Description ==
    1213
    13 This plugin integrates the new Facebook Social Platform tools with Wordpress
    14 
    15 It provides the Social Plugins as fully customizable Wordpress Widgets, including:
     14If you would like to increase the exposure of your blog WordPress Connect
     15it the perfect plugin for you. It comes with a unique set of tools through
     16which you can reach the largest social networking community on the planet
     17that would engage and then share and discuss your content. It will enable
     18you to build up a fan base and to connect with a wider and a more relevant
     19audience. Now your blog readers with a Facebook account can post comments,
     20create discussions and like your posts and pages.
     21
     22The plugin integrates Facebook Social plugins with WordPress. It provides
     23tools to add the Facebook Like Button and Facebook Comments automatically
     24to every post and page. Of course, the user has a full control over settings
     25such as width, font, color scheme, etc.
     26
     27Wordpress Connect also provides fully customizable Wordpress Widgets for the
     28following Facebook Social Plugins
    1629
    1730* Activity Widget
    18 * Comments Widget (XFBML only)
    19 * Facepile Widget (XFBML only)
     31* Comments Widget
     32* Facepile Widget
    2033* Like Box Widget
    2134* Like Button Widget
    2235* Live Stream Widget
    23 * Login Widget (XFBML only)
     36* Login Widget
    2437* Recommendation Widget
    25 
    26 The widgets can be added to your blog just as easy as any other Wordpress Widget,
    27 i.e. through the widgets page (under Appearance on your Dashboard).
    28 
    29 Apart from the widgets, the plugin also delivers Facebook Comments and the Like Button
    30 to individual posts. Now anyone with Facebook account can post comments on your blog
    31 and like your posts.
    32 
    33 Whenever available (as per the Facebook implementation), the user can choose from two
    34 rendering options: to either render the modules in an iframe or using the Facebook
    35 Javascript API.
     38* Send Button Widget
     39
     40The widgets can be added to your blog just as easy as any other Wordpress
     41Widget, i.e. through the widgets page (under Appearance on your Dashboard).
     42
     43Since 2.0, all Wordpress Connect widgets are rendered in the XFBML mode (i.e
     44no iframes) to provide full functionality the iframe versions may lack.
     45
     46A big addition since 2.0 is a simple yet powerful [API](http://wp-connect.tomasvorobjov.com/api/ "WordPress Connect API")
     47for plugin and theme developers who can now specify default settings for Wordpress
     48Connect to reflect the needs of their plugin/theme. The API provides an easy
     49way to include any widget (such as the Like Button of Comments) anywhere in
     50the theme, e.g. to add the Like Button to the header or Comments to the
     51footer.
    3652
    3753**Requirements**
    3854
    3955* PHP 5.2.0 or newer
    40 * WordPress 2.8 or newer
     56* WordPress 3.0 or newer
    4157
    4258== Installation ==
    … …  
    44601. Upload the plugin files to your `/wp-content/plugins/` directory
    45612. Activate the plugin through the 'Plugins' menu in WordPress
    46 3. Go to the "Connect" settings (via you administration dashboard) and set
     623. Go to the "WP Connect" settings (via you administration dashboard) and set
    4763   the value for Application ID (there is a link to a Facebook page where
    4864   you can create those).
    … …  
    5066== Frequently Asked Questions ==
    5167
    52 = What is the API Key and Application ID for? =
    53 
    54 Many of the Facebook Social Plugins are available to be rendered in iframes, however,
    55 some (Comments, Facepile and Login) can be added to websites only via the Facebook
    56 Platform Javascript API. The Javascript API require a unique application key and ID
    57 to work. Technically, you don't need to fill-in those fields, however the widgets
    58 provided by this plugin will work only in the "iframe" mode (iframe type in the widget
    59 settings).
    60 
    61 Although mostly there is no difference between the two rendering modes (iframe/xfbml),
    62 the xfbml rendering mode offers additional functionality not available through iframes.
    63 
    64 = Can I enable both the Comments Module and the Like Button? =
    65 
    66 No. An equivalent of the Like Button is already a part of the Comments Module.
    67 Furthermore the Comments and the Like Button module do not seem to co-exist on the same
    68 page without conflicts. Therefore, enabling Comments (for blog posts) will automatically
    69 remove the Like Button (a warning message appears on the Like Button Settings Page whenever
    70 the Comments are enabled)
     68Below are asnwers to most common questions. If you have a question which is not
     69answered here, please ask your question on the [support forums](http://wordpress.org/tags/wordpress-connect/ "WordPress Connect Support Forums").
     70I monitor those and will try to answer as soon as possible.
     71
     72= How does it work =
     73
     74Using Wordpress Connect is very easy. Simply install and activate the plugin.
     75The default settings will ensure that you can start benefiting from the
     76features of Wordpress Connect right away. By default, Like Buttons will appear
     77at the top of all posts and pages (just before the content) and Comments will
     78appear at the bottom of your posts and pages (right after the content). All
     79widgets are pre-configured with Facebook default values and are available from
     80the Widgets Menu for an immediately use.
     81
     82= I have upgraded to 2.0 and some/all of my previous settings are gone =
     83
     84Version 2.0 of WordPress connect offers greatly extended functionality, more
     85features and more control over the social plugins. Unfortunately, as a direct
     86consequence, a few settings from previous version(s) are incompatible and will
     87need to be entered as again via the settings pages.
     88
     89Furthermore, Facebook has rolled out many new features in March 2011 and
     90consequently the format and xfbml markup of some of their social plugins has
     91changed. New options on WordPress Connect setting pages reflect these changes,
     92but unfortunately, it was not possible to keep every single setting from
     93previous versions.
     94
     95If you notice any unexpected behavior, please double check the values set
     96on the WordPress Connect settings (available through your administratior
     97dashboard). Additionally, please consult the [documentation pages](http://wp-connect.tomasvorobjov.com/docs/ "Wordpress Connect Documentation").
     98
     99= Cannot access comments moderation =
     100
     101After adding the comments plugin to your blog and creating a new [Facebook Application](http://developers.facebook.com/setup/)
     102clicking on "Settings" on the comments box displays the following error:
     103> Cannot edit global settings or moderation mode without fb:app_id
     104
     105To solve this problem, you will need to add the domain of your blog
     106to the Facebook Applpication settings:
     107
     1081. Go to [My Apps](http://www.facebook.com/developers/apps.php "My Apps on Facebook")
     1092. Select the application your created for your blog/site (from the list of applications on the left side)
     1103. Click on 'Edit Settings' in the list of links on the right side (next to application details)
     1114. Click on 'Web Site' (the second link from the top)
     1125. Fill in the 'Site Domain' field. If your blog is at http://www.myblog.com enter just 'myblog.com'
     1136. After clicking on 'Save Changes' and reloading the page with the comments on it, you should be able to access the moderation settings
     114
     115Please visit the [FAQ pages](http://wp-connect.tomasvorobjov.com/faq/#comments-moderation-access "WordPress Connect FAQ")
     116for a more detailed walk-through of the process described above (including screenshots)
     117
     118= What is the Application ID for? =
     119
     120The Facebook Javascript API require a unique application ID to work. A new
     121ID can easiliy be created by registering your site/blog at
     122http://developers.facebook.com/setup/
     123
     124= How do I change the position of the Like Button/Comments? =
     125
     126The default position of the Like Button and Comments can be changed from the
     127WP Connect options pages accessible through the dashboard. If you would
     128like to change the position of the Like Button of Comments in a particular
     129post or page, simply go to edit the post/page and select the new position
     130from the Like Button and Comments position drop-downs (or the right-hand side,
     131in the "Wordpress Connect" module).
     132
     133For more details about customizing the position and the settings of individual
     134Like Buttons and Comments see the [documentation page](http://wp-connect.tomasvorobjov.com/docs/ "WordPress Connect Documentation")
     135and [FAQ pages](http://wp-connect.tomasvorobjov.com/faq/ "WordPress Connect FAQ").
    71136
    72137= Do the widgets work with WP Super Cache and other caching plugins? =
    73138
    74 Yes, the content in all widgets will update every time a user visits your site regardless
    75 of the rendering mode (iframe/xfbml), even if the page (in which the widgets are embedded)
    76 remains unchanged. This is because Facebook delivers content to widgets either via iframes
    77 or via asynchronous Javascript calls (xfbml), i.e. content is requested with every
    78 page load.
     139Yes, the content in all widgets will update every time a user visits your site,
     140even if the page (in which the widgets are embedded) remains unchanged.
     141This is because Facebook delivers content to widgets either via asynchronous
     142Javascript calls (xfbml), i.e. content is requested after every page load.
     143
     144= The widgets I place in my sidebar are cut-off =
     145
     146Some Facebook Social Plugins have a minimum width below which they will not
     147resize any further (but the will rather get cut-off). For example,
     148the comments box needs to be at least 400px wide. If the container into which
     149you are placing the widget is not wide enough, the content of the widget will
     150not display properly. The usual sidebar that comes with most themes is too
     151narrow for widgets such as the comments box. The only solution is to place the
     152widget into a widget area that is wide enough, such as the 'Footer Widget
     153Area' of the defeault twenty ten theme.
    79154
    80155= The plugin doesn't work in my favorite theme =
    81156
    82 If the plugin doesn't work in one theme but does in others, the most likely reason is
    83 that the theme itself doesn't implement Wordpress hooks properly. For everything to work
    84 correctly, the plugin needs to add code into the html head tag (wordpress header) and
    85 the footer of the blog pages. It uses wordpress hooks (add_action and add_filter calls)
    86 for this purpose. If the theme author has not included the common wordpress hooks into the
     157If the plugin doesn't work in one theme but does in others, the most
     158likely reason is that the theme itself doesn't implement Wordpress hooks
     159properly. For everything to work correctly, the plugin needs to add code into
     160the html head tag (wordpress header) and the footer of the blog pages.
     161It uses wordpress hooks (`add_action` and `add_filter`) for this purpose.
     162If the theme author has not included the common wordpress hooks into the
    87163theme, required code cannot be added into the pages.
    88164
    89 You should contact the theme author and ask him/her to implement the wp_head and wp_footer
    90 action calls correctly. 
     165You should contact the theme author and ask him/her to implement the
     166wp_head and wp_footer action calls correctly. 
    91167
    92168= I updated the plugin to the latest version but don't see the changes =
    93169
    94 If you are using any caching solution, such as WP Cache or WP Supercache, you'll need to reset the cache,
    95 i.e. to delete the cached pages. This is necessary so that the xfbml and iframe markup values can be updated.
    96 
    97 = Plugins Info =
     170If you are using any caching solution, such as WP Cache or WP Supercache,
     171you'll need to reset the cache, i.e. to delete the cached pages. This is
     172necessary so that the xfbml markup values can be updated.
     173
     174= Facebook Social Plugins Info =
    98175
    99176More information about the plugins can be found back on Facebook at
    100177http://developers.facebook.com/docs/reference/plugins/
    101178
     179= I set an image as the feature image but it doesn't show on Facebook =
     180
     181The theme you are using must support `post-thumbnails` for this particular
     182feature to work.
     183
     184= FAQ =
     185
     186See the [FAQ pages](http://wp-connect.tomasvorobjov.com/faq/ "WordPress Connect FAQ")
     187for more info and details about Wordpress Connect Plugin
     188
    102189== Screenshots ==
    103190
    104 1. Wordpress Connect Widgets
    105 2. Wordpress Connect Widgets Settings
    106 3. Wordpress Connect (global)
    107 4. The Like Button Settings
    108 5. New Comments Module Settings (enabling users to select on which pages
    109    will the comments appear)
    110 6. New Comments Module Settings (enabling users to force the module to
    111    a new line)
     1911. Settings page - General plugin settings: The Application ID and Application Admins field will need to have proper values filled in. Here, the Image URL is set to the logo of the [WordPress Connect Facebook Page](http://www.facebook.com/pages/Wordpress-Connect/203079109734244) to demo how to option appears when a valid image URL is saved - note that you can use the URL of any image you upload to your WordPress blog (simply copy and paste the url).
     192
     1932. WordPress Connect in action - The Like Button and Comments are displayed using the default options (set when the WordPress Connect plugin is activated or updated from a previous version). Here the Like Button is shown immediately  after the post (article) title (the position is set to `Top` by default) and the Comments box is at the end after the post's content (the position is set to `Bottom` by default).
     194   
     1953. Using WordPress shortcodes to customize the Like Button and Comments - The Like Button and the Comments positions are set to `Custom`. Setting the position value to `Custom` prevents the plugin from automatically adding the Like Button and Comments in their usual place; the shortcodes will be replaced with the appropriate HTML markup even if the position is set to `Top` or `Bottom` but in that case another Like Button and/or Comments would appear at that position within the post). Leaving the `href` options empty will automatically use the permalink of the current post (or page) when the Like Button and/or Comments are rendered. The colorscheme value is set to `dark`. Also notice, that the `href` option of the second Like Button (at the end of the post) is set to a completely different URL (nhl.com). Theoretically, you can add as many Like Buttons (and even Comments) into a single post as you would like.
     196 
     1974. Custom Like Buttons and Comment box (based on the values set in screenshot 3)
     198   rendered from shortcodes. The top button links to the current post/page but
     199   the bottom button is a for a different page hosted on a completely
     200   different domain.
     201
     2025. Admin Dashboard - Widgets: WordPress Connect provides WordPress Widget
     203   for every single of the Facebook Social Plugins. Simply drag-n-drop a
     204   widget in one of the widget areas and set the appropriate options (or
     205   leave in the defaults).
     206
     2076. Widgets: Send Button and Comments in the footer widgets area (content's
     208   height is shrunk to fit in the footer for a better demo view)
     209
    112210   
    113211== ChangeLog ==
     212= 2.00 =
     213* API for plugin and theme developers
     214    * template tags
     215    * hooks
     216* New settings pages with more options
     217* Greater control and flexibility
     218* New widgets with additional customization options
     219* Shortcodes for placing the Like Button and Comments anywhere within
     220  the body of your posts/pages
     221* Editor buttons (WYSIWYG) for Like Button and Comments
     222* Ability to disable/enable and reposition the Like Button and Comments for
     223  individual posts and pages
     224* Light and dark colorscheme
     225* Automated description meta tag based on the currently display page (home,
     226  category, tag, search, single, etc)
     227* Ability to set the share image (the og:image meta tag) to the featured image
     228  of the post/page - The image must still be at least 50px by 50px and have a
     229  maximum aspect ratio of 3:1 (if the image does not fulfill the requirements,
     230  the default image will be used instead)
     231* New documentation and support pages
     232* Improved [FAQ](http://wp-connect.tomasvorobjov.com/faq/ "WordPress Connect FAQ")
     233  and [Support](http://wordpress.org/tags/wordpress-connect "WordPress Connect Support") (professional support available on request)
     234* Thorough API [documentation](http://wp-connect.tomasvorobjov.com/api/ "Wordpress Connect API").
     235* Professional Support available
     236
    114237= 1.09 =
    115238* Added a like button to the comments box (iframe only for now)
    … …  
    141264 
    142265== Upgrade Notice ==
     266= 2.0 =
     267* The 2.0 version of Wordpress Connect brings the newest features of Facebook
     268  Social plugins such as light/dark theme for the comments box, threaded
     269  comments and many features requested from versions 1.x such as
     270  enabled/disable the like button or comments for indivual posts/pages,
     271  choosing the place within a particular post/page where the FB plugins should
     272  appear (a completely custom location can be set so that the like box can
     273  appear in the middle of the post if that is desired), etc.
     274   
     275* This latest version provides API for plugin and theme developers to include
     276  facebook social plugins automatically within their theme/plugins.
    143277
    144278= 1.05 =
Note: See TracChangeset for help on using the changeset viewer.