Social Bookmarking Plugin

Added by Shannon Krebs, last edited by Shannon Krebs on May 25, 2008  (view change) show comment
Name Social Bookmarking Plugin
Vendor Atlassian Software Systems (Website)
Authors Shannon Krebs, Jonathan Nolen, Richard Wallace, Don Willis, David Chui
Homepage http://confluence.atlassian.com/display/CONFEXT/Social+Bookmarking+Plugin
Issue Management http://developer.atlassian.com/jira/browse/MARK
Categories Content Macros
Version 1.2
Availability Confluence v2.7 to v2.9-m2-r2
State Stable
Support Atlassian Supported Plugins
License Freeware / Open Source (BSD)
Price Free
Release Docs http://confluence.atlassian.com/display/CONFEXT/Social+Bookmarking+Plugin
Java API Docs n/a
Download Source http://svn.atlassian.com/svn/public/contrib/confluence/socialbookmarking-plugin/tags/1.2/
Download JAR socialbookmarking-1.2.jar
Social Bookmarking Plugin

This plugin provides social bookmarking functionality allowing users to create and share bookmarks in a Confluence instance.

Public Confluence Installations

Prior to the 1.2 release this plugin allows users to add new content but didn't support global CAPTCHA settings. Therefore releases prior to 1.2 are not recommended for use in public Confluence installations where anonymous users (or public signups) are allowed to prevent spam bookmarks.

Atlassian Support

Bundled versions of this plugin are supported by Atlassian, refer to the compatibility matrix below for support on version that are not bundled.

Compatibility With Confluence

Plugin Version 2.4.5 2.5.8 2.6.2 2.7.3 2.8.0 Tested
1.0.3     David Chui (Oct/19/2007)
1.0.7     David Chui (Dec/19/2007)
1.0.8     David Chui (Jan/25/2008)
1.0.9       David Chui (Feb/4/2008)
1.1.3     David Chui (Apr/15/2008)
1.1.4     David Chui (May/13/2008)
1.2            

Installation

The plugin can be installed from the Confluence Plugin Repository or you can download the jar file for manual install from here: http://svn.atlassian.com/svn/public/contrib/confluence/socialbookmarking/jars/

Pre Confluence 2.8 the add bookmark link on the space actions section is disabled by default as it can make some themes look a bit bunched up. If you enable this component you will get a link like this:

Since Confluence 2.8 has moved to a menu structure this web item is now enabled by default (Plugin version 1.1.3).

Uninstall

If you are removing this plugin you will have to manually remove all of the bookmarks that have been created.

(Since all of the bookmarks in a space will be children of a page called .bookmarks it might be easiest to create a temporary space and use the move page functionality to move the entire bookmarks tree to that space, then delete the space, rather then delete each bookmark page individually. CONF-5974 and CONF-5368 would make this process easier. )

Usage

Below is an overview of the plugin usage. In addition, the Confluence User Guide provides the following detailed instructions:

Creating and Editing a Bookmark

Once the plugin has been installed there should be an option under the space add content menu to add a bookmark. This will display a screen you can use to enter the bookmark details. The title, url and space are required, you can also enter a description for the bookmark or add some labels. A link to edit a bookmark is available from the bookmark view or from a list of bookmarks (if you have permission).

On the Bookmarks browse space menu there is also a bookmarklet that can be used to make creating a bookmark in the confluence install easy when you a browsing another page.

To label a bookmark as being for another space you need to give it the label for<spacekey>. For personal spaces, use _for~<username>_ e.g. for~jsmith_. This will cause the label to show on the Links for <space name> tab of the other space's Bookmarks page.

Bookmarks are stored as pages within confluence. The first time a bookmark is created in a space a page called .bookmarks will be created. All of the bookmarks in that space will be stored as child pages of this page. You should avoid moving or editing the bookmark pages through the normal page interfaces if possible as you might break something.

Viewing bookmarks

The latest bookmarks in a space can be viewed through the browse space Bookmarks menu. Here you can also view the bookmarks that have been labeled as for this space.

You can also subscribe to an RSS feed for bookmarks created in a space, or for bookmarks labelled for a particular space.

Bookmarks can also be included in any page by using the {bookmarks} macro.

Bookmarks Macro

This macro displays a list of bookmarks using the search criteria supplied.
Searching Options

  • spaces comma separated list of spaces to search for. Meta space names @all, @personal, @global can also be used. If no labels and spaces are supplied will default to current space.)
  • labels list of labels that are applied to the bookmarks. If multiple labels are specified bookmarks only have to match one label to be included.
  • creators comma separated list of users that have created bookmarks.

Criteria within each search category (spaces, labels, creators) are OR'd while the matches are AND'd between the different categories.

Sorting Options

  • sort comma separated list of attributes to sort the bookmarks by. Valid values are:
    • creation Bookmark Created Date
    • creator Bookmark Author Name
    • title Bookmark title
      Default is just sorting by created date. (Since it is unlikely that two bookmarks will be created at the same time, supplying extra sort parameters after the date param will normally have no effect.)
  • reverseSort Reverse the order of the bookmarks. Default is false.

Display Options

  • showAuthor The user that created the bookmark.
  • showDate The relative date the bookmark was created.
  • showDescription The bookmark description
  • showEditLinks If the current user has permission, show quick links to edit or remove the bookmark.
  • showLabels The labels for the bookmark
  • showListHeader The bookmark list header (with the rss feed link).
  • max The maximum number of bookmarks to display. Defaults to 15.
  • showSpace The space the bookmark is saved in
  • showViewLink A link to the actual bookmark page

Examples

{bookmarks}

Default macro will display bookmarks from the current space

Searching for Bookmarks

As the bookmark information is stored on Confluence pages you can search for the contents of bookmarks by using a normal search where the content type includes pages.

From the 1.1 release a new field has been added to the lucene index making it possible to search the contents of bookmarks only. To do this you will still need to search within the page content type, but adding bookmark:yes or bookmark:true to your search query will limit the search to pages which are bookmarks.

Issues

If you find any bugs or have suggestions for new features please create an issue in the Social Bookmarking Jira project.

Atlassian Developer Network JIRA (10 issues)
T Key Summary Assignee Reporter Pr Status Res Created Updated Due
Bug MARK-81 Space Bookmark page misaligned in 2.9-m5 David Chui Jonathan Nolen Minor Open UNRESOLVED Jul 02, 2008 Jul 02, 2008
Bug MARK-80 Layout issues with link underlines David Chui Jonathan Nolen Minor Open UNRESOLVED Jul 02, 2008 Jul 02, 2008
Bug MARK-79 Create Bookmarks page doesn't respect correct permissions David Chui Jonathan Nolen Critical Open UNRESOLVED Jul 01, 2008 Jul 01, 2008
New Feature MARK-70 Restrict bookmark creation in spaces Shannon Krebs oren teich Major Open UNRESOLVED Apr 09, 2008 Jun 10, 2008
Improvement MARK-57 Use velocity macros for bookmark add/update action errors Shannon Krebs Shannon Krebs Minor Open UNRESOLVED Mar 09, 2008 May 25, 2008
New Feature MARK-54 Add ability to vote bookmarks up or down Shannon Krebs Daniel A. Munz Major Open UNRESOLVED Jan 25, 2008 Jan 25, 2008
Improvement MARK-47 Bookmarks plugin to use CSS classes for styles Shannon Krebs Roberto Dominguez Major Open UNRESOLVED Nov 26, 2007 Apr 07, 2008
Improvement MARK-43 Ability to change the wording of the 'bookmark in confluence" link and text Shannon Krebs Paul Carruthers Major Open UNRESOLVED Sep 27, 2007 Sep 27, 2007
Improvement MARK-39 Labels should be ORed or ANDed Shannon Krebs Sébastien Pouillet Critical Open UNRESOLVED Aug 30, 2007 Aug 30, 2007
Improvement MARK-16 Add an option to display the full description or the excerpt in the bookmark list mode Unassigned Shannon Krebs Minor Open UNRESOLVED May 11, 2007 May 29, 2007

Plugin Versions

Version Date State License Price
Show description 1.2 (#300) 25 May 2008 Stable Freeware / Open Source (BSD) Free

Release Notes

This plugin provides social bookmarking functionality allowing users to create and share bookmarks in a Confluence instance.

The 1.2 release adds standard Confluence CAPTCHA functionality to the Social Bookmarking Plugin.

Contributors

  • Shannon Krebs — Developer

Show description 1.1.4 (#204) 13 May 2008 Stable Freeware / Open Source (BSD) Free

Release Notes

Internationalization fixes.

  • [MARK-73] - Internationalized the notiation guide.
  • [MARK-72] - Corrected message displayed in the parent bookmark page (.bookmark).

Contributors

  • David Chui — Developer

Show description 1.1.3 (#203) 27 Mar 2008 Stable Freeware / Open Source (BSD) Free

Release Notes

Fixes compatibility problems with Confluence 2.8.

  • [MARK-66] - Labels field in bookmark create and edit stopped working in Confluence 2.8-m9-r3
  • [MARK-63] - Rename 'Add Bookmark' link on Add menu to 'Bookmark' and place it in 'add-to-space' section in Confluence 2.8

Contributors

  • David Chui — Developer
  • Shannon Krebs — Developer

Show description 1.1.1 (#201) 11 Mar 2008 Stable Freeware / Open Source (BSD) Free

Release Notes

Fixes some bugs and a compatibility problem with Confluence 2.8.

  • [MARK-42] - Notifications for bookmark pages have NullPointerException for bookmark macro
  • [MARK-58] - Description field in bookmark edit page not internationalized
  • [MARK-60] - XSS vulnerability in updatebookmark.action
  • [MARK-61] - Replace BookmarkCondition with use of Confluence conditions

Contributors

  • David Chui — Developer
  • Shannon Krebs — Developer

Show description 1.1 (#200) 08 Mar 2008 Stable Freeware / Open Source (BSD) Free

Release Notes

This plugin provides social bookmarking functionality allowing users to create and share bookmarks in a Confluence instance.

The 1.1 release is a feature release, the following features have been added:
  • [MARK-2] - add bookmark fields to search index
  • [MARK-3] - dynamic header and rss description text
  • [MARK-46] - Use absolute URLs for links in the content of the Social Bookmarking RSS feed items
The following bugs have also been fixed in this release:
  • [MARK-48] - Bookmark name field not internationalised when adding a bookmark
  • [MARK-49] - Browser bookmark title is too long and not useful
  • [MARK-56] - Cancelling on bookmark creation via the bookmarklet redirects to an invalid Confluence location.
http://developer.atlassian.com/jira/browse/MARK/fixforversion/10483

Contributors

  • David Chui — Developer
  • Shannon Krebs — Developer

Show description 1.0.9 (#109) 02 Feb 2008 Stable Freeware / Open Source (BSD) Free

Release Notes

This plugin provides social bookmarking functionality allowing users to create and share bookmarks in a Confluence instance.

The 1.0.9 release is bug fix release for the following issues:
  • [MARK-32] - Labelling for a personal space does not work when the user name contains an invalid label character
  • [MARK-53] - private labels are being displayed to all users on bookmarks
Due to the fix for displaying private labels, this is a recommended upgrade for all users.

Contributors

  • Shannon Krebs — Bug Fixer

Show description 1.0.8 (#108) 24 Jan 2008 Stable Freeware / Open Source (BSD) Free

Release Notes

This plugin provides social bookmarking functionality allowing users to create and share bookmarks in a Confluence instance.

The 1.0.8 release is bug fix release for the following issues:
  • [MARK-40] - Bookmark creation as Anonymous
  • [MARK-50] - Changing space of a bookmark gives error
  • [MARK-52] - Bookmarklet causes redirect to www.atlassian.com rather than original page

Contributors

  • Shannon Krebs — Bug Fixer

Show description 1.0.7 (#107) 14 Dec 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

This plugin provides social bookmarking functionality allowing users to create and share bookmarks in a Confluence instance.

The 1.0.7 release is a bug fix release for the following issues:
  • [MARK-51] - Bookmark feature bypasses request validation for space actions under some app servers.

Contributors

  • Don Willis — Bug Fixer

Show description 1.0.6 (#106) 24 Oct 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

This plugin provides social bookmarking functionality allowing users to create and share bookmarks in a Confluence instance.

The 1.0.6 release is a bug fix release for the following issues:
  • [MARK-44] - Bookmark feature not working in SSL encrypted page

Contributors

  • Richard Wallace — Developer

Show description 1.0.3 (#103) 05 Aug 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

This plugin provides social bookmarking functionality allowing users to create and share bookmarks in a Confluence instance.

The 1.0.3 release is a bug fix release for the following issues:
  • [MARK-34] - javascript bookmarklet links to localhost

Contributors

  • Shannon Krebs — Developer
  • Jonathan Nolen — Developer

Show description 1.0.2 (#102) 19 Jul 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

This plugin provides social bookmarking functionality allowing users to create and share bookmarks in a Confluence instance.

The 1.0.2 release is a bug fix release for the following issues:
  • [MARK-30] - Handle special characters in the title
  • [MARK-31] - Textual changes on 'Add Bookmark' page

Contributors

  • Shannon Krebs — Developer
  • Jonathan Nolen — Developer

Show description 1.0.1 (#101) 04 Jul 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

This plugin provides social bookmarking functionality allowing users to create and share bookmarks in a Confluence instance.

The 1.0.1 release is a bug fix release for the following issues:
  • [MARK-28] - problem with linking and clustering
  • [MARK-29] - Don't create pages in spaces with no bookmarks

Contributors

  • Shannon Krebs — Developer
  • Jonathan Nolen — Developer

Show description 1.0 (#100) 01 Jun 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

This plugin provides social bookmarking functionality allowing users to create and share bookmarks in a Confluence instance.

Contributors

  • Shannon Krebs — Developer
  • Jonathan Nolen — Developer

Show description 0.6 (#6) 31 May 2007 Beta Freeware / Open Source (BSD) Free

Release Notes

Beta release: Avoid use in a production system. Refer to the documentation page for more information about the current status.

Issues

  • [MARK-23] - Changing a bookmarks space doesn't remove it from the current space
  • [MARK-24] - image urls without $helper.getDomainName()
  • [MARK-25] - {bookmarks:labels=foo} renders to an empty string
  • [MARK-26] - update listener is throwing NPE
+ other minor UI updates that didn't make it into Jira Issues.

Thanks to Peter Teichman for providing patches to fix MARK-24 and MARK-25

Contributors

  • Shannon Krebs — Developer
  • Jonathan Nolen — Developer

Show description 0.5 (#5) 25 May 2007 Beta Freeware / Open Source (BSD) Free

Release Notes

Beta release: Avoid use in a production system. Refer to the documentation page for more information about the current status.

This release is not compatible with previous releases, you need to delete all bookmark pages before installing this version if upgrading.

Contributors

  • Shannon Krebs — Developer
  • Jonathan Nolen — Developer

Labels

 

Comments (35)

 

  1. Jun 10, 2007

    Jim Hanna says:

    Great addition to Confluence\! We've been wrestling with a variety of ways to ag...

    Great addition to Confluence! We've been wrestling with a variety of ways to aggregate bookmarks in our Confluence spaces, but all of the workarounds are too complicated to get consistent usage.  This is a great asset for anyone doing collaborative research and data gathering.  Thanks for working out such a great solution and including the javascript for the browser link!

  2. Jul 08, 2007

    Kevin King says:

    Hi has anyone else had trouble making links for other users? I have been unable ...

    Hi - has anyone else had trouble making links for other users? I have been unable to do so thus far. I have tried both "for_username" and "for_~username". Making links for other spaces has worked fine.

    Otherwise it's been a great addition to our site. Thanks!

    1. Jul 09, 2007

      Shannon Krebs says:

      Hi Kevin, for\username should work. (Atleast it does for me on a standalone ins...

      Hi Kevin,

      for_~username should work. (Atleast it does for me on a standalone install.) The doco does need to be clarified a bit about this... MARK-32

      This is probably a long shot, but is there anything else preventing the bookmark being displayed when you label it this way such as page permissions?

      1. Jul 09, 2007

        Kevin King says:

        Hi Shannon, Thanks for the response. I doubt it's permissions because the probl...

        Hi Shannon,

        Thanks for the response. I doubt it's permissions because the problem takes place in my personal space as well. For example, when I label a bookmark for my personal space (for_~kevinrking), I get this:

        The page you were trying to reach does not exist. You may want to try a search, or browse the site to find the page you were looking for.

        MARK-32 perfectly captures what's going on for me. I will cross-post this over there.

        We're running a Crowded Confluence version 2.5.3 if that helps.

  3. Jul 25, 2007

    N Waanders says:

    It would be nice to be able to set a "bookmarking allowed"permission for a speci...

    It would be nice to be able to set a "bookmarking allowed"permission for a specific space, or possibly set bookmarking as a space permission for users/groups in a space!

    1. Jul 25, 2007

      Shannon Krebs says:

      Adding a configuration option to the space admin to turn bookmarking on or off f...