# Change Log
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).


## [Unreleased]


## [1.3.0] - 2026-02-19
Fixes interoperability with Zotero v8 + BetterBibtex, but not backward
compatible.
### Changed
- Update queries for the new Zotero SQLite DB format for citation keys.
- Move Better Bibtex mapping to use the new Zotero SQLite citation key table.


## [1.2.0] - 2026-01-04
### Changed
- Switch build tools to [pixi].
- Add support for Python 3.13.
- Upgrade [zensols.dbutil] to 1.5.0.


## [1.1.0] - 2025-01-11
### Removed
- Support for Python 3.10.

### Changed
- Upgraded to [zensols.util] version 1.15.


## [1.0.0] - 2024-09-22
Somewhat minor feature release to add BetterBibtex citation and item attachment
(paper) lookup.

### Changed
- Refactored the database (`zensols.zotsite.db`) module by separating SQL into
  resource file and use connection pooling with the [zensols.dbutil] package.

### Removed
- The command line render (`show` option) to render the website after export.

### Added
- BetterBibtex citation key output with the `lookup` command line action.
- Integration tests with mock Zotero database. Now all tests are self
  contained.
- An API and command line to give attachment (paper document) paths based on an
  item key.  This can be combined with the item ID to citation ID mapping if
  starting with a BetterBibtex citation ID.
- An example of using finding and displaying papers using the new API.


## [0.9.1] - 2024-01-02
### Changed
- BetterBibtex version 6.7.140: retrieve citations keys from the `citationkey`
  table rather than the JSON blob in the `better-bibtex` table.  This change
  fixes new entries using the BetterBibtex citation keys for some users and
  fixes runtime errors for others.


## [0.9.0] - 2023-12-05
### Changed
- Upgrade to [zensols.util] version 1.14.

### Added
- Support for Python 3.11.

### Removed
- Support for Python 3.9.


## [0.8.2] - 2023-10-25
### Changed
- [Fixed SQLite access](https://github.com/plandes/zotsite/pull/29) to cite
  keys, by [Emiliano Heyns](https://github.com/retorquere), after better-bibtex
  upgrade.
- Added icon mapping for `preprint` and `dataset`.


## [0.8.1] - 2023-08-23
### Changed
- Add an configuration option to robustly handle errors generated by the
  operating system on file system access (perhaps from a corrupted database.


## [0.8.0] - 2023-08-16
Downstream moderate risk update release.

### Changed
- Upgrade to [zensols.util] v1.13.0.


## [0.7.0] - 2023-01-22
### Changed
- Upgrade to [zensols.util] v1.12.0.


## [0.6.3] - 2022-11-21
### Changed
- Default tilde home directory as Windows uses other environment variables.
  Python's `pathlib` appears to be able to find them per [issue 20].

- Updated documentation.


## [0.6.2] - 2022-10-30
### Changed
- Another bug fix to [DataTables] initialization.


## [0.6.1] - 2022-10-29
### Changed
- Bug fix to [DataTables] initialization.


## [0.6.0] - 2022-10-29
### Added
- Added a collections table of all the child items/papers.  This involves
  adding [DataTables] as a dependency.
- Optionally view the created export in a browser using [zensols.showfile].

### Changes
- Storage (paper PDF files) keep time stamps to speed up rsync.
- Upgraded to Bootstrap 4.6.2.


## [0.5.0] - 2022-10-28
### Changes
- Sort nodes by item name in the left tree navigation (thanks to
  [Cai-98](https://github.com/Cai-98)).
- Upgrade to [zensols.util] 1.11.
- Separate database filtering using `where` clauses and regular expression
  pattern filtering. 

### Added
- Support for Python 3.9, 3.10.

### Removed
- Support for Python 3.7, 3.8.


## [0.4.0] - 2022-08-08
### Added
- Add URL parameter to go directly to the PDF.

### Changed
- Fix `zensols.util` dependency for Python 3.7 and 3.8 comparability.


## [0.3.6] - 2021-03-23
### Changed
- Add pattern support for attachment prefix in items.  It appears that it acts
  like `storage` used to point to a file in the storage path.  See issue
  [#18](https://github.com/plandes/zotsite/issues/18).


## [0.3.5] - 2021-03-16
### Changed
- Switch from travis to github workflows.
- Upgrade to [zensols.util] 1.4.1.


## [0.3.4] - 2020-12-09
### Added
- Sphinx documentation, which includes API docs.
### Changed
- Upgrade to [zensols.util] 1.3.0.


## [0.3.3] - 2020-04-25
### Changed
- Upgrade to [zensols.util] 1.2.0.

### Removed
- Drop support for Python 3.6.

### Added
- Added icons for thesis, patents and blog posts.
- Added option to sort items in the tree navigation.


## [0.3.2] - 2020-01-03
### Added
- Compatibility with [ZotFile].  Specifically, now storage locations are used
  verbatim if 1) no `storage:` is found in the resource name and 2) if the
  resource is a file found on the OS.


## [0.3.1] - 2019-12-24
### Changed
- Fixed export error: `No such file or directory: 'resources/src'`.


## [0.3.0] - 2019-12-20
### Added
- Collections filtering using regular expressions is now fully supported.
- Ability to link directly to any item in the hierarchy.
- Link button that copies the current page URL to the clipboard.
- Added [BetterBibtex] references for easy linking to the site with citation
  keys.
- HTML (i.e. snapshots) are now visible in the pane PDFs are displayed.
- Short files to reduce character/file system conflicts.
- Clear button to reset the interface.
- Added creators (authors) to metadata pane.

### Changed
- Beautification of the metadata keys in the item table view.
- Changed default naming to use short files.
- Simpler command line by moving configuration to the configuration file.
- Refactored: cleaned up class structure and graph iteration OO class patterns.
- Retrofit new actioncli features.
- Move to more advanced configparser, which uses new notation (example:
  `$(HOME)s` -> `${HOME}`).
- Metadata is sorted.


## [0.2.3] - 2018-09-08
### Added
- Feature to export collections based on an regular expression match on name.

### Changes
- Notes now have full note text with Zotero CSS, so it looks as it does in the
  desktop app.  Note titles have the text from the note title instead of just
  `Note`.


## [0.2.2] - 2018-08-31
### Added
- Get version from pkg resources.


## [0.2.1] - 2018-08-11
### Changed
- Fixed pip wheel dependency auto install.
- New python build.


## [0.2.0] - 2018-08-10
### Added
- More icons for more resource types
- Added example site.

### Changed
- Fix new item type for which there is no icon.
- Fix include trash doc.
- Move to three dimension version numbering


## [0.0.1] - 2018-03-07
### Added
- Initial version


[Unreleased]: https://github.com/plandes/zotsite/compare/v1.3.0...HEAD
[1.3.0]: https://github.com/plandes/zotsite/compare/v1.2.0...v1.3.0
[1.2.0]: https://github.com/plandes/zotsite/compare/v1.1.0...v1.2.0
[1.1.0]: https://github.com/plandes/zotsite/compare/v1.0.0...v1.1.0
[1.0.0]: https://github.com/plandes/zotsite/compare/v0.9.1...v1.0.0
[0.9.1]: https://github.com/plandes/zotsite/compare/v0.9.0...v0.9.1
[0.9.0]: https://github.com/plandes/zotsite/compare/v0.8.2...v0.9.0
[0.8.2]: https://github.com/plandes/zotsite/compare/v0.8.1...v0.8.2
[0.8.1]: https://github.com/plandes/zotsite/compare/v0.8.0...v0.8.1
[0.8.0]: https://github.com/plandes/zotsite/compare/v0.7.0...v0.8.0
[0.7.0]: https://github.com/plandes/zotsite/compare/v0.6.3...v0.7.0
[0.6.3]: https://github.com/plandes/zotsite/compare/v0.6.2...v0.6.3
[0.6.2]: https://github.com/plandes/zotsite/compare/v0.6.1...v0.6.2
[0.6.1]: https://github.com/plandes/zotsite/compare/v0.6.0...v0.6.1
[0.6.0]: https://github.com/plandes/zotsite/compare/v0.5.0...v0.6.0
[0.5.0]: https://github.com/plandes/zotsite/compare/v0.4.0...v0.5.0
[0.4.0]: https://github.com/plandes/zotsite/compare/v0.3.6...v0.4.0
[0.3.6]: https://github.com/plandes/zotsite/compare/v0.3.5...v0.3.6
[0.3.5]: https://github.com/plandes/zotsite/compare/v0.3.4...v0.3.5
[0.3.4]: https://github.com/plandes/zotsite/compare/v0.3.3...v0.3.4
[0.3.3]: https://github.com/plandes/zotsite/compare/v0.3.2...v0.3.3
[0.3.2]: https://github.com/plandes/zotsite/compare/v0.3.1...v0.3.2
[0.3.1]: https://github.com/plandes/zotsite/compare/v0.3.0...v0.3.1
[0.3.0]: https://github.com/plandes/zotsite/compare/v0.2.3...v0.3.0
[0.2.3]: https://github.com/plandes/zotsite/compare/v0.2.2...v0.2.3
[0.2.2]: https://github.com/plandes/zotsite/compare/v0.2.1...v0.2.2
[0.2.1]: https://github.com/plandes/zotsite/compare/v0.2.0...v0.2.1
[0.2.0]: https://github.com/plandes/zotsite/compare/v0.1...v0.2.0

<!-- links -->
[BetterBibtex]: https://github.com/retorquere/zotero-better-bibtex
[ZotFile]: http://zotfile.com
[zensols.util]: https://github.com/plandes/util
[zensols.showfile]: https://github.com/plandes/rend
[zensols.dbutil]: https://github.com/plandes/dbutil
[DataTables]: https://datatables.net
[issue 20]: https://github.com/plandes/zotsite/issues/20#issuecomment-1321320667
[pixi]: https://pixi.sh
