Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/main' into 8747-data-field
Browse files Browse the repository at this point in the history
* upstream/main:
  Add date format and respective test case (#9310)
  Bump jackson-datatype-jsr310 from 2.13.4 to 2.14.0 (#9357)
  Bump jackson-dataformat-yaml from 2.13.4 to 2.14.0 (#9356)
  Bump tika-core from 2.5.0 to 2.6.0 (#9358)
  Refine guideline "Set up a local workspace" (#9355)
  Adds missing "requires" statement (#9354)
  Bind "Find unlinked files" default directory to the current library (#9290)
  Rename "Remote" to "Tele" (#9270)
  Fixed display of file field adjusting for the dark theme (#9343)
  Update sorting of entries in maintable by special fields immediately (#9338)
  New translations JabRef_en.properties (German) (#9336)
  Fix Abbreviation for Escaped Ampersand (#9288)
  Fix font size preference not updating in preference dialog 8386 (#9287)

# Conflicts:
#	CHANGELOG.md
  • Loading branch information
Siedlerchr committed Nov 8, 2022
2 parents 8464bd6 + 2b38019 commit 5f0e567
Show file tree
Hide file tree
Showing 91 changed files with 879 additions and 347 deletions.
1 change: 0 additions & 1 deletion .github/workflows/deployment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ concurrency:
group: ${{ github.ref }}
cancel-in-progress: true


jobs:
build:
strategy:
Expand Down
18 changes: 12 additions & 6 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
name: Deploy Jekyll site to Pages

on:
pull_request:
paths:
- 'docs/**'
- '.github/workflows/pages.yml'
push:
paths:
- 'docs/**'
Expand All @@ -27,19 +31,21 @@ jobs:
- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.0' # Not needed with a .ruby-version file
ruby-version: '2.7' # Not needed with a .ruby-version file
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
cache-version: 0 # Increment this number if you need to re-download cached gems
cache-version: 1 # Increment this number if you need to re-download cached gems
working-directory: docs/
- name: Setup Pages
id: pages
uses: actions/configure-pages@v2
- name: Build with Jekyll
uses: actions/jekyll-build-pages@v1
with:
source: docs/
destination: ./_site
run: |
cd docs
bundle exec jekyll build
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: docs/_site/

deploy:
if: github.ref == 'refs/heads/main'
Expand Down
14 changes: 0 additions & 14 deletions .idea/runConfigurations/JabRef_Main.xml

This file was deleted.

5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
- An SLR can now be started from the SLR itself. [#9131](https://github.com/JabRef/jabref/pull/9131), [koppor#601](https://github.com/koppor/jabref/issues/601)
- Implement a new ISBN Fetcher ([doi-to-bibtex-converter.herokuapp.com](http://doi-to-bibtex-converter.herokuapp.com) as source). [#9145](https://github.com/JabRef/jabref/pull/9145)
- We added support for the Ukrainian and Arabic languages. [#9236](https://github.com/JabRef/jabref/pull/9236), [#9243](https://github.com/JabRef/jabref/pull/9243)
- The default file directory of a library is used as default directory for [unlinked file lookup](https://docs.jabref.org/collect/findunlinkedfiles#link-the-pdfs-to-your-bib-library). [koppor#546](https://github.com/koppor/jabref/issues/546)

### Changed

Expand Down Expand Up @@ -55,6 +56,8 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve

### Fixed

- We fixed the readability of the file field in the dark dark theme [#9340](https://github.com/JabRef/jabref/issues/9340)
- We fixed that sorting of entries in the maintable by special fields is updated immediately [#9334](https://github.com/JabRef/jabref/issues/9334)
- We fixed the Cleanup entries dialog is partially visible [#9223](https://github.com/JabRef/jabref/issues/9223)
- We fixed the display of the "Customize Entry Types" dialogue title [#9198](https://github.com/JabRef/jabref/issues/9198)
- We fixed an issue where author names with tilde accents (for example ñ) were marked as "Names are not in the standard BibTex format" [#8071](https://github.com/JabRef/jabref/issues/8071)
Expand All @@ -81,6 +84,8 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
- We fixed a typo within a connection error message. [koppor#625](https://github.com/koppor/jabref/issues/625)
- We fixed an issue where the 'close dialog' key binding was not closing the Preferences dialog. [#8888](https://github.com/jabref/jabref/issues/8888)
- We fixed an issue where editing entry's "date" field in library mode "biblatex" causes an uncaught exception. [#8747][https://github.com/JabRef/jabref/issues/8747]
- We fixed an issue where journal abbreviations would not abbreviate journal titles with escaped ampersands (\\&). [#8948](https://github.com/JabRef/jabref/issues/8948)
- We fixed an issue where font size preferences did not apply correctly to preference dialog window and the menu bar. [#8386](https://github.com/JabRef/jabref/issues/8386) and [#9279](https://github.com/JabRef/jabref/issues/9279)
- We fixed an issue when using an unsafe character in the citation key, the auto-linking feature fails to link files. [#9267](https://github.com/JabRef/jabref/issues/9267)

### Removed
Expand Down
6 changes: 3 additions & 3 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ dependencies {
implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.12.0'
implementation 'com.h2database:h2-mvstore:2.1.214'

implementation group: 'org.apache.tika', name: 'tika-core', version: '2.5.0'
implementation group: 'org.apache.tika', name: 'tika-core', version: '2.6.0'

// required for reading write-protected PDFs - see https://github.com/JabRef/jabref/pull/942#issuecomment-209252635
implementation 'org.bouncycastle:bcprov-jdk18on:1.71.1'
Expand All @@ -143,8 +143,8 @@ dependencies {

implementation group: 'org.eclipse.jgit', name: 'org.eclipse.jgit', version: '6.3.0.202209071007-r'

implementation group: 'com.fasterxml.jackson.dataformat', name: 'jackson-dataformat-yaml', version: '2.13.4'
implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.13.4'
implementation group: 'com.fasterxml.jackson.dataformat', name: 'jackson-dataformat-yaml', version: '2.14.0'
implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.14.0'

implementation group: 'org.mariadb.jdbc', name: 'mariadb-java-client', version: '2.7.6'

Expand Down
3 changes: 3 additions & 0 deletions docs/.dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.jekyll-cache
.jekyll-metadata
_site/
2 changes: 2 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
Gemfile.lock
.jekyll-cache
.jekyll-metadata
_site/
14 changes: 14 additions & 0 deletions docs/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
FROM ruby:2.7

ENV LC_ALL C.UTF-8
ENV LANG en_US.UTF-8
ENV LANGUAGE en_US.UTF-8

EXPOSE 4000

WORKDIR /srv/jekyll
COPY . /srv/jekyll

RUN gem install bundler && bundle install

CMD bundle exec jekyll serve -H 0.0.0.0 -t
17 changes: 15 additions & 2 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
source 'https://rubygems.org'

gem "jekyll", "~> 4.2" # installed by `gem jekyll`
gem "webrick" # required when using Ruby >= 3
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.0.rc3"

gem "jekyll-remote-theme"

# Added, because defualt layout with path "**/*.md" does not work at Jekyll
# Source: https://jekyllrb.com/docs/configuration/front-matter-defaults/#glob-patterns-in-front-matter-defaults
# Homepage: https://github.com/benbalter/jekyll-default-layout#jekyll-default-layout
gem 'jekyll-default-layout'

# Somehow, "title" is set "magically" when on GitHub, but not when running locally
# Homepage: https://github.com/benbalter/jekyll-titles-from-headings#jekyll-titles-from-headings
gem 'jekyll-titles-from-headings'
8 changes: 6 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,11 @@ and go to <http://localhost:4000/> in your browser.
On **Windows**, using a dockerized environment is recommended:

```terminal
docker run -p 4000:4000 --rm --volume="C:\git-repositories\jabref\docs":/srv/jekyll jekyll/jekyll:4 jekyll serve
docker build . -t jrjekyll
docker run -p 4000:4000 -it --rm --volume="C:\git-repositories\jabref\docs":/srv/jekyll jrjekyll jekyll serve -H 0.0.0.0 -t
```

In case you get errors regarding `Gemfile.lock`, just delete `Gemfile.lock` and rerun.
* With <kbd>Ctrl</kbd>+<kbd>C</kbd> you can stop the server (this is enabled by the `-it` switch).
* In case you get errors regarding `Gemfile.lock`, just delete `Gemfile.lock` and rerun.
* The current `Dockerfile` is based on <https://github.com/just-the-docs/just-the-docs/blob/main/Dockerfile>.
The [Jekyll Docker image](https://github.com/envygeeks/jekyll-docker#jekyll-docker) did not work end of 20222 (because Ruby was too new).
26 changes: 26 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: "Developer Documentation"
remote_theme: just-the-docs/just-the-docs@v0.4.0.rc3
color_scheme: light

exclude: [CNAME, 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/
# Browse alternative themes at https://stylishthemes.github.io/Syntax-Themes/pygments/
Expand Down Expand Up @@ -34,4 +36,28 @@ baseurl: ""
url: ""

plugins:
- jekyll-default-layout
- jekyll-figure
- jekyll-remote-theme
- jekyll-titles-from-headings

jekyll-figure:
paragraphs: false

callouts_level: quiet # or loud
callouts:
highlight:
title: Summary
color: blue
important:
title: Important
color: yellow
new:
title: New
color: green
note:
title: Note
color: purple
warning:
title: Warning
color: red
8 changes: 8 additions & 0 deletions docs/_sass/custom/custom.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
figcaption {
font-size: .75em;
font-weight: 550;
}

figcaption:before {
content: "Figure: "
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 5f0e567

Please sign in to comment.