Skip to content

Commit

Permalink
Enhance doc
Browse files Browse the repository at this point in the history
  • Loading branch information
calixtus committed Oct 14, 2024
1 parent 0a963c9 commit 5808f0d
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/code-howtos/fetchers.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,17 @@ In `build.gradle`, these variables are filled:
"springerNatureAPIKey" : System.getenv('SpringerNatureAPIKey')
```

The `BuildInfo` class reads from that file and the key needs to be put into the map of default api keys in `JabRefCliPreferences::getDefaultFetcherKeys`
The `BuildInfo` class reads from that file and the key needs to be put into the map of default api keys in `JabRefCliPreferences::getDefaultFetcherKeys`.

```java
keys.put(SpringerFetcher.FETCHER_NAME, buildInfo.springerNatureAPIKey);
```

Check failure on line 83 in docs/code-howtos/fetchers.md

View workflow job for this annotation

GitHub Actions / Markdown

Fenced code blocks should be surrounded by blank lines

docs/code-howtos/fetchers.md:83 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md031.md
The fetcher api key can then be obtained by calling the preferences.

```java
importerPreferences.getApiKey(SpringerFetcher.FETCHER_NAME);
```


Check failure on line 90 in docs/code-howtos/fetchers.md

View workflow job for this annotation

GitHub Actions / Markdown

Multiple consecutive blank lines

docs/code-howtos/fetchers.md:90 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md012.md
When executing `./gradlew run`, gradle executes `processResources` and populates `build/build.properties` accordingly. However, when working directly in the IDE, Eclipse keeps reading `build.properties` from `src/main/resources`. In IntelliJ, the task `JabRef Main` is executing `./gradlew processResources` before running JabRef from the IDE to ensure the `build.properties` is properly populated.

Expand Down

0 comments on commit 5808f0d

Please sign in to comment.