Tweak the text and code of the `citar' section

This commit is contained in:
Gerard Vermeulen 2024-01-22 17:15:03 +01:00
parent 256fa93546
commit 6b38f282a5

View File

@ -3201,34 +3201,35 @@ minibuffer as well as the option to run different commands on those
selections. The article [[https://kristofferbalintona.me/posts/202206141852/][Citations in org-mode: Org-cite and Citar]] tries to walk selections. The article [[https://kristofferbalintona.me/posts/202206141852/][Citations in org-mode: Org-cite and Citar]] tries to walk
you from understanding the general context (bibliography producer, text you from understanding the general context (bibliography producer, text
processor, text to product convertor) to an Emacs setup. Listing processor, text to product convertor) to an Emacs setup. Listing
[[lst:set-org-cite+citar-options]] shows my =org-cite=, =citar=, and =org= setup. [[lst:set-oc+citar-options]] shows the =oc= and =citar= setup with binding of
{{{kbd(C-c b)}}} to src_emacs-lisp{(call-interactively 'org-cite-insert)} in
=org-mode-map=.
#+caption[Set =org-cite= and =citar= options]: #+caption[Set =oc= and =citar= options]:
#+caption: Set =org-cite= and =citar= options. #+caption: Set =oc= and =citar= options.
#+name: lst:set-org-cite+citar-options #+name: lst:set-oc+citar-options
#+begin_src emacs-lisp -n #+begin_src emacs-lisp -n
(with-eval-after-load 'org
(keymap-set org-mode-map "C-c b" #'org-cite-insert))
(when (ensure-package-installation 'citar 'citar-embark) (when (ensure-package-installation 'citar 'citar-embark)
(with-eval-after-load 'embark (with-eval-after-load 'embark
(when (fboundp 'citar-embark-mode) (when (fboundp 'citar-embark-mode)
(citar-embark-mode +1))) (citar-embark-mode +1)))
(when (require 'citar nil 'noerror)
(setopt citar-bibliography '("~/VCS/research/refs.bib")
citar-library-file-extensions '("djvu" "pdf")
citar-library-paths '("~/VCS/research/papers/")))
(with-eval-after-load 'oc (with-eval-after-load 'oc
(setopt org-cite-export-processors '((latex biblatex) (setopt org-cite-export-processors '((latex biblatex)
(t csl)) (t csl))
org-cite-global-bibliography '("~/VCS/research/refs.bib")) org-cite-global-bibliography '("~/VCS/research/refs.bib"))
(if (not (require 'citar nil 'noerror))
(when (require 'citar nil 'noerror) (user-error "Fails to require `citar' and to setup `citar' and `oc'")
;; Synchronize the two involved bibliographies.
(setopt citar-bibliography org-cite-global-bibliography
citar-library-file-extensions '("djvu" "pdf")
;; Here are the `.djvu' and `.pdf' files.
citar-library-paths '("~/VCS/research/papers/"))
(setopt org-cite-activate-processor 'citar (setopt org-cite-activate-processor 'citar
org-cite-follow-processor 'citar org-cite-follow-processor 'citar
org-cite-insert-processor 'citar)))) org-cite-insert-processor 'citar)
(with-eval-after-load 'org
(keymap-set org-mode-map "C-c b" #'org-cite-insert)))))
#+end_src #+end_src
Ref. [cite:@Schulte.MCSE.2011.41] shows that [[https://orgmode.org/][Org-mode]] is a simple, plain-text Ref. [cite:@Schulte.MCSE.2011.41] shows that [[https://orgmode.org/][Org-mode]] is a simple, plain-text
@ -3238,9 +3239,10 @@ setup, provided that =citar-bibliography= and =citar-library-paths= point to
valid directories and files. In an [[https://orgmode.org/][Org-mode]] buffer this setup allows to: valid directories and files. In an [[https://orgmode.org/][Org-mode]] buffer this setup allows to:
1. Insert one or more [[https://orgmode.org/][Org-mode]] cite links: 1. Insert one or more [[https://orgmode.org/][Org-mode]] cite links:
1. Type {{{kbd(C-c b)}}} or {{{kbd(M-x org-cite-insert)}}}. 1. Type {{{kbd(C-c b)}}} or {{{kbd(M-x org-cite-insert)}}}.
2. Navigate to a bibliographic entry to insert: 2. Choose one or multiple citations from the bibliography:
1. Select it with {{{kbd(TAB)}}} to select more entries. 1. by navigating to an item and selecting it with {{{kbd(RET)}}}
2. Select it with {{{kbd(RET)}}} to select the last entry. 2. by repeatingly navigating to an item and preselecting it with
{{{kbd(TAB)}}}. Select all preselected items with {{{kbd(RET)}}}.
2. View an electronic copy of an [[https://orgmode.org/][Org-mode]] cite link: 2. View an electronic copy of an [[https://orgmode.org/][Org-mode]] cite link:
1. Move point to the [[https://orgmode.org/][Org-mode]] cite link. 1. Move point to the [[https://orgmode.org/][Org-mode]] cite link.
2. Type {{{kbd(C-:)}}} or {{{kbd(M-x embark-dwim)}}}. 2. Type {{{kbd(C-:)}}} or {{{kbd(M-x embark-dwim)}}}.
@ -3251,6 +3253,9 @@ valid directories and files. In an [[https://orgmode.org/][Org-mode]] buffer th
2. Type {{{kbd(C-:)}}} or {{{kbd(M-x embark-dwim)}}}. 2. Type {{{kbd(C-:)}}} or {{{kbd(M-x embark-dwim)}}}.
3. Navigate to the corresponding link. 3. Navigate to the corresponding link.
4. Select it. 4. Select it.
4. The following =citar= functions may be useful too:
1. src_emacs-lisp{(call-interactively 'citar-insert-citation)}.
2. src_emacs-lisp{(call-interactively 'citar-open)}.
*** TODO Compare bibtex and biblatex *** TODO Compare bibtex and biblatex
1. [[https://www.economics.utoronto.ca/osborne/latex/BIBTEX.HTM][Using bibtex: a short guide]] 1. [[https://www.economics.utoronto.ca/osborne/latex/BIBTEX.HTM][Using bibtex: a short guide]]