Skip to content

v4.3.0
Compare
Choose a tag to compare
@mrossinek mrossinek released this 12 Nov 11:23
· 463 commits to master since this release
v4.3.0
e7f4242
This commit was signed with the committer’s verified signature.
mrossinek Max Rossmannek
GPG key ID: 56A00C6733F2D056
Verified
Learn about vigilant mode.

[4.3.0] - 2023-11-12

Pypi: https://pypi.org/project/cobib/4.3.0/

Prelude

Detailed Authors

coBib now has the ability to store more detailed author information (see #92 and
!88). This means, that the author field of an entry is analyzed in more detail
and coBib will separate out the first and last names as well as name pre- and
suffixes. The new setting config.database.format.author_format determines,
whether this detailed information is kept directly in the database (the
AuthorFormat.YAML setting; the new default) or is only constructed at
runtime and the author field is still simply saved in BibLaTeX form
(AuthorFormat.BIBLATEX).

Note, that the YAML format also implies, that Unicode characters are allowed
and will not be encoded in LaTeX form. This has an effect on how you may need
to format your searches. See also #130 for some more insights on this.

If you have company names or any author name which you want to have treated
verbatim, you can simply wrap it in curly braces (e.g. {My Company}).
Refer to the online documentation of cobib.database.Author and the above
setting for more details.

Wiki

coBib now has a Wiki where we can
gather useful configuration resources and other details which may not make it
into the full documentation.

For example, if you are interested in the tracking more metadata of your
database (as suggested in #123), be sure to check out
this wiki page!

Added

  • the -f short-hand alias for the --field argument of the open command
  • the opened_entries attribute of the OpenCommand (which is accessible during the PostOpenCommand hook)
  • the new git command to simplify running git operations on the database (#124)
  • new bindings for Home, End, PageUp, and PageDown in the TUI
  • (DEV) added a new DEPRECATED logging level which has value 45
  • Python 3.12 is now officially tested and supported
  • the config.commands.show.encode_latex setting
  • the encode_latex attribute to the BibtexParser
  • the config.database.format.verbatim_fields setting
  • the config.database.format.author_format setting. The new default behavior
    is to store detailed author information in YAML form.
  • the encode_latex keyword-argument to the Entry.stringify method
  • the Entry.formatted method. This replaces the Entry.escape_special_chars method.

Changed

  • an error will be logged when a file is not found during the open command
  • the following commands are now treated specially when run via the : prompt of the TUI:
    • init: will log an error
    • git: will log an error
    • show: will log a warning

Deprecated

  • The LabelSuffix.CAPTIAL value because it was misspelled. Please use LabelSuffix.CAPITAL instead.

Fixed

  • non-asynchronous commands triggered via the : prompt of the TUI will no longer break it (#125)
  • ensure UTF-8 encoding is used for downloaded data (this fixes many odd encounters w.r.t. special characters)
  • the spelling of the LabelSuffix.CAPITAL value (it used to be spelled LabelSuffix.CAPTIAL)

Removed

  • the Entry.escape_special_chars method. Use Entry.formatted instead.
Assets 2
Loading