Home

 

Add a list of bookmarks to a Web page

Embed a list of bookmarks into your Web pages. Your Web application can use this resource to enable users to see and navigate to a selected list of bookmarks relevant to your Web page.


Atom API request details

Resource Description
/lisnippet Retrieves bookmarks matching search criteria. Returns JavaScript™ code that emits XHTML containing the search results, with each result specified in a <li> element.

Search can only find bookmarks that the indexer has processed. The indexing interval is stored in a configuration property that your administrator can configure. See Manage search and index operations in the Administering Bookmarks section of the Lotus Connections information center for more details. Use one or more of the input parameters to narrow the search. Separate multiple parameters with an ampersand (&).


Input parameters

Parameter Description
access Filters the bookmarks based on whether they are private or public. Options are:

    any

    Returns all bookmarks only if the request is made over secure http (https). If the request is made over https, it is redirected to the /mybookmarks URI. If the request is made over http, only public bookmarks are returned. This value is the default value.

    private

    Only returns private bookmarks. Private bookmarks can only be accessed by their owner, and only if the owner is authenticated. The user is prompted to log in and is redirected to the /mybookmarks URI from which only private bookmarks are returned.

    public

    Only returns public bookmarks.

base Returns only bookmarks to pages hosted by a given Web site. For example, to retrieve only bookmarks to pages on the Web site www.w3c.org/TR, specify "base=www.w3.org/TR"
email Internet e-mail address. Returns bookmarks created by the user specified by the e-mail address. Format the HTTP request using the proper URL encoding. For example, the encoded form of the @ symbol is %40 as in:

    adam_eventide%40garden.com
    

Do not use this parameter if Lotus Connections is configured to prevent e-mail addresses from being displayed. Use the userid parameter instead.

lang Language code. Language for strings in the output. If not specified, the language specified by the first matching client, typically the Web browser, is used, if available. The server then redirects the request to add this parameter to the URL. Specify this parameter to avoid the redirect.
network Filters the bookmarks based on the network that it is available from. Options are:

  • all – Default. Returns all bookmarks.

  • internet – Only returns the bookmarks that link to Internet resources, which are visible outside the intranet firewall.

  • intranet – Only returns the bookmarks that link to resources available on the corporate intranet, that is, resources that are not externally visible.

page Page number. Specifies the page to be returned. Default is 1.
ps Page size. Specifies the number of entries to return per page. Default 10. Maximum value allowed is 50.
search Well-formed full text search query. Performs a text search on the title, description, and tags of all bookmarks. Orders results by relevance. Respects other constraints. Help topic "Using advanced search options", available from the Bookmarks user interface, provides details on the search operators you can use in the search query to perform advanced searches for bookmarks.

When you use this parameter, the search can only find bookmarks that the indexer has processed. The indexing interval is stored in a configuration property that your administrator can configure. See Managing search and index operations in the Administering section of the Lotus Connections information center for more details.

searchOperator Default operator between search terms. Options are:

  • and

  • or

The default value is set by your system administrator. Use in conjunction with "search" parameter to override the system default operator for search queries.

showFavIcon Includes links to bookmark icons (also known as "favorite icons") in the response. Bookmarks uses link relation "http://www.ibm.com/xmlns/prod/sn/icon" to identify this link in a bookmark Atom entry. Boolean. Options are:

  • false – Default. Links to bookmark icons are not included.

  • true – Includes links to bookmark icons.

since Includes in the resulting feed all bookmarks updated after a specified date. Specify the date using a date-time value that conforms to RFC3339. Use an upper case "T" to separate the date and time, and an uppercase "Z" in the absence of a numeric time zone offset. For example: 2009-01-04T20:32:31.171Z.
sort Specifies how the results should be sorted. Options are:

  • date – Default. Bookmark entries are sorted by the date they were created.

  • popularity – Bookmarks are sorted by popularity.

sortOrder Specifies the order the results should be sorted in. Options are:

  • asc – Default. Bookmarks are sorted in ascending order (oldest to newest, or least to most popular).

  • desc – Bookmarks are sorted in descending order (newest to oldest, or most to least popular).

tag Returns bookmarks with the specified tag. You can search for multiple tags; separate the tags with a space or comma. If you use a space, URL-encode the space using %20.
url A well-formed Web address. Returns bookmarks for the given Web address. When you use this parameter, all other search parameters are ignored.
userid Unique ID that represents a specific person.

 

Example

The following sample HTML code adds bookmarks that have the "id" tag associated with them to a Web page as a formatted list:

where dogear.css contains the following content:

The resulting page displays a bulleted list of documentation links.

If a new bookmark with a tag of "id" is added, and the page is refreshed, the list will be updated to show the newly added bookmark as well. This example applies the style defined for the doglink class to the resulting list of bookmarks.

This example applies the styles defined for the doglink, dogearauthor, and dogeartags classes to the resulting list of bookmarks.


Extending bookmarks

 

Related reference


Add popular bookmarks to a Web page


+

Search Tips   |   Advanced Search