[[PageOutline(2-5,Contents,pullout)]]

= Bookmark Trac resources

== Description

This plugin adds a bookmark feature to Trac. A star-icon is displayed in the context navigation area where bookmarks can be defined. Users can:
 * add and remove bookmarks of resources, such as tickets, reports, wiki pages and milestones.
 * quick jump to a bookmark via the contextual navigation drop-down.
 * see a list of the pages they have bookmarked at `/bookmark`.

=== Bookmark button

[[Image(contextmenu.jpg, border=2)]]

=== Shortcut menu of bookmarks

[[Image(pulldown.png, border=2)]]

=== Bookmark page

[[Image(bookmarkpage.jpg, border=2)]]

== Bugs/Feature Requests

Existing bugs and feature requests for BookmarkPlugin are 
[report:9?COMPONENT=BookmarkPlugin here].

If you have any issues, create a 
[/newticket?component=BookmarkPlugin new ticket].

[[TicketQuery(component=BookmarkPlugin&group=type,format=progress)]]

== Download

Download the zipped source from [export:bookmarkplugin here].

The plugin is also available on [pypi:TracBookmark PyPI].

== Source

You can check out BookmarkPlugin from [/svn/bookmarkplugin here] using Subversion, or [source:bookmarkplugin browse the source] with Trac.

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

Technically the bookmarks are maintained in a new database table `bookmarks`.
For this reason it is necessary to upgrade your TRAC environment,
just as described in the [TracPlugins#Upgradingtheenvironment TracPlugins] page.
{{{
$ trac-admin /path/to/env upgrade
}}}

== Recent Changes

[[ChangeLog(bookmarkplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:saigon] [[BR]]
'''Maintainer:''' [[Maintainer]], [wiki:jun66j5], rjollos [[BR]]
'''Contributors:''' [http://www.opengroove.com/ OpenGroove], [http://ciklone.com/ ciklone]