Skip to content

Commit

Permalink
Refine push documentation w.r.t. emacs
Browse files Browse the repository at this point in the history
  • Loading branch information
koppor committed Sep 4, 2023
1 parent a6828fd commit 7a60bc3
Show file tree
Hide file tree
Showing 36 changed files with 15 additions and 1 deletion.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
16 changes: 15 additions & 1 deletion en/cite/pushtoapplications.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ To push as citation, first select the entries in your entry table that you would

By default the external editor used to push citations is TeXstudio. You can select another application in **Options → Preferences → External programs**. Under the **Push applications** section, click on the **Application to push entries to** field. This will cause a dropdown menu to appear, from which you are then able to select from a list of all the external editors you have configured.

![Select External Application](<../.gitbook/assets/during-application-selection (2) (2) (2) (2) (2) (2) (2) (2) (4) (4) (1) (1) (1) (1) (1) (1) (2) (1) (3).png>)
![Preferences: External Programs: Configuration](../.gitbook/assets/pushtoapplications-preferences.png)

You can configure the citation command at "Cite command". JabRef intelligently parses the value you gave here. In the example, the congiration `\cite{key1,key2}` means, that the cite command is `\cite`, the keys are enclosed by `{...}` and that multiple keys are separted by a comma (`,`). With that, you can even support Pandoc's Markdown citation syntax. Configure it with `[@key1,@key2]`.

Once you have made your selection and click **Save**, the push-to-external application button icon will change to match that of the selected external editor application.

Expand All @@ -31,3 +33,15 @@ When you click on the push-to-external application button, JabRef will export yo
As long as you continue using the same external editor application, clicking on the push-to-external application button for subsequent exports will just add new citations or extend an existing citation with additional entries. Following the example above, here is what happens when you export a second entry to TeXStudio on an existing citation, which is extended to include the new entry in your LaTeX document.

![Subsequent Push to External Export](<../.gitbook/assets/subsequent-push-export (2) (2) (2) (2) (2) (2) (2) (2) (4) (4) (4) (1) (1) (2) (1) (3).png>)

## Hints on Emacs

There are the tools [`emacsclient`](https://www.emacswiki.org/emacs/EmacsClient) and `gnuclient`. Both support [GNU Emacs](https://www.emacswiki.org/emacs/GnuEmacs). Additionally, `gnuclient` supports [XEmacs](https://www.emacswiki.org/emacs/XEmacs). As default configuration, JabRef uses `emacsclient`. JabRef passes `-e` as parameter, because JabRef adds the emacs command after the given parameters. For a discussion on the use of `emacsclient`, see [a stackoferflow answer](https://stackoverflow.com/a/10911288/873282). The parameter `-n` (for `--no-wait`) is also passed, but that is not necessary.

On Windows, you can install emacs using `choco install emacs`. Then, start emacs. Afterwards, start the emacs daemon with following command:

```cmd
C:\tools\emacs\bin\emacs.exe --daemon
```

If that does not work, hints are provided at <https://emacs.stackexchange.com/q/35545/12933>.

0 comments on commit 7a60bc3

Please sign in to comment.