Version 2.2.1

citar-denote.el

@@ -5,7 +5,7 @@
 ;; Author: Peter Prevos <[email protected]>
 ;; Maintainer: Peter Prevos <[email protected]>
 ;; Homepage: https://github.com/pprevos/citar-denote
-;; Version: 2.2
+;; Version: 2.2.1
 ;; Package-Requires: ((emacs "28.1") (citar "1.4") (denote "2.0") (dash "2.19.1"))
 
 ;; This file is NOT part of GNU Emacs.
@@ -28,21 +28,14 @@
 ;; A minor-mode integrating 'citar' and 'denote' to create and manage
 ;; bibliographic notes.
 ;;
-;; Taking notes about the articles and books you read is essential to
-;; intellectual life.  Many note-taking systems can connect to a
-;; bibliographic database (such as a plain text BibTeX file or external
-;; software such as Zotero).  These databases are helpful when you need to
-;; add citations to your writing.  Electronic bibliographies also help you
-;; create and find notes related to your literature collection and provide
-;; access to related materials, such as online sources and files stored on
-;; your computer.
-
 ;; Citar-Denote integrates the Citar bibliography package with the Denote
 ;; note-taking system.  Citar lets you browse and act on bibliographic data
 ;; in BibTeX, BibLaTeX or JSON format.  Denote is a versatile Emacs package
 ;; for taking and managing notes. Combining these two packages enables
 ;; linking notes in your Denote collection to your bibliography, providing
 ;; a complete solution for documenting literature reviews.
+;;
+;; Read the manual with `C-h R citar-denote`.
 
 ;;; Code:
 

citar-denote.org

@@ -71,9 +71,9 @@ The default term between authors is "and", which can be changed by customising ~
 For example, when using up to three authors and "&" as a connecting term, the title for the example above becomes "Coppa, Hass & Peck et al. (2008)." 
 
 ** Bibliographic keywords
-Every new bibliographic note includes the =bib= file tag. This tag minimises the search space when caching notes to accelerate the process. The ~citar-denote-keyword~ variable lets you change the tag to something else. For example, if your primary language is Welsh, you might want to change it to =lly=.
+Every new bibliographic note includes the =bib= file tag. This tag minimises the search space when caching notes to accelerate the process. The ~citar-denote-keyword~ variable lets you change the tag to something else. For example, if your primary language is Welsh, you might want to change it to =llenyddiaeth= (literature).
 
-Changing the default keyword requires updating all your bibliographic notes because the package only recognises a single string. The Denote-Explore package provides a function to rename Denote keywords.
+Changing the default keyword requires updating all your bibliographic notes because the package only recognises a single string. The Denote-Explore package provides a function to rename Denote keywords. [[info:denote-explore#Managing Keywords][Denote-Explore]]
 
 The ~citar-denote-use-bib-keywords~ variable lets you include any keywords defined in the bibliography as Denote keywords. When set to =t=, Citar-Denote extracts the available keywords from the BibTeX =keywords= field and uses these as Denote file tags.
 
@@ -94,7 +94,10 @@ For example, when the citation key is =einstein_1905=, the signature becomes =ei
 ** Create notes using templates
 Denote allows you to create templates for various types of notes. You could have standard headings for bibliographic notes, other headings for meta notes, or whatever else you might need.
 
-To include templates in new bibliographic notes, set the ~citar-denote-template~ to non-nil and define a template.
+To include templates in new bibliographic notes, set the ~citar-denote-template~ to either:
+
+- =t=: Ask for a template when creating a note.
+- The name of the default template for creating new notes
 
 The example below lets the user choose between a note with two headings (Abstract and Review) or a plain note without any template content, [[info:denote#The denote-templates option][Denote templates]]
 
@@ -104,6 +107,8 @@ The example below lets the user choose between a note with two headings (Abstrac
           (plain . nil)))
 #+end_src
 
+Setting ~citar-denote-template~ to =biblio= will always use this template for new literature notes.
+
 ** Literature meta notes
 If you have a set of notes from the same book and use Org mode, you can create a meta note to combine the relevant notes. This note can have automated links to all related references with dynamic blocks or transclude the note's content.
 

readme.org

@@ -0,0 +1,74 @@
+[[https://melpa.org/#/citar-denote][file:https://melpa.org/packages/citar-denote-badge.svg]]    [[https://stable.melpa.org/#/citar-denote][file:https://stable.melpa.org/packages/citar-denote-badge.svg]]
+
+Citar-Denote is a minor-mode integrating the Emacs [[https://github.com/emacs-citar/citar][Citar]] and [[https://protesilaos.com/emacs/denote][Denote]] packages to enable create managing bibliographic notes and citations.
+
+For more information read the [[file:citar-denote.org][Citar-Denote Manual]] in this repository with =C-h R= (~info-display-manual~) and select =citar-denote=.
+
+* Change Log
+** Version 2.2.1
+- ~citar-denote-template~ has additional options:
+  - =nil=: No template
+  - =t=: Ask or a template
+  - =string=: Name of the default template for literature notes
+- Updated manual
+
+** Version 2.2
+- ~citar-denote-subdir~ has additional options:
+  - =nil=: No subdirectory
+  - =t=: Ask for subdirectory
+  - =string= : When using any string, save in a subdirectory with that name under ~denote-directory~
+- Modified behaviour of ~citar-denote-signature~. Users can choose between manually adding a signature or using citation key without prompting.
+
+** Version 2.1.2
+- Removed lighter string to not clobber the mode line
+- Bug fixed when using non-standard ~citar-denote-keyword~
+
+** Version 2.1.1
+- Updated the manual
+- Minor code updates
+
+** Version 2.1
+- Included Texinfo manual.
+- Bug fixes in regex to find citations.
+- New function: ~citar-denote-no-bibliography~ lists all citations that do not appear in the global bibliography in the =*Messages*= buffer.
+- Updated function documentation.
+
+** Version 2.02
+- Improved function docstrings
+- Updated example config
+
+** Version 2.0.1
+- Updated minor mode definition
+- Updated =readme.org= and =minimum-config.el= to define order or installation
+
+** Version 2.0
+- Commenced Change Log.
+- Updated all functions for full compatibility with Denote 2.2
+- Added =minimum-config.el= to provide minimal configuration example.
+- Added ~citar-denote-signature~ variable to add signatures for new bibliographic notes. When entering an empty string as signature, the citation key is used as signature.
+- The ~citar-denote-template~ variable defines whether a not template is used.
+- Added ~citar-denote-nocite~ function to open Citar completion menu with all bibliographic entries neither cited nor referenced in any Denote file. This negates the need for ~citar-denote-reference-nocite~ because notes can be created from within the Citar menu.
+- Existing reference removed from Citar completion menu when adding a new reference to a note.
+- Fixed a bug in ~citar-denote-add-citekey~ and ~citar-denote-remove-citekey~ when using multiple file types.
+- Removed false positives from ~citar-denote--extract-citations~.
+- Behaviour of ~citar-denote-use-bib-keywords~ changed. When not-nil, don't prompt for keywords and only use those in the bibliography.
+- The ~citar-denote-keyword~ ("bib") is removed from the keyword completion menu to avoid confusion.
+- Resolved bug for when ~citar-denote-keyword~ is =nil=.
+- ~citar-denote-link-reference~ check that file is a Denote file and fixed linking bug.
+- Added ~citar-denote--select-file-using-title~ to select a Denote filename using their title in the completion menu.
+- When only one candidate available in ~citar-denote-find-citation~, skip the section menu.
+
+** Version 1.8
+- Fixing bugs and improve package documentation.
+- Marked private functions with double dash
+- Updated ~citar-denote-citekey-regex~ to detect citations with multiple entries
+- Updated Citar-Denote manual in [[https://lucidmanager.org/productivity/citar-denote-managing-bibliographic-notes-in-emacs/][Emacs Writing Studio]].
+
+** Version 1.7
+- Code refactoring and pretty-printing
+- Updated function documentation
+- Bug fix to ~citar-denote-remove-citekey~
+- Package documentation update
+- Code refactoring
+- Added ~citar-denote-link-reference~ to insert a Denote link to an existing bibliographic note.
+- Added ~citar-denote-find-citation~ to find a citation in your Denote files.