Switch linter (#469)

.github/workflows/lint.yaml

@@ -5,9 +5,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Set up Git repository
-        uses: actions/checkout@v2
-      - name: Lint all files
-        uses: avto-dev/markdown-lint@v1
+        uses: actions/checkout@v4
         with:
-          args: 'README.md'
-          config: '.markdownlint.yml'
+          show-progress: ''
+      - name: markdownlint-cli2-action
+        uses: DavidAnson/markdownlint-cli2-action@v9
+        with:
+          globs: |
+            **/*.md
+            #node_modules

.markdownlint.yml

@@ -3,6 +3,9 @@ default: true
 # Using h2 has side effects in GitBook's toc. Thus, we sometimes switch from h1 to h3
 MD001: false
 
+# GitBook mixes * and - as list styles
+MD004: false
+
 # Something goes wrong with the lists with GitBook
 MD007: false
 
@@ -25,7 +28,7 @@ MD026:
 
 MD033:
   # we have <a> tags with ids
-  allowed_elements: ['a']
+  allowed_elements: ['a', 'div', 'figure', 'figcaption', 'img', 'p', 'mark']
 
 # we allow images without alt text
 MD045: false

.vscode/ltex.dictionary.en-US.txt

@@ -0,0 +1,3 @@
+JabRef
+Medline
+OpenDocument

CONTRIBUTING.md

@@ -1 +1,3 @@
+# Contribution guide
+
 See our guide at [en/contributing/how-to-improve-the-help-page.md](en/contributing/how-to-improve-the-help-page.md).

README.md

@@ -23,14 +23,20 @@ Use <https://github.com/koppor/gitbook-summary-generator>.
 
 You can use the [markdown-lint docker image](https://github.com/marketplace/actions/markdown-linting-action):
 
-```terminal
+```shell
 docker run --rm \
     -v "$(pwd):/tmp/check" \
     -e INPUT_CONFIG=/tmp/check/.markdownlint.yml \
     avtodev/markdown-lint:v1 \
     /tmp/check/en
 ```
 
+Alternatively, you can run the GitHub Lint workflow:
+
+```shell
+act --rm --platform ubuntu-latest=fwilhe2/act-runner:latest -W .github/workflows/lint.yaml
+```
+
 ### How to rename files
 
 The gitbook integration changes some of the file names and appends "(1) (2) (1)" or something like this.

en/advanced/commandline.md

@@ -27,7 +27,7 @@ Locate `JabRef.bat`, for example: `JabRef-5.0-portable_windows\JabRef\runtime\bi
 
 The following documentation is for Windows, but works equally well on Linux and macOS:
 
-```
+```cmd
 C:\portable-apps\JabRef-5.0-portable_windows\JabRef\runtime\bin\JabRef.bat [OPTIONS] [BIBTEX_FILE]
 ```
 
@@ -38,7 +38,7 @@ Take care to specify all options before your list of file names.\
 Ensure that the first file name is not misunderstood as being an argument for an option; this simply means that if a boolean option like `-n` or `-l` immediately precedes a file name, add the word `true` as an argument. \
 For instance, the command line will correctly load the file `original.bib`, export it in [docbook format](https://docbook.org/whatis) to `filetoexport.xml`, and suppress the GUI:
 
-```
+```cmd
 C:\portable-apps\JabRef-5.0-portable_windows\JabRef\runtime\bin\JabRef.bat -o filetoexport.xml,docbook5 -n true original.bib
 ```
 
@@ -97,7 +97,7 @@ _Note:_ The `-i` option can be specified only once, and for one file only.
 
 ### Export file: `-o filename[,export format]`
 
-(or `--output filename[,export format]`
+(or `--output filename[,export format]`)
 
 Export or save a file imported or loaded by the same command line.
 
@@ -117,13 +117,13 @@ _Note:_ The `-o` option can be specified only once, and for one file only.
 
 The first option is to export all entries, which are included in the `entries.bib` file to the specified `export.xmp` file. The second argument, separated by comma, is the type of exporter used by JabRef.
 
-```
+```cmd
 JabRef.bat -o path\export.xmp,xmp  path\entries.bib -n
 ```
 
 The second option is to export every entry in the entries.bib in a single .xmp file. Therefore, the file name is replaced by the keyword `split` without a file ending! JabRef generates individual .xmp files at the `path` location. The file name is a combination of the identifier provided by JabRef and the cite key of the entry.
 
-```
+```cmd
 JabRef.bat -o path\split,xmp  path\entries.bib -n
 ```
 

en/advanced/debugging-your-library-file.md

@@ -6,7 +6,7 @@ description: When error ensues, how to debug your library file with various meth
 
 ## Use Backups
 
-If you encounter any errors that are related to wrong, erroneous, corrupt or vanished data in your library file or simply unintended behaviour that has unknown causes, the first thing that is advised to do, is to find and make use of your backups.
+If you encounter any errors that are related to wrong, erroneous, corrupt or vanished data in your library file or simply unintended behavior that has unknown causes, the first thing that is advised to do, is to find and make use of your backups.
 
 1. **Navigate to your** [**backup directory**](https://docs.jabref.org/advanced/autosave#where-can-i-find-the-backup-files)**.**
 2. **Find and select all** [**backups files**](https://docs.jabref.org/advanced/autosave#what-are-.sav-.bak-and-.tmp-files) (the `.bak` files).
@@ -51,7 +51,7 @@ Halving as a process of elimination will quickly lead to results, as the followi
 | ----------------- | - | - | - | - | - | - | - | - | -- | -- | -- | -- | --- | --- | --- |
 | Steps             | 1 | 2 | 2 | 3 | 3 | 3 | 3 | 4 | 4  | 5  | 6  | 7  | 8   | 9   | ... |
 
-#### Related Literature:
+#### Related Literature
 
 If you want to find out more about this method, the following articles explain the method of halving in various contexts:
 

en/advanced/fields.md

@@ -38,12 +38,12 @@ There is a lot of different fields in _BibTeX_, and some additional fields that
 
 The following fields are recognized by the default bibliography styles:
 
-*   **bibtexkey** A unique string used to refer to the entry in LaTeX documents. Note that when referencing an entry from LaTeX, the key must match case-sensitively with the reference string. Some characters should not be used in bibtexkey as they are not compatible or not recommended:
+* **bibtexkey** A unique string used to refer to the entry in LaTeX documents. Note that when referencing an entry from LaTeX, the key must match case-sensitively with the reference string. Some characters should not be used in bibtexkey as they are not compatible or not recommended:
 
     `{ } ( ) , \ " - # ~ ^ : '`
 * **address** Usually the address of the `publisher` or other type of institution. For major publishing houses, you may omit the information entirely or give simply the city. For small publishers, on the other hand, you can help the reader by giving the complete address.
 * **annote** An annotation. It is not used by the standard bibliography styles, but may be used by others that produce an annotated bibliography.
-*   **author** This field should contain the complete author list for your entry. The names are separated by the word _and_, even if there are more than two authors. Each name can be written in two equivalent forms:
+* **author** This field should contain the complete author list for your entry. The names are separated by the word _and_, even if there are more than two authors. Each name can be written in two equivalent forms:
 
     Donald E. Knuth _or_ Knuth, Donald E.
 
@@ -61,7 +61,7 @@ The following fields are recognized by the default bibliography styles:
 * **key** Used for alphabetizing, cross referencing, and creating a label when the \`\`author'' information is missing. This field should not be confused with the key that appears in the `\cite` command and at the beginning of the library entry.
 * **month** The month in which the work was published or, for an unpublished work, in which it was written. You should use the standard three-letter abbreviation of the English names (jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec).
 * **note** Any additional information that can help the reader. The first word should be capitalized.
-*   **number**
+* **number**
 
     The number of a journal, magazine, technical report, or of a work in a series. An issue of a journal or magazine is usually identified by its volume and number; the organization that issues a technical report usually gives it a number; and sometimes books are given numbers in a named series.
 * **organization** The organization that sponsors a conference or that publishes a manual.
@@ -120,7 +120,7 @@ You can create new fields by [editing (or creating) entry types](../setup/custom
 ## Hints on fields
 
 * Generally, you can use LaTeX commands inside of fields containing text. _BibTeX_ will automatically format your reference lists, and those fields that are included in the lists will be (de)capitalized according to your bibliography style. To ensure that certain characters remain capitalized, enclose them in braces, like in the word _{B}elgium_.
-*   An institution name should be inside `{}` brackets.
+* An institution name should be inside `{}` brackets.
 
     If the institution name also includes its abbreviation, this abbreviation should be also in `{}` brackets.
 

en/advanced/how-to-expand-firstnames.md

@@ -1,8 +1,8 @@
-# How to expand first names of an entry
+# How to expand first names of a BibTeX entry
 
 Sometimes, one has a BibTeX/biblatex entry with abbreviated short names:
 
-```
+```bibtex
 @Article{Eshuis_2015,
   author    = {R. Eshuis and A. Norta and O. Kopp and E. Pitkanen},
   journal   = {{IEEE} Transactions on Services Computing},
@@ -18,15 +18,19 @@ Sometimes, one has a BibTeX/biblatex entry with abbreviated short names:
 
 Now, one wants to have the full first names. In case, there is a DOI available, this is as simple as the following steps:
 
-1.  Determine the DOI: Switch to the "General" tab and click on "Look up DOI"
+1. Determine the DOI: Switch to the "General" tab and click on "Look up DOI"
+
+   ![Screenshot of determine DOI](../../.gitbook/assets/expand-firstnames-step-1.png)
+
+2. Fetch BibTeX data from the DOI: Click on "Get BibTeX data from DOI"
+
+   ![Screenshot of get BibTeX data from DOI](../../.gitbook/assets/expand-firstnames-step-2.png)
+
+3. A popup appears. Select which data you want to merge into the eixting entry
 
-    <img src="../.gitbook/assets/expand-firstnames-step-1.png" alt="Screenshot of determine DOI" data-size="original">
-2.  Fetch BibTeX data from the DOI: Click on "Get BibTeX data from DOI"
+   ![Screenshot of Merge Entries Dialog](../../.gitbook/assets/expand-firstnames-step-3.png)
 
-    <img src="../.gitbook/assets/expand-firstnames-step-2.png" alt="Screenshot of get BibTeX data from DOI" data-size="original">
-3.  A popup appears. Select which data you want to merge into the existing entry
+4. Now the first names are expanded:
 
-    <img src="../.gitbook/assets/expand-firstnames-step-3 (1).png" alt="Screenshot of Merge Entries Dialog" data-size="original">
-4.  Now the first names are expanded:
+   ![Screenshot of Result](../../.gitbook/assets/expand-firstnames-step-4.png)
 
-    <img src="../.gitbook/assets/expand-firstnames-step-4.png" alt="Screenshot of Result" data-size="original">

en/advanced/journalabbreviations.md

@@ -8,7 +8,7 @@ JabRef can automatically toggle journal names between abbreviated and unabbrevia
 
 This feature can be configured under **Options → Preferences → Manage journal abbreviations**.
 
-JabRef includes a fairly extensive build-in list of journal abbreviations. This list is a merge of all lists available at [abbrv.jabref.org](https://abbrv.jabref.org). However, this might still be be incomplete (or outdated) for the purposes of some users. Thus, JabRef allows to add abbreviations in the form of a personal list or external lists.
+JabRef includes a fairly extensive build-in list of journal abbreviations. This list is a merge of all lists available at <https://abbrv.jabref.org>. However, this might still be incomplete (or outdated) for the purposes of some users. Thus, JabRef allows to add abbreviations in the form of a personal list or external lists.
 
 ![General view](<../.gitbook/assets/JournalAbbreviations (2) (2) (2) (2) (2) (2) (2) (2) (3) (3) (4) (1) (1) (1).png>)
 
@@ -47,14 +47,14 @@ You can link to a number of external lists. These links can be set up on top of
 
 External lists can be found at [JabRef's repository abbreviation lists](http://abbrv.jabref.org). These data files are in CSV format (using semicolons as separators):
 
-```
-<full name>;<abbreviation>[;<shortest unique abbreviation>[;<frequency>]]
+```csv
+<full name>,<abbreviation>[,<shortest unique abbreviation>[,<frequency>]]
 ```
 
 The two last fields are optional, and you can omit them. JabRef supports the third field, which contains the shortest unique abbreviation. The last field is not currently used; its intention is gives frequency (e.g., `M` for monthly). For instance:
 
-```
-Accounts of Chemical Research;Acc. Chem. Res.;ACHRE4;M
+```csv
+Accounts of Chemical Research,Acc. Chem. Res.,ACHRE4,M
 ```
 
 #### Contributing an external journal list

en/cite/export-to-microsoft-word.md

@@ -2,26 +2,25 @@
 
 You can import your citations into a Microsoft Word document through JabRef's export feature. Please follow the steps below for instructions on how to export your JabRef sources into a Microsoft Word document.
 
-1. Select the "File" tab in the upper lefthand corner of JabRef, hover over "Export", and select "Export selected entries". Be sure to save your file as a "MS Office 2007" file. 
+1. Select the "File" tab in the upper lefthand corner of JabRef, hover over "Export", and select "Export selected entries". Be sure to save your file as a "MS Office 2007" file.
 2. Open Microsoft Word and click on the "References" tab.
-3. Select "Manage Sources", click "Browse", and locate the desired file. The file type should be an XML document. 
+3. Select "Manage Sources", click "Browse", and locate the desired file. The file type should be an XML document.
 
       ***Mac OS users will not see a "Manage Sources" button. Mac users should follow these steps:***
 
       a.) Copy the selected file to /Library/Containers/com.microsoft.word/Data/Library/Application Support/Microsoft/Office or alternatively to
-      /Users/<username>/Library/Containers/com.microsoft.Word/Data/Library/Application Support/Microsoft/Office/ and name it Sources.xml
+      /Users/{username}/Library/Containers/com.microsoft.Word/Data/Library/Application Support/Microsoft/Office/ and name it Sources.xml
 
       b.) Restart Word
 
       c.) Select "References", and then select "Citations"
 
-      d.) A sidebar will open on the right side of the window. Click the icon with three dots. 
+      d.) A sidebar will open on the right side of the window. Click the icon with three dots.
 
-      e.) Click “Citation Sources Manager” from the drop down bar. 
-
-      f.) Copy over your citations from the masters list.  
-4. Click on "Bibliography" under the "References" tab to add your cited sources.
+      e.) Click “Citation Sources Manager” from the drop down bar.
 
+      f.) Copy over your citations from the masters list.
+4. Click on "Bibliography" under the "References" tab to add your cited sources.
 
 More discussion at [https://tex.stackexchange.com/a/351452/9075](https://tex.stackexchange.com/a/351452/9075). See [https://www.youtube.com/watch?v=2PpLZTol9\_o](https://www.youtube.com/watch?v=2PpLZTol9_o)
 

en/cite/openofficeintegration.md

@@ -38,7 +38,7 @@ To edit an already loaded custom style file or to reload changes that you made t
 
 Here is an example style file:
 
-```
+```text
 NAME
 Example style file for JabRef-OpenOffice integration.
 
@@ -185,7 +185,7 @@ If you are using numbered citations, the number for each entry will be automatic
 ## Known issues
 
 * Make sure to save your Writer document in OpenDocument format (odt). Saving to Word format will lose your reference marks.
-  * Otherwise try to use the external tool [JabRef LibreOffice Converter](https://github.com/teertinker/JabRef\_LibreOffice\_Converter). This LibreOffice extension converts the reference marks to code that can be saved.
+  * Otherwise, try to use the external tool [JabRef LibreOffice Converter](https://github.com/teertinker/JabRef\_LibreOffice\_Converter). This LibreOffice extension converts the reference marks to code that can be saved.
 * There is currently no support for footnote based citations.
 * The cursor may be poorly positioned after inserting a citation.
 * Copy-pasting the example style file directly from this page can give an unparseable file. To avoid this, instead download the example file from the link in the download section.

en/collaborative-work/send-as-email.md

@@ -2,7 +2,7 @@
 
 JabRef allows you to send entries to third parties via email.
 
-### How to send as e-mail:
+### How to send as e-mail
 
 1. Select one or multiple entries
 2. Choose **Tools → Send as email** in the menu

en/collect/findunlinkedfiles.md

@@ -25,19 +25,19 @@ JabRef offers a BibTeX key generation and offers different patterns described at
 In case you have numerous PDF files and want to convert them into new entries, JabRef can search automatically for the PDF files, let you select the relevant ones, and convert them into new entries.
 
 1. Create or open a `.bib` library.
-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`)
 
     <img src="../.gitbook/assets/bildschirmfoto-2021-07-05-um-19.19.09.png" alt="FindUnlinkedFiles - Menu" data-size="original"><img src="../.gitbook/assets/findunlinkedfiles-menu-5.2 (2) (2) (2) (2) (2) (2) (2) (2) (3) (3) (4) (1) (1) (2) (1) (5).png" alt="FindUnlinkedFiles - Menu" data-size="original">
-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 (2) (2) (2) (2) (2) (2) (2) (2) (1) (1) (1) (1) (1).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 (2) (2) (2) (2) (2) (2) (2) (2) (4) (3) (1) (1) (1) (1) (2) (1).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 (2) (2) (2) (2) (2) (2) (2) (2) (2) (3) (1) (1) (2) (1) (4).png>)