BibliographyPlugin » History » Version 4

Chris Cannam, 2011-06-27 02:16 PM

1 1 Luis Figueira
h1. Bibliography Plugin Documentation
2 1 Luis Figueira
3 1 Luis Figueira
We're developing a Plugin to manage project's and user's bibliographical entries. In the issue tracker it is names _feature_36_.
4 1 Luis Figueira
5 4 Chris Cannam
* [[BibliographyOngoingReviewNotes|Ongoing miscellaneous review notes]] from testing during development
6 4 Chris Cannam
7 1 Luis Figueira
h2. Plugin Architecture
8 1 Luis Figueira
9 1 Luis Figueira
h3. Models
10 1 Luis Figueira
11 1 Luis Figueira
h4. Publications
12 1 Luis Figueira
13 1 Luis Figueira
h4. Bibtex_Entries
14 1 Luis Figueira
15 1 Luis Figueira
h4. Authors
16 1 Luis Figueira
17 1 Luis Figueira
h4. Authorships
18 1 Luis Figueira
19 1 Luis Figueira
Model that "ties" the authors and publications models together. It contains relation-specific information: 
20 1 Luis Figueira
21 1 Luis Figueira
* @name_on_paper@: author's name on that specific publication;
22 1 Luis Figueira
* @order@: author's order in that publication;
23 1 Luis Figueira
* @institution@: author's institution when the publication was published;
24 1 Luis Figueira
* @email@: author's email on that specific publication.
25 1 Luis Figueira
26 1 Luis Figueira
27 1 Luis Figueira
h3. Relationships
28 1 Luis Figueira
29 1 Luis Figueira
NOTE: upload the class UML. 
30 1 Luis Figueira
31 1 Luis Figueira
32 1 Luis Figueira
h3. Tying it all togheter
33 1 Luis Figueira
34 2 Luis Figueira
This is the complete documentation used to create the plugin:
35 2 Luis Figueira
http://www.redmine.org/projects/redmine/wiki/Hooks
36 1 Luis Figueira
37 2 Luis Figueira
h3. Views
38 1 Luis Figueira
39 2 Luis Figueira
There should be two main ways to browse publications:
40 2 Luis Figueira
41 2 Luis Figueira
# General
42 2 Luis Figueira
# Project 
43 2 Luis Figueira
44 2 Luis Figueira
h4. General Publications View
45 2 Luis Figueira
46 3 Luis Figueira
All the publications published in the website.
47 3 Luis Figueira
48 2 Luis Figueira
h4. Project Publications View
49 2 Luis Figueira
50 3 Luis Figueira
All the publications related to a specific project.
51 3 Luis Figueira
52 3 Luis Figueira
h4. My Publications
53 3 Luis Figueira
54 3 Luis Figueira
In the My Page, there should be a "box" with a list of all the publications added by the user and/or publications where the user is an author
55 1 Luis Figueira
56 1 Luis Figueira