src/txt/README

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