Merge branch 'main' into jabkit-extract-references-docs

Siedlerchr · web-flow · commit 0e34435c08eb · 2026-07-20T21:43:03.000+02:00
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -6,7 +6,7 @@ on:
   pull_request:
   workflow_dispatch:
 jobs:
-  lint:
+  markdown-lint:
     runs-on: ubuntu-latest
     steps:
       - name: Set up Git repository
@@ -19,3 +19,31 @@ jobs:
           globs: |
             **/*.md
             #node_modules
+  textlint:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+      - name: Set up Git repository
+        uses: actions/checkout@v4
+        with:
+          show-progress: ''
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+      - name: Install dependencies
+        run: npm ci
+      - name: textlint
+        run: npm run textlint
+  vale-lint:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+      - name: Set up Git repository
+        uses: actions/checkout@v4
+        with:
+          show-progress: ''
+      - name: vale
+        uses: vale-cli/vale-action@v2
+        with:
+          fail_on_error: false
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 _site/
 .idea/
+.github/styles/
 !/.editorconfig
 !/.git*
 !/.travis.yml
diff --git a/.textlintrc.json b/.textlintrc.json
@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "common-misspellings": true
+  }
+}
diff --git a/.vale.ini b/.vale.ini
@@ -0,0 +1,9 @@
+StylesPath = .github/styles
+MinAlertLevel = suggestion
+
+Packages = write-good
+
+[*.md]
+BasedOnStyles = write-good
+# E-Prime (flagging every "is"/"are"/"be") is too strict for technical docs.
+write-good.E-Prime = NO
diff --git a/en/advanced/journalabbreviations.md b/en/advanced/journalabbreviations.md
@@ -23,7 +23,7 @@ Journal name conversion can be accessed either from within the entry editor, or
 
 If the current journal name is not found in your journal lists, the field will not be modified.
 
-To convert the journal names of many entries in bulk, you can select any number of entries, and choose **Quality → Abbreviate journal names → DEFAULT**, **Quality → Abbreviate journal names → MEDLINE**, **Quality → Abbreviate journal names → SHORTEST UNIQUE**, or **Quality → Unabbreviate journal names**. These three actions will abbreviate and unabbreviate the journal names of all selected entries for which the journal name could be found in your journal lists.
+To convert the journal names of many entries in bulk, you can select any number of entries and go to **Quality → Clean up entries → Journal-related → Manage journal abbreviations**. From the dropdown menu, choose an action: **Abbreviate (default)**, **Abbreviate (dotless)**, **Abbreviate (shortest unique)**, **Unabbreviate** or **No changes**. These actions will abbreviate or unabbreviate the journal names of all selected entries for which the journal name could be found in your journal lists.
 
 ## Setting up additional journal lists
 
diff --git a/en/ai/ai-providers-and-api-keys.md b/en/ai/ai-providers-and-api-keys.md
@@ -18,7 +18,7 @@ You can find more information about providers in the [`langchain4j` documentatio
 
 We cannot give a clear recommendation. Providers change their service and their prices regularly and our documentation page is too static to keep up with daily changes. It is recommended to look up LLM benchmarks on the internet or to use the trial and error method. To date, remote AI providers like OpenAI, Google, Mistral and others offer state of the art quality.
 
-If you want to [run a model locally](local-llm.md), you can choose Ollama or make use of the OpenAI API. In comparison to remote AI providers, open weight local models that are compatible with average consumer devices offer less capabilities. There are state of the art local models available, but they are very large (in terms of number of parameters) and the higher the number of parameters, the more memory is needed. To run the largest models, very expensive and capable hardware is required. That said, even small models can be sufficient for the [add entry using refrence text](../collect/newentryfromplaintext.md) workflow.
+If you want to [run a model locally](local-llm.md), you can choose Ollama or make use of the OpenAI API. In comparison to remote AI providers, open weight local models that are compatible with average consumer devices offer less capabilities. There are state of the art local models available, but they are very large (in terms of number of parameters) and the higher the number of parameters, the more memory is needed. To run the largest models, very expensive and capable hardware is required. That said, even small models can be sufficient for the [add entry using reference text](../collect/newentryfromplaintext.md) workflow.
 
 ## Why do I need an API key?
 
diff --git a/en/collaborative-work/export/customexports.md b/en/collaborative-work/export/customexports.md
@@ -50,7 +50,7 @@ You can also specify multiple formatters separated by commas. These will be call
 
 will cause the formatter **ToLowerCase** to be called first, and then **HTMLChars** will be called to format the result. You can list an arbitrary number of formatters in this way.
 
-The argument to the formatters, withing the curly braces, does not have to be a field command. Instead, you can insert normal text, which will then be passed to the formatters instead of the contents of any field. This can be useful for some fomatters, e.g. the CurrentDate formatter (described below).
+The argument to the formatters, within the curly braces, does not have to be a field command. Instead, you can insert normal text, which will then be passed to the formatters instead of the contents of any field. This can be useful for some formatters, e.g. the CurrentDate formatter (described below).
 
 Some formatters take an extra argument, given in parentheses immediately after the formatter name. The argument can be enclosed in quotes, which is necessary if it includes the parenthesis characters. For instance, `\format[Replace("\s,_")]{\journal}` calls the **Replace** formatter with the argument **\s,\_** (which results in the "journal" field after replacing all whitespace by underscores).
 
diff --git a/en/collect/add-entry-using-an-id.md b/en/collect/add-entry-using-an-id.md
@@ -76,7 +76,7 @@ ID search is carried out using the [Library of Congress Control Number](https://
 
 [MathSciNet](http://www.ams.org/mathscinet/) is a searchable online bibliographic database. It contains all of the contents of the journal Mathematical Reviews (MR) since 1940 along with an extensive author database, links to other MR entries, citations, full journal entries, and links to original articles. It contains almost 3 million items and over 1.7 million links to original articles ([Wikipedia](https://en.wikipedia.org/wiki/MathSciNet)).
 
-ID search is carried out using the MR number.
+ID search is carried out using the MR number, e.g. `MR3300361`.
 
 ### Medline/Pubmed
 
diff --git a/en/collect/import-using-online-bibliographic-database.md b/en/collect/import-using-online-bibliographic-database.md
@@ -20,7 +20,7 @@ If you need to use an HTTP proxy server, you can configure JabRef to use a proxy
 
 ## Search Syntax
 
-Since version [5.2](https://github.com/JabRef/jabref/blob/main/CHANGELOG.md#52--2020-12-24):
+Since version [6.0](https://github.com/JabRef/jabref/blob/main/CHANGELOG.md#unreleased):
 
 JabRef searches the catalogs by using the specified keywords. One can use quotes (`"`) to keep words togehter: An example is `"process mining"`. It is also possible to restrict the search to dedicated fields:
 
@@ -39,11 +39,11 @@ One can usually combine different searches using the Boolean operators `AND` and
 
 ### Examples
 
-* `author:smith and author:jones`: search for references with authors "smith" and "jones"
-* `author:smith or author:jones`: search for references with either author "smith" or author "jones"
-* `author:smith and not title:processor`: search for author "smith" and omit references with "processor" in the title
+* `author=smith and author=jones`: search for references with authors "smith" and "jones"
+* `author=smith or author=jones`: search for references with either author "smith" or author "jones"
+* `author=smith and not title=processor`: search for author "smith" and omit references with "processor" in the title
 
-Technial note: The search syntax is adapted from [Apache Lucene](https://lucene.apache.org/core/2\_9\_4/queryparsersyntax.html). JabRef takes the Lucene syntax and transforms it to the syntax required by the supported catalogs.
+Technical note: The web search syntax currently uses the same syntax as the [local search functionality](../finding-sorting-and-cleaning-entries/search.md) in JabRef. The terms are then transformed into the required format for the specific APIs used in the background.
 
 ## Supported catalogs
 
@@ -158,8 +158,8 @@ Year ranges are not supported. In case a year range is provided, it is ignored.
 #### Sample queries
 
 * `marx kapital`
-* `author:grodke and title:db2`
-* `author:"Maas,jan?"`
+* `author=grodke and title=db2`
+* `author="Maas,jan?"`
 
 ### IEEEXplore
 
@@ -192,7 +192,7 @@ Currently disabled because of traffic limit
 
 [Jstor](https://jstor.org) is an online catalog with access to more than 12 million journal articles, books, and sources in 75 disciplines. [About](https://about.jstor.org)
 
-It is possible to limit the search by adding a field name to the search, such as `field:"text"`. The supported fields are:
+It is possible to limit the search by adding a field name to the search, such as `field="text"`. The supported fields are:
 
 * `title`: The title of the article
 * `author`: an author of the article
@@ -203,6 +203,8 @@ It is possible to limit the search by adding a field name to the search, such as
 
 [MathSciNet](https://www.ams.org/mathscinet/) is a searchable online bibliographic catalog. It contains all of the contents of the journal Mathematical Reviews (MR) since 1940 along with an extensive author catalog, links to other MR entries, citations, full journal entries, and links to original articles. It contains almost 3 million items and over 1.7 million links to original articles ([Wikipedia](https://en.wikipedia.org/wiki/MathSciNet)).
 
+You can also search directly using the MR number, e.g. `MR3300361`.
+
 ### Medline/PubMed
 
 [MEDLINE](https://www.nlm.nih.gov/bsd/pmresources.html) is a bibliographic catalog of life sciences and biomedical information. It includes bibliographic information for articles from academic journals covering medicine, nursing, pharmacy, dentistry, veterinary medicine, and health care. MEDLINE also covers much of the literature in biology and biochemistry, as well as fields such as molecular evolution ([Wikipedia](https://en.wikipedia.org/wiki/MEDLINE)).
@@ -270,14 +272,14 @@ You cannot use the same query syntax as in the one-line search at zbmath.org; yo
 #### Examples
 
 * \`\`[`algebra*`](https://zbmath.org/?q=algebra\*): Searches for publications containing a term starting with algebra (e.g. algebra, algebras, algebraic, etc.) in any field.
-* [`title:"Graph Theory"`](https://zbmath.org/?q=ti%3A+%E2%80%9CGraph+Theory%E2%80%9D): Searches for publications with the exact phrase _Graph Theory_ in their `title` field.
-* [`an:0492.90056`](https://zbmath.org/?q=an%3A0492.90056): Searches for the document with zbl number _0492.90056_.
-* [`author:Berge and title:"Graph Theory"`](https://zbmath.org/?q=au%3A+Berge+%26+ti%3A+%E2%80%9CGraph+Theory%E2%80%9D): Searches for entries written by _Berge_ with `Graph Theory` in their **title** field.
-* [`dt:b author:Berge`](https://zbmath.org/?q=dt%3A+b+au%3A+Berge): Searches for all books written by Berge.
-* [`title:"Graph Theory" yearrange:2010-2020`](https://zbmath.org/?q=ti%3A+%E2%80%9CGraph+Theory%E2%80%9D+py%3A+2010-2020): Searches for documents containing the exact phrase `Graph Theory` in their **title** that are published between _2010_ and _2020_.
-* [`so:Combinatorica`](https://zbmath.org/?q=so%3A+Combinatorica): Searches for documents published in the journal `Combinatorica`.
-* [`cc:"(05C|90C)"`](https://zbmath.org/?q=cc%3A+%2805C%7C90C%29): Searches for documents with **MSC code** in `05C` or `90C`.
-* [`la:"es | pt"`](https://zbmath.org/?q=la%3A+es+%7C+pt): Searches for documents written in Spanish or Portuguese.
-* [`sw:python`](https://zbmath.org/?q=sw%3Apython): Searches for publications using the **software** `python`.
-* [`en:arXiv`](https://zbmath.org/?q=en%3AarXiv): Searches for entries with a link to an `arXiv` preprint.
-* [`br:"Claude Berge"`](https://zbmath.org/?q=br%3AClaude+Berge): Searches for publications with biographical information on `Claude Berge`.
+* [`title="Graph Theory"`](https://zbmath.org/?q=ti%3A+%E2%80%9CGraph+Theory%E2%80%9D): Searches for publications with the exact phrase _Graph Theory_ in their `title` field.
+* [`an=0492.90056`](https://zbmath.org/?q=an%3A0492.90056): Searches for the document with zbl number _0492.90056_.
+* [`author=Berge and title="Graph Theory"`](https://zbmath.org/?q=au%3A+Berge+%26+ti%3A+%E2%80%9CGraph+Theory%E2%80%9D): Searches for entries written by _Berge_ with `Graph Theory` in their **title** field.
+* [`dt=b author=Berge`](https://zbmath.org/?q=dt%3A+b+au%3A+Berge): Searches for all books written by Berge.
+* [`title="Graph Theory" yearrange=2010-2020`](https://zbmath.org/?q=ti%3A+%E2%80%9CGraph+Theory%E2%80%9D+py%3A+2010-2020): Searches for documents containing the exact phrase `Graph Theory` in their **title** that are published between _2010_ and _2020_.
+* [`so=Combinatorica`](https://zbmath.org/?q=so%3A+Combinatorica): Searches for documents published in the journal `Combinatorica`.
+* [`cc="(05C|90C)"`](https://zbmath.org/?q=cc%3A+%2805C%7C90C%29): Searches for documents with **MSC code** in `05C` or `90C`.
+* [`la="es | pt"`](https://zbmath.org/?q=la%3A+es+%7C+pt): Searches for documents written in Spanish or Portuguese.
+* [`sw=python`](https://zbmath.org/?q=sw%3Apython): Searches for publications using the **software** `python`.
+* [`en=arXiv`](https://zbmath.org/?q=en%3AarXiv): Searches for entries with a link to an `arXiv` preprint.
+* [`br="Claude Berge"`](https://zbmath.org/?q=br%3AClaude+Berge): Searches for publications with biographical information on `Claude Berge`.
diff --git a/en/collect/newentryfromplaintext.md b/en/collect/newentryfromplaintext.md
@@ -33,7 +33,7 @@ O. Kopp, A. Armbruster, und O. Zimmermann, "Markdown Architectural Decision Reco
 
 ### Rule-based
 
-This is the default parser. It does not require any extensive setups, nor does it send data to remote services. Any conversions are executed locally on your device. The rule-based parser also is deterministic, as the rules are hard-coded. Unfortunately, at time of writing, the rule-based parser is far from perfect. As one can see in the example above, the number "10" was wrongly interpreted as a page number, which is clearly not the intended result. The underlying rules are insufficient to account for all possibilities that bibliographic metadata may contain and ideally would require a way more fine-grained, but an ever more complex rule-set. It is recommended to use the rule-based parser as a last-resort, when the Grobid or LLM based parsers are not available or not desireable.
+This is the default parser. It does not require any extensive setups, nor does it send data to remote services. Any conversions are executed locally on your device. The rule-based parser also is deterministic, as the rules are hard-coded. Unfortunately, at time of writing, the rule-based parser is far from perfect. As one can see in the example above, the number "10" was wrongly interpreted as a page number, which is clearly not the intended result. The underlying rules are insufficient to account for all possibilities that bibliographic metadata may contain and ideally would require a way more fine-grained, but an ever more complex rule-set. It is recommended to use the rule-based parser as a last-resort, when the Grobid or LLM based parsers are not available or not desirable.
 
 ### Grobid
 
diff --git a/en/finding-sorting-and-cleaning-entries/keywords.md b/en/finding-sorting-and-cleaning-entries/keywords.md
@@ -8,7 +8,7 @@ description: Keywords help you in organizing, sorting and searching your entries
 
 Keywords can be added to your entries in a specific field. In the entry editor, the keywords field is displayed in the General tab. There, you can add new keywords to an entry by typing it in. If auto-completion is activated for the field keywords (**File → Preferences → Entry editor**), suggestions are given based on existing keywords.
 
-By default, the keyword separator is a comma. It can be redefined in the preferences (**File → Preferences → Entry**).
+By default, the keyword separator is a comma. It can be redefined in the preferences (**File → Preferences → Entry**). To use the separator character within a keyword itself, you can escape it with a backslash (`\`).
 
 {% hint style="info" %}
 If some entries have a keyword separator differing from the prescribed one, you can use menu **Edit → Find and replace**. For example, you may want to replace semi-columns (;) by commas (,). Select the radio button "Limit to Fields" and type in "keywords" as the relevant field.​​
diff --git a/en/installation.md b/en/installation.md
@@ -116,7 +116,7 @@ Note: This could not work in JabRef 5.12. or later.
 {% endtab %}
 
 {% tab title="macOS" %}
-#### I cannot start JabRef 5.9 due to file beeing damaged
+#### I cannot start JabRef 5.9 due to file being damaged
 
 Execute xattr -d com.apple.quarantine /Applications/JabRef.app
 (This is a known problem related to Apple's notarization)
diff --git a/en/related-work/related-work.md b/en/related-work/related-work.md
@@ -6,7 +6,7 @@ Please discuss with us at [the forum](https://discourse.jabref.org/) list if you
 
 * A large list of possible reference managers is provided by [WikiPedia](https://en.wikipedia.org/wiki/Comparison_of_reference_management_software).
 * [alternative.to](https://alternativeto.net/software/jabref/) also provides a list of popular alternatives.
-* An interactive table is provided at the [ultimate reference management software comparision](https://ultimate-comparisons.github.io/ultimate-reference-management-software-comparison/).
+* An interactive table is provided at the [ultimate reference management software comparison](https://ultimate-comparisons.github.io/ultimate-reference-management-software-comparison/).
 * An evaluation from the year 2007 of collaborative literature tools: [Fachstudie Nr. 61](https://www2.informatik.uni-stuttgart.de/cgi-bin/NCSTRL/NCSTRL_view.pl?id=FACH-0061&mod=0&engl=1).
 
 In the list below, we pick interesting candidates.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +  "rules": {
 +    "common-misspellings": true
 +  }
 +}