build.xml: Generate the jar file in current directory
[JabRefChicagoForOrgmode.git] / CHICAGO.ODF.README
blob72d7913b24e592d17594e5aa301f6d08402e42c6
1 \r
2 ==============================================\r
3 ==============================================\r
4 ====                                      ====\r
5 ====            Turabian and              ====\r
6 ====        Chicago Manual of Style       ====\r
7 ====            Export Plugins            ====\r
8 ====                                      ==== \r
9 ====             for JabRef               ====\r
10 ====                                      ====\r
11 ====      version 1.2  22 April 2012      ====\r
12 ====                                      ====\r
13 ====           Juan José Baldrich         ====\r
14 ====                                      ====\r
15 ====  juan.baldrich.grd.soci@aya.yale.edu ====\r
16 ====                                      ====\r
17 ==============================================\r
18 ==============================================\r
20         \r
21 The Chicago Manual of Style and Kate Turabian’s A Manual for Writers of Term Papers, Theses, and Dissertations served as the basis for the preparation of the Chicago and Turabian plugins. Available in both Spanish and English, the plugins add up to four. Contrary to the claim in the back cover of the Turabian manual, separate plugins are necessary because the styles, despite their strong similarities, are not reflections of each other. Each plugin prepares output in the Rich Text Format (RTF) for the two basic systems.\r
23         author-date                     (two filters)\r
24         notes and bibliography          (three filters)\r
27 The plugins prepare entries that the user can export to the clipboard and then paste into a document for word processing in Word, Word Perfect, Open Office, etc. These plugins prepare exports for the following entry types of JabRef:  \r
29 article                 inproceedings           phdthesis\r
30 book                    incollection            unpublished\r
31 conference              mastersthesis\r
32 electronic\r
36 Author-date style\r
37 =================\r
39 According to both manuals, the author-date system consists of two distinct parts. Accordingly, each plugin contains filters for \r
41         reference lists for the complete list of sources\r
42         text citations enclosed in parenthesis.\r
45 The reference list export feature consists of the following twelve files:\r
48         Chicago.reference.article.layout\r
49         Chicago.reference.begin.layout\r
50         Chicago.reference.book.layout\r
51         Chicago.reference.conference.layout\r
52         Chicago.reference.electronic.layout\r
53         Chicago.reference.end.layout\r
54         Chicago.reference.incollection.layout\r
55         Chicago.reference.inproceedings.layout\r
56         Chicago.reference.layout\r
57         Chicago.reference.mastersthesis.layout\r
58         Chicago.reference.phdthesis.layout\r
59         Chicago.reference.unpublished.layout\r
61 The text citation export feature consists of the following twelve files that serve as pointers to the reference list:\r
63         Chicago.text.article.layout\r
64         Chicago.text.begin.layout\r
65         Chicago.text.book.layout\r
66         Chicago.text.conference.layout\r
67         Chicago.text.electronic.layout\r
68         Chicago.text.end.layout\r
69         Chicago.text.incollection.layout\r
70         Chicago.text.inproceedings.layout\r
71         Chicago.text.layout\r
72         Chicago.text.mastersthesis.layout\r
73         Chicago.text.phdthesis.layout\r
74         Chicago.text.unpublished.layout\r
77 Note and bibliography style\r
78 ===========================\r
80 Both manuals consider three distinct formats for an entry:\r
82         biblio for bibliographies\r
83         footend for footnotes and endnotes\r
84         footend short for subsequent notes or works with full bibliographies.\r
87 The bibliography export feature consists of the following twelve files:\r
90         Chicago.biblio.article.layout\r
91         Chicago.biblio.begin.layout\r
92         Chicago.biblio.book.layout\r
93         Chicago.biblio.conference.layout\r
94         Chicago.biblio.electronic.layout\r
95         Chicago.biblio.end.layout\r
96         Chicago.biblio.incollection.layout\r
97         Chicago.biblio.inproceedings.layout\r
98         Chicago.biblio.layout\r
99         Chicago.biblio.mastersthesis.layout\r
100         Chicago.biblio.phdthesis.layout\r
101         Chicago.biblio.unpublished.layout\r
104 The full citation for the export of footnotes and endnotes-feature consists of the following twelve files. This feature prepares the complete reference that accompanies the first citation of a bibliographic entry in a work lacking a full bibliography.\r
106         Chicago.footend.article.layout\r
107         Chicago.footend.begin.layout\r
108         Chicago.footend.book.layout\r
109         Chicago.footend.conference.layout\r
110         Chicago.footend.electronic.layout\r
111         Chicago.footend.end.layout\r
112         Chicago.footend.incollection.layout\r
113         Chicago.footend.inproceedings.layout\r
114         Chicago.footend.layout\r
115         Chicago.footend.mastersthesis.layout\r
116         Chicago.footend.phdthesis.layout\r
117         Chicago.footend.unpublished.layout\r
120 The shortened citation for the export of footnotes and endnotes-feature consists of the following twelve files.\r
122         Chicago.footend.short.article.layout\r
123         Chicago.footend.short.begin.layout\r
124         Chicago.footend.short.book.layout\r
125         Chicago.footend.short.conference.layout\r
126         Chicago.footend.short.electronic.layout\r
127         Chicago.footend.short.end.layout\r
128         Chicago.footend.short.incollection.layout\r
129         Chicago.footend.short.inproceedings.layout\r
130         Chicago.footend.short.layout\r
131         Chicago.footend.short.mastersthesis.layout\r
132         Chicago.footend.short.phdthesis.layout\r
133         Chicago.footend.short.unpublished.layout\r
136 Abstract and note filters\r
137 =========================\r
139 The user may wish to use the "abstract" field to summarize and annotate a particular entry. The following feature presents the entry in the bibliography format followed by the "abstract" field. The feature follows the note and bibliography style.\r
141         Chicago.abstract.article.layout\r
142         Chicago.abstract.begin.layout\r
143         Chicago.abstract.book.layout\r
144         Chicago.abstract.conference.layout\r
145         Chicago.abstract.electronic.layout\r
146         Chicago.abstract.end.layout\r
147         Chicago.abstract.incollection.layout\r
148         Chicago.abstract.inproceedings.layout\r
149         Chicago.abstract.layout\r
150         Chicago.abstract.mastersthesis.layout\r
151         Chicago.abstract.phdthesis.layout\r
152         Chicago.abstract.unpublished.layout\r
155 Finally, some user may wish to use the "note" field for other purposes as to write down the call number, ISBN or other properties of an entry. The following feature presents the reference in the bibliography format followed by the "note" field.\r
157         Chicago.note.article.layout\r
158         Chicago.note.begin.layout\r
159         Chicago.note.book.layout\r
160         Chicago.note.conference.layout\r
161         Chicago.note.electronic.layout\r
162         Chicago.note.end.layout\r
163         Chicago.note.incollection.layout\r
164         Chicago.note.inproceedings.layout\r
165         Chicago.note.layout\r
166         Chicago.note.mastersthesis.layout\r
167         Chicago.note.phdthesis.layout\r
168         Chicago.note.unpublished.layout\r
171 Installation\r
172 ============\r
174 The seven features are available in both the English and Spanish versions of the Turabian and Chicago plugins. Please note that the Readme file remains in English but phrases as "Paper presented at" appear in Spanish in the layout files.\r
176 Download the plugins needed, open JabRef 2.5 or better and then go on to press the Plugins item in the toolbar menu. Open the “Manage plugins” and install the plugin. When JabRef restarts all seven filters for each plugin will load automatically.\r
179 Notes on the filters\r
180 ====================\r
182 The user should consider the output from the plugins as a draft that may require some fine adjustment from the word processor.\r
185 ***     Reference lists and bibliographies require a hanging indent that the layout options do not seem to offer. Once the entries are in the word processor, use the hanging indent function.\r
187 ***     In the note and bibliography format, if the author's or editor's first or middle name is an initial or ends with one, two periods will end the field. One corresponds to the initial and the other for the end of field.\r
189 ***     The Turabian manual requires the access date for all web online sources.  Enter the access date in the “comment” field of all electronic entry types. The Chicago plugins do not export the contents of the “comment” field.\r
191 ***     To print correctly the names of authors that lack surnames -- such as NGOs and corporations -- add a comma at the end of the name in the author or editor field.\r
193 ***     In the author-date format, delete the colon to make newspapers and magazines fit the article layout.\r
195 ***     JabRef automatically wraps the text by omitting line breaks. To overcome this default, when exporting fields such as abstract or note, the user must insert:\r
196 \\\r
197 \\\r
198 in the text to make a line break and a double space.\r
200 \newline\r
201 \newline\r
202 Will also do it.\r
206 Enhancements to version 1.2\r
207 ===========================\r
209 ***     Version 1.2 allows the simultaneous installation of the four plugins or any desired combination.\r
211 ***     The plugins enabled the month field. This enhancement allows for the separation of the month from the year field that is very important for the author-date system in particular for the article, conference, electronic, and unpublished  entry types.\r
213 ***     Added Rich Text Format (RTF) functionality to the volume field of the book entry. Added the volume field with its corresponding RTF functionality to the incollection  and inproceedings entry types.\r
215 ***     Both Turabian plugins use the comment field for the access date phrase that the manual requires for online sources. The Chicago Manual does not require them.\r
217 ***     Fixed a bug in the page field of the article entry. When the page field is empty, the plugin no longer adds the colon and ends the reference with a period.\r
219 ***     Fixed a bug in the author-date system. The plugins no longer force the use of initials in substitution of the given names of the authors.\r
221 ***     Fixed a bug at the end of the title of a conference in the footend short format. The plugins no longer add a period after the quotation marks of the title of a conference. The period appears now inside the quotation marks.\r
224 Acknowledgments\r
225 ===============\r
227 Morten Omholt Alver generously prepared the initial source code and the Java plugin to host the filters. In the preparation of these plugins, I have followed JabRef's, “Custom export filters,” SourceForge.net, 29 Jan. 2012, http://jabref.sourceforge.net/help/CustomExports.php.  I have also relied on gottfried's Harvard filter (vosgerau@uni-tuebingen.de) and Matthias Stürmer MIS Quarterly-filter which are both native to JabRef. The Department of Sociology and Anthropology of the University of Puerto Rico funded this work.