emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: change link format

Browse source
This commit is contained in:
TEC 2022-09-26 02:19:42 +08:00 • committed by Henrik Lissner
parent 58fb83c98e
commit 5ac2a5258b
160 changed files with 1161 additions and 1152 deletions
Download patch file Download diff file Expand all files Collapse all files

35
modules/tools/biblio/README.org
View file

@ -19,12 +19,12 @@ selected so it should be possible to use without modifications.
/This module has no flags./
** Packages
- [[doom-package:][bibtex-completion]] if [[doom-module:][:completion ivy]] or [[doom-module:][:completion helm]]
- [[doom-package:][parsebib]] if [[doom-module:][:completion ivy]] or [[doom-module:][:completion helm]] or [[doom-module:][:completion vertico]]
- [[doom-package:][citar]] if [[doom-module:][:completion vertico]]
- [[doom-package:][citar-embark]] if [[doom-module:][:completion vertico]]
- [[doom-package:][helm-bibtex]] if [[doom-module:][:completion helm]]
- [[doom-package:][ivy-bibtex]] if [[doom-module:][:completion ivy]]
- [[doom-package:bibtex-completion]] if [[doom-module::completion ivy]] or [[doom-module::completion helm]]
- [[doom-package:parsebib]] if [[doom-module::completion ivy]] or [[doom-module::completion helm]] or [[doom-module::completion vertico]]
- [[doom-package:citar]] if [[doom-module::completion vertico]]
- [[doom-package:citar-embark]] if [[doom-module::completion vertico]]
- [[doom-package:helm-bibtex]] if [[doom-module::completion helm]]
- [[doom-package:ivy-bibtex]] if [[doom-module::completion ivy]]
** Hacks
/No hacks documented for this module./
@ -37,19 +37,18 @@ selected so it should be possible to use without modifications.
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
There are no hard dependencies for this module, but this module can benefit from
having a PDF reader and one of Doom's [[doom-module:][:completion]] modules.
having a PDF reader and one of Doom's [[doom-module::completion]] modules.
** PDF viewing
An application for opening PDF files is required. By default =DocView= is used
though [[doom-module:][:tools pdf]] is highly recommended so PDFs can be viewed within Emacs.
though [[doom-module::tools pdf]] is highly recommended so PDFs can be viewed within Emacs.
** Bibtex completion
For vertico, helm, or ivy bibtex completion you should enable [[doom-module:][:completion
vertico]], [[doom-module:][:completion helm]], or [[doom-module:][:completion ivy]] respectively.
For vertico, helm, or ivy bibtex completion you should enable [[doom-module::completion vertico]], [[doom-module::completion helm]], or [[doom-module::completion ivy]] respectively.
* Usage
Both [[doom-package:][helm-bibtex]] (includes [[doom-package:][helm-bibtex]], [[doom-package:][ivy-bibtex]], and bibtex-completion code)
and [[doom-package:][citar]] provide an extensive range of features so it is best to check their
Both [[doom-package:helm-bibtex]] (includes [[doom-package:helm-bibtex]], [[doom-package:ivy-bibtex]], and bibtex-completion code)
and [[doom-package:citar]] provide an extensive range of features so it is best to check their
respective sites for a full list of features.
On a high-level you can expect:
@ -64,7 +63,7 @@ To understand the interaction between these packages this [[https://www.reddit.c
explain the unique features and the overlapping functionality, if any.
In addition, this module provides support for native Org-mode citations
([[doom-package:][org-cite]]).
([[doom-package:org-cite]]).
* Configuration
To override any defaults set by this module, do so in an ~(after! package ...)~
@ -72,7 +71,7 @@ block in =$DOOMDIR/config.el=.
** Org-cite
*** Processor configuration
[[doom-package:][org-cite]] provides rich features and flexible configuration options via its
[[doom-package:org-cite]] provides rich features and flexible configuration options via its
"processor" capabilities.
1. /insert/ provides =org-cite-insert= integration for inserting and editing
@ -83,7 +82,7 @@ block in =$DOOMDIR/config.el=.
This module makes the following processors available:
1. The core =oc-basic=, =oc-natbib=, =oc-biblatex=, and =oc-csl=.
2. [[doom-package:][citar]] for integration with [[doom-package:][vertico]] completion.
2. [[doom-package:citar]] for integration with [[doom-package:vertico]] completion.
The module configures these processors as follows for the different completion
modules:
@ -101,9 +100,9 @@ directory for your CSL styles:
#+end_src
** Path configuration
You must set the path variable for either [[doom-package:][citar]] (if using [[doom-module:][:completion vertico]])
or [[doom-package:][bibtex-completion]] (if using [[doom-module::completion ivy][ivy]] or [[doom-module::completion helm][helm]]); this module will in turn set the
[[var:][org-cite-global-bibliography]] variable to the same value:
You must set the path variable for either [[doom-package:citar]] (if using [[doom-module::completion vertico]])
or [[doom-package:bibtex-completion]] (if using [[doom-module::completion ivy][ivy]] or [[doom-module::completion helm][helm]]); this module will in turn set the
[[var:org-cite-global-bibliography]] variable to the same value:
#+begin_src emacs-lisp
(setq! bibtex-completion-bibliography '("/path/to/references.bib"))
#+end_src