Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/main' into addPrefsForBak
Browse files Browse the repository at this point in the history
* upstream/main: (31 commits)
  Fixes #9372 Change default File Chooser to show supported files extensions
  Fix path in devs documentation (#9810)
  New translations JabRef_en.properties (Tagalog)
  New translations JabRef_en.properties (Persian)
  New translations JabRef_en.properties (Indonesian)
  New translations JabRef_en.properties (Portuguese, Brazilian)
  New translations JabRef_en.properties (Vietnamese)
  New translations JabRef_en.properties (Chinese Traditional)
  New translations JabRef_en.properties (Chinese Simplified)
  New translations JabRef_en.properties (Ukrainian)
  New translations JabRef_en.properties (Turkish)
  New translations JabRef_en.properties (Swedish)
  New translations JabRef_en.properties (Russian)
  New translations JabRef_en.properties (Portuguese)
  New translations JabRef_en.properties (Polish)
  New translations JabRef_en.properties (Norwegian)
  New translations JabRef_en.properties (Dutch)
  New translations JabRef_en.properties (Korean)
  New translations JabRef_en.properties (Japanese)
  New translations JabRef_en.properties (Italian)
  ...
  • Loading branch information
Siedlerchr committed Apr 28, 2023
2 parents ddca12a + bf6e57c commit 12b0979
Show file tree
Hide file tree
Showing 90 changed files with 1,117 additions and 905 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
- We fixed an issue where searching for unlinked files would include the current library's .bib file [#9735](https://github.com/JabRef/jabref/issues/9735)
- We fixed an issue where it was no longer possible to connect to a shared mysql database due to an exception [#9761](https://github.com/JabRef/jabref/issues/9761)
- We fixed the citation key generation for (`[authors]`, `[authshort]`, `[authorsAlpha]`, `authIniN`, `authEtAl`, `auth.etal`)[https://docs.jabref.org/setup/citationkeypatterns#special-field-markers] to handle `and others` properly. [koppor#626](https://github.com/koppor/jabref/issues/626)
- We fixed the Save/save as file type shows BIBTEX_DB instead of "Bibtex library" [#9372](https://github.com/JabRef/jabref/issues/9372)

### Removed

Expand Down
2 changes: 1 addition & 1 deletion docs/Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ gem "jekyll", "~> 4.3" # installed by `gem jekyll`
# Homepage: https://github.com/paulrobertlloyd/jekyll-figure#jekyll-figure
gem 'jekyll-figure'

gem "just-the-docs", "0.4.2"
gem "just-the-docs", "0.5.0"

gem "jekyll-remote-theme"

Expand Down
4 changes: 2 additions & 2 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
repository: JabRef/jabref
title: "Developer Documentation"
remote_theme: just-the-docs/just-the-docs@v0.4.0.rc3
remote_theme: just-the-docs/just-the-docs@v0.5.0
color_scheme: light

exclude: [CNAME, README.md, mkdocs-custom.css]
exclude: [_config.yml, .dockerignore, .gitignore, CNAME, Dockerfile, Gemfile, Gemfile.lock, README.md, mkdocs-custom.css]

# Hint by https://github.com/just-the-docs/just-the-docs/issues/374#issuecomment-680273258
# Theme read from https://github.com/StylishThemes/Syntax-Themes/blob/master/pygments/css-github/
Expand Down
85 changes: 85 additions & 0 deletions docs/code-howtos/IntelliJ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
parent: Code Howtos
---

# IntelliJ Hints

{: .highlight }
Did you know that [IntelliJ allows for reformatting selected code](https://www.jetbrains.com/help/idea/reformat-and-rearrange-code.html#reformat\_code) if you press <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>L</kbd>?

## Key hints for IntelliJ

* <kbd>Shift</kbd>+<kbd>Shift</kbd> (AKA double-shift): Open the search dialog.
* <kbd>Ctrl</kbd>+<kbd>N</kbd>: Open the search dialog and select search for a class.
* <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>F</kbd>: Search everywhere in the code base.
* <kbd>Alt</kbd>+<kbd>F1</kbd> and then <kbd>Enter</kbd>: Locate the file in the search bar on the left side.
* <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>T</kbd>: Navigate from a class to the test class.

---
parent: Set up a local workspace
grand_parent: Getting into the code
nav_order: 49
---

## Other notes on IntelliJ

{: .note}
Here, some notes on IntelliJ setup are written down.
These are intended for pro users.

You should use IntelliJ IDEA's internal build system for compiling and running JabRef tests during development, because it is usually more responsive.
Essentially, you now have the best of both worlds:
You can run Gradle tasks using the Gradle Tool Window.
You can compile and run tests with IntelliJ's faster internal build system
(unless you haven't made changes to input files that generate sources).

{: .important}
When using IntelliJ's build system, **it is important** that you understand that JabRef relies on generated sources which are only built through Gradle.
Therefore, to build or update these dependencies you need to run the `run` (or `assemble`) Gradle task at least once.
When you followed this guide, you should have done it in the Gradle setup.

Running JabRef itself through IntelliJ's build system is **not** possible as we encounter difficulties when reading resources though `.class.getResource(...)`.
Although solutions are discussed in length [on stackoverflow](https://stackoverflow.com/q/26328040/873282), there is no "good" solution for us.

## Running JabRef using IntelliJ's build system

{ :note }
Maybe does not work

To run JabRef from IntelliJ, we let IntelliJ create a launch configuration:

Locate the class `Launcher`:
Press <kbd>Ctrl</kbd>+<kbd>N</kbd>.
Then, the "Search for classes dialog" pops up.
Enter `Launcher`.
Now, only one class should have been found:

{% figure caption:"IntelliJ search for class “Launcher”" %}
![IntelliJ search for class "Launcher"](../images/intellij-search-for-launcher.png)
{% endfigure %}

Press <kbd>Enter</kbd> to jump to that class.

Hover on the green play button.

{% figure caption:"However on green play" %}
![However on green play](../images/intellij-hover-on-play-button.png)
{% endfigure %}

Then, click on it.
A popup menu opens.
Choose the first entry and click on it.

{% figure caption:"Run JabRef via launcher" %}
![Popup menu - Run JabRef via launcher](../images/intellij-run-jabref-from-launcher.png)
{% endfigure %}

Then, JabRef starts.

You also have an entry in the Launch configurations to directly launch the JabRef GUI:

{% figure caption:"Launch menu contains “Launcher”" %}
![Launch menu contains launcher](../images/intellij-run-launcher.png)
{% endfigure %}

You can also click on the debug symbol next to it to enable stopping at breakpoints.
18 changes: 9 additions & 9 deletions docs/code-howtos/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This page lists some software we consider useful.
* [Refined GitHub](https://github.com/sindresorhus/refined-github) - GitHub on steroids
* [GitHub Issue Link Status](https://github.com/fregante/github-issue-link-status) - proper coloring of linked issues and PRs.
* [Codecov Browser Extension](https://github.com/codecov/browser-extension) - displaying code coverage directly when browsing GitHub
* [Sourcegraph Browser Extension](https://docs.sourcegraph.com/integration/browser\_extension) - Navigate through source on github
* [Sourcegraph Browser Extension](https://docs.sourcegraph.com/integration/browser\_extension) - Navigate through source on GitHub

## git hints

Expand All @@ -37,31 +37,31 @@ See also: [https://help.github.com/articles/syncing-a-fork/](https://help.github
(As Administrator - one time)

1. Install [chocolatey](https://chocolatey.org)
2. `choco install git`
3. `choco install conemu clink`
4. `choco install notepadplusplus`
5. If you want to have your jdk also managed via chocolatey: `choco install temurin`
2. `choco install git.install -y --params "/GitAndUnixToolsOnPath /WindowsTerminal`
3. `choco install notepadplusplus`
4. If you want to have your JDK also managed via chocolatey: `choco install temurin`

Then, each weak do `choco upgrade all` to ensure all tooling is uptodate.
Then, each weak do `choco upgrade all` to ensure all tooling is kept updated.

### General git tooling on Windows

* Use [git for windows](https://git-for-windows.github.io), no additional git tooling required
* [Git Credential Manager for Windows](https://github.com/Microsoft/Git-Credential-Manager-for-Windows) is included. Ensure that you include that in the installation. Aim: Store password for GitHub permanently for https repository locations
* [Git Credential Manager for Windows](https://github.com/Microsoft/Git-Credential-Manager-for-Windows) is included. Ensure that you include that in the installation. Aim: Store password for GitHub permanently for `https` repository locations
* [Use notepad++ as editor](http://stackoverflow.com/a/2486342/873282) for `git rebase -i`

### Better console applications

#### ConEmu plus clink

* `choco install conemu clink`
* [ConEmu](http://conemu.github.io) -> Preview Version - Aim: Colorful console with tabs
* At first start:
* "Choose your startup task ...": \`{Bash::Git bash\}}
* `OK`
* Upper right corner: "Settings..." (third entrry Eintrag)
* Startup/Tasks: Choose task no. 7 ("Bash::Git bash"). At "Task parameters" `/dir C:\git-repositories\jabref\jabref`
* `Save Settings`
* [clink](http://mridgers.github.io/clink/) - Aim: Unix keys (Alt+B, Ctrl+S, etc.) also available at the prompt of `cmd.exe`
* [clink](http://mridgers.github.io/clink/) - Aim: Unix keys (<kbd>Alt</kbd>+<kbd>B</kbd>, <kbd>Ctrl</kbd>+<kbd>S</kbd>, etc.) also available at the prompt of `cmd.exe`

#### Other bundles

Expand All @@ -76,4 +76,4 @@ Then, each weak do `choco upgrade all` to ensure all tooling is uptodate.
* [AutoHotkey](http://autohotkey.com) - Preparation for the next step
* [https://github.com/koppor/autohotkey-scripts](https://github.com/koppor/autohotkey-scripts) - Aim: Have Win+C opening ConEmu
1. Clone the repository locally.
2. Then link `ConEmu.ahk` and `WindowsExplorer.ahk` at the startup menu (Link creation works with drag'n'drop using the right mouse key and then choosing "Create link" when dropping). Hint: Startup is in the folder `Startup` (German: `Autostart`) at `%APPDATA%\Microsoft\Windows\Start Menu\Programs\` - accessible via `Win+r`: `shell:startup`
2. Then link `ConEmu.ahk` and `WindowsExplorer.ahk` at the startup menu (Link creation works with drag'n'drop using the right mouse key and then choosing "Create link" when dropping). Hint: Startup is in the folder `Startup` (German: `Autostart`) at `%APPDATA%\Microsoft\Windows\Start Menu\Programs\` - accessible via <kbd>Win</kbd>+<kbd>R</kbd>: `shell:startup`
Loading

0 comments on commit 12b0979

Please sign in to comment.