Skip to content

Commit 3fd3c26

Browse files
palukkukoppor
andauthored
Add cayw documentation (#580)
Co-authored-by: Oliver Kopp <[email protected]>
1 parent 3aa44db commit 3fd3c26

File tree

2 files changed

+61
-0
lines changed

2 files changed

+61
-0
lines changed

en/cite/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,5 @@ description: Include citations of your references to your documents.
1212

1313
{% page-ref page="pushtoapplications.md" %}
1414

15+
{% page-ref page="cite-as-you-write.md" %}
16+

en/cite/cite-as-you-write.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
description: Using Cite As You Write to insert citations "on the fly" directly in your editor.
3+
---
4+
5+
# Cite As You Write (CAYW)
6+
7+
JabRef allows you to open up a search dialog to search for entries and their citation keys directly from your LaTeX
8+
editor and automatically insert them at your current cursor position.
9+
It works with different editors, such as TeXstudio, TeXworks, and Emacs.
10+
11+
Make sure you set the path to the application you want to use in JabRefs settings.
12+
13+
To use the Cite As You Write (CAYW) feature, you need to have JabRef running and the HTTP server enabled.
14+
15+
You can enable the HTTP server in **File → Preferences → General** and under the **HTTP Server** section check the box
16+
for **Enable HTTP Server**.
17+
18+
## Application setup
19+
20+
For instructions on how to setup your editor to use the CAYW endpoint, please consult the documentation of [Better BibTeX for Zotero](https://retorque.re/zotero-better-bibtex/citing/cayw/index.html).
21+
22+
## Endpoint parameters
23+
24+
We are working on becoming fully compatible with the CAYW endpoint
25+
of [Better BibTeX for Zotero](https://retorque.re/zotero-better-bibtex/citing/cayw/index.html).
26+
The endpoint is available under `http://localhost:23119/better-bibtex/cayw`.
27+
28+
Currently, the following optional **GET** parameters are supported:
29+
30+
| Parameter | Description | Default |
31+
|---------------|-----------------------------------------------------------------------------------------------|------------|
32+
| `probe` | If set to `true` or any non-empty value, the endpoint returns `ready` | |
33+
| `format` | The format of the output, for a full list of the supported formats see below | `biblatex` |
34+
| `clipboard` | If set to `true`, the output is copied to the clipboard | |
35+
| `application` | You can set it to any of the applications listed below to push directly to them | |
36+
| `texstudio` | If set to `true` or any non-empty value, it is the same as if you set `application=texstudio` | |
37+
| `selected` | If set to `true` or any non-empty value, it will use the current selected entries in JabRef | |
38+
| `select` | If set to `true` or any non-empty value, it will select the selected entries in JabRef | |
39+
| `librarypath` | The path to the library file, if not set, it will use the currently opened library in JabRef | |
40+
41+
Following formats are supported:
42+
43+
| Format | Description |
44+
|---------------|--------------------------------------------------------------------------------------------------------|
45+
| `biblatex` | Additional `command` parameter, which allows to use another command for citing, defaults to `autocite` |
46+
| `simple-json` | A simple json containing the entry ID and the citation key |
47+
48+
Following applications are supported:
49+
50+
- emacs
51+
- LyX
52+
- Sublime
53+
- Texmaker
54+
- TeXShop
55+
- TeXstudio
56+
- TeXworks
57+
- vim
58+
- VS Code
59+
- WinEdt

0 commit comments

Comments
 (0)