Share-Me Plugin

Add a bar of icons to share a TWiki page on popular social media sites and bookmarking sites such as Digg, Facebook, StumbleUpon, Twitter.

Syntax Rules

Add %SHAREME% anywhere in a TWiki page or preferably in a TWiki skin:

Write this:	Renders as: (if installed)	Simulated example:
%SHAREME%

Optionally, a list of social media sites (defined below) can be specified, such as:
%SHAREME{"Delicious, Facebook, StumbleUpon, Twitter"}%.

Social Media Sites

This table defines the social media sites. The following variables can be used in the URL column:

• $link: Link of the TWiki topic
• $title: Spaced out topic name
• $summary: Topic summary
• $site: Site host name (www.twiki.org)

Name	Image	URL
Delicious		http://delicious.com/post?url=$link&title=$title&notes=$summary
Digg		http://digg.com/submit?phase=2&url=$link&title=$title&bodytext=$summary
E-mail		mailto:?subject=$title&body=$link
Facebook		http://www.facebook.com/share.php?u=$link&t=$title
FriendFeed		http://www.friendfeed.com/share?title=$title&link=$link
Google Bookmarks		http://www.google.com/bookmarks/mark?op=edit&bkmk=$link&title=$title&annotation=$summary
LinkedIn		http://www.linkedin.com/shareArticle?mini=true&url=$link&title=$title&source=$site&summary=$summary
Live		https://favorites.live.com/quickadd.aspx?marklet=1&url=$link&title=$title
MisterWong		http://www.mister-wong.com/addurl/?bm_url=$link&bm_description=$title&plugin=soc
Mixx		http://www.mixx.com/submit?page_url=$link&title=$title
NewsVine		http://www.newsvine.com/_tools/seed&save?u=$link&h=$title
Ping.fm		http://ping.fm/ref/?link=$link&title=$title&body=$summary
Posterous		http://posterous.com/share?linkto=$link&title=$title&selection=$summary
Reddit		http://reddit.com/submit?url=$link&title=$title
RSS		http://www.twiki.org/cgi-bin/view/TWiki05x00/WebRss
Simpy		http://www.simpy.com/simpy/LinkAdd.do?href=$link&title=$title
Slashdot		http://slashdot.org/bookmark.pl?title=$title&url=$link
StumbleUpon		http://www.stumbleupon.com/submit?url=$link&title=$title
Technorati		http://technorati.com/faves?add=$link
Twitter		http://twitter.com/home?status=$title%20-%20$link
Yahoo! Bookmarks		http://bookmarks.yahoo.com/toolbar/savebm?u=$link&t=$title&opener=bm&ei=UTF-8&d=$summary
Yahoo! Buzz		http://buzz.yahoo.com/submit/?submitUrl=$link&submitHeadline=$title&submitSummary=$summary&submitCategory=science&submitAssetType=text

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, such as %SHAREMEPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Icon bar to share TWiki pages on popular social media sites such as Facebook, StumbleUpon, Twitter

• Topic that defines the social media sites: (default: This topic)
  • Set SITEDEFINITIONS = ShareMePlugin

• Default site icons shown in %SHAREME%, subset of the ones defined in the Social Media Sites section:
  • Set DEFAULTSITES = Twitter, Delicious, Digg, Facebook, Google Bookmarks, LinkedIn, Reddit, StumbleUpon

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

• Download the ZIP file from the Plugin Home (see below)
• Unzip ShareMePlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/ShareMePlugin.txt	Plugin topic
  data/TWiki/ShareMePlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/ShareMePlugin.pm	Plugin Perl module
  pub/TWiki/ShareMePlugin/*.png	16x16 pixel icons of social networking sites

• Configure the Plugin:
  • TWiki 4.0 and up: Run the configure script to enable the Plugin
  • Overload the plugin settings as needed. Do not change the plugin page, but create settings in the TWikiPreferences page. For example, to overload the DEFAULTSITES setting, create a SHAREMEPLUGIN_DEFAULTSITES in the TWikiPreferences page.
• Test if the installation was successful:

Plugin Info

Plugin Author:	TWiki:Main/PeterThoeny, Twiki, Inc.
Copyright:	© 2010, TWiki:Main/PeterThoeny
License:	GPL (GNU General Public License)
Plugin Version:	2010-06-06 (18930)
Change History:
2010-06-06:	XHTML validation fixes; moving CSS to HTML head using TWiki::Func::addToHEAD
2010-01-16:	Doc fixes
2010-01-09:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.1
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.008
Benchmarks:	GoodStyle 99%, FormattedSearch 100%, ShareMePlugin 100%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/ShareMePlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/ShareMePluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/ShareMePluginAppraisal

This plugin is inspired by Sociable plugin for WordPress. Some GPLed icons have been taken from that plugin.

Related Topics: VarSHAREME, TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- TWiki:Main/PeterThoeny - 2010-06-06