Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/slotthe/arxiv-citation
Generate citation data for PDF files from the arXiv // GitHub mirror
https://github.com/slotthe/arxiv-citation
arxiv emacs emacs-lisp latex zbmath
Last synced: about 1 month ago
JSON representation
Generate citation data for PDF files from the arXiv // GitHub mirror
- Host: GitHub
- URL: https://github.com/slotthe/arxiv-citation
- Owner: slotThe
- License: gpl-3.0
- Created: 2022-04-26T20:10:55.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-10T08:09:47.000Z (about 1 year ago)
- Last Synced: 2024-10-15T07:51:57.849Z (3 months ago)
- Topics: arxiv, emacs, emacs-lisp, latex, zbmath
- Language: Emacs Lisp
- Homepage: https://gitlab.com/slotThe/arxiv-citation
- Size: 81.1 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# arXiv-citation
Generate citation data for PDF files from the [arXiv] or from [zbmath].
Additionally, download preprints to a specified directory and open them.
Includes [elfeed] support.
[arXiv]: https://arxiv.org/
[elfeed]: https://github.com/skeeto/elfeed
[zbmath]: https://zbmath.org/
## Features
The high-level overview is:
+ `arxiv-citation-gui`: Slurp an arXiv (or zbmath) link from the
primary selection or the clipboard and insert the corresponding
citation into every file specified in `arxiv-citation-bibtex-files`
(NOTE: this is `nil` by default!). This uses `gui-get-selection` and
is thus dependent on X11. Below is a showcase of invoking this
function via a global keybinding, instead of inside Emacs itself.
+ `arxiv-citation-elfeed`: Invoking this function when viewing a paper
in elfeed downloads it to `arxiv-citation-library` with name
"author1-author2-...authorn_title-sep-by-dashes.pdf" and opens it
with `arxiv-citation-open-pdf-function`.
+ `arxiv-citation-download-and-open`: This works much like
`arxiv-citation-elfeed`, but relies on X selections for getting the
url to the paper.
A blog post that discusses the integration of `arxiv-citation` with
[XMonad]—a tiling window manager—is available [here][xmonad-emacs].
[xmonad-emacs]: https://tony-zorman.com/posts/2022-05-25-calling-emacs-from-xmonad.html
[XMonad]: https://xmonad.org/
## Installation
### MELPA
The package is on MELPA, so you can install it like any other package:
M-x package-install RET arxiv-citation RET
### Manual
Copy `arxiv-citation.el` into a directory within your `load-path` and
require it. For example, assuming that this file was placed within the
`~/.config/emacs/elisp` directory:
``` emacs-lisp
(add-to-list 'load-path "~/.config/emacs/elisp/")
(require 'arxiv-citation)
```
If you use [use-package], you can express the above as
``` emacs-lisp
(use-package arxiv-citation
:load-path "~/.config/emacs/elisp/")
```
[use-package]: https://github.com/jwiegley/use-package
## Configuration
You will need to customise at least `arxiv-citation-bibtex-files` if you
want to use any function that adds citations and
`arxiv-citation-library` to download files to an appropriate directory.
For example:
``` emacs-lisp
(use-package arxiv-citation
:commands (arxiv-citation-elfeed arxiv-citation-gui)
:custom
(arxiv-citation-library "~/library")
(arxiv-citation-bibtex-files
'("~/.tex/bibliography.bib"
"~/projects/super-secret-project/main.bib")))
```