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

= Zotero integration into Trac

== Description

This is a plugin used to show and cite a local [http://www.zotero.org/ Zotero] database. Zotero [zoh-TAIR-oh] is a free, easy-to-use tool to help you collect, organize, cite, and share your research sources.

Key features:
 * Collection tree is created and always shown, which based on [http://bassistance.de/jquery-plugins/jquery-plugin-treeview/ jQuery plugin: Treeview].
 * Show all items in a collection.
 * Show a item with all fields, attachment, and related items.
 * Cross links to authors, year, publisher.
 * Clouds for authors, year, publisher, which based on tags clouds in TagsPlugin.
 * Cite item(s) in the Wikis and tickets.
 * [t:TracLinks TracLink] provider. Examples: `[zot:key], [zot:RAXETNDM see], [zot:0_RAXETNDM see]`.
 * Search database.

== Bugs/Feature Requests

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

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

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

== Download

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

== Source

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

== Installation

Install as follows:
 * Grab the source from [/svn/traczoteroplugin SVN].
 * Build and install an egg from this source. 

== Configuration

 * The Zotero database (folder including zotero.sqlite) must be located in the `htdocs` directory of your Trac environment.
 * Add section '[zotero]' section in your `trac.ini` file, in which you set the path of the Zotero database:
{{{#!ini
[zotero]
path = Reference
}}}
  * if you have different database name other than 'zotero.sqlite', you can set 'dbname':
{{{#!ini
[zotero]
path = Reference
dbname = zotero.sqlite
}}}
  * The columns to show items could be specified by 'fields' and 'labels':
{{{#!ini
columns = firstCreator, year, publicationTitle, title
}}}
  * The links of attachments are rendered in two ways: `http://` and `zotero://`. The default is `http://`. You can set 'attachmentlink' as 'local' to render attachment as `zotero://`:
{{{#!ini
attachmentlink = local
}}}

== Screenshots

'''Start page'''

[[Image(start.png, height=200px)]]

''' Collection '''

[[Image(collections.png, height=250px)]]

''' Item '''

[[Image(item.png, height=200px)]]

''' Publisher cloud '''

[[Image(cloud.png, height=200px)]]

''' Cite list '''

[[Image(cite.png, height=100px)]]

== Example

 * Cite a reference with key:
{{{
[[ZotCite(TTQ685TT)]]
}}}
 * Cite multiple references with keys separated by comma ','. The keys can also start with '0_':
{{{
[[ZotCite(TTQ685TT, GCSENNQ8, 0_CVJBVNCN)]]
}}}
 * You can add any other words except comma after keys to let them easier to look:
{{{
[[ZotCite(CVJBVNCN(Marcellos&Single1975))]]
}}}
 * Add argument 'ait' or 'authorintext' to cite them as 'Author (year)':
{{{
[[ZotCite(GCSENNQ8(Rebbecketal.2007),ait)]]
}}} 
 * Show reference list:
{{{
[[ZotRef]]
}}}
 * Show all related items:
{{{
[[ZotRelated(5RUPZP36)]]
}}}

== Recent Changes

[[ChangeLog(traczoteroplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:helend] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''