Bookmarks Portlet

About Bookmarks portlet

Bookmarks portlet

This portlet allows users to add, edit, delete, export bookmarks to file and import existing bookmarks from a workstation. The bookmarks can be organized in folders. The user can create, edit, delete and re-order these folders. The user can use these bookmarks to access regularly visited websites. This portlet also provide the feature to bookmark WebSphere Portal pages and supports JSR 168 specification.

Back to top

Download Bookmarks portlet

Download the source code for the Bookmarks portlet from here.

Back to top

Bookmarks portlet screenshots

Edit Bookmark
Edit Bookmark - Select a language
Edit Bookmark - Use a selected langage
Edit Folder
Edit Folder - Select a language
Edit Folder - Use a selected langage
Delete Item

Back to top

Documents

How to build Bookmarks portlet?

  1. Download the source code of the Bookmarks portlet from here.
  2. Unzip the source code to a directory.
  3. Create a directory named lib at the same location as the Bookmarks portlet source code directory.
  4. Put the following jars into the lib directory:
  5. Switch to the Bookmarks portlet source code directory and run the ant utility.

Note: You should have ant version 1.5.4 or above installed on your system.

Back to top

User Guide

The Bookmarks portlet allows you to keep the sites you use most, at your fingertips. You can bookmark both internal pages as well as external sites. These bookmarks can be organized with the help of folders. With the Bookmarks portlet, you can do the following:

There are three modes in the Bookmarks portlet:

In the Edit and Configure Modes, all the actions described above can be performed. The changes done in the Configure Mode are reflected throughout the portal, whereas the changes done in the View mode will be reflected only in the respective portlet. The Edit Mode is used for setting the Multi-Language support flag.

View Bookmarks

  1. Click any bookmark to view.
  2. Click any folder with displayed next to it to view the bookmarks in the folder.
  3. External bookmarks open in a new window. Close this window to return to your list of bookmarks.

Create Bookmarks

  1. Go to Actions Menu.
  2. Choose Create New Bookmark from the list displayed.
  3. Type a bookmark title in Name, if desired.
  4. Select a folder to store the bookmark. By default, Root is selected if no folder is specified.
  5. Select Internal portal bookmark if the bookmark is internal. Select the page that you want to bookmark.

    Note: A page created by a user must have a custom unique name specified under Portal Settings in the Administration tab in order to appear on the list of available pages to bookmark. See your system administrator for more information.

  6. Select External bookmark for an external bookmark, and type the fully qualified URL, for example, http://www.ibm.com/.
  7. Type an Image URL for the selected bookmark, if desired. Click Refresh to preview the image.
  8. Click Ok to confirm your changes, Cancel to start over.

Edit Bookmarks

  1. Go to the bookmark that you would like to edit and select the icon.
  2. Choose Edit from the menu displayed.
  3. Type a bookmark title in Name, if desired.
  4. Select a folder to store the bookmark, or (Root) if you do not want the bookmark in a folder.
  5. Type an Image URL for the selected bookmark, if desired. Click Refresh to preview the image.
  6. Click Ok to confirm your changes, Cancel to start over.

Delete Bookmarks

  1. Go to the bookmark that you would like to delete and select the icon.
  2. Choose Delete from the menu displayed.
  3. A prompt to confirm the deletion is displayed. Click Ok to delete the bookmark or Cancel to start over.

Create Folders

  1. Go to Actions Menu.
  2. Choose Create New Folder from the list displayed.
  3. Type the name of the folder you would like to add in the Folder Name field.
  4. Choose the location of your folder from the Location menu.
  5. Click Ok to confirm your changes or Cancel to start over.

Edit Folders

  1. Go to the folder that you would like to edit and select the icon.
  2. Choose Edit from the menu displayed.
  3. Type the name of the folder in the Folder Name field.
  4. Choose the location of your folder from the Location menu.
  5. Click Ok to confirm your changes or Cancel to start over.

Delete Folders

  1. Go to the bookmark you would like to edit and select the icon.
  2. Choose Delete from the menu displayed.
  3. A prompt to confirm the deletion is displayed. Click Ok to delete the folder or Cancel to start over.

Rearranging Bookmarks

  1. Go to Actions Menu.
  2. Choose Rearrange from the list displayed.
  3. Select the folder or bookmark that you want to move.
  4. Click Move up to move the item up the list or Move down to move the item down the list.
  5. To move items with a folder, select the folder, and click Rearrange folder items. Move selected items as desired.
  6. Click on the parent folder name to return to a parent folder.
  7. Click Done to save your changes.

Importing Bookmarks

  1. Go to Actions Menu.
  2. Choose Import from the list displayed. A new window opens up.
  3. Specify the location of the file which you have to import in the directory field.
  4. Click Ok to import the file. The bookmarks will get imported onto the page.
  5. Click Cancel to cancel the import.

Exporting Bookmarks

  1. Go to Actions Menu.
  2. Choose Export from the list displayed. You will be prompted to save the file containing the bookmarks.
  3. Save the file in the appropriate location.

Configuring Bookmarks Portlet for Multi-Language Support

You can enable or disable the Multi-Language support for bookmarks portlet by selecting the option Yes/No in Edit mode of this portlet.

Adding folder name for other languages

  1. Go to Create New Folder or Update Folder screen by selecting Create New Folder from Actions Menu or by selecting Edit option from the menu, when icon is selected while on the folder.
  2. Select Edit this folder name for other languages link.
  3. In the Edit this folder name for Other Languages screen, select any of the languages displayed for creating new/modifying folder name for that language.
  4. In the Edit Folder Screen, type the Folder name in textbox provided.
  5. Select Ok to save and return back to Edit this Folder name for Other Languages Screen or Cancel to start over again.
  6. Select Ok to Save the Folder names entered for various languages or Cancel to start over again.

Adding bookmark for other languages

  1. Go to Create New Bookmark or Edit Bookmark screen by selecting Create New Bookmark from Actions Menu or by selecting Edit option from the menu, when icon is selected while on the bookmark.
  2. Select Edit this bookmark for other languages link.
  3. In the Edit this Bookmark for Other Languages screen, select any of the languages displayed for creating new/modifying Bookmark for that language.
  4. In the Edit Bookmark Screen, type the Bookmark name and URL in the 2 textboxes provided.
  5. Select Ok to save and return back to Edit this Bookmark for Other Languages Screen or Select Cancel to start over again.
  6. Select Ok to Save the Bookmarks entered for various languages or Select Cancel start over again.

Field Descriptions

Note: The image size need not be specified, as all images do appear as bullets by default.

Field Descriptions for Folders

Back to top

Open Source License

The Bookmarks portlet is licensed under CPL.

Back to top

FAQs

Frequently asked questions with their answers to go here.

Back to top

Contributions to the Bookmarks portlet

Overview

This section provides the guidelines for contributing code to the Bookmarks Portlet. Contribution includes added functionality or enhancements to this portlet. Bug fixes can always be submitted.

Back to top

General Contribution Requirements

We will be glad to take a look at the code you wish to contribute to Bookmarks Portlet. We cannot guarantee that the code will be included. Contributions of general interest and written according to the guidelines have a better chance of becoming a part of this portlet.

For any significant new functionality, contact the Bookmarks Portlet development team through the mailing list first, and discuss the features, design and scope of the possible contribution. This helps ensure that the contribution is expected and will be welcome, that it will fit in well with the rest of the Bookmarks Portlet, and that it does not overlap with other development work that may be underway.

While you are considering contributing code to Bookmarks Portlet, make sure that the legal terms are acceptable to you and your organization.

Back to top

Legal Issues

In order for your code to be contributed, you need to assign to IBM joint copyright ownership in the contribution. You retain joint ownership in the contribution without restriction. (For the complete set of terms, please see the forms mentioned below.)

The sections below describe two processes, for one-time contributors and for ongoing contributors. In either case, please complete the form(s) electronically and send it/them to IBM for review. After review by IBM, please print and sign the form(s), send it/them by mail, and send the code. The code will then be evaluated.

Please consult a legal representative if you do not understand the implications of the copyright assignment.

Back to top

One-Time Contributors

If you would like to make a contribution only once or infrequently, please use the Joint Copyright Assignment - One-time Contribution form . The contribution will be identified by a bug ID which is unique to the contribution and will be entered into the form. Therefore, please make sure that there is an appropriate bug (or Request For Enhancement) in the portlet bug database, or submit one.

The code contribution will be checked into a special part of the Bookmarks portlet source code repository and evaluated. The Bookmarks portlet team may request updates, for example, for better conformance with the design principles, coding and testing guidelines, or performance. Such updates can be contributed without exchanging another form. A Bookmarks portlet team member commits related materials into the Bookmarks portlet source code repository using the same bug ID that was entered in the copyright assignment form.

Back to top

Ongoing Contributors

If you are interested in making frequent contributions to the Bookmarks portlet, then the Bookmarks portlet Project Management Committee may agree to invite you as an ongoing contributor. Ongoing contributors may be individuals but are more typically expected to be companies with one or more people ("authors") writing different parts of one or more contributions.

In this case, the relationship between the contributor and the Bookmarks portlet team is much closer: One or more authors belonging to the contributor will have commit access to the Bookmarks portlet source code repository. With this direct access come additional responsibilities, including an understanding that the contributor will work to follow the technical guidelines for contributions, and agreement to adhere to the terms of the copyright assignment forms for all future contributions.

The process for ongoing contributors involves two types of forms. Initially, and only once, an ongoing contributor submits a Joint Copyright Assignment by Ongoing Contributor form, agreeing to essentially the same terms as in the one-time contributor form, for all future contributions.

The contributor must also send another form, Addendum to Joint Copyright Assignment by Ongoing Contributor: Authors, for the initial set and each addition of authors to Bookmarks portlet contributions, before any contributions from these authors are committed into the Bookmarks portlet source code repository. (Only new, additional authors need to be listed on each such form.) The contributor agrees to ensure that all of these authors agree to adhere to the terms of the associated Joint Copyright Assignment by Ongoing Contributor Agreement.

Some of an ongoing contributor's authors will have commit access to the Bookmarks portlet source code repository. Their committer IDs need to be established before completing the Authors Addendum form, so that these committer IDs can be entered there. (The committer IDs should be activated only after the form is received.)

Committer authors commit materials directly into the appropriate parts of the Bookmarks portlet source code repository. Contributions from an ongoing contributor are identified by their association with the contributor's committer IDs.

Back to top

Previous Contributions

All previous contributions from non-IBM sources to the Bookmarks portlet are listed on the code contributions page in Bookmarks portlet's source code repository. The page contains links to the softcopies of the Joint Copyright Assignment forms.

Back to top

Development

Source Code Repository

You can browse the source code repository at bmarksportlet.cvs.sourceforge.net/cvsroot/bmarksportlet using a CVS client.

Back to top

Defects and Features Database

You can report a bug or submit a feature/support request for the Bookmarks portlet here .

Back to top

Mailing List/Contacts

Bookmarks Portlet uses bmarksportlet-support@lists.sourceforge.net mailing lists for discussions, announcements and notifications. The mailing list server provides web-based subscription with many options, list archives, digest mode, etc.

Note: In order to send emails to the following lists you need to subscribe to them. You can look at the list archives without subscribing.

When you subscribe to the lists, please make sure that the email address that you are subscribing matches exactly the address that your email program is using. Otherwise, your emails will not go through to the list. The mailing list server matches addresses strictly, including case and the domain (server name) part of addresses.

As a general rule of etiquette, please do not include confidential information or mark your e-mails as urgent. These are public mailing lists used by many volunteers. The volunteers will try to answer your question as soon as possible.

Click here to subscribe to bmarksportlet-support@lists.sourceforge.net mailing list.

Back to top

Related Websites

http://catalog.lotus.com/wps/portal/portal.

Back to top