RELEASE NOTES for Calibre2Opds v3.2
-----------------------------------
Documentation
~~~~~~~~~~~~~
Online documentation for Calibre2Opds can now be found at:
http://calibre2opds.com/read-the-documentation/
There is a link to this from the main Calibre2Opds GUI via the Help
button. It is also included in the Calibre2Opds catalogs at the top
level. User areencouraged to pass back suggestions for enhancments
to reflect their experience of using Calibre2Opds.
The #number type references in these notes refer to the bug number
entries for calibre2opds in the calibre2opds Issue register that is at:
http://calibre2opds.myjetbrains.com/youtrack/
Localizations
~~~~~~~~~~~~~
The Calibre2Opds application is designed to make it easy to be
localized to languages other than English. However to do so, input
is required from those who can speak those languages to provide the
correct localization text. This is not a task that requires
programming skills, so users are encouraged to contribute their
expertise in this area. The details on how to go about this can be
found at:
http://calibre2opds.com/read-the-doc.../localization/
Known Issues
~~~~~~~~~~~~
The following issues are known to be outstanding in this release. More detail can be found by
looking at the calibre2opds issue register (
http://calibre2opds.myjetbrains.com/youtrack/)
- #627926 Publish mode limiting formats allowed (will be fixed by #c2o-93)
- #729859 Internal links not working in XML catalogs
(may not be fixable as it tends to be a limitation of the OPDS clients)
- #c2o-15 Filenames generated can exceed system limits
(this is particularly likely to happen in the larger catalog sections on very large
libraries, or if many sub-levels based on tags are specified). The avoidance actio is
to ensure that the Maximum Number of Split Levels option is set to a small value (e.g. 3)
- #c2o-94: Trook compatibility (lack of Nook+Trook hindering investigation)
- #c2o-86: Incorrect Mime type for FB2 files (will be fixed by #c2o-93)
- #c2o-100: Uninstall does not work under Windows 7
- #c2o-123: Not handling missing file
- Localization: The current localizations now have significant gaps until users can provide the
required translation strings for the large number of new messages introduced in v3.0.
If you think that you have found a bug, or would simply like to raise a feature request for a
new capability this can be done via the calibre2opds Issue tracking system at
http://calibre2opds.myjetbrains.com/youtrack/
Outstanding Feature Requests
~~~~~~~~~~~~~~~~~~~~--------
The items listed below are under consideration for future releases.
Nore detail can be found in many cases on the calibre2opds Issue register
(
http://calibre2opds.myjetbrains.com/youtrack/). Note that the fact a feature is listed
here is not a committment that it will appear, but merely that it is under consideration.
User are encouraged to add comments to the relevant issues in the Issue Register on their views.
- Improve/Extend localizations.
- #c2o-26: Introduce a carousel mode for the book pages
- #c2o-29: Generate a recent books RSS-compatible catalog
- #c2o-38: Is it possible to generate a flat display for catalogues
- #c2o-48: Generate the full-text search HTML page dynamically
- #c2o-59: Use Calibre library_sort field when sorting books
- #c2o-62: Unfriendly error message when problem with Search in custom catalogs
- #c2o-63: Allow for authors to be displayed like in Calibre
- #c2o-66: Custom catalog tab not correctly reset on switching profiles
- #c2o-74: Goto Page option in HTML catalogs
- #c2o-76: Add context sensitive links to help (documentation)
- #c2o-82: Test option for Saved Searches/ Custom Catalogs
- #c2o-90: Make Custom Catalogs setting easier to edit manually in XML
- #c2o-93: Make supported formats and Mime type extendable by users
- #c2o-96: Add some runtime stats on Search database
- #c2o-102: Advise user when Log file contains errors or warnings
- #c2o-103: Goodreads URL (by Goodreads ID when available)
- #c2o-105: Add a download link to the 'group' pages
- #c2o-107: Speed up All Books phase of catalog generation
- #c2o-108: Omit download section for books with no available download
- #c2o-109: Improve navigation links in pages
- #c2o-115: Send to Readmill Library
- #c2o-118: Provide more control over display and sorting of Authors
- #c2o-119: Provide more control over display and sorting of Series
- #c20-125: Add Publishers section to generated catalog
- #c20-139: Include the .opf files when copying the library in "Publish" mode
- #c2o-143: Allow the book links to external sites to be localized
- #c20-144: Remove redundant folder names in relative links
- #c2o-145: Option to avoid splitting books by letter within a tag
- #x2o-146: Improve Search facility for large libraries
- #c2o-147: Option to suppress selected tags in tags sub-catalog
- #c2o-153: Allow Calibre Custom Column values to be displayed in Book Details
- #c2o-154: Allow Calibre Custom Column values to be treated like additional tags
- #c2o-155: Allow Calibre Custom Column values to be used in calibre2opds search criteria
Any requests for new features should be made by adding them to the Issue Register,
but please look through the list above first to avoid unecessary duplication. If you
have a requirement that might need some new feature, but you are nor sure exactly what
that feature might be thenIt might be a good idea to first discuss them either in the
calibre2opds forum, or the "Related Tools" section of the Calibre forum
Release History
---------------
The following shows the Calibre2Opds releases in reverse chronological order (so that the most recent
is at the top) showing main changes and bug fixes. The bug number references are to those
that have been recorded in the Issue tracker.
v3.2
- Change: Documentation moved back to wiki on MobileRead as it is easier to maintain than is the case on WordPress.
Using a wiki also allows for users to update it directly which should help with improving the documentation.
- Change: Reworked the way that filenames within the catalog are derived. Should mean that filenames are shorter
and less cryptic. However invalidates any cached names from earlier releases.
- Change: Reworked way the 'encrypt' files option is handled. When active an 'encryption string' is
added at the start of folder/file names only - but the remainder of names is same as unecrypted versions.
- Change: Improvements to run.cmd and rungui.cmd for handling 32-bit Java on 64-bit Windows
- Change: Changed the way progress text messages are derived so should be more meaningfull.
- New: Added counts to some of the generation progress lines where it made sense (authors, tags, series etc)
- Fix: #c2o-18: Re-organise GUI fields amongst the various tabs
(in particular move Featured Books fields to Custom Catalogs tab)
- Fix: #c2o-85: Sorting in the All Books catalog should ignore case
- Fix: #c2o-91: Setting catalog folder to root (/) is not treated as an error
- New: #c2o-97: Context sensitive help on configuration tabs
- Fix: #c2o-110: Remove the display of the "Stop catalog generation Button" while other dialog displayed on top
- Fix: #c2o-111: The "All Books" section within an author not sorted alphabetically
- New: #c2o-112: Do not delete .htaccess files from generated catalog
- Fix: #c2o-113: Tags have square brackets added in Book Details
- Fix: #c2o-114: Language is ignored when running on command line (cli)
- Fix: #c20-116: Improvements to German localization (thanks to Venia.Legendi)
- New: #c2o-117: Include year in Recent sub-catalog entries
- New: #c2o-120: Remove option to Exit from the confirm dialog displayed after pressing Save
- New: #c20-121: Add links to Localization and customization guides to Help menu
- New: #c2o-122: Allow more control over contents of Book Details pages.
- Fix: #c2o-123: Not handling missing file
- Fix: #c2o-128: Not Reading Ratings
- Fix: #c2o-130: prc format crashed calibre2opds
- Fix: #c2o-133: Add support for Kindle KF8 and AZW3 formats
- Fix: #c2o-134: Wrong sorting of list of authors/title with accent
- Fix: #c20-135: CALIBRE2OPDS_CONFIG Environment variable used incorrectly
- Fix: #c2o-140: Help URL's do not point to latest documentation
- Fix: #c2o-141: The 'Open Log File' option does not work on Windows 8
- New: #c2o-142: Allow the book links to external sites to be localized
(implemented for GUI defauls - not yet made book language specific)
- New: #c2o-147: (partial for Language) Option to suppress selected tags in tags sub-catalog
- Fix: #c2o-148: Catalog generation crashes 3.2 RC (r206)
- New: #c2o-149: Added an option to clear encrypted filenames cache to Tools menu
- Fix: #c2o-150: Bug 3.2 rev206M - java.lang.NullPointerException: null
= Fix: #c2o-151: Incorrect index link
- Fix: #c2o-152: Catalog generation causes crash. v. 3.1 rev170M and v3.2 Release Candidate (rev 206)
- Fix: #c2o-153: Crash during Copy if Calibre has altered book author/title during run
- New: #c2o-154: Allow the user to decide if language should be treated like a tag