Load /tmp/tmp.JUKpM13035/jabref-2.0.1+2.1b2 into
[debian/jabref.git] / src / txt / README~
1
2 JabRef 2.1 beta
3 ---------------
4
5
6 Introduction:
7
8 JabRef is a graphical Java application for editing bibtex (.bib)
9 databases. JabRef lets you organize your entries into overlapping
10 logical groups, and with a single click limit your view to a single
11 group or an intersection or union of several groups. You can customize
12 the entry information shown in the main window, and sort by any of the
13 standard Bibtex fields. JabRef can autogenerate bibtex keys for your
14 entries. JabRef also lets you easily link to PDF or web sources for your
15 reference entries.
16
17 JabRef can import from and export to several formats, and you can
18 customize export filters. JabRef can be run as a command line application
19 to convert from any import format to any export format.
20
21
22 License:
23 JabRef is free open source software, distributed under the GNU General
24 Public Licence. See the enclosed text file 'gpl.txt', or the About
25 dialog, for details about the GPL.
26
27 JabRef also uses libraries distributed by other porties; see the About
28 box for details.
29
30
31 Requirements:
32 JabRef runs on any system equipped with the Java Virtual Machine
33 (1.4.2 or newer), which can be downloaded at no cost from
34 http://java.sun.com. If you do not plan to compile JabRef, the Java
35 Runtime Environment may be a better choice than the Java Development
36 Kit.
37
38
39 Installing and running, Windows:
40 JabRef is available in Windows Installer (.msi) format. To install,
41 double-click the .msi file. A shortcut to JabRef will be added to your
42 start menu.
43
44 The Windows installation was made by Dale Visser, using the following open-source tools:
45 JSmooth (.exe wrapper for Java apps), available at http://jsmooth.sf.net/
46 Wix (tool for compiling MSI files from an XML specification), available at http://wix.sf.net/
47
48
49 Installing and running, general:
50 JabRef can be downloaded as an executable .jar file. Run the
51 program as follows:
52 If you are using the Java Development Kit:
53      java -jar <path to jar>
54 or, if you are using the Java Runtime Environment:
55      jre -new -jar <path to jar> or
56      jrew -new -jar <path to jar>
57
58 We recommend running JabRef under the Java 5.0 JRE. If you do, you should add
59 the option "-Dswing.aatext=true" before the "-jar" option, to activate
60 antialiased text throughout the application.
61
62
63 The jar file containing JabRef can be unpacked with the command:
64     jar xf <path to jar>
65 or  jar xf <path to jar> <list of files to extract>
66 Unpacking the jar file is not necessary to run the program.
67
68
69
70 Building JabRef from source:
71 Please see the INSTALL file for instructions for building from source.
72
73 Documentation:
74 JabRef comes with an online help function, accessed by pressing F1 or
75 clicking on a question mark icon. The help files are probably not
76 exhaustive enough to satisfy everyone yet, but they should help sort
77 out the most important issues about using the program. The help files
78 can also be viewed outside the program with a standard HTML browser.
79 If you choose languages other than English, some or all help pages may
80 appear in your chosen languages.
81
82 Change log:
83 2.1b2   - Added option to toggle floating of marked entries to the top of the table.
84         - Added option to open, append and import multiple BibTeX files.
85         - Improved support for LaTeX special characters in HTML and RTF representations.
86         - Fixed bug that made entry selection get lost when an edit modifies the entry's
87           position in the main table.
88         - Fixed bug in BibTeXML export (entry type name missing in tag).
89         - Fixed name handling in (non-compliant) Endnote files giving all author names
90           on the same line.
91         - Fixed problem with keyword handling in Medline import.
92         - Fixed (harmless) NullPointerException when medline fetch is cancelled.
93         - Fixed bug in parser that made {"} illegal in fields quoted with ".
94 2.1b    - Known issue: font sizes cannot be changed, but should follow OS settings on
95           Windows and Mac.
96         - Known issue: some HTML may be handled inappropriately when downloading from
97           IEEEXplore.
98         - Changed Paste function so timestamp and owner fields are updated.
99         - Added "Other" item to the "New entry ..." menu.
100         - Changed sorting order so marked entries are displayed at the top of the table.
101         - Added IEEEXplore search and download feature.
102         - Added option to store entries in their original order. Unsorted table view now
103           shows entries in their original order.
104         - Added option to autogenerate keys for entries with missing keys before each save.
105         - Improved handling of external URLs to prevent problems with special characters.
106         - Medline and Endnote imports no longer automatically add curly braces around capital
107           letters in title.
108         - Float search now scrolls table to the top.
109         - Fixed lockup problem in preview with uneven number of # characters in fields.
110         - Fixed problem with default content selector fields reappearing after removal.
111         - Fixed problem with unsupported character encodings being selectable and causing
112           unreported save errors.
113         - Fixed bug that blocked last line in table columns setup from being removed.
114         - Fixed missing export formats from command line.
115         - Fixed bug that made Review tab impossible to remove from entry editor.
116         - Fixed bug in Medline XML import that assigned wrong PMID for some entries.
117         - Fixed bug in custom export that collapsed sequences of two or more backslashes
118           into a single backslash in output.
119         - Fixed bug (misspelled formatter name) in Harvard RTF export.
120 2.0.1:  - Fixed bug that made a hidden entry editor under some circumstances store a
121               field value to the wrong entry.
122             - Fixed synchronization bug that made the opening of a new database sometimes fail.
123             - Fixed bug in setting external journal lists when no personal list is set.
124 2.0:    - Changed sorting selection interface for main table for more intuitive
125           operation.
126         - Made import operation update "working directory".
127         - Removed hard-coded author/editor name rearrangement in OpenOffice and
128           OpenDocument exports.
129         - Fixed hangup when parsing RIS files from Nature.
130         - Fixed NullPointerException when generating database from AUX file on Mac OS X.
131         - Fixed bug in routine for adding braces around capital letters.
132         - Fixed bug in switching preview layouts.
133         - Fixed bug in link handling in entry preview.
134 2.0b2:  - Changed field order in OpenDocument export to comply with bibliography requirement.
135         - Added support for inserting citations into Emacs using gnuserv/gnuclient.
136         - Added option to set a regular expression replace operation on generated bibtex keys.
137         - Added support for custom importers inside a jar file.
138         - Fixed bug in opening URLs containing '&' on Windows.
139 2.0b:   - Added a system for registering custom import formats in the form of Java classes.
140         - Added export option for OpenDocument spreadsheet.
141         - Added new options for name formatting in main table.
142         - Added REPEC-NEP import filter.
143         - Added option for non-field parameters for export formatters. If the parameters does not start with the
144           backslash character, it will be passed unchanged to the formatter in place of any field value.
145         - Added export formatter CurrentDate, which returns the current date, and takes a format string as
146           parameter.                   
147         - Added customization of table colors, accessible from Tools -> Preferences -> Entry table.
148         - Added new Appearance tab to preferences dialog to gather appearance related options.
149         - Added toggling of abbreviated and full journal names. The list of journals is realized as
150            an external file, but editable from a Manage Journal Abbreviations panel. Secondary lists can also
151            be linked, but not edited. There is a download option to quickly get a list available on the internet,
152            and we will provide one or more lists for download from the SourceForge web server.
153         - Added functionality for new JabRef instances to detect a running instance, and send
154           command line parameters to the running instance for processing.
155         - Added handling of HTML links in preview panel.
156         - Added confirmation dialog when database is saved and the chosen encoding doesn't support all characters.
157           Gives options to save, cancel or try a different encoding.
158         - The encoding used when opening a database is now remembered, and used when database is stored.
159         - Added review field for research comments, paper reviews, etc.
160         - Added option to disable wrapping for certain fields. Wrapping of pdf, ps, doi and url is disabled by
161           default.
162         - Antialiasing option now affects entry editor text fields as well as table text.
163         - Changed to monospaced font in source editor field.
164         - Removed option to put double braces around BibTeX fields, but retained option to remove double braces
165           when loading. Added option to put braces around capital letters of a chosen set of fields.
166         - Improved Ovid import.
167         - Fixed problem with ordering of BibTeX strings that are referred to by other strings.
168         - Fixed problem with loading 16-bit encoded bib files with 8-bit encoding as default, and vice versa.
169         - Fixed multiplying authors bug when author/editor field appears both in Required and Optional tabs.
170         - Fixed startup freeze when trying to load certain malformed bib files.
171         - Fixed bug related to multi-line fields in RIS import.
172         - Fixed bug related to looking up a fully qualified DOI
173         - Included review field to preview panel 1, which shows the abstract
174         - Fixed bug where booktitle field was not displayed in preview
175           for conference proceedings, similar to journal field
176         - By default preserve capitalization on the following fields: title;journal;booktitle;review;abstract
177 1.8.1:  - Added automatic timestamp with configurable format for entries.
178         - Added new key generator modifier ":abbr" to abbreviate field contents.
179         - Added Help button in Preferences -> Entry preview
180         - Added Big5, Big5_HKSCS and GBK encodings for Chinese.
181         - Improved marking feature. Username is now used for marking, so different users can mark
182           entries separately without interference.
183         - Improved handling of names such as "Firstname de la Lastname jr.", with different handling
184           for presentation and sorting purposes. Key generation now should always use the genuine last
185           name, and not produce keys like "de2001".
186         - Removed duplicate warning from inspection dialog for non-selected entries.
187         - Fixed setting of sheet name in OpenOffice.org Calc export.
188         - Fixed bug that prevented PDF/PS opening by F4 from automatically finding files in
189           subdirectories below the main PDF/PS dir.
190         - Fixed BibTeX parser bug that made it choke on short comment strings.
191         - Fixed bug that made regexp search fail for fields containing newline characters.
192         - Fixed platform-dependent handling of newline characters.
193         - Fixed bug that prevented command line import with explicit format.
194         - Fixed bug that made it impossible to disable table antialiasing.
195         - Fixed AuthorAndsCommaReplacer.
196 1.8:    - Search panel now starts visible if it was visible at last shutdown.
197         - Added option to disable import inspection window when only one entry is being imported.
198         - Fixed parser bug that caused problems for bib files containing extra characters after the
199           last entry.
200         - Fixed missing month in JStor import.
201             - Fixed some bugs in "new from plain-text" wizard
202 1.8b2:  - Changed handling of external updates so the notification is suppressed when there are
203           no actual changes.
204         - Changed autodetecting import so BibTeX files are handled more similarly to other formats.
205         - Enabled sorting by icon columns.
206         - Added option to remove BibTeX source panel from entry editor.
207         - Added command line option to not load any files at startup. Will override any autoloading
208           or other command line options that normally load or import files.
209         - Added handling of duplicates to import inspection window.
210         - Made entry preview be updated whenever the selection is expanded by one row, to make
211           it more useful while selecting a set of entries.
212         - Changed BibTeX field parsing to avoid inserting line breaks at wrong places.
213         - Improved handling of page numbers in Medline import.
214         - Fixed import of file links when importing SixPack files.
215         - Fixed bug that prevented closing of search interface when no databases are open.
216         - Fixed OpenOffice Calc export to be compatible with OpenOffice.org 2.0 beta.
217         - Fixed bugs in Refer/Endnote import filter. 
218         - Fixed bug that caused changes to be lost in some cases when the same field is present
219           in multiple entry editor tabs.
220         - Fixed bug that prevented command line autodetecting import from working with BibTeX files.
221         - Fixed minor bug in routine for removing double braces.
222 1.8b:   - Added option to store bib file with double braces.
223         - Follow @input tags in aux files to indicate nested aux files for
224           generating subdatabases.
225         - Improved wrapping and formatting of bib files, to preserve paragraph separator (empty line).
226         - Added test buttons for customization of preview layouts.
227         - Added inspection dialog for previewing and generating keys for imported entries,
228           and deciding which ones to keep and discard. The dialog allows inspection during long import
229           processes such as Medline search.
230         - Restructured layout to use a common side pane with all tabs.
231         - Added import filter for Cambridge Scientific Abstracts (CSA) format.
232         - Added PS directory with similar options as PDF.
233             - Added [authshort] and [edtrshort] key field markers. Patch submitted by
234               Kolja Brix.
235         - Made the program remember preview enable setting.
236         - Improved handling of illegal regular expressions in search.
237         - Removed options to search only Required, Optional and/or General fields,
238           in order to simplify search interface.
239         - Changed keys for Next and Previous tab to CTRL-PGDN and CTRL-PGUP to match shortcuts in a
240           certain popular web browser.
241         - Minor change to Preferences -> Table columns to enable insertion of column in position 2.
242         - Fixed parser bug that caused problems for files with >10000 entries.
243         - Fixed bug in entry editor that caused the source edit panel to remove marking from entries.
244         - Fixed export bug that made "\begin" tags fail if encountered immediately after an "\end" tag. 
245         - Fixed export bug that made whitespace disappear after empty field values.
246         - Fixed ISI import bug that handled SO fields with line breaks wrong.
247         - Fixed bug occuring when choosing not to import duplicate imported entry.
248         - Fixed problem with detecting popup trigger on Mac OSX with one button mouse.
249         - Fixed erroneous relative paths for PDF files when PDF directory is not set.
250         - Fixed entry preview to resolve string references.
251 1.7.1   - Removed unnecessary stack traces when opening external viewer.
252         - Fixed bug that made Ctrl-E destroy current edit in entry editor.
253         - Fixed problem when copying modified BibTeX key gave old value.
254         - Fixed missing 'booktitle' import in CONF entries in RIS import.
255         - Fixed bug that made group tree disappear for certain keyword expressions.
256         - Fixed bug that made standard BibTeX fields be saved without line wrapping.
257 1.7     - When fetching from Medline or CiteSeer, fetched entry is now opened in editor.
258         - Added French translations of help files.
259         - Added color highlighting of focused text field in entry editor.
260         - Added option in context menu of entry editor for changing capitalization
261               of field contents.
262             - Added name conversion "Smith, RA" -> "Smith, R. A." to Medline import.
263             - Fixed bug that left some search settings items disabled when they shouldn't be.
264         - Fixed bug that caused requirement for restart to register change in default
265           key pattern.
266         - Fixed bug that caused crash some times after adding/removing field content selectors.
267         - Fixed bug in recognizing custom entry types when reading bib files.
268         - Fixed bug that allowed a deleted entry to stay visible in the entry editor.
269 1.7b2:  - Made side pane resizable.
270         - Replaced entry customization dialog with improved interface.
271         - Added standard entry type "conference", similar to "inproceedings".
272         - Added default key pattern to avoid the need to set similar patterns manually.
273         - Added line wrapping to metadata in saved .bib file to avoid long lines.
274         - Added "bibtexkey" as implicit fourth sort criterion, to minimize problem with almost
275           similar entries swapping places.
276         - Added OpenOffice.org Calc export filter that exports spreadsheet compatible with the
277           OpenOffice.org bibliography feature.
278         - Added a couple of previously unsupported publication types in SciFinder.
279         - Added extra shortcuts CTRL-+ and CTRL-- for switching tabs in entry editor, since
280           original shortcuts CTRL[-SHIFT]-TAB is used by some window managers.
281         - Updated Endnote export filter.
282         - Fixed focus and key binding problems for switching tabs/entries in entry editor
283         - Fixed bug that prevented required fields tab from appearing for entries with only bibtex key
284           as required field.
285         - Fixed bug that prevented the user from changing the default encoding.
286         - Fixed bugs in RIS import.
287         - Fixed bug 1112050; freeze when reading certain author fields with mismatched braces.
288 1.7b:   - Changed routine for rearranging author names (Lastname, Firstname) so bracketed
289             expressions are treated as units.
290         - Grouping controls now allow group hierarchies, and now allow explicit and search
291           expression groups as well as keyword groups.
292         - Added full customization of general fields tabs
293         - Added option to preserve formatting for non-BibTeX fields.
294         - Added integrity check for database.
295         - Added export filters EndNote and Harvard RTF.
296         - Added automatic import format chooser for import (same as wildcard import below).
297         - Added wildcard (*) option for command-line import, to try to automatically
298           determine the correct format.
299         - Improved layout of Preferences dialog.
300         - Improved several import filters.
301         - Added authIniN/edtrIniN key formatters.
302         - Marked entries now float to the top when no searching or grouping reordering is active.
303         - Fixed problem with opening file dialog on Win NT - AWT dialog is now opened if
304           Swing dialog fails.
305 1.6:    - Improved handling of entry selection in various ways. E.g. selected entry is now scrolled
306           into view when opening entry editor and entry is kept selected when importing CiteSeer
307           fields.
308         - Fixed update bug between autogenerated bibtex key and source panel.
309         - Fixed missing . at the end of last author name in RIS import.
310         - Fixed NullPointerException on certain special characters when exporting to BibTeXML.
311         - Fixed bug that sometimes prevented the unmarking of entries.
312         - Fixed problem with formatting one-name authors.
313 1.6b:   - Added mnemonic keys to menus and menu items.
314         - Added MODS and tab-separated file export
315         - Added facility for detecting and handling external changes to open bib files.
316         - Added scan option for exact duplicates with automatic removal.
317         - Bibtex strings are now sorted automatically.
318         - Bibtex strings are now resolved when exporting database.
319         - Fixed problem with field content selector getting too wide. Limited width.
320         - Fixed PDF/PS view routine to remove problems with filenames
321           containing spaces.
322         - Fixed bug that interfered with Fetch Medline by ID, and fixed
323           parsing problem with certain Medline entries.
324         - Fixed bug that interfered with Push to WinEdt.
325         - Fixed HTML output so \c{c} is handled correctly.
326         - command line option for generating a sub-database from LaTex aux file
327           entries
328         - simple copy/paste menu in entry editor
329         - experimental: text-input-area with underlying infotext in plaintext import dialog
330 1.55:   - Made method for opening PDF files robust with regard to file separators (/ and \),
331           so bib files can easier be used across platforms.
332         - Improved Medline fetcher. Can now fetch entries based on a search expression.
333         - Added features for fetching fields and referring publications from the CiteSeer
334           database.
335         - Added option to always save database ordered by author/editor/year, and made this
336           the default setting.
337         - When a single entry is selected, right-click menu now shows a checkbox menu for group
338           memberships instead of the regular "Add to" and "Remove from" menus.
339         - Improved [shorttitle] and [veryshorttitle] special key pattern fields.
340         - Added dialog box for conveniently setting the fields of an entry from a
341           plain text description.
342         - Added formatter "ResolvePDF" to create correct PDF/PS links in HTML export when
343           relative file names are used.
344         - Added Abstract panel in entry editor.
345         - Added alternate preview with abstract, and made both previews configurable.
346         - Added the option to create a subset of a database based on an .aux file.
347         - Added 'Cancel' button to duplicate resolver dialog, so the process can be stopped.
348         - Added check for spaces in custom entry type names.
349         - Added several new key pattern markers.
350         - Added toolbar buttons for Mark/Unmark to improve discoverability.
351         - Fixed bug that made export filters ignore the chosen character encoding.
352         - Fixed bug that interfered with author name formatting.
353         - Fixed various bugs in import filters.
354         - Fixed bug that prevented confirmation dialog when deleting entry from the entry editor.
355         - Fixed bug that made the next entry be opened instead of the current, when pressing
356           Enter in table.
357         - Fixed bug that made it possible to leave a source edit when the source didn't validate
358           properly. Also made it impossible to change table selection until source validates.
359 1.5:    - Enabled selection of default encoding, and started storing encoding information in
360           saved .bib files, which is used when reopening.
361         - Added Highlight and select options to the group interface, and made it possible
362             to change the number of visible lines in the list.
363               - Added option to allow or disallow direct table editing.
364         - Added optional confirmation dialog for deleting entries.
365               - Added optional warning dialog for duplicate BibTeX keys.
366         - Added warnings to bibtex parser, and prevented failure to load files with
367           duplicate string definitions.
368               - Added JStor import filter.
369         - Changed the look and feel to JGoodies Forms on non-Macintosh platforms.
370         - Optimized performance in several areas.
371         - Numerous usability improvements.
372         - Fixed RIS import bug caused by short lines.
373               - Fixed bug in SciFinder import.
374               - Fixed bug that made entire field get cleared when removing from group.
375 1.4:    - Added advanced search feature.
376         - Added facility for using custom export formats.
377         - Added command line options for importing/exporting files, importing/exporting
378           user preferences, loading session and for suppressing the GUI (using RitOpt for
379           parsing options).
380         - Added automatic stripping of \url{} when opening url.
381         - Improved export filters.
382         - Fixed focus bug which sometimes interfered with cut/copy/paste.
383 1.3.1:  - Bugfix.
384 1.3:    - Added entry preview.
385         - Added detection of duplicate entries.
386               - Added possibility to mark entries persistently.
387         - Added import filter for Sixpack and Biblioscape Tag files.
388               - Added option to use a standard directory for PDFs. PDFs placed in or below this directory
389           and named after an entry's BibTeX key can be automatically found.
390             - Added optional columns showing clickable icons for pdf/ps and url/doi links.
391         - Added menu and toolbar actions for open pdf/ps and url/doi.
392         - Added web lookup of DOI.
393         - Added several new special field markers to the key autogenerator.
394               - Added BibTeXML and simple HTML export.
395               - Changed browsing of entries. Entry editor now shows the selected entry.
396               - Improved HTML export for several entry types.
397               - Improved compatibility with Mac OS X.
398         - Made it possible to set custom secondary and tertiary sort fields.
399         - Made the entry number column width customizable.
400               - Fixed bug that caused database to always be marked as changed after viewing source.
401                - Fixed bug in selector word removal.
402                - Fixed  bug that made the file chooser unable to interpret Mac OS X aliases.
403 1.2:    - Replaced the icon set.
404         - Added support for French language.
405         - Added customization of key generation.
406         - Improved HTML export.
407         - Added Replace string feature.
408             - Made a couple of adaptations for Mac OS X users.
409         - Added option in Table Preferences to set current column widths as default.
410             - Added import filter for BibTeXML.
411         - Fixed bug that allowed non-lowercase grouping field, leading to problems.
412         - Fixed bug that made selector words added in the dialog to be lowercased.
413         - Fixed bug relating to translated help files.
414 1.19:   - Entry editor is now opened for an entry that causes an error when saving.
415         - Added options to display names in harmonised format in the main table.
416         - Added Docbook and (experimental) HTML export.
417         - Enabled 'doi' and 'pii' fields for Medline import.
418         - Enabled antialiasing fonts.
419         - Added the Kunststoff look&feel to give a more pleasant user interface.
420         - Added font selector for the main table.
421         - Improved table column customization.
422         - Added word selector feature for selected fields (keywords, journal).
423         - Added support for German and Norwegian language.
424         - Generalized copy cite key features for multiple entries.
425         - Added quick load/save session feature.
426         - Fixed issue/number bug in ISI import.
427         - Added "Open pdf/ps" item in right-click menu.
428         - Fixed bug causing external viewer to only work in General fields.
429         - Added functionality for using Browse buttons for file-related fields
430           (ps, pdf, etc.).
431         - Added Browse buttons to External programs tab in Preferences.
432         - Fixed bug related to Save database and Source field which caused changes
433           to disappear.
434 1.1:    - Added bibtex key uniqueness checking, and prevented autogeneration
435           from generating non-unique keys.
436         - Added command line option to load file on startup.
437         - Fixed problem with autogeneration creating invalid keys.
438         - Improved Refer/Endnote import.
439         - Added feature for importing entries and/or strings and/or group
440           definitions from another BibTeX database.
441         - Added menu choices to import into open database.
442               - Added toolbar button for closing current database.
443               - Fixed shortcut key for "Store field" in entry editor, and fixed
444                 problem that made shortcut for "Save database" unavailable from
445           entry editor.
446         - Added option to fetch Medline entries automatically by
447           ID, based on a patch submitted by Mike Smoot.
448         - Fixed bug in RIS import.
449         - Added options to copy key and copy "\cite{key}" to right-click menu.
450         - Fixed bug that caused some General fields not to get displayed.
451         - Enabled customization of General fields.
452         - Enabled customization of existing entry types, and definition of
453           new types.
454 1.0:    First release.
455
456
457 Bug reports, suggestions, other feedback:
458 We are thankful for any bug reports or other feedback. If there are
459 features you want included in JabRef, tell us!
460
461
462 JabRef homepage:
463 http://jabref.sourceforge.net
464
465 You can always get the very latest version of the program from our CVS
466 repository; instructions for downloading are found on the
467 homepage. Note that the CVS version may contain untested features, or
468 have other stability issues. Unless you're feeling extremely lucky, go
469 for the version in the HEAD branch of the module 'jabref'.
470
471
472 Bug submission and Open Discussions and Help forums are found at:
473 http://sourceforge.net/projects/jabref
474
475
476 Corresponding authors:
477 mortenalver _ users.sourceforge.net
478 nbatada _ users.sourceforge.net