diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index fe6a34e5e6..6be624cb00 100644 --- a/.github/workflows/lint.yaml +++ b/.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 diff --git a/.markdownlint.yml b/.markdownlint.yml index 09b2b52a65..ee1fc76544 100644 --- a/.markdownlint.yml +++ b/.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 tags with ids - allowed_elements: ['a'] + allowed_elements: ['a', 'div', 'figure', 'figcaption', 'img', 'p', 'mark'] # we allow images without alt text MD045: false diff --git a/.vscode/ltex.dictionary.en-US.txt b/.vscode/ltex.dictionary.en-US.txt new file mode 100644 index 0000000000..50d6d0020f --- /dev/null +++ b/.vscode/ltex.dictionary.en-US.txt @@ -0,0 +1,3 @@ +JabRef +Medline +OpenDocument diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 19d7b814fb..9737ecf2bc 100644 --- a/CONTRIBUTING.md +++ b/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). diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000..c0338f7a5f --- /dev/null +++ b/LICENSE @@ -0,0 +1,427 @@ +Attribution-ShareAlike 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution-ShareAlike 4.0 International Public +License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution-ShareAlike 4.0 International Public License ("Public +License"). To the extent this Public License may be interpreted as a +contract, You are granted the Licensed Rights in consideration of Your +acceptance of these terms and conditions, and the Licensor grants You +such rights in consideration of benefits the Licensor receives from +making the Licensed Material available under these terms and +conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. BY-SA Compatible License means a license listed at + creativecommons.org/compatiblelicenses, approved by Creative + Commons as essentially the equivalent of this Public License. + + d. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + e. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + f. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + g. License Elements means the license attributes listed in the name + of a Creative Commons Public License. The License Elements of this + Public License are Attribution and ShareAlike. + + h. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + i. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + j. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + k. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + l. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + m. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. Additional offer from the Licensor -- Adapted Material. + Every recipient of Adapted Material from You + automatically receives an offer from the Licensor to + exercise the Licensed Rights in the Adapted Material + under the conditions of the Adapter's License You apply. + + c. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + b. ShareAlike. + + In addition to the conditions in Section 3(a), if You Share + Adapted Material You produce, the following conditions also apply. + + 1. The Adapter's License You apply must be a Creative Commons + license with the same License Elements, this version or + later, or a BY-SA Compatible License. + + 2. You must include the text of, or the URI or hyperlink to, the + Adapter's License You apply. You may satisfy this condition + in any reasonable manner based on the medium, means, and + context in which You Share Adapted Material. + + 3. You may not offer or impose any additional or different terms + or conditions on, or apply any Effective Technological + Measures to, Adapted Material that restrict exercise of the + rights granted under the Adapter's License You apply. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material, + including for purposes of Section 3(b); and + + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/LICENSE.md b/LICENSE.md deleted file mode 100644 index 3230fc20de..0000000000 --- a/LICENSE.md +++ /dev/null @@ -1,161 +0,0 @@ -This work is licensed under [Creative Commons 4.0 Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) - -# Creative Commons Attribution 4.0 International - -Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible. - -### Using Creative Commons Public Licenses - -Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses. - -* __Considerations for licensors:__ Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. [More considerations for licensors](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensors). - -* __Considerations for the public:__ By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. [More considerations for the public](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensees). - -## Creative Commons Attribution 4.0 International Public License - -By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions. - -### Section 1 – Definitions. - -a. __Adapted Material__ means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. - -b. __Adapter's License__ means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License. - -c. __Copyright and Similar Rights__ means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. - -d. __Effective Technological Measures__ means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. - -e. __Exceptions and Limitations__ means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material. - -f. __Licensed Material__ means the artistic or literary work, database, or other material to which the Licensor applied this Public License. - -g. __Licensed Rights__ means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license. - -h. __Licensor__ means the individual(s) or entity(ies) granting rights under this Public License. - -i. __Share__ means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them. - -j. __Sui Generis Database Rights__ means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. - -k. __You__ means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning. - -### Section 2 – Scope. - -a. ___License grant.___ - - 1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to: - - A. reproduce and Share the Licensed Material, in whole or in part; and - - B. produce, reproduce, and Share Adapted Material. - - 2. __Exceptions and Limitations.__ For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions. - - 3. __Term.__ The term of this Public License is specified in Section 6(a). - - 4. __Media and formats; technical modifications allowed.__ The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material. - - 5. __Downstream recipients.__ - - A. __Offer from the Licensor – Licensed Material.__ Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. - - B. __No downstream restrictions.__ You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. - - 6. __No endorsement.__ Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). - -b. ___Other rights.___ - - 1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise. - - 2. Patent and trademark rights are not licensed under this Public License. - - 3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties. - -### Section 3 – License Conditions. - -Your exercise of the Licensed Rights is expressly made subject to the following conditions. - -a. ___Attribution.___ - - 1. If You Share the Licensed Material (including in modified form), You must: - - A. retain the following if it is supplied by the Licensor with the Licensed Material: - - i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated); - - ii. a copyright notice; - - iii. a notice that refers to this Public License; - - iv. a notice that refers to the disclaimer of warranties; - - v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; - - B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and - - C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. - - 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information. - - 3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable. - - 4. If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the Adapted Material from complying with this Public License. - -### Section 4 – Sui Generis Database Rights. - -Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material: - -a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database; - -b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and - -c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database. - -For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights. - -### Section 5 – Disclaimer of Warranties and Limitation of Liability. - -a. __Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.__ - -b. __To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.__ - -c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability. - -### Section 6 – Term and Termination. - -a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically. - -b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates: - - 1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or - - 2. upon express reinstatement by the Licensor. - - For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License. - -c. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License. - -d. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. - -### Section 7 – Other Terms and Conditions. - -a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed. - -b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License. - -### Section 8 – Interpretation. - -a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License. - -b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions. - -c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor. - -d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority. - -``` -Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at [creativecommons.org/policies](http://creativecommons.org/policies), Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses. - -Creative Commons may be contacted at creativecommons.org -``` diff --git a/README.md b/README.md index 9e25939708..a056d63c7d 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Use . 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 \ @@ -31,6 +31,12 @@ docker run --rm \ /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. diff --git a/en/advanced/commandline.md b/en/advanced/commandline.md index 0511df0c27..6cb412261f 100644 --- a/en/advanced/commandline.md +++ b/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 ``` diff --git a/en/advanced/debugging-your-library-file.md b/en/advanced/debugging-your-library-file.md index ddeb82f73e..0d8337c45d 100644 --- a/en/advanced/debugging-your-library-file.md +++ b/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: diff --git a/en/advanced/fields.md b/en/advanced/fields.md index 9bc5f85e08..6bcbcb49e9 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/advanced/how-to-expand-firstnames.md b/en/advanced/how-to-expand-firstnames.md index 15d54c92b9..ddc2b2205f 100644 --- a/en/advanced/how-to-expand-firstnames.md +++ b/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 - Screenshot of determine DOI -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) - Screenshot of get BibTeX data from DOI -3. A popup appears. Select which data you want to merge into the existing entry +4. Now the first names are expanded: - Screenshot of Merge Entries Dialog -4. Now the first names are expanded: + ![Screenshot of Result](../../.gitbook/assets/expand-firstnames-step-4.png) - Screenshot of Result diff --git a/en/advanced/journalabbreviations.md b/en/advanced/journalabbreviations.md index 72a1efcf90..7ef5ebcd49 100644 --- a/en/advanced/journalabbreviations.md +++ b/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 . 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): -``` -;[;[;]] +```csv +,[,[,]] ``` 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 diff --git a/en/cite/export-to-microsoft-word.md b/en/cite/export-to-microsoft-word.md index 700930b4d6..b9991bc14a 100644 --- a/en/cite/export-to-microsoft-word.md +++ b/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//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) diff --git a/en/cite/openofficeintegration.md b/en/cite/openofficeintegration.md index bafb26a106..1517ee1d77 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. @@ -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. diff --git a/en/collaborative-work/send-as-email.md b/en/collaborative-work/send-as-email.md index b91d827ab5..083c0f6893 100644 --- a/en/collaborative-work/send-as-email.md +++ b/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 diff --git a/en/collect/findunlinkedfiles.md b/en/collect/findunlinkedfiles.md index 3c6c5926b5..112f9c9220 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 - MenuFindUnlinkedFiles - Menu -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 (2) (2) (2) (2) (2) (2) (2) (2) (2) (3) (1) (1) (2) (1) (4).png>) diff --git a/en/collect/jabref-browser-extension.md b/en/collect/jabref-browser-extension.md index 9ca4eb074e..1574363fbd 100644 --- a/en/collect/jabref-browser-extension.md +++ b/en/collect/jabref-browser-extension.md @@ -94,7 +94,7 @@ Most JabRef installations include the necessary files, so test the extension bef * `/etc/opt/chrome/native-messaging-hosts/org.jabref.jabref.json` to install with admin rights for all users * `~/.config/google-chrome/NativeMessagingHosts/org.jabref.jabref.json` to install without admin rights for the current user - + Note: Brave is using the Google file structure for `NativeMessagingHosts`, see [Github Issue](https://github.com/brave/brave-browser/issues/5074). - Chromium: Download [org.jabref.jabref.json](https://raw.githubusercontent.com/JabRef/jabref/main/buildres/linux/native-messaging-host/chromium/org.jabref.jabref.json) and put it into @@ -119,21 +119,25 @@ Most JabRef installations include the necessary files, so test the extension bef * Edge: `snap connect jabref:etc-opt-edge-native-messaging-jabref` #### Flatpak + 1. Install the flatpak of [Jabref](https://flathub.org/apps/details/org.jabref.jabref). 2. Install the JabRef browser extension: [Firefox](https://addons.mozilla.org/en-US/firefox/addon/jabref/?src=external-github), [Chrome](https://chrome.google.com/webstore/detail/jabref-browser-extension/bifehkofibaamoeaopjglfkddgkijdlh), [Edge](https://microsoftedge.microsoft.com/addons/detail/pgkajmkfgbehiomipedjhoddkejohfna), [Vivaldi](https://chrome.google.com/webstore/detail/jabref-browser-extension/bifehkofibaamoeaopjglfkddgkijdlh) #### Browser + If the browser is installed as a snap or flatpak there is an extra step to enable the extension. With Firefox installed as a snap (default in Ubuntu): -* `flatpak permission-set webextensions org.jabref.jabref snap.firefox yes` + +* `flatpak permission-set webextensions org.jabref.jabref snap.firefox yes` With Firefox installed as a flatpak: + * Enable the following permission (Note that this will partially disable confinement): * via terminal command: `flatpak override --user --talk-name=org.freedesktop.Flatpak org.mozilla.firefox` * via Flatseal app: add `org.freedesktop.Flatpak` to the `Session Bus Talk` section for `org.mozilla.firefox` -### Mac OS +### macOS 1. Download and install the DMG package of [JabRef](https://www.jabref.org/#download) (>= 5.0). 2. Install the JabRef browser extension: [Firefox](https://addons.mozilla.org/en-US/firefox/addon/jabref/?src=external-github), [Chrome](https://chrome.google.com/webstore/detail/jabref-browser-extension/bifehkofibaamoeaopjglfkddgkijdlh), [Edge](https://microsoftedge.microsoft.com/addons/detail/pgkajmkfgbehiomipedjhoddkejohfna), [Vivaldi](https://chrome.google.com/webstore/detail/jabref-browser-extension/bifehkofibaamoeaopjglfkddgkijdlh) @@ -147,7 +151,7 @@ With Firefox installed as a flatpak: * `/Library/Google/Chrome/NativeMessagingHosts/org.jabref.jabref.json` to install with admin rights for all users * `~/Library/Application Support/Google/Chrome/NativeMessagingHosts/org.jabref.jabref.json` to install without admin rights for the current user - + Note: Brave is using the Google file structure for `NativeMessagingHosts`, see [Github Issue](https://github.com/brave/brave-browser/issues/5074). - Chromium based: If it's not auto-installed for you, download [org.jabref.jabref.json](https://raw.githubusercontent.com/JabRef/jabref/main/buildres/mac/native-messaging-host/chromium/org.jabref.jabref.json) and put it into @@ -169,4 +173,3 @@ With Firefox installed as a flatpak: #### Local JabRef installs org.jabref.jabref.json directs the browser extension to a python script in the JabRef app, which is set to the most common install path by default (`/Applications/JabRef.app/Contents/Resources/jabrefHost.py`). If you have installed JabRef somewhere else, most likely to your local applications folder (`~/Applications/JabRef`), then you will need to update this path to the correct location. For example, in local installs this would be `/Users/USER/Applications/JabRef.app/Contents/Resources/jabrefHost.py`, where `USER` is your username. - diff --git a/en/collect/newentryfromplaintext.md b/en/collect/newentryfromplaintext.md index ea87988948..b642ef80e6 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/README.md b/en/contributing/README.md index b4e2b11272..8118847059 100644 --- a/en/contributing/README.md +++ b/en/contributing/README.md @@ -61,16 +61,12 @@ Have a look at [JabRefs candidates for university projects](https://github.com/o We collect good issues to start with at our [list of good first issues](https://github.com/orgs/JabRef/projects/5/views/1). After finding something, please check our [CONTRIBUTING.md](https://github.com/JabRef/jabref/blob/main/CONTRIBUTING.md). - **I want something with huge impact** [![Discourse](https://img.shields.io/badge/discourse-online-green.svg)](https://discourse.jabref.org/c/features/6) Look at the discussions in our forum about [new features](https://discourse.jabref.org/c/features/6). Find an interesting topic, discuss it and start contributing. Alternatively, you can check out [JabRefs projects page at GitHub](https://github.com/JabRef/jabref/projects?query=is%3Aopen). Although, of course, you can choose to work on ANY issue, choosing from the projects page has the advantage that these issues have already been categorized, sorted and screened by JabRef maintainers. A typical sub-classifications scheme is "priority" (high, normal and low). Fixing high priority issues is preferred. -**I am a lecturer** - -If you ask yourself how to integrate JabRef into your class, please read the [documentation about how to integrate JabRef into a class of software engineering training](https://devdocs.jabref.org/teaching.html#jabref-and-software-engineering-training). As student, you may notify your lecturer about this possibility. - +**I am a lecturer** If you ask yourself how to integrate JabRef into your class, please read the [documentation about how to integrate JabRef into a class of software engineering training](https://devdocs.jabref.org/teaching.html#jabref-and-software-engineering-training). As student, you may notify your lecturer about this possibility. **I want to know how to contribute code and set up my workspace** [![Join the chat at https://gitter.im/JabRef/jabref](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/JabRef/jabref) @@ -78,13 +74,11 @@ If you ask yourself how to integrate JabRef into your class, please read the [do Check out the [documentation for developers](https://devdocs.jabref.org/contributing.html#contribute-code) - **I need help with the code** [![Join the chat at https://gitter.im/JabRef/jabref](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/JabRef/jabref) You can talk to the core developers of JabRef in the [gitter chat](https://gitter.im/JabRef/jabref). - **I want to learn about code quality** [![Join the chat at https://gitter.im/JabRef/jabref](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/JabRef/jabref) Please head to [devdocs about code-quality](https://devdocs.jabref.org/code-howtos/code-quality.html#code-quality) to learn about our current efforts to measure and improve code quality. diff --git a/en/contributing/how-to-translate-the-ui.md b/en/contributing/how-to-translate-the-ui.md index bf4ead8b46..2edb29c7f3 100644 --- a/en/contributing/how-to-translate-the-ui.md +++ b/en/contributing/how-to-translate-the-ui.md @@ -10,11 +10,11 @@ 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_ +* Visit [https://translate.jabref.org/](https://translate.jabref.org) to get started +* 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) @@ -48,7 +48,7 @@ For each language, there is the file `JabRef_xx.properties` (`xx` denotes the co Each entry is first given in English, then in the other language, with the two parts separated by an '=' character. For instance, a line can look like this in a German translation file: -``` +```properties Background\ color\ for\ optional\ fields=Hintergrundfarbe für optionale Felder ``` @@ -56,7 +56,7 @@ Note that each space character is escaped (`\`) to make it a valid property key. Some entries contain "variables" that are inserted at runtime by JabRef - this can for instance be a file name or a file type name: -``` +```properties Synchronizing\ %0\ links...=Synchronisiere %0-Links... ``` @@ -64,7 +64,7 @@ A variable is denoted by `%0`, `%1`, `%2` etc. In such entries, simply repeat th As we can see, there are several "special" characters: the percent sign and the equals sign, along with the colon character. If these characters are to be part of the actual text in an entry, they must be escaped in the English version, as with the colon in the following example: -``` +```properties Error\ writing\ XMP\ to\ file\:_%0=Fehler beim Schreiben von XMP in die Datei: %0 ``` diff --git a/en/faq/README.md b/en/faq/README.md index e093eb0a8f..cfe36c5d52 100644 --- a/en/faq/README.md +++ b/en/faq/README.md @@ -37,13 +37,13 @@ A: Don't panic. No data should be damaged in your bib library. Since version 5.0 ## Q: I have a huge library. What can I do to mitigate performance issues? A: Check your configuration. Disable some or all of following preferences: - + - disable fulltext index (File → Preferences → Linked files → Fulltext Index → ...) - disable time stamps (File → Preferences → General → Time Stamp → ...) - disable field formatters (Library → Library Properties → Saving → Save actions → ...) - disable autosave (File → Preferences → File → Saving → ...) - disable count of items in group (File → Preferences → Groups → ...) - + Any preference that has the potential to affect all your entries at once is worth inspecting. ## Q: Are there any publications dealing with JabRef? diff --git a/en/faq/how-tos/how-to-expand-firstnames.md b/en/faq/how-tos/how-to-expand-firstnames.md deleted file mode 100644 index 11aefece5a..0000000000 --- a/en/faq/how-tos/how-to-expand-firstnames.md +++ /dev/null @@ -1,36 +0,0 @@ -# How to expand first names of a BibTeX entry - -Sometimes, one has a BibTeX entry with abbreviated short names: - -```text -@Article{Eshuis_2015, - author = {R. Eshuis and A. Norta and O. Kopp and E. Pitkanen}, - journal = {{IEEE} Transactions on Services Computing}, - title = {Service Outsourcing with Process Views}, - year = {2015}, - month = {jan}, - number = {1}, - pages = {136--154}, - volume = {8}, - publisher = {Institute of Electrical and Electronics Engineers ({IEEE})}, -} -``` - -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" - - ![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 - - ![Screenshot of Merge Entries Dialog](../../.gitbook/assets/expand-firstnames-step-3.png) - -4. Now the first names are expaned: - - ![Screenshot of Result](../../.gitbook/assets/expand-firstnames-step-4.png) - diff --git a/en/finding-sorting-and-cleaning-entries/filelinks.md b/en/finding-sorting-and-cleaning-entries/filelinks.md index 58868df324..d1a4cfcbc5 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/finding-sorting-and-cleaning-entries/findduplicates.md b/en/finding-sorting-and-cleaning-entries/findduplicates.md index ed5232696c..3721606729 100644 --- a/en/finding-sorting-and-cleaning-entries/findduplicates.md +++ b/en/finding-sorting-and-cleaning-entries/findduplicates.md @@ -10,24 +10,24 @@ Detection of potential duplicates is done by an edit distance algorithm. Extra w The differences between the two entries can be configured through the toolbox located at the top of the window. From the toolbox, you can choose to show or hide differences, choose how to display differences _(Unified or Split)_ and you can also choose how to compare entries _(by words or characters)_. -**Show or Hide Differences** +## Show or Hide Differences * **Plain Text —** This option hides the differences. * **Show Differences —** This option shows the differences. -**Choose Differences Display Mode** +## Choose Differences Display Mode * **Unified View —** In this mode, differences are shown on the right side. * **Split View —** In this mode, differences are shown on both sides, with deletions on the left side and additions and updates on the right side. -**Choose Entries Comparison Method** +## Choose Entries Comparison Method * **Highlight words —** This option compares entries values in terms of words. * **Highlight characters —** This option compares entries values in terms of characters. It divides both entry values into characters before comparing each character individually. This is perfect for comparing values with small differences _(1 or 2 different characters)_. From the toolbox's top-left corner, you also can choose to select all the left entry values by clicking `Left` or selecting all the right entry values by clicking `Right`. Be aware that selecting all entry values will select a value even when it is empty. -### Selecting which entry to keep +## Selecting which entry to keep ![Screenshot of the buttons to choose which entry to keep](../.gitbook/assets/herdhjkkk.PNG) diff --git a/en/finding-sorting-and-cleaning-entries/getbibtexdatafromdoi.md b/en/finding-sorting-and-cleaning-entries/getbibtexdatafromdoi.md index 9021f77714..a4636684e8 100644 --- a/en/finding-sorting-and-cleaning-entries/getbibtexdatafromdoi.md +++ b/en/finding-sorting-and-cleaning-entries/getbibtexdatafromdoi.md @@ -5,15 +5,15 @@ JabRef can fetch automatically additional information about your entries. It can * To _find identifiers_ (arxiv, DOI)_: select the entries and go to the menu **Lookup → search document identifier online**.​ * To _find the DOI_: open the [entry editor](../advanced/entryeditor/), and in the General tab, click on the button **Lookup DOI**. * To _find the document_ related to an entry: select the entry and to the menu **Lookup → search full text documents online**.​ - + Be aware: The options above require your entry or entries to be filled with enough and correct bibliographic information. If the entry holds incomplete or inaccurate data, fetching the identifier or text document my fail. ## Completing information based on DOI or ISBN -JabRef can help you complement your entries with bibliographic data, which is associated with their registered DOI or ISBN. +JabRef can help you complement your entries with bibliographic data, which is associated with their registered DOI or ISBN. This is a very reliable way of obtaining correct bibliographic information and is very much recommended. -_(The following features require your entry to have a DOI or ISBN and are disabled / greyed out otherwise.)_ +_The following features require your entry to have a DOI or ISBN and are disabled / greyed out otherwise._ - Option A) In the entry table, right-click on the entry to complement, and select the menu **Get bibliographic data from DOI/ISBN/...** - Option B) Open the [entry editor](../advanced/entryeditor/), and in the General tab, click on the button **Get bibliographic data from DOI** diff --git a/en/finding-sorting-and-cleaning-entries/mergeentries.md b/en/finding-sorting-and-cleaning-entries/mergeentries.md index 208657ac94..a96a3c0c65 100644 --- a/en/finding-sorting-and-cleaning-entries/mergeentries.md +++ b/en/finding-sorting-and-cleaning-entries/mergeentries.md @@ -12,17 +12,17 @@ The **Merge entries** window will pop up: The differences between the two entries can be configured through the toolbox located at the top of the window. From the toolbox, you can choose to show or hide differences, choose how to display differences *(Unified or Split)* and you can also choose how to compare entries *(by words or characters)*. -**Show or Hide Differences** +### Show or Hide Differences - **Plain Text —** This option hides the differences. - **Show Differences —** This option shows the differences. -**Choose Differences Display Mode** +### Choose Differences Display Mode - **Unified View —** In this mode, differences are shown on the right side. - **Split View —** In this mode, differences are shown on both sides, with deletions on the left side and additions and updates on the right side. -**Choose Entries Comparison Method** +### Choose Entries Comparison Method - **Highlight words —** This option compares entries values in terms of words. - **Highlight characters —** This option compares entries values in terms of characters. It divides both entry values into characters before comparing each character individually. This is perfect for comparing values with small differences *(1 or 2 different characters)*. diff --git a/en/installation.md b/en/installation.md index 9d4b3a4eb6..ac68710913 100644 --- a/en/installation.md +++ b/en/installation.md @@ -22,8 +22,8 @@ Download it from [downloads.jabref.org](https://downloads.jabref.org). These are * for Windows `JabRef.exe`. * for Linux - - either run`bin/JabRef` - - or `/lib/runtime/bin/JabRef`. + * either run`bin/JabRef` + * or `/lib/runtime/bin/JabRef`. * for Mac, this is the file `JabRef.app`. Be sure to activate "Load and Save preferences from/to jabref.xml on start-up (memory stick mode)" in Options → Preferences → General. @@ -103,7 +103,7 @@ You might need to install an additional font for JabRef to display characters co #### Submenus from the menu bar close immediately after left click is let go of if the menu bar was clicked in its top half -This issue seems to be related to this [JavaFX bug](https://bugs.openjdk.org/browse/JDK-8251240). A temporary workaround is to click the menu bar in its lower half. To fix the issue permanently set the following system property: ```java -Djdk.gtk.version=2```. This can be done globally by adding ```_JAVA_OPTIONS="-Djdk.gtk.version=2"``` to ```/etc/environment```. It can also be set locally by editing `JabRef.cfg` in your installation folder (possibly located at `/opt/JabRef/lib/app/JabRef.cfg`) and add the line `-Djdk.gtk.version=2` in the `[JavaOptions]` section. +This issue seems to be related to this [JavaFX bug](https://bugs.openjdk.org/browse/JDK-8251240). A temporary workaround is to click the menu bar in its lower half. To fix the issue permanently set the following system property: ```java -Djdk.gtk.version=2```. This can be done globally by adding ```_JAVA_OPTIONS="-Djdk.gtk.version=2"``` to ```/etc/environment```. It can also be set locally by editing `JabRef.cfg` in your installation folder (possibly located at `/opt/JabRef/lib/app/JabRef.cfg`) and add the line `-Djdk.gtk.version=2` in the `[JavaOptions]` section. {% endtab %} @@ -129,7 +129,7 @@ This method is mainly for package maintainers and users who would like to build To build JabRef from source, you first need to have a working Java Development Kit (see above link for details) and Git installed on your system. After installing the two requirements, you open a terminal window (i.e., a command prompt) and type the following: -``` +```shell git clone --depth=10 https://github.com/JabRef/jabref cd jabref ./gradlew assemble diff --git a/en/setup/citationkeypatterns.md b/en/setup/citationkeypatterns.md index 158834cc39..48108f367b 100644 --- a/en/setup/citationkeypatterns.md +++ b/en/setup/citationkeypatterns.md @@ -150,13 +150,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) @@ -166,12 +166,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 diff --git a/en/setup/databaseproperties.md b/en/setup/databaseproperties.md index 2149d709df..905afbb329 100644 --- a/en/setup/databaseproperties.md +++ b/en/setup/databaseproperties.md @@ -2,7 +2,7 @@ Each library can have specific properties that can be modified through **Library→ Library properties**. These specific properties override the generic properties defined in **Options → Preferences**. -The library-specific properties are stored in the database itself. This way, when moving the database to another computer, these properties are preserved. In most of cases these are stored in the bib-file database using text blocks starting with _@Comment{jabref-meta:_ . +The library-specific properties are stored in the database itself. This way, when moving the database to another computer, these properties are preserved. In most of cases, these are stored in the bib-file database using text blocks starting with `@Comment{jabref-meta:`. {% hint style="warning" %} **For shared SQL databases**, some properties are not available as they are not handled like a .bib file.\ @@ -14,6 +14,7 @@ The following properties are not available: {% endhint %} The library properties window consists of four tabs: + - General - Saving - String constants @@ -97,4 +98,3 @@ The [string constants](../advanced/strings.md) of the library. ![LibraryProperties-CitationKeyPatterns](https://user-images.githubusercontent.com/6931104/187706432-5ed71148-e78f-4666-9a49-0b9548873260.png) The [citation key patterns](../setup/citationkeypatterns.md) to be used with this library. - diff --git a/en/setup/generalfields.md b/en/setup/generalfields.md index 28f5fa33e2..f9d29dfa8e 100644 --- a/en/setup/generalfields.md +++ b/en/setup/generalfields.md @@ -6,12 +6,12 @@ You specify one tab on each line. The line should start with the name of the tab For example: -```text +```csv General:url;keywords;doi;pdf Abstract:abstract;annote ``` -will give one tab named "General" containing the fields _url_, _keywords_, _doi_ and _pdf_, and another tab named "Abstract" containing the fields _abstract_ and _annote_. +will give one tab named "General" containing the fields _url_, _keywords_, _doi_ and _pdf_, and another tab named "Abstract" containing the fields _abstract_ and _annote_. It does not matter how you capitalise your field names. In the entry editor's tabs, normally fields' first letter is capitalised, i.e. _abstract_ is represented as _Abstract_, _KEYwords_ would be represented as _Keywords_ (_DOI_, _ISBN_, _URL_ are exceptions in that all letters are capitalised). In the bibtex code, all field names use lower case: _KEYwords_ is _keywords_ in the entry's bibtex code.