From a2a70dd5008e478139bac899eb17aaafecd874c8 Mon Sep 17 00:00:00 2001 From: Ruslan Date: Sat, 24 Aug 2024 14:58:44 +0300 Subject: [PATCH] Fix linter errors (#506) * Fix linter errors * Fix more linter errors * Fix linter errors (final) --- en/advanced/fields.md | 8 ++++---- en/cite/openofficeintegration.md | 2 +- en/collect/findunlinkedfiles.md | 8 ++++---- en/collect/newentryfromplaintext.md | 10 +++++----- en/contributing/how-to-translate-the-ui.md | 4 ++-- en/finding-sorting-and-cleaning-entries/filelinks.md | 2 +- en/setup/citationkeypatterns.md | 12 ++++++------ 7 files changed, 23 insertions(+), 23 deletions(-) diff --git a/en/advanced/fields.md b/en/advanced/fields.md index d26dbdfb4..04875c9b3 100644 --- a/en/advanced/fields.md +++ b/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. diff --git a/en/cite/openofficeintegration.md b/en/cite/openofficeintegration.md index d72854137..1c5d70c2d 100644 --- a/en/cite/openofficeintegration.md +++ b/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. diff --git a/en/collect/findunlinkedfiles.md b/en/collect/findunlinkedfiles.md index a6663b9ca..990cf0d8b 100644 --- a/en/collect/findunlinkedfiles.md +++ b/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`) ![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. FindUnlinkedFiles - Initial dialog 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. FindUnlinkedFiles - Found files 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 (1).png>) diff --git a/en/collect/newentryfromplaintext.md b/en/collect/newentryfromplaintext.md index f123ce9c6..c7bd705ab 100644 --- a/en/collect/newentryfromplaintext.md +++ b/en/collect/newentryfromplaintext.md @@ -6,20 +6,20 @@ In case you have a reference string, JabRef offers the functionality to convert 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. New entry from plain text -2. The "Plain Reference Parser" window opens +2. The "Plain Reference Parser" window opens Plain Reference Parser -3. Paste the reference text: +3. Paste the reference text: Paste 4. Click "Add to current library" -5. The result is selected in the entry table: +5. The result is selected in the entry table: Result of Grobid Parsing diff --git a/en/contributing/how-to-translate-the-ui.md b/en/contributing/how-to-translate-the-ui.md index ab2a70143..83672588b 100644 --- a/en/contributing/how-to-translate-the-ui.md +++ b/en/contributing/how-to-translate-the-ui.md @@ -11,10 +11,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_ Screenshot of Crowdin select file page -* 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 index b400c591c..94a78d9ce 100644 --- a/en/finding-sorting-and-cleaning-entries/filelinks.md +++ b/en/finding-sorting-and-cleaning-entries/filelinks.md @@ -14,7 +14,7 @@ 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._ Main file directory 2. **Library → Library properties**, items _General file directory,_ and _User-specific file directory_.![Override default file directories](../.gitbook/assets/jabref-lib-properties.png) diff --git a/en/setup/citationkeypatterns.md b/en/setup/citationkeypatterns.md index 1c83e56d4..18e9a9211 100644 --- a/en/setup/citationkeypatterns.md +++ b/en/setup/citationkeypatterns.md @@ -153,13 +153,13 @@ The default key pattern is **`[auth][year]`**, and this could produce keys like To change the citation key pattern to `[authors][camel]` for all libraries without individual settings, execute the following steps: -1. Open the preferences +1. Open the preferences File → Preferences -2. Navigate to "Citation key generator" +2. Navigate to "Citation key generator" Citation key generator preferences -3. Change the default pattern to `[authors][camel]` +3. Change the default pattern to `[authors][camel]` Citation key generator preferences - authors camel 4. Press "Enter" (forgetting to do this is a leading cause of puzzlement) @@ -169,12 +169,12 @@ To change the citation key pattern to `[authors][camel]` for all libraries witho 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 +1. Make sure the library is open and selected in the JabRef main window Main screen selected library -2. From the "Library" menu, open the "Citation key pattern" setting +2. From the "Library" menu, open the "Citation key pattern" setting Library Citation key patterns -3. Set the pattern for the desired entry types, and press the apply button. +3. Set the pattern for the desired entry types, and press the apply button. Citation key patterns