BibliographyPlugin » History » Version 6

Luis Figueira, 2011-07-27 05:13 PM
Added a paragraph explaining the main idea supporting this module

1 1 Luis Figueira
h1. Bibliography Plugin Documentation
2 1 Luis Figueira
3 6 Luis Figueira
We're developing a Plugin to manage project's and user's bibliographical entries. In the issue tracker it is named _feature_36_.
4 1 Luis Figueira
5 4 Chris Cannam
* [[BibliographyOngoingReviewNotes|Ongoing miscellaneous review notes]] from testing during development
6 1 Luis Figueira
* [[BibliographyPluginAlphaVersion|Plugin's Alpha Version Requisites and Notes]]
7 6 Luis Figueira
8 6 Luis Figueira
9 6 Luis Figueira
h2. Objective and Philosophy
10 6 Luis Figueira
11 6 Luis Figueira
Projects hosted on code.soundsoftware.ac.uk are usually associated with academic publications (papers, articles, etc). These often offer a strong theoretical background to the code that's being hosted on this site, and many times are the only way users can understand what's happening under the hood for a specific project. On the other hand many researchers are now adopting a "reproducible research" philosophy, in which they not only publish the paper/article itself, but also the code and/or data that supports such publication.
12 6 Luis Figueira
13 6 Luis Figueira
The main idea behind this module is to be able to provide a service that ties both features together, making it easy for researchers to make their source code and publications available on the same platform. 
14 4 Chris Cannam
15 1 Luis Figueira
h2. Plugin Architecture
16 1 Luis Figueira
17 1 Luis Figueira
h3. Models
18 1 Luis Figueira
19 1 Luis Figueira
h4. Publications
20 1 Luis Figueira
21 1 Luis Figueira
h4. Bibtex_Entries
22 1 Luis Figueira
23 1 Luis Figueira
h4. Authors
24 1 Luis Figueira
25 1 Luis Figueira
h4. Authorships
26 1 Luis Figueira
27 1 Luis Figueira
Model that "ties" the authors and publications models together. It contains relation-specific information: 
28 1 Luis Figueira
29 1 Luis Figueira
* @name_on_paper@: author's name on that specific publication;
30 1 Luis Figueira
* @order@: author's order in that publication;
31 1 Luis Figueira
* @institution@: author's institution when the publication was published;
32 1 Luis Figueira
* @email@: author's email on that specific publication.
33 1 Luis Figueira
34 1 Luis Figueira
35 1 Luis Figueira
h3. Relationships
36 1 Luis Figueira
37 1 Luis Figueira
NOTE: upload the class UML. 
38 1 Luis Figueira
39 1 Luis Figueira
40 1 Luis Figueira
h3. Tying it all togheter
41 1 Luis Figueira
42 2 Luis Figueira
This is the complete documentation used to create the plugin:
43 2 Luis Figueira
http://www.redmine.org/projects/redmine/wiki/Hooks
44 1 Luis Figueira
45 2 Luis Figueira
h3. Views
46 1 Luis Figueira
47 2 Luis Figueira
There should be two main ways to browse publications:
48 2 Luis Figueira
49 2 Luis Figueira
# General
50 2 Luis Figueira
# Project 
51 2 Luis Figueira
52 2 Luis Figueira
h4. General Publications View
53 2 Luis Figueira
54 3 Luis Figueira
All the publications published in the website.
55 3 Luis Figueira
56 2 Luis Figueira
h4. Project Publications View
57 2 Luis Figueira
58 3 Luis Figueira
All the publications related to a specific project.
59 3 Luis Figueira
60 3 Luis Figueira
h4. My Publications
61 3 Luis Figueira
62 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
63 1 Luis Figueira
64 1 Luis Figueira