From fc59f0a21ae342e254cef4eb63a98a9a23e32b93 Mon Sep 17 00:00:00 2001 From: Philip <37398281+palukku@users.noreply.github.com> Date: Thu, 24 Jul 2025 14:30:20 +0200 Subject: [PATCH 1/2] add cayw documentation --- en/cite/README.md | 2 ++ en/cite/cite-as-you-write.md | 58 ++++++++++++++++++++++++++++++++++++ 2 files changed, 60 insertions(+) create mode 100644 en/cite/cite-as-you-write.md diff --git a/en/cite/README.md b/en/cite/README.md index 0d53edf1a2..0af1747126 100644 --- a/en/cite/README.md +++ b/en/cite/README.md @@ -12,3 +12,5 @@ description: Include citations of your references to your documents. {% page-ref page="pushtoapplications.md" %} +{% page-ref page="cite-as-you-write.md" %} + diff --git a/en/cite/cite-as-you-write.md b/en/cite/cite-as-you-write.md new file mode 100644 index 0000000000..b95865855b --- /dev/null +++ b/en/cite/cite-as-you-write.md @@ -0,0 +1,58 @@ +--- +description: Using Cite As You Write to insert citations "on the fly" directly in your editor. +--- + +# Cite As You Write (CAYW) + +JabRef allows you to open up a search dialog to search for entries and their citation keys directly from your LaTeX +editor and automatically insert them at your current cursor position. +It works with different editors, such as TeXstudio, TeXworks, and Emacs. + +Make sure you set the path to the application you want to use in JabRefs settings. + +To use the Cite As You Write (CAYW) feature, you need to have JabRef running and the HTTP server enabled. + +You can enable the HTTP server in **File → Preferences → General** and under the **HTTP Server** section check the box +for **Enable HTTP Server**. + +## Endpoint Parameters + +We are working on becoming fully compatible with the CAYW Endpoint +of [Better BibTeX for Zotero](https://retorque.re/zotero-better-bibtex/citing/cayw/index.html). + +For Instructions on how to setup your editor to use the CAYW endpoint, you can see the Documentation of [Better BibTeX for Zotero](https://retorque.re/zotero-better-bibtex/citing/cayw/index.html). + +The endpoint is available under `http://localhost:23119/better-bibtex/cayw`. + +Currently, the following optional **GET** parameters are supported: + +| Parameter | Description | Default | +|---------------|-----------------------------------------------------------------------------------------------|------------| +| `probe` | If set to `true` or any non-empty value, the endpoint returns `ready` | | +| `format` | The format of the output, for a full list of the supported formats see below | `biblatex` | +| `clipboard` | If set to `true`, the output is copied to the clipboard | | +| `application` | You can set it to any of the applications listed below to push directly to them | | +| `texstudio` | If set to `true` or any non-empty value, it is the same as if you set `application=texstudio` | | +| `selected` | If set to `true` or any non-empty value, it will use the current selected entries in JabRef | | +| `select` | If set to `true` or any non-empty value, it will select the selected entries in JabRef | | +| `librarypath` | The path to the library file, if not set, it will use the currently opened library in JabRef | | + +This is the list of the currently supported formats: + +| Format | Description | +|---------------|--------------------------------------------------------------------------------------------------------| +| `biblatex` | Additional `command` parameter, which allows to use another command for citing, defaults to `autocite` | +| `simple-json` | A simple json containing the entry ID and the citation key | + +And this is the list of supported applications: + +- emacs +- lyx +- texmaker +- texstudio +- texworks +- vim +- winedt +- sublime +- texshop +- vscode From aa408a16e1cb49cc522eab6c1a2c5b4c37ba6d36 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Thu, 24 Jul 2025 15:27:00 +0200 Subject: [PATCH 2/2] Refine text --- en/cite/cite-as-you-write.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/en/cite/cite-as-you-write.md b/en/cite/cite-as-you-write.md index b95865855b..57447f66f5 100644 --- a/en/cite/cite-as-you-write.md +++ b/en/cite/cite-as-you-write.md @@ -15,13 +15,14 @@ To use the Cite As You Write (CAYW) feature, you need to have JabRef running and You can enable the HTTP server in **File → Preferences → General** and under the **HTTP Server** section check the box for **Enable HTTP Server**. -## Endpoint Parameters +## Application setup -We are working on becoming fully compatible with the CAYW Endpoint -of [Better BibTeX for Zotero](https://retorque.re/zotero-better-bibtex/citing/cayw/index.html). +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). -For Instructions on how to setup your editor to use the CAYW endpoint, you can see the Documentation of [Better BibTeX for Zotero](https://retorque.re/zotero-better-bibtex/citing/cayw/index.html). +## Endpoint parameters +We are working on becoming fully compatible with the CAYW endpoint +of [Better BibTeX for Zotero](https://retorque.re/zotero-better-bibtex/citing/cayw/index.html). The endpoint is available under `http://localhost:23119/better-bibtex/cayw`. Currently, the following optional **GET** parameters are supported: @@ -37,22 +38,22 @@ Currently, the following optional **GET** parameters are supported: | `select` | If set to `true` or any non-empty value, it will select the selected entries in JabRef | | | `librarypath` | The path to the library file, if not set, it will use the currently opened library in JabRef | | -This is the list of the currently supported formats: +Following formats are supported: | Format | Description | |---------------|--------------------------------------------------------------------------------------------------------| | `biblatex` | Additional `command` parameter, which allows to use another command for citing, defaults to `autocite` | | `simple-json` | A simple json containing the entry ID and the citation key | -And this is the list of supported applications: +Following applications are supported: - emacs -- lyx -- texmaker -- texstudio -- texworks +- LyX +- Sublime +- Texmaker +- TeXShop +- TeXstudio +- TeXworks - vim -- winedt -- sublime -- texshop -- vscode +- VS Code +- WinEdt