JabRef

https://docs.jabref.org
Admin
JabRef is an open-source, cross-platform citation and reference management tool that helps you...
Tokens:55,287
Snippets:914
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Start Ollama Server

Source: https://docs.jabref.org/ai/local-llm

Start the ollama local web server. A 'cannot bind' error may indicate the server is already running.

```bash
ollama serve
```

--------------------------------

### Configure Emacs Daemon on Windows

Source: https://docs.jabref.org/cite/pushtoapplications

Use this command to start the Emacs daemon on Windows after installing Emacs via Chocolatey. This is necessary for JabRef to communicate with Emacs.

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

--------------------------------

### Query JabRef Documentation via HTTP GET

Source: https://docs.jabref.org/advanced/autosave

Perform an HTTP GET request on a documentation URL with the `ask` query parameter to get dynamic answers. Use this when information is not explicit, requires clarification, or you need related sections.

```http
GET https://docs.jabref.org/advanced/autosave.md?ask=<question>
```

--------------------------------

### Example JabRef Style File

Source: https://docs.jabref.org/cite/openofficeintegration

This is an example of a style file used for JabRef-OpenOffice integration. It defines various properties, citation formats, and layout rules for different bibliographic entry types. Ensure style files are saved with UTF-8 encoding.

```plaintext
NAME
Example style file for JabRef-OpenOffice integration.

JOURNALS
Journal name 1
Journal name 2

PROPERTIES
Title="References"
IsSortByPosition="false"
IsNumberEntries="false"
ReferenceParagraphFormat="Default"
ReferenceHeaderParagraphFormat="Heading 1"

CITATION
AuthorField="author/editor"
YearField="year"
MaxAuthors="3"
MaxAuthorsFirst="3"
AuthorSeparator=", "
AuthorLastSeparator=" & "
EtAlString=" et al."
ItalicEtAl="true"
YearSeparator=" "
InTextYearSeparator=" "
BracketBefore="["
BracketAfter="]"
BracketBeforeInList="["
BracketAfterInList="]"
CitationSeparator="; "
UniquefierSeparator=","
GroupedNumbersSeparator="-"
MinimumGroupingCount="3"
FormatCitations="false"
CitationCharacterFormat="Default"
MultiCiteChronological="false"
PageInfoSeparator="; "

LAYOUT
article=\format[AuthorLastFirst,AuthorAbbreviator,AuthorAndsReplacer]{\author}
(<b>\year\uniq</b>). <i>\title</i>, \journal \volume\begin{pages} :
\format[FormatPagesForHTML]{\pages}\end{pages}.

book=\format[AuthorLastFirst,AuthorAbbreviator,AuthorAndsReplacer]{\author}\begin{editor}
\format[AuthorLastFirst,AuthorAbbreviator,AuthorAndsReplacer]{\editor} (Ed.)\end{editor},
<b>\year\uniq</b>. <i>\title</i>. \publisher, \address.

incollection=\format[AuthorLastFirst,AuthorAbbreviator,AuthorAndsReplacer]{\author}
(<b>\year\uniq</b>). <i>\title</i>. In: \format[AuthorLastFirst,
AuthorAbbreviator,AuthorAndsReplacer]{\editor} (Ed.), <i>\booktitle</i>, \publisher.

inbook=\format[AuthorLastFirst,AuthorAbbreviator,AuthorAndsReplacer]{\author}
(<b>\year\uniq</b>). <i>\chapter</i>. In: \format[AuthorLastFirst,
AuthorAbbreviator,AuthorAndsReplacer]{\editor} (Ed.), <i>\title</i>, \publisher.

phdthesis=\format[AuthorLastFirst,AuthorAbbreviator,AuthorAndsReplacer]{\author}
(<b>\year\uniq</b>). <i>\title</i>, \school.

default=\format[AuthorLastFirst,AuthorAbbreviator,AuthorAndsReplacer]{\author}
(<b>\year\uniq</b>). <i>\title</i>, \journal \volume\begin{pages} :
\format[FormatPagesForHTML]{\pages}\end{pages}.
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.jabref.org/advanced/entryeditor/add-entry-manually

Demonstrates how to query JabRef documentation dynamically using an HTTP GET request with the 'ask' query parameter. This is useful for retrieving specific information not immediately apparent on the page.

```http
GET https://docs.jabref.org/advanced/entryeditor/add-entry-manually.md?ask=<question>
```

--------------------------------

### Basic Command Line Structure

Source: https://docs.jabref.org/advanced/commandline

This is the general structure for running JabRef from the command line. Replace the path with your JabRef installation directory. Options should precede the BibTeX file names.

```cmd
C:\portable-apps\JabRef-5.0-portable_windows\JabRef\runtime\bin\JabRef.bat [OPTIONS] [BIBTEX_FILE]
```

--------------------------------

### Query JabRef Documentation via HTTP GET

Source: https://docs.jabref.org/cite/pushtoapplications

Perform an HTTP GET request to the current page URL with the `ask` query parameter to dynamically query the documentation. Use this for clarifications, additional context, or retrieving related sections when information is not explicitly present.

```http
GET https://docs.jabref.org/cite/pushtoapplications.md?ask=<question>
```

--------------------------------

### Querying Documentation with 'ask' Parameter

Source: https://docs.jabref.org/advanced/how-to-expand-firstnames

Demonstrates how to query the documentation dynamically for additional information using the 'ask' query parameter in an HTTP GET request.

```http
GET https://docs.jabref.org/advanced/how-to-expand-firstnames.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.jabref.org/collaborative-work/export

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. Use this when the answer is not explicitly present, for clarification, or to retrieve related sections.

```http
GET https://docs.jabref.org/collaborative-work/export.md?ask=<question>
```

--------------------------------

### Enable Firefox Snap Permissions

Source: https://docs.jabref.org/collect/jabref-browser-extension

Set web extension permissions for JabRef when Firefox is installed as a snap.

```bash
flatpak permission-set webextensions org.jabref.jabref snap.firefox yes
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.jabref.org/collect

To get information not explicitly present on a page, make an HTTP GET request to the page URL with an 'ask' query parameter containing your question. The response includes the answer and relevant documentation excerpts.

```http
GET https://docs.jabref.org/collect.md?ask=<question>
```

--------------------------------

### Clone and Build JabRef from Source

Source: https://docs.jabref.org/installation

Use this command to clone the latest JabRef snapshot and build an executable package. Ensure you have Java Development Kit and Git installed.

```shell
git clone --recurse-submodules --depth=10 https://github.com/JabRef/jabref
cd jabref
./gradlew :jabgui:jpackage
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.jabref.org/jabkit

To get additional information not directly on the page, perform an HTTP GET request with the `ask` query parameter. The question should be specific and self-contained.

```http
GET https://docs.jabref.org/jabkit.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.jabref.org/contributing/how-to-translate-the-ui

Perform an HTTP GET request on a documentation URL with the `ask` query parameter to retrieve specific information. The question should be specific and self-contained.

```http
GET https://docs.jabref.org/contributing/how-to-translate-the-ui.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.jabref.org/ai/local-llm

Perform an HTTP GET request to query documentation dynamically. Replace `<question>` with your specific query.

```http
GET https://docs.jabref.org/ai/local-llm.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.jabref.org/advanced/debugging-your-library-file

Perform an HTTP GET request on the current page URL with the `ask` query parameter to get specific information. The question should be specific, self-contained, and written in natural language. The response will contain a direct answer and relevant excerpts.

```http
GET https://docs.jabref.org/advanced/debugging-your-library-file.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.jabref.org/collect/findunlinkedfiles

To get information not explicitly present on the page, perform an HTTP GET request to the page URL with the `ask` query parameter. The question should be specific and self-contained.

```http
GET https://docs.jabref.org/collect/findunlinkedfiles.md?ask=<question>
```

--------------------------------

### Example Property File Entry

Source: https://docs.jabref.org/contributing/how-to-translate-the-ui

Illustrates the key/value format for translation entries in property files. Spaces in keys are escaped with a backslash.

```properties
Background\ color\ for\ optional\ fields=Hintergrundfarbe für optionale Felder
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.jabref.org/faq/osx

Use this HTTP GET request to query the documentation dynamically with a specific question. This is useful when the answer is not explicitly present on the page.

```http
GET https://docs.jabref.org/faq/osx.md?ask=<question>
```

--------------------------------

### Perform HTTP GET Request to Query Documentation

Source: https://docs.jabref.org/advanced/fields

Use this method to dynamically query the documentation. The question should be specific and self-contained. The response will contain a direct answer and relevant excerpts.

```http
GET https://docs.jabref.org/advanced/fields.md?ask=<question>
```

--------------------------------

### Display Help and Options

Source: https://docs.jabref.org/advanced/commandline

Use the -h or --help option to display a summary of all available command-line options and supported import/export formats.

```cmd
JabRef.bat -h
```

--------------------------------

### Install JabKit as a CLI application

Source: https://docs.jabref.org/jabkit

To make JabKit available on the command line as `jabkit`, first install JBang, then use the `jbang app install` command.

```bash
jbang app install jabkit@jabref
```

--------------------------------

### No Files at Startup

Source: https://docs.jabref.org/advanced/commandline

The -b option prevents JabRef from opening any files automatically on startup.

```cmd
JabRef.bat -b
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.jabref.org/advanced/newbasedonaux

To get more information not present on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.jabref.org/advanced/newbasedonaux.md?ask=<question>
```

--------------------------------

### Querying Documentation with GET Request

Source: https://docs.jabref.org/cite/bibtex-and-biblatex

To get additional information not present on the current page, perform an HTTP GET request to the page URL with the 'ask' query parameter followed by your question.

```http
GET https://docs.jabref.org/cite/bibtex-and-biblatex.md?ask=<question>
```

--------------------------------

### Example BibTeX Entry

Source: https://docs.jabref.org/advanced/how-to-expand-firstnames

An example of a BibTeX entry with abbreviated author names.

```bibtex
@Article{Eshuis_2015,
  author    = {R. Eshuis and A. Norta and O. Kopp and E. Pitkanen},
  journal   = {{IEEE} Transactions on Services Computing},
  title     = {Service Outsourcing with Process Views},
  year      = {2015},
  month     = {jan},
  number    = {1},
  pages     = {136--154},
  volume    = {8},
  publisher = {Institute of Electrical and Electronics Engineers ({IEEE})},
}
```

--------------------------------

### Import File

Source: https://docs.jabref.org/advanced/commandline

Use the -i or --import option to load a specified file. JabRef attempts to auto-detect the format if not explicitly provided. This option can only be used once per command.

```cmd
JabRef.bat -i filename.bib
```

```cmd
JabRef.bat -i filename.txt,customImportFormat
```

--------------------------------

### Query Documentation via HTTP GET Request

Source: https://docs.jabref.org/ai/troubleshooting

To get additional information not explicitly on the page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.jabref.org/ai/troubleshooting.md?ask=<question>
```

--------------------------------

### Import Preferences

Source: https://docs.jabref.org/advanced/commandline

Use the -p option to import JabRef preferences from a specified file.

```cmd
JabRef.bat -p filename.prefs
```

--------------------------------

### Download gg.cmd

Source: https://docs.jabref.org/contributing

Download the gg.cmd script, a cross-platform version manager. Store it in your home directory.

```bash
wget ggcmd.io -OutFile gg.cmd
```

```bash
wget ggcmd.io/gg.cmd
```

```bash
curl -L ggcmd.io > gg.cmd
```

--------------------------------

### GET Request to Documentation Index

Source: https://docs.jabref.org/import-export/export/customexports

Use this GET request to ask a question about the documentation. The response will contain a direct answer and relevant excerpts.

```http
GET https://docs.jabref.org/collaborative-work/export/customexports.md?ask=<question>
```

--------------------------------

### Example Journal Abbreviation Entry

Source: https://docs.jabref.org/advanced/journalabbreviations

An example of a journal abbreviation entry in CSV format, including the optional shortest unique abbreviation and frequency fields.

```csv
Accounts of Chemical Research,Acc. Chem. Res.,ACHRE4,M
```

--------------------------------

### Create Subdatabase from .aux file

Source: https://docs.jabref.org/advanced/commandline

The -a option creates a subdatabase from an .aux file, specifying input and output files, and a base BibTeX file.

```cmd
JabRef.bat -a infile.aux,outfile.bib base.bib
```

--------------------------------

### Query Documentation Index

Source: https://docs.jabref.org/import-export/other-integrations/openofficeintegration

Perform an HTTP GET request to the documentation index with the 'ask' parameter to get a direct answer to a specific question. The question should be self-contained and in natural language.

```http
GET https://docs.jabref.org/cite/openofficeintegration.md?ask=<question>
```

--------------------------------

### Query JabRef Documentation Dynamically

Source: https://docs.jabref.org/advanced/knowledge/endnote-export-filter

Perform an HTTP GET request to the current page URL with the `ask` query parameter to ask a question about the documentation. The question should be specific and self-contained. Use this when the answer is not explicitly present, for clarification, or to retrieve related sections.

```http
GET https://docs.jabref.org/advanced/knowledge/endnote-export-filter.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.jabref.org/advanced/remote

To get more information not present on the page, perform an HTTP GET request to the current page URL with the `ask` query parameter. The question should be specific and in natural language.

```HTTP
GET https://docs.jabref.org/advanced/remote.md?ask=<question>
```

--------------------------------

### JabRef Typed Strings Examples

Source: https://docs.jabref.org/advanced/strings

Examples of JabRef's typed strings, indicated by prefixes like 'a' for author, 'i' for institution, and 'p' for publisher. These help in using strings in appropriate fields.

```bibtex
@String { aKopp = "Kopp, Oliver" }
@String { iMIT = "{Massachusetts Institute of Technology ({MIT})}" }
@String { anct = "Anecdote" }
@String { lTOSCA = "Topology and Orchestration Specification for Cloud Applications" }
```

```bibtex
@String { aMIT = "{Massachusetts Institute of Technology ({MIT})}" }
@String { iMIT = "{Massachusetts Institute of Technology ({MIT})}" }
@String { pMIT = "{Massachusetts Institute of Technology ({MIT}) press}" }
```

```bibtex
@String{aKahle = "Kahle, Brewster "}
@String{aStallman = "Stallman, Richard"}
@String{iMIT = "{Massachusetts Institute of Technology ({MIT})}" }
@String{pMIT = "{Massachusetts Institute of Technology ({MIT}) press}" }
@String{anct = "Anecdote" }
@String{eg = "for example" }
@String{et = " and " }
@String{lBigMac = "Big Mac" }
```

--------------------------------

### Basic Custom Name Formatter Example

Source: https://docs.jabref.org/collaborative-work/export/customexports

This small example demonstrates a basic custom name formatter. It takes an author's full name and formats it to show the last name followed by the first initial.

```BibTeX
"{ll}, {f.}"
```

--------------------------------

### WrapFileLinks Formatter Example

Source: https://docs.jabref.org/collaborative-work/export/customexports

Demonstrates using the WrapFileLinks formatter to format file links with index, description, and path. Useful for creating enumerated lists of files associated with an entry.

```jabref
\format[WrapFileLinks(\i. \d (\p))]{\file}
```

--------------------------------

### Display Output in Console

Source: https://docs.jabref.org/advanced/commandline

Use the --console option to ensure that JabRef's output is directed to the command-line console.

```cmd
JabRef.bat --console
```

--------------------------------

### Fetch Entries from Web

Source: https://docs.jabref.org/advanced/commandline

Use the -f option to fetch entries from a web source using a specified fetcher and query string.

```cmd
JabRef.bat -f=FetcherName:QueryString
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.jabref.org/advanced/journalabbreviations

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

```HTTP
GET https://docs.jabref.org/advanced/journalabbreviations.md?ask=<question>
```

--------------------------------

### Complex Custom Name Formatter Example

Source: https://docs.jabref.org/collaborative-work/export/customexports

This large example illustrates a complex custom name formatter designed to handle a list of authors. It formats the first three authors with last name and first initial, and the last two authors differently, using specific separators.

```BibTeX
1@*@{ll}, {f}.@@2@1@{ll}, {f}.@2@ and {ll}, {f}.@@*@1..-3@{ll}, {f}., @-2@{ll}, {f}.@-1@ and {ll}, {f}.
```

--------------------------------

### Register Firefox Native Messaging Host (Windows)

Source: https://docs.jabref.org/collect/jabref-browser-extension

Use this command to register the JabRef native messaging host for Firefox on Windows. Ensure the path points to your `jabref-firefox.json` file. Administrator rights may be required.

```bash
REG ADD "HKEY_LOCAL_MACHINE\SOFTWARE\Mozilla\NativeMessagingHosts\org.jabref.jabref" /ve /d "C:\path\to\jabref-firefox.json" /f
```

--------------------------------

### Perform HTTP GET Request with 'ask' Parameter

Source: https://docs.jabref.org/cite/cite-as-you-write

Use this method to query documentation dynamically. The question should be specific and in natural language. The response includes direct answers and relevant excerpts.

```http
GET https://docs.jabref.org/cite/cite-as-you-write.md?ask=<question>
```

--------------------------------

### Cleanup URL Link Example

Source: https://docs.jabref.org/finding-sorting-and-cleaning-entries/saveactions

Illustrates the cleanup of URL-encoded characters in links.

```plaintext
http%3A%2F%2Fwikipedia.org ⇒ http://wikipedia.org
```
Tokens:
Raw