Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added en/.gitbook/assets/slr-catalogs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/.gitbook/assets/slr-define-parameters.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/.gitbook/assets/slr-queries.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/.gitbook/assets/slr-questions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/.gitbook/assets/slr-study-folder.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/.gitbook/assets/slr_start-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
164 changes: 164 additions & 0 deletions en/advanced/systematic-literature-review.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
# Systematic literature review

JabRef supports managing systematic literature reviews by structuring research questions, search queries, catalogs, and results within a dedicated study directory created by JabRef.
This feature helps organize search configuration and collected references, but it does not replace methodological decisions made by the researcher.

---

## Starting a systematic literature review

A new study definition can be created via:

`Tools → Start new systematic literature review`

<figure>
<img src="../.gitbook/assets/slr_start-menu.png" alt="Start new systematic literature review dialog">
<figcaption>Starting a new systematic literature review</figcaption>
</figure>

This opens the **Define study parameters** dialog, where JabRef stores the configuration used for search and data collection.

---

## Study parameters

The study definition dialog contains several sections that determine how JabRef performs searches and stores results.

<figure>
<img src="../.gitbook/assets/slr-define-parameters.png" alt="Define study parameters window">
<figcaption>Study definition dialog</figcaption>
</figure>

### Authors and title

This section defines the study metadata:

* Study title
* At least one author

These elements identify the study and are required before the survey can begin.

---

### Research questions

Research questions define the scope of the study within JabRef.
They help relate queries and later screening decisions to the study purpose.

Each question should be:

* Clear
* Focused
* Defined by the research goal rather than tool settings

<figure>
<img src="../.gitbook/assets/slr-questions.png" alt="Research questions tab">
<figcaption>Defining research questions</figcaption>
</figure>

---

### Queries

Queries define how JabRef retrieves literature from the selected catalogs.

<figure>
<img src="../.gitbook/assets/slr-queries.png" alt="Queries tab of SLR setup">
<figcaption>Defining search queries</figcaption>
</figure>

Queries typically combine keywords using Boolean operators:

* `AND`
* `OR`
* `NOT`

Queries can be adjusted later if search results need refinement.

---

### Catalogs

Catalogs define the external services that JabRef queries for literature.

<figure>
<img src="../.gitbook/assets/slr-catalogs.png" alt="Catalog selection in SLR">
<figcaption>Selecting catalogs</figcaption>
</figure>

Examples include:

* ACM Portal
* arXiv
* DBLP
* Crossref
* IEEE Xplore

Using multiple catalogs increases coverage and reduces the risk of selection bias.

---

### Finalize

In this step, a directory for storing the study is selected.

⚠ **The selected study directory must be empty before starting the survey.**
When the survey begins, JabRef initializes the directory by creating the internal study structure, configuration files, and result database.

The **Start survey** button becomes available only after the study definition is complete. The definition must include:

* Study title
* At least one author
* At least one research question
* At least one query

These requirements ensure that JabRef can execute searches and store results using the defined study structure.

---

## After starting the survey

Starting the survey triggers the search and data collection process using the defined study parameters.

During this process:

* Queries are executed on the selected catalogs
* Retrieved records are written into the study database
* The study directory structure is populated with configuration and result data

References can then be:

* Screened
* Filtered
* Tagged
* Exported

<figure>
<img src="../.gitbook/assets/slr-study-folder.png" alt="SLR study folder structure">
<figcaption>Generated study directory structure after starting the survey</figcaption>
</figure>

---

## Role of the SLR feature

The SLR feature provides structural and organizational support inside JabRef. It does **not**:

* Perform methodological quality assessment
* Replace screening decisions
* Replace inclusion or exclusion criteria
* Define research methodology

It supports managing search processes and organizing review data within JabRef.

---

## Best practices

* Define research questions before constructing queries
* Start with broader queries and refine if needed
* Use multiple catalogs to retrieve records from different sources
* Document queries used in the study definition
* Use tags and groups to organize screening decisions

This supports consistent and reproducible handling of search results in JabRef.
14 changes: 6 additions & 8 deletions en/ai/how-to-enable-and-use-ai-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,24 @@ Thank you for checking out JabRef AI features! We believe you can find them usef
## 1. Locate and accept the AI Privacy Policy

1. Run JabRef, open a library, select an entry and open the [entry editor](../advanced/entryeditor/). There you will see tabs that have AI in their name.
![AI related entry editor tabs](../.gitbook/assets/ai-new-entries.png)

<figure><img src="../.gitbook/assets/ai-new-entries.png" alt="AI related entry editor tabs (AI Summary and AI Chat)"><figcaption><p>AI related entry editor tabs</p></figcaption></figure>
2. Open the **AI Chat** or the **AI Summary** tab. The first time you open any of these tabs, JabRef will ask for your permission to accept the Privacy notice. In order to enable all AI features, you need to accept it, by pressing the **I agree** button. If you do not accept it, none of your information will be transmitted to external services.

<figure><img src="../.gitbook/assets/ai-preferences-connection.png" alt="AI privacy notice"><figcaption><p>AI privacy notice</p></figcaption></figure>

In the AI Privacy notice you can find links to Privacy Policies of supported external services and an explanation what data is sent to external services.
![AI privacy notice](../.gitbook/assets/ai-preferences-connection.png)
In the AI Privacy notice you can find links to Privacy Policies of supported external services and an explanation what data is sent to external services.

## 2. Attach a file to your entry

In order to use the following AI features in the entry editor, you need to [add PDFs to an entry](../collect/add-pdfs-to-an-entry.md):

* AI Chat and&#x20;
* AI Chat
* AI Summary tabs

This in turn requires you to [set a main file directory](../finding-sorting-and-cleaning-entries/filelinks.md#directories-for-files). JabRef supports other AI features that do not require you to attach a file to your entry, such as [using a language model to turn plain reference text into an entry](../collect/newentryfromplaintext.md#llm) and if that's all you need, you can skip this step.

## 3. Connect to an external AI provider

There is only one crucial step left for using AI features. You need to setup a connection to an external AI provider. With _external_, we mean a provider outside of JabRef, regardless, if that entails connecting to an [AI app on your local device](local-llm.md) or connecting to a remote online service.
There is only one crucial step left for using AI features. You need to set up a connection to an external AI provider. With _external_, we mean a provider outside of JabRef, regardless, if that entails connecting to an [AI app on your local device](local-llm.md) or connecting to a remote online service.

While the former may or may not require an API key, online services most definitely will require you to enter one, therefore here is some guidance:

Expand All @@ -34,7 +32,7 @@ Please look at the [AI providers and API keys](ai-providers-and-api-keys.md) doc

#### 2. Enter an API key

After you got your API key, you need to enter it in JabRef's [preferences.md](preferences.md "mention").
After you got your API key, you need to enter it in JabRef's [Preferences](preferences.md).

1. Open the preferences menu via `File > Preferences`.
2. Locate the `AI` tab.
Expand Down