Imported Upstream version 2.10~beta2+ds
[debian/jabref.git] / src / txt / README
index cf529108af36c0030561d311d3b725f63fe117b5..35385b6d178099f7609697b32db1d82d3f6f5607 100644 (file)
@@ -1,7 +1,5 @@
-
-JabRef 2.1 beta
----------------
-
+JabRef 2.10 beta 2
+------------------
 
 Introduction:
 
@@ -20,17 +18,19 @@ to convert from any import format to any export format.
 
 
 License:
-JabRef is free open source software, distributed under the GNU General
-Public Licence. See the enclosed text file 'gpl.txt', or the About
-dialog, for details about the GPL.
+JabRef is free software: you can redistribute it and/or modify it under the
+terms of the GNU General Public License as published by the Free Software
+Foundation, either version 2 of the License, or (at your option) any later
+version.  dialog, for details about the GPL. See the enclosed text files
+'gpl2.txt' and 'gpl3.txt' for the full details.
 
-JabRef also uses libraries distributed by other porties; see the About
+JabRef also uses libraries distributed by other parties; see the About
 box for details.
 
 
 Requirements:
 JabRef runs on any system equipped with the Java Virtual Machine
-(1.4.2 or newer), which can be downloaded at no cost from
+(1.5 or newer), which can be downloaded at no cost from
 http://java.sun.com. If you do not plan to compile JabRef, the Java
 Runtime Environment may be a better choice than the Java Development
 Kit.
@@ -55,9 +55,8 @@ or, if you are using the Java Runtime Environment:
      jre -new -jar <path to jar> or
      jrew -new -jar <path to jar>
 
-We recommend running JabRef under the Java 5.0 JRE. If you do, you should add
-the option "-Dswing.aatext=true" before the "-jar" option, to activate
-antialiased text throughout the application.
+If you run JabRef under Java 1.5, you can add the option "-Dswing.aatext=true" before the
+"-jar" option, to activate antialiased text throughout the application.
 
 
 The jar file containing JabRef can be unpacked with the command:
@@ -79,369 +78,6 @@ can also be viewed outside the program with a standard HTML browser.
 If you choose languages other than English, some or all help pages may
 appear in your chosen languages.
 
-Change log:
-2.1b    - Known issue: font sizes cannot be changed, but should follow OS settings on
-          Windows and Mac.
-        - Known issue: some HTML may be handled inappropriately when downloading from
-          IEEEXplore.
-        - Changed Paste function so timestamp and owner fields are updated.
-        - Added "Other" item to the "New entry ..." menu.
-        - Changed sorting order so marked entries are displayed at the top of the table.
-        - Added IEEEXplore search and download feature.
-        - Added option to store entries in their original order. Unsorted table view now
-          shows entries in their original order.
-        - Added option to autogenerate keys for entries with missing keys before each save.
-        - Improved handling of external URLs to prevent problems with special characters.
-        - Medline and Endnote imports no longer automatically add curly braces around capital
-          letters in title.
-        - Float search now scrolls table to the top.
-        - Fixed lockup problem in preview with uneven number of # characters in fields.
-        - Fixed problem with default content selector fields reappearing after removal.
-        - Fixed problem with unsupported character encodings being selectable and causing
-          unreported save errors.
-        - Fixed bug that blocked last line in table columns setup from being removed.
-        - Fixed missing export formats from command line.
-        - Fixed bug that made Review tab impossible to remove from entry editor.
-        - Fixed bug in Medline XML import that assigned wrong PMID for some entries.
-        - Fixed bug in custom export that collapsed sequences of two or more backslashes
-          into a single backslash in output.
-        - Fixed bug (misspelled formatter name) in Harvard RTF export.
-2.0.1: - Fixed bug that made a hidden entry editor under some circumstances store a
-             field value to the wrong entry.
-           - Fixed synchronization bug that made the opening of a new database sometimes fail.
-           - Fixed bug in setting external journal lists when no personal list is set.
-2.0:    - Changed sorting selection interface for main table for more intuitive
-          operation.
-        - Made import operation update "working directory".
-        - Removed hard-coded author/editor name rearrangement in OpenOffice and
-          OpenDocument exports.
-        - Fixed hangup when parsing RIS files from Nature.
-        - Fixed NullPointerException when generating database from AUX file on Mac OS X.
-        - Fixed bug in routine for adding braces around capital letters.
-        - Fixed bug in switching preview layouts.
-        - Fixed bug in link handling in entry preview.
-2.0b2:  - Changed field order in OpenDocument export to comply with bibliography requirement.
-        - Added support for inserting citations into Emacs using gnuserv/gnuclient.
-        - Added option to set a regular expression replace operation on generated bibtex keys.
-        - Added support for custom importers inside a jar file.
-        - Fixed bug in opening URLs containing '&' on Windows.
-2.0b:   - Added a system for registering custom import formats in the form of Java classes.
-        - Added export option for OpenDocument spreadsheet.
-        - Added new options for name formatting in main table.
-        - Added REPEC-NEP import filter.
-        - Added option for non-field parameters for export formatters. If the parameters does not start with the
-          backslash character, it will be passed unchanged to the formatter in place of any field value.
-        - Added export formatter CurrentDate, which returns the current date, and takes a format string as
-          parameter.                   
-        - Added customization of table colors, accessible from Tools -> Preferences -> Entry table.
-        - Added new Appearance tab to preferences dialog to gather appearance related options.
-        - Added toggling of abbreviated and full journal names. The list of journals is realized as
-           an external file, but editable from a Manage Journal Abbreviations panel. Secondary lists can also
-           be linked, but not edited. There is a download option to quickly get a list available on the internet,
-           and we will provide one or more lists for download from the SourceForge web server.
-        - Added functionality for new JabRef instances to detect a running instance, and send
-          command line parameters to the running instance for processing.
-        - Added handling of HTML links in preview panel.
-        - Added confirmation dialog when database is saved and the chosen encoding doesn't support all characters.
-          Gives options to save, cancel or try a different encoding.
-        - The encoding used when opening a database is now remembered, and used when database is stored.
-        - Added review field for research comments, paper reviews, etc.
-        - Added option to disable wrapping for certain fields. Wrapping of pdf, ps, doi and url is disabled by
-          default.
-        - Antialiasing option now affects entry editor text fields as well as table text.
-        - Changed to monospaced font in source editor field.
-        - Removed option to put double braces around BibTeX fields, but retained option to remove double braces
-          when loading. Added option to put braces around capital letters of a chosen set of fields.
-        - Improved Ovid import.
-        - Fixed problem with ordering of BibTeX strings that are referred to by other strings.
-        - Fixed problem with loading 16-bit encoded bib files with 8-bit encoding as default, and vice versa.
-        - Fixed multiplying authors bug when author/editor field appears both in Required and Optional tabs.
-        - Fixed startup freeze when trying to load certain malformed bib files.
-        - Fixed bug related to multi-line fields in RIS import.
-        - Fixed bug related to looking up a fully qualified DOI
-        - Included review field to preview panel 1, which shows the abstract
-        - Fixed bug where booktitle field was not displayed in preview
-          for conference proceedings, similar to journal field
-        - By default preserve capitalization on the following fields: title;journal;booktitle;review;abstract
-1.8.1:  - Added automatic timestamp with configurable format for entries.
-        - Added new key generator modifier ":abbr" to abbreviate field contents.
-        - Added Help button in Preferences -> Entry preview
-        - Added Big5, Big5_HKSCS and GBK encodings for Chinese.
-        - Improved marking feature. Username is now used for marking, so different users can mark
-          entries separately without interference.
-        - Improved handling of names such as "Firstname de la Lastname jr.", with different handling
-          for presentation and sorting purposes. Key generation now should always use the genuine last
-          name, and not produce keys like "de2001".
-        - Removed duplicate warning from inspection dialog for non-selected entries.
-        - Fixed setting of sheet name in OpenOffice.org Calc export.
-        - Fixed bug that prevented PDF/PS opening by F4 from automatically finding files in
-          subdirectories below the main PDF/PS dir.
-        - Fixed BibTeX parser bug that made it choke on short comment strings.
-        - Fixed bug that made regexp search fail for fields containing newline characters.
-        - Fixed platform-dependent handling of newline characters.
-        - Fixed bug that prevented command line import with explicit format.
-        - Fixed bug that made it impossible to disable table antialiasing.
-        - Fixed AuthorAndsCommaReplacer.
-1.8:    - Search panel now starts visible if it was visible at last shutdown.
-        - Added option to disable import inspection window when only one entry is being imported.
-        - Fixed parser bug that caused problems for bib files containing extra characters after the
-          last entry.
-        - Fixed missing month in JStor import.
-           - Fixed some bugs in "new from plain-text" wizard
-1.8b2:  - Changed handling of external updates so the notification is suppressed when there are
-          no actual changes.
-        - Changed autodetecting import so BibTeX files are handled more similarly to other formats.
-        - Enabled sorting by icon columns.
-        - Added option to remove BibTeX source panel from entry editor.
-        - Added command line option to not load any files at startup. Will override any autoloading
-          or other command line options that normally load or import files.
-        - Added handling of duplicates to import inspection window.
-        - Made entry preview be updated whenever the selection is expanded by one row, to make
-          it more useful while selecting a set of entries.
-        - Changed BibTeX field parsing to avoid inserting line breaks at wrong places.
-        - Improved handling of page numbers in Medline import.
-        - Fixed import of file links when importing SixPack files.
-        - Fixed bug that prevented closing of search interface when no databases are open.
-        - Fixed OpenOffice Calc export to be compatible with OpenOffice.org 2.0 beta.
-        - Fixed bugs in Refer/Endnote import filter. 
-        - Fixed bug that caused changes to be lost in some cases when the same field is present
-          in multiple entry editor tabs.
-        - Fixed bug that prevented command line autodetecting import from working with BibTeX files.
-        - Fixed minor bug in routine for removing double braces.
-1.8b:   - Added option to store bib file with double braces.
-        - Follow @input tags in aux files to indicate nested aux files for
-          generating subdatabases.
-        - Improved wrapping and formatting of bib files, to preserve paragraph separator (empty line).
-        - Added test buttons for customization of preview layouts.
-        - Added inspection dialog for previewing and generating keys for imported entries,
-          and deciding which ones to keep and discard. The dialog allows inspection during long import
-          processes such as Medline search.
-        - Restructured layout to use a common side pane with all tabs.
-        - Added import filter for Cambridge Scientific Abstracts (CSA) format.
-        - Added PS directory with similar options as PDF.
-           - Added [authshort] and [edtrshort] key field markers. Patch submitted by
-             Kolja Brix.
-        - Made the program remember preview enable setting.
-        - Improved handling of illegal regular expressions in search.
-        - Removed options to search only Required, Optional and/or General fields,
-          in order to simplify search interface.
-        - Changed keys for Next and Previous tab to CTRL-PGDN and CTRL-PGUP to match shortcuts in a
-          certain popular web browser.
-        - Minor change to Preferences -> Table columns to enable insertion of column in position 2.
-        - Fixed parser bug that caused problems for files with >10000 entries.
-        - Fixed bug in entry editor that caused the source edit panel to remove marking from entries.
-        - Fixed export bug that made "\begin" tags fail if encountered immediately after an "\end" tag. 
-        - Fixed export bug that made whitespace disappear after empty field values.
-        - Fixed ISI import bug that handled SO fields with line breaks wrong.
-        - Fixed bug occuring when choosing not to import duplicate imported entry.
-        - Fixed problem with detecting popup trigger on Mac OSX with one button mouse.
-        - Fixed erroneous relative paths for PDF files when PDF directory is not set.
-        - Fixed entry preview to resolve string references.
-1.7.1   - Removed unnecessary stack traces when opening external viewer.
-        - Fixed bug that made Ctrl-E destroy current edit in entry editor.
-        - Fixed problem when copying modified BibTeX key gave old value.
-        - Fixed missing 'booktitle' import in CONF entries in RIS import.
-        - Fixed bug that made group tree disappear for certain keyword expressions.
-        - Fixed bug that made standard BibTeX fields be saved without line wrapping.
-1.7     - When fetching from Medline or CiteSeer, fetched entry is now opened in editor.
-        - Added French translations of help files.
-        - Added color highlighting of focused text field in entry editor.
-        - Added option in context menu of entry editor for changing capitalization
-              of field contents.
-            - Added name conversion "Smith, RA" -> "Smith, R. A." to Medline import.
-            - Fixed bug that left some search settings items disabled when they shouldn't be.
-        - Fixed bug that caused requirement for restart to register change in default
-          key pattern.
-        - Fixed bug that caused crash some times after adding/removing field content selectors.
-        - Fixed bug in recognizing custom entry types when reading bib files.
-        - Fixed bug that allowed a deleted entry to stay visible in the entry editor.
-1.7b2:  - Made side pane resizable.
-        - Replaced entry customization dialog with improved interface.
-        - Added standard entry type "conference", similar to "inproceedings".
-        - Added default key pattern to avoid the need to set similar patterns manually.
-        - Added line wrapping to metadata in saved .bib file to avoid long lines.
-        - Added "bibtexkey" as implicit fourth sort criterion, to minimize problem with almost
-          similar entries swapping places.
-        - Added OpenOffice.org Calc export filter that exports spreadsheet compatible with the
-          OpenOffice.org bibliography feature.
-        - Added a couple of previously unsupported publication types in SciFinder.
-        - Added extra shortcuts CTRL-+ and CTRL-- for switching tabs in entry editor, since
-          original shortcuts CTRL[-SHIFT]-TAB is used by some window managers.
-        - Updated Endnote export filter.
-        - Fixed focus and key binding problems for switching tabs/entries in entry editor
-        - Fixed bug that prevented required fields tab from appearing for entries with only bibtex key
-          as required field.
-        - Fixed bug that prevented the user from changing the default encoding.
-        - Fixed bugs in RIS import.
-        - Fixed bug 1112050; freeze when reading certain author fields with mismatched braces.
-1.7b:  - Changed routine for rearranging author names (Lastname, Firstname) so bracketed
-            expressions are treated as units.
-        - Grouping controls now allow group hierarchies, and now allow explicit and search
-          expression groups as well as keyword groups.
-        - Added full customization of general fields tabs
-        - Added option to preserve formatting for non-BibTeX fields.
-        - Added integrity check for database.
-        - Added export filters EndNote and Harvard RTF.
-        - Added automatic import format chooser for import (same as wildcard import below).
-        - Added wildcard (*) option for command-line import, to try to automatically
-          determine the correct format.
-        - Improved layout of Preferences dialog.
-        - Improved several import filters.
-        - Added authIniN/edtrIniN key formatters.
-        - Marked entries now float to the top when no searching or grouping reordering is active.
-        - Fixed problem with opening file dialog on Win NT - AWT dialog is now opened if
-          Swing dialog fails.
-1.6:    - Improved handling of entry selection in various ways. E.g. selected entry is now scrolled
-          into view when opening entry editor and entry is kept selected when importing CiteSeer
-          fields.
-        - Fixed update bug between autogenerated bibtex key and source panel.
-        - Fixed missing . at the end of last author name in RIS import.
-        - Fixed NullPointerException on certain special characters when exporting to BibTeXML.
-        - Fixed bug that sometimes prevented the unmarking of entries.
-        - Fixed problem with formatting one-name authors.
-1.6b:  - Added mnemonic keys to menus and menu items.
-        - Added MODS and tab-separated file export
-        - Added facility for detecting and handling external changes to open bib files.
-        - Added scan option for exact duplicates with automatic removal.
-        - Bibtex strings are now sorted automatically.
-        - Bibtex strings are now resolved when exporting database.
-        - Fixed problem with field content selector getting too wide. Limited width.
-        - Fixed PDF/PS view routine to remove problems with filenames
-          containing spaces.
-        - Fixed bug that interfered with Fetch Medline by ID, and fixed
-          parsing problem with certain Medline entries.
-        - Fixed bug that interfered with Push to WinEdt.
-        - Fixed HTML output so \c{c} is handled correctly.
-        - command line option for generating a sub-database from LaTex aux file
-          entries
-        - simple copy/paste menu in entry editor
-        - experimental: text-input-area with underlying infotext in plaintext import dialog
-1.55:  - Made method for opening PDF files robust with regard to file separators (/ and \),
-          so bib files can easier be used across platforms.
-        - Improved Medline fetcher. Can now fetch entries based on a search expression.
-        - Added features for fetching fields and referring publications from the CiteSeer
-          database.
-        - Added option to always save database ordered by author/editor/year, and made this
-          the default setting.
-        - When a single entry is selected, right-click menu now shows a checkbox menu for group
-          memberships instead of the regular "Add to" and "Remove from" menus.
-        - Improved [shorttitle] and [veryshorttitle] special key pattern fields.
-        - Added dialog box for conveniently setting the fields of an entry from a
-          plain text description.
-        - Added formatter "ResolvePDF" to create correct PDF/PS links in HTML export when
-          relative file names are used.
-        - Added Abstract panel in entry editor.
-        - Added alternate preview with abstract, and made both previews configurable.
-        - Added the option to create a subset of a database based on an .aux file.
-        - Added 'Cancel' button to duplicate resolver dialog, so the process can be stopped.
-        - Added check for spaces in custom entry type names.
-        - Added several new key pattern markers.
-        - Added toolbar buttons for Mark/Unmark to improve discoverability.
-        - Fixed bug that made export filters ignore the chosen character encoding.
-        - Fixed bug that interfered with author name formatting.
-        - Fixed various bugs in import filters.
-        - Fixed bug that prevented confirmation dialog when deleting entry from the entry editor.
-        - Fixed bug that made the next entry be opened instead of the current, when pressing
-          Enter in table.
-        - Fixed bug that made it possible to leave a source edit when the source didn't validate
-          properly. Also made it impossible to change table selection until source validates.
-1.5:   - Enabled selection of default encoding, and started storing encoding information in
-          saved .bib files, which is used when reopening.
-        - Added Highlight and select options to the group interface, and made it possible
-            to change the number of visible lines in the list.
-              - Added option to allow or disallow direct table editing.
-        - Added optional confirmation dialog for deleting entries.
-              - Added optional warning dialog for duplicate BibTeX keys.
-        - Added warnings to bibtex parser, and prevented failure to load files with
-          duplicate string definitions.
-              - Added JStor import filter.
-        - Changed the look and feel to JGoodies Forms on non-Macintosh platforms.
-        - Optimized performance in several areas.
-        - Numerous usability improvements.
-        - Fixed RIS import bug caused by short lines.
-              - Fixed bug in SciFinder import.
-              - Fixed bug that made entire field get cleared when removing from group.
-1.4:   - Added advanced search feature.
-        - Added facility for using custom export formats.
-        - Added command line options for importing/exporting files, importing/exporting
-          user preferences, loading session and for suppressing the GUI (using RitOpt for
-          parsing options).
-        - Added automatic stripping of \url{} when opening url.
-        - Improved export filters.
-        - Fixed focus bug which sometimes interfered with cut/copy/paste.
-1.3.1: - Bugfix.
-1.3:   - Added entry preview.
-        - Added detection of duplicate entries.
-              - Added possibility to mark entries persistently.
-        - Added import filter for Sixpack and Biblioscape Tag files.
-              - Added option to use a standard directory for PDFs. PDFs placed in or below this directory
-          and named after an entry's BibTeX key can be automatically found.
-            - Added optional columns showing clickable icons for pdf/ps and url/doi links.
-        - Added menu and toolbar actions for open pdf/ps and url/doi.
-        - Added web lookup of DOI.
-        - Added several new special field markers to the key autogenerator.
-              - Added BibTeXML and simple HTML export.
-              - Changed browsing of entries. Entry editor now shows the selected entry.
-              - Improved HTML export for several entry types.
-              - Improved compatibility with Mac OS X.
-        - Made it possible to set custom secondary and tertiary sort fields.
-        - Made the entry number column width customizable.
-              - Fixed bug that caused database to always be marked as changed after viewing source.
-               - Fixed bug in selector word removal.
-               - Fixed bug that made the file chooser unable to interpret Mac OS X aliases.
-1.2:   - Replaced the icon set.
-        - Added support for French language.
-        - Added customization of key generation.
-        - Improved HTML export.
-        - Added Replace string feature.
-            - Made a couple of adaptations for Mac OS X users.
-        - Added option in Table Preferences to set current column widths as default.
-            - Added import filter for BibTeXML.
-        - Fixed bug that allowed non-lowercase grouping field, leading to problems.
-        - Fixed bug that made selector words added in the dialog to be lowercased.
-        - Fixed bug relating to translated help files.
-1.19:  - Entry editor is now opened for an entry that causes an error when saving.
-        - Added options to display names in harmonised format in the main table.
-        - Added Docbook and (experimental) HTML export.
-        - Enabled 'doi' and 'pii' fields for Medline import.
-        - Enabled antialiasing fonts.
-        - Added the Kunststoff look&feel to give a more pleasant user interface.
-        - Added font selector for the main table.
-        - Improved table column customization.
-        - Added word selector feature for selected fields (keywords, journal).
-        - Added support for German and Norwegian language.
-        - Generalized copy cite key features for multiple entries.
-        - Added quick load/save session feature.
-        - Fixed issue/number bug in ISI import.
-        - Added "Open pdf/ps" item in right-click menu.
-        - Fixed bug causing external viewer to only work in General fields.
-        - Added functionality for using Browse buttons for file-related fields
-          (ps, pdf, etc.).
-        - Added Browse buttons to External programs tab in Preferences.
-        - Fixed bug related to Save database and Source field which caused changes
-          to disappear.
-1.1:   - Added bibtex key uniqueness checking, and prevented autogeneration
-          from generating non-unique keys.
-        - Added command line option to load file on startup.
-        - Fixed problem with autogeneration creating invalid keys.
-        - Improved Refer/Endnote import.
-        - Added feature for importing entries and/or strings and/or group
-          definitions from another BibTeX database.
-        - Added menu choices to import into open database.
-              - Added toolbar button for closing current database.
-              - Fixed shortcut key for "Store field" in entry editor, and fixed
-                problem that made shortcut for "Save database" unavailable from
-          entry editor.
-        - Added option to fetch Medline entries automatically by
-          ID, based on a patch submitted by Mike Smoot.
-        - Fixed bug in RIS import.
-        - Added options to copy key and copy "\cite{key}" to right-click menu.
-        - Fixed bug that caused some General fields not to get displayed.
-        - Enabled customization of General fields.
-        - Enabled customization of existing entry types, and definition of
-          new types.
-1.0:   First release.
-
 
 Bug reports, suggestions, other feedback:
 We are thankful for any bug reports or other feedback. If there are
@@ -451,12 +87,10 @@ features you want included in JabRef, tell us!
 JabRef homepage:
 http://jabref.sourceforge.net
 
-You can always get the very latest version of the program from our CVS
+You can always get the very latest version of the program from our SVN
 repository; instructions for downloading are found on the
-homepage. Note that the CVS version may contain untested features, or
-have other stability issues. Unless you're feeling extremely lucky, go
-for the version in the HEAD branch of the module 'jabref'.
-
+homepage. Note that the SVN version may contain untested features, or
+have other stability issues.
 
 Bug submission and Open Discussions and Help forums are found at:
 http://sourceforge.net/projects/jabref