Skip to content

Commit 3e1a4f4

Browse files
kopporsubhramit
andauthored
Update docs to new structure (#13039)
* Use mise instead of GitHub actions * Do not "fix" main at initial setup - main is upstream/main * Use mise - and update documentation * Add mise dr * Use eval mise hook-env Suggested at jdx/mise#4973 (comment) * Discard changes to .github/workflows/deployment.yml * Discard changes to .github/workflows/tests-fetchers.yml * Discard changes to .github/workflows/tests.yml * Discard changes to build-logic/src/main/kotlin/buildlogic.java-common-conventions.gradle.kts * Fix ref * Replace mise.toml by .sdkmanrc * Fix ref * pre-02-software, pre-03-code, and intellij-11-code-into-ide * Refine 11 and 12 * Finish 12 * Minor refinements of bibtex.md * Apply suggestions from code review Co-authored-by: Subhramit Basu <[email protected]> * Address review comments --------- Co-authored-by: Subhramit Basu <[email protected]>
1 parent 8da3a0d commit 3e1a4f4

35 files changed

+192
-141
lines changed

.sdkmanrc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
java=24.0.1-tem
2+
#visualvm=2.1.10

build-logic/src/main/kotlin/buildlogic.java-common-conventions.gradle.kts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ java {
4242
// - build.gradle -> jacoco -> toolVersion (because JaCoCo does not support newest JDK out of the box. Check versions at https://www.jacoco.org/jacoco/trunk/doc/changes.html)
4343
// - .devcontainer/devcontainer.json#L34 and
4444
// - .moderne/moderne.yml
45-
// - .github/workflows/deployment*.yml
45+
// - .github/workflows/binaries*.yml
4646
// - .github/workflows/tests*.yml
4747
// - .github/workflows/update-gradle-wrapper.yml
4848
// - docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-12-build.md
49-
// - mise.toml
49+
// - .sdkmanrc
5050
languageVersion = JavaLanguageVersion.of(24)
5151
// See https://docs.gradle.org/current/javadoc/org/gradle/jvm/toolchain/JvmVendorSpec.html for a full list
5252
// See https://docs.gradle.org/current/javadoc/org/gradle/jvm/toolchain/JvmVendorSpec.html for a full list

docs/code-howtos/bibtex.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,15 @@ parent: Code Howtos
55

66
The main class to handle a single BibTeX entry is `org.jabref.model.entry.BibEntry`.
77
The content of a `.bib` file is handled in `org.jabref.model.database.BibDatabase`.
8-
Things not written in the `.bib` file, but required for handling are stored in `org.jabref.model.database.BibDatabaseContext`.
8+
The BibTeX contents (as in the `BibDatabase`) along with some metadata required for handling are stored in `org.jabref.model.database.BibDatabaseContext`.
99
For instance, this stores the mode of the library, which can be BibTeX or `biblatex`.
1010

1111
Standard BibTeX fields known to JabRef are modeled in `org.jabref.model.entry.field.StandardField`.
1212
A user-defined field not known to JabRef's code is modelled in `org.jabref.model.entry.field.UnknownField`.
1313
Typically, to get from a String to a `Field`, one needs to use `org.jabref.model.entry.field.FieldFactory#parseField(java.lang.String)`.
1414

15+
Reading of `.bib` files is done in `org.jabref.logic.importer.fileformat.BibtexImporter`.
16+
1517
## Cross-references
1618

1719
BibTeX allows for referencing other entries by the field `crossref` (`org.jabref.model.entry.field.StandardField#CROSSREF`).
83.1 KB
Loading
30.6 KB
Loading
29.9 KB
Loading
52.4 KB
Loading
42.7 KB
Loading
11.2 KB
Loading
35.7 KB
Loading

0 commit comments

Comments
 (0)