Fix docs (#549)

subhramit · web-flow · commit 5bd4c7b5b4a2 · 2025-02-17T06:56:05.000+01:00
diff --git a/en/.gitbook/assets/library-menu.jpeg b/en/.gitbook/assets/library-menu.jpeg
diff --git a/en/.gitbook/assets/library-properties-citationkey.jpeg b/en/.gitbook/assets/library-properties-citationkey.jpeg
diff --git a/en/ai/local-llm.md b/en/ai/local-llm.md
@@ -38,7 +38,7 @@ Now, you are all set and can chat "locally".
 The following steps guide you on how to use `GPT4All`to download and run local LLMs.
 
 1. Install `GPT4All`from their [website](https://www.nomic.ai/gpt4all).
-2. Open GPT4All, [download a model](https://docs.gpt4all.io/gpt4all_desktop/models.html), configure it in the[ settings](https://docs.gpt4all.io/gpt4all_desktop/settings.html) and [run it as a server](https://docs.gpt4all.io/gpt4all_api_server/home.html).
+2. Open GPT4All, [download a model](https://docs.gpt4all.io/gpt4all_desktop/models.html), configure it in the [settings](https://docs.gpt4all.io/gpt4all_desktop/settings.html) and [run it as a server](https://docs.gpt4all.io/gpt4all_api_server/home.html).
 3. Open JabRef, go to "File" > "Preferences" > "AI"
 4. Set the "AI provider" to "GPT4All"
 5. Set the "Chat model" to the name (including the `.gguf`part) of the model you have downloaded in GPT4All.
diff --git a/en/collect/findunlinkedfiles.md b/en/collect/findunlinkedfiles.md
@@ -39,19 +39,19 @@ This information is partially outdated. Please help to improve it ([how to edit
 {% endhint %}
 
 1. Create or open a library (AKA a `.bib` file).
-2.  Go to **Lookup -> Search for unlinked local files**. (or press `SHIFT + F7`)
+2. Go to **Lookup -> Search for unlinked local files**. (or press `SHIFT + F7`)
 
     ![FindUnlinkedFiles - Menu](<../.gitbook/assets/bildschirmfoto-2021-07-05-um-19.19.09 (1).png>) ![FindUnlinkedFiles - Menu](<../.gitbook/assets/findunlinkedfiles-menu-5.2 (6).png>)
-3.  The "Search for unlinked local files" dialog opens.
+3. The "Search for unlinked local files" dialog opens.
 
     <img src="../.gitbook/assets/findunlinkedfiles-window-5.2 (6).png" alt="FindUnlinkedFiles - Initial dialog" data-size="original">
 4. Choose a start directory using the "Browse" button.
 5. Click on "Search" / "Scan directory".
-6.  In "Select files", the files not yet contained in the library are shown.
+6. In "Select files", the files not yet contained in the library are shown.
 
     <img src="../.gitbook/assets/findunlinkedfiles-foundfiles-5.2 (6).png" alt="FindUnlinkedFiles - Found files" data-size="original">
 7. Select the entries you are interested in. Note: the button `Export selected files` allows you to export the list of the selected files (a text file containing on each line one filename with its path)
-8.  Click on `Import`.
+8. Click on `Import`.
 
     The windows close and the entry table now contains the newly-imported entries.
 9. The entry editor with the last imported entry is shown ![FindUnlinkedFiles - 08 - entry editor](<../.gitbook/assets/findunlinkedfiles-08-entry-editor (5).png>)
diff --git a/en/collect/newentryfromplaintext.md b/en/collect/newentryfromplaintext.md
@@ -1,3 +1,5 @@
+<!-- markdownlint-disable MD033 -->
+
 # Add entry using reference text
 
 > Entries can be created from a reference text.
@@ -10,49 +12,44 @@ Different parsers will lead to different results. It is strongly recommended to
 
 Example:
 
-```
+```text
 O. Kopp, A. Armbruster, und O. Zimmermann, "Markdown Architectural Decision Records: Format and Tool Support", in 10th ZEUS Workshop, 2018.
 ```
 
-
-
-1.  Click Library and select "New entry from plain text..." Alternatively, you can press Ctrl+Shift+N.
-
-
+1. Click Library and select "New entry from plain text..." Alternatively, you can press Ctrl+Shift+N.
 
     <div align="left"><figure><picture><source srcset="../.gitbook/assets/Bild 1 - dark mode.jpg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/Bild 1.png" alt=""></picture><figcaption></figcaption></figure></div>
-2.  The "Plain Reference Parser" window opens
-
 
+2. The "Plain Reference Parser" window opens
 
     <div align="left"><figure><picture><source srcset="../.gitbook/assets/Bild 2 - Plain citations parser dialog opens - dark mode.png" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/Bild 2 - Plain citations parser dialog opens - light mode.png" alt=""></picture><figcaption></figcaption></figure></div>
-3.  Paste the reference text:
-
 
+3. Paste the reference text:
 
     <div align="left"><figure><picture><source srcset="../.gitbook/assets/Bild 3 - paste text - dark mode (2).png" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/new-entry-from-plain-text-step-3 (1).png" alt=""></picture><figcaption></figcaption></figure></div>
-4.  Choose a parser from the drop-down menu.
+
+4. Choose a parser from the drop-down menu.
 
     <div align="left"><figure><picture><source srcset="../.gitbook/assets/Bild 4 - Parser Choise (Rule-based, Grobid and LLM) - dark mode.png" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/Bild 4 - Parser Choise (Rule-based, Grobid and LLM) - light mode.png" alt=""></picture><figcaption></figcaption></figure></div>
-5. Click "Add to current library"
-6.  The result is selected in the entry table:
 
+5. Click "Add to current library"
 
+6. The result is selected in the entry table:
 
     <figure><picture><source srcset="../.gitbook/assets/Bild 5 - rule based result is selected in entry table - dark mode.png" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/Bild 5 - rule based result is selected in entry table - light mode.png" alt=""></picture><figcaption></figcaption></figure>
 
-### Parser Explanation
+## Parser Explanation
 
-#### Rule-based
+### 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.
 
-#### Grobid
+### Grobid
 
 JabRef uses the technology offered by [Grobid](https://github.com/kermitt2/grobid), a machine learning software project with decades of experience and development dedicated to bibliographic metadata extraction. The Grobid parser usually tends to achieve better results than the rule-based parser. Since JabRef runs Grobid on a remote instance, users will have to confirm sending data to JabRef's online service in the preferences (_File > Preferences > Web search > Remote Services_). Sending data is disabled by default. It cannot be guaranteed that JabRef's Grobid instance will always be up and running, but it is possible for you to set up your [own Grobid Instance](https://grobid.readthedocs.io/en/latest/Grobid-docker/).
 
 <figure><picture><source srcset="../.gitbook/assets/Bild 6 - Grobid Preferences - dark mode.png" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/Bild 6 - Grobid Preferences - light mode.png" alt=""></picture><figcaption><p>Grobid related preference section in JabRef</p></figcaption></figure>
 
-#### LLM
+### LLM
 
 Large Language Models too can be used to convert the reference text. The quality of the results is surprisingly good, tends to be better than the rule-based parser and competes with Grobid. Nevertheless, it depends on the model or service that is used and if they are trained/designed for this use-case. Extensive documentation about how to set up a local LLM or connect to a remote AI service can be found in the [AI functionality](../ai/) section. Data privacy depends on the external application that you are using to run the local model and/or on the remote AI provider, if you are connecting to one of those.
diff --git a/en/contributing/how-to-translate-the-ui.md b/en/contributing/how-to-translate-the-ui.md
@@ -1,3 +1,5 @@
+<!-- markdownlint-disable MD033 -->
+
 # How to translate the JabRef User Interface
 
 ## Introduction
@@ -11,10 +13,10 @@ If the JabRef interface already exists in your language, you can help improve it
 We use the service of [Crowdin](https://translate.jabref.org) to keep our translations updated. It is a service directly running in the browser and one can quickly join and start translating.
 
 * Visit [https://translate.jabref.org/](https://translate.jabref.org) to get started
-*   Select your preferred language, login, and click on _JabRef\_en.properties_
+* Select your preferred language, login, and click on _JabRef\_en.properties_
 
     <img src="../.gitbook/assets/crowdin-select-file (4).png" alt="Screenshot of Crowdin select file page" data-size="original">
-*   Choose the string you want to translate in the left panel (strings to be translated are listed first)
+* Choose the string you want to translate in the left panel (strings to be translated are listed first)
 
     and enter the translation in the central panel (suggestions are given at the bottom)
 
diff --git a/en/finding-sorting-and-cleaning-entries/filelinks.md b/en/finding-sorting-and-cleaning-entries/filelinks.md
@@ -1,3 +1,5 @@
+<!-- markdownlint-disable MD033 -->
+
 # Manage associated files
 
 JabRef lets you link up your entries with files of any type stored on your system. Thereby, it uses the field `file`, which contains a list of linked files. Each entry can have an arbitrary number of file links, and each linked file can be opened quickly from JabRef. The fields `url` and `doi` are used as links to documents on the web in the form of a URL or a DOI identifier, respectively (see [URL and DOI in JabRef](../advanced/externalfiles.md)).
@@ -14,9 +16,10 @@ If the "file" field is included in [General fields](../setup/generalfields.md),
 
 JabRef offers the following directory settings:
 
-1.  **File → Preferences → Linked files**, item _Main file directory._
+1. **File → Preferences → Linked files**, item _Main file directory._
 
     <img src="../.gitbook/assets/preferences-linkedfiles-5.2 (2).png" alt="Main file directory" data-size="original">
+
 2. **Library → Library properties**, items _Library-specific file directory,_ and _User-specific file directory_.![Override default file directories](<../.gitbook/assets/jabref-lib-properties (1).png>)
 
 One of these settings is required. Mostly the "Main file directory" is enough.
@@ -39,7 +42,7 @@ If you have a file within or below one of your file directories with an extensio
 
 The rules for which file names can be auto-linked to a citation key can be set up in **File → Preferences → Linked files**, section _Autolink files_.
 
-![](<../.gitbook/assets/preferences-linkedfiles-5.2 (2).png>)
+![Linked FIles Preferences](<../.gitbook/assets/preferences-linkedfiles-5.2 (2).png>)
 
 ## Filename format and file directory pattern
 
diff --git a/en/setup/citationkeypatterns.md b/en/setup/citationkeypatterns.md
@@ -1,3 +1,5 @@
+<!-- markdownlint-disable MD033 -->
+
 # Customize the citation key generator
 
 The pattern used in the auto generation of citation labels can be set for each of the standard entry types in **File → Preferences**, tab **Citation key generator**. A detailed description can be found in the [default citation key pattern section](citationkeypatterns.md#default-citation-key-pattern).
@@ -184,9 +186,9 @@ To change the citation key patterns for a single library to `[auth][shortyear]`,
 1. Make sure the library is open and selected in the JabRef main window
 
     <img src="../.gitbook/assets/main-screen-selected-library (7).png" alt="Main screen selected library" data-size="original">
-2. From the "Library" menu, open the "Citation key pattern" setting
+2. From the "Library" menu, open "Library properties"
 
-    <img src="../.gitbook/assets/library-citation-key-patterns (3).png" alt="Library Citation key patterns" data-size="original">
-3. Set the pattern for the desired entry types, and press the apply button.
+    <img src="../.gitbook/assets/library-menu.jpeg" alt="Library Citation key patterns" data-size="original">
+3. Set the pattern for the desired entry types (keeping in mind to press enter after setting each), and press the apply button.
 
-    <img src="../.gitbook/assets/citation-key-patterns (8).png" alt="Citation key patterns" data-size="original">
+    <img src="../.gitbook/assets/library-properties-citationkey.jpeg" alt="Citation key patterns" data-size="original">
