GitBook: [master] 5 pages and 25 assets modified

JabRef · Dec 25, 2020 · d5139b1 · d5139b1
1 parent d9de349
commit d5139b1
Show file tree

Hide file tree

Showing 22 changed files with 38 additions and 19 deletions.
diff --git a/docs/.gitbook/assets/contribution-process-reviews (2).svg b/docs/.gitbook/assets/contribution-process-reviews (2).svg
diff --git a/...ution-process-reviews-with-instructor.svg → ...ocess-reviews-with-instructor (1) (1).svg b/...ution-process-reviews-with-instructor.svg → ...ocess-reviews-with-instructor (1) (1).svg
diff --git a/docs/.gitbook/assets/contribution-process-reviews-with-instructor (1) (2).svg b/docs/.gitbook/assets/contribution-process-reviews-with-instructor (1) (2).svg
diff --git a/...book/assets/eclipse-create-run-config.png → ...ets/eclipse-create-run-config (1) (2).png b/...book/assets/eclipse-create-run-config.png → ...ets/eclipse-create-run-config (1) (2).png
diff --git a/docs/.gitbook/assets/eclipse-create-run-config (1) (3).png b/docs/.gitbook/assets/eclipse-create-run-config (1) (3).png
diff --git a/docs/.gitbook/assets/github-flow (2).png b/docs/.gitbook/assets/github-flow (2).png
diff --git a/docs/.gitbook/assets/intellij-checkstyle-settings (1).png b/docs/.gitbook/assets/intellij-checkstyle-settings (1).png
diff --git a/docs/.gitbook/assets/intellij-enable-annotation-processing (1).png b/docs/.gitbook/assets/intellij-enable-annotation-processing (1).png
diff --git a/...ntellij-gradle-config-ignore-buildSrc.png → ...gradle-config-ignore-buildSrc (2) (1).png b/...ntellij-gradle-config-ignore-buildSrc.png → ...gradle-config-ignore-buildSrc (2) (1).png
diff --git a/docs/.gitbook/assets/intellij-gradle-config-ignore-buildSrc (2) (2).png b/docs/.gitbook/assets/intellij-gradle-config-ignore-buildSrc (2) (2).png
diff --git a/...ij-run-configuration-command-line (1).png → ...un-configuration-command-line (2) (1).png b/...ij-run-configuration-command-line (1).png → ...un-configuration-command-line (2) (1).png
diff --git a/...tellij-run-configuration-command-line.png → ...un-configuration-command-line (2) (2).png b/...tellij-run-configuration-command-line.png → ...un-configuration-command-line (2) (2).png
diff --git a/docs/.gitbook/assets/intellij-run-configuration-command-line (2) (3).png b/docs/.gitbook/assets/intellij-run-configuration-command-line (2) (3).png
diff --git a/docs/.gitbook/assets/grafik (1) (1).png → ...ets/intellij-wrap-at-right-margin (1).png b/docs/.gitbook/assets/grafik (1) (1).png → ...ets/intellij-wrap-at-right-margin (1).png
diff --git a/docs/.gitbook/assets/grafik (1).png → ...ets/intellij-wrap-at-right-margin (2).png b/docs/.gitbook/assets/grafik (1).png → ...ets/intellij-wrap-at-right-margin (2).png
diff --git a/docs/.gitbook/assets/grafik.png → ...ets/intellij-wrap-at-right-margin (3).png b/docs/.gitbook/assets/grafik.png → ...ets/intellij-wrap-at-right-margin (3).png
diff --git a/docs/.gitbook/assets/intellij-wrap-at-right-margin (4).png b/docs/.gitbook/assets/intellij-wrap-at-right-margin (4).png
diff --git a/docs/README.md b/docs/README.md
@@ -27,7 +27,7 @@ The package `org.jabref.cli` is responsible for handling the command line option
 
 During development, one can configure IntelliJ to pass command line parameters:
 
-![IntelliJ-run-configuration](.gitbook/assets/intellij-run-configuration-command-line%20%282%29.png)
+![IntelliJ-run-configuration](.gitbook/assets/intellij-run-configuration-command-line%20%282%29%20%281%29.png)
 
 Passing command line arguments using gradle is currently not possible as all arguments \(such as `-Dfile.encoding=windows-1252`\) are passed to the application.
 
@@ -45,9 +45,9 @@ For new ADRs, please use [template.md](https://github.com/JabRef/jabref/tree/3b3
 
 ## FAQ
 
-* Q: I get `java: package org.jabref.logic.journals does not exist`.  
+* Q: I get `java: package org.jabref.logic.journals does not exist`.
 
-  A: You have to ignore `buildSrc/src/main`  as source directory in IntelliJ as indicated in our [setup guide](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace).
+  A: You have to ignore `buildSrc/src/main` as source directory in IntelliJ as indicated in our [setup guide](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace).
 
-     Also filed as IntelliJ issue [IDEA-240250](https://youtrack.jetbrains.com/issue/IDEA-240250).
+  Also filed as IntelliJ issue [IDEA-240250](https://youtrack.jetbrains.com/issue/IDEA-240250).
 
diff --git a/docs/adr.md b/docs/adr.md
@@ -16,12 +16,13 @@ Architectural decisions for JabRef:
 * [ADR-0011](https://github.com/JabRef/jabref/tree/master/docs/adr/0011-test-external-links-in-documentation.md) - Test external links in documentation
 * [ADR-0012](https://github.com/JabRef/jabref/tree/master/docs/adr/0012-handle-different-bibEntry-formats-of-fetchers.md) - Handle different bibentry formats of fetchers by adding a layer
 * [ADR-0013](https://github.com/JabRef/jabref/tree/master/docs/adr/0013-add-native-support-biblatex-software.md) - Add Native Support for BibLatex-Software
-fix checkstyle in adr
+
+  fix checkstyle in adr
+
 * [ADR-0014](https://github.com/JabRef/jabref/tree/master/docs/adr/0014-separate-URL-creation-to-enable-proper-logging.md) - Separate URL creation to enable proper logging
 * [ADR-0015](https://github.com/JabRef/jabref/tree/master/docs/adr/0015-support-an-abstract-query-syntax-for-query-conversion.md) - Query syntax design
 * [ADR-0016](https://github.com/JabRef/jabref/tree/master/docs/adr/0016-mutable-preferences-objects.md) - Mutable preferences objects
 * [ADR-0017](https://github.com/JabRef/jabref/tree/master/docs/adr/0017-allow-model-access-logic.md) - Allow org.jabref.model to access org.jabref.logic
 
-
 For new ADRs, please use [template.md](https://github.com/JabRef/jabref/tree/master/docs/adr/template.md) as basis. More information on the used format is available at [https://adr.github.io/madr/](https://adr.github.io/madr/). General information about architectural decision records is available at [https://adr.github.io/](https://adr.github.io/). Then add them to the above list.
 
diff --git a/docs/getting-into-the-code/code-howtos.md b/docs/getting-into-the-code/code-howtos.md
@@ -173,11 +173,21 @@ General hints:
 The tests check whether translation strings appear correctly in the resource bundles.
 
 1. Add new `Localization.lang("KEY")` to Java file. Run the `LocalizationConsistencyTest`under \(src/test/org.jabref.logic.
-\)
+
+   \)
+
 2. Tests fail. In the test output a snippet is generated which must be added to the English translation file.
 3. Add snippet to English translation file located at `src/main/resources/l10n/JabRef_en.properties`
 4. Please do not add translations for other languages directly in the properties. They will be overwritten by [Crowdin](https://crowdin.com/project/jabref)
 
+## Adding a new Language
+
+1. Add the new Language to the Language enum in [https://github.com/JabRef/jabref/blob/master/src/main/java/org/jabref/logic/l10n/Language.java](https://github.com/JabRef/jabref/blob/master/src/main/java/org/jabref/logic/l10n/Language.java)
+2. Create an empty &lt;locale code&gt;.properties file
+3. Configure the new language in [https://crowdin.com/project/jabref ](https://crowdin.com/project/jabref)
+
+If the language is a variant of a language `zh_CN` or `pt_BR`  it is necessary to add a language mapping for Crowdin to the crowdin.yml file in the root. Of course the properties file also has to be named according to the language code and locale.
+
 ## Cleanup and Formatters
 
 We try to build a cleanup mechanism based on formatters. The idea is that we can register these actions in arbitrary places, e.g., onSave, onImport, onExport, cleanup, etc. and apply them to different fields. The formatters themself are independent of any logic and therefore easy to test.