Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
29e454e
Add daily workflow merging feature branches into all-branches-merged
Jul 27, 2026
3c408ba
Merge directory-rest-api from JabRef/jabref
Jul 27, 2026
15de89d
Note why merge-all-branches.yml must stay on the default branch
koppor Jul 27, 2026
456ce7a
Merge into experimental instead of all-branches-merged
koppor Jul 27, 2026
0183b58
Rename workflow to update-experimental
koppor Jul 27, 2026
0344416
Merge add-comments-tab and re-run when the branch list changes
koppor Jul 27, 2026
625bbc6
Merge branch 'JabRef:main' into main
calixtus Jul 27, 2026
f1d4df3
Merge branch 'JabRef:main' into main
koppor Jul 29, 2026
e9a7aab
Remove merged zotero-item-import-endpoint from experimental branch list
koppor Jul 29, 2026
1dd5a3c
Drop add-comments-tab from the experimental branch list
koppor Aug 3, 2026
7d96263
Merge branch 'JabRef:main' into main
koppor Aug 18, 2026
ad09065
Use PAT
koppor Aug 23, 2026
df58d8e
Add fixUnlinkedFiles (PR #16696) to experimental merge
koppor Aug 28, 2026
87678d8
Update update-experimental.yml
koppor Aug 28, 2026
bd86efc
Add common-style (PR #16708) to experimental merge
koppor Aug 31, 2026
fe9f386
Drop merged/closed branches from experimental merge list
koppor Aug 31, 2026
7185d04
Merge remote-tracking branch 'origin/main' into koppor-main-sync
koppor Sep 3, 2026
fcba284
Merge branch 'JabRef:main' into main
koppor Sep 3, 2026
bbbefa4
Add fulltext-context-menu to the experimental merge list
koppor Sep 3, 2026
9fac562
Update update-experimental.yml
koppor Sep 3, 2026
e8611d0
Add show-diff-button to experimental merge list
koppor Sep 3, 2026
bfaa38b
Merge remote-tracking branch 'origin/main' into HEAD
koppor Sep 3, 2026
8c01097
Merge branch 'JabRef:main' into main
calixtus Sep 3, 2026
daf6639
Add keyword-separator-per-library to experimental
koppor Sep 3, 2026
30a2959
Link PRs in update-experimental branch list
koppor Sep 3, 2026
96d9a80
Drop directory-convert from the experimental merge list
koppor Sep 3, 2026
74a516f
Point the experimental merge list at the new stack tip directory-split
koppor Sep 3, 2026
17aab27
Drop merged-upstream branches from the experimental merge list
github-actions[bot] Sep 5, 2026
701d641
Drop three more merged-upstream branches from the experimental merge …
koppor Sep 7, 2026
d83909a
Merge branch 'JabRef:main' into main
koppor Sep 7, 2026
ee37a8b
Update experimental branch hourly (#761)
koppor Sep 7, 2026
ee967c3
Merge remote-tracking branch 'origin/main' into koppor-main
koppor Sep 9, 2026
a2a42a5
Add plan for Godot-style dock layout prototype
koppor Sep 9, 2026
99ef07a
Dock layout: side pane as tabs on the left, entry editor on the right
koppor Sep 9, 2026
35f773a
Library tabs share the dock look, changelog entry
koppor Sep 9, 2026
f021156
Link the changelog entry to the PR
koppor Sep 9, 2026
563ac2d
Use the forge-ref format heylogs expects for the changelog link
koppor Sep 10, 2026
55c18ad
Merge remote-tracking branch 'origin/main' into koppor-main
koppor Sep 10, 2026
79a3994
Note the koppor main sync in the plan
koppor Sep 10, 2026
65a94fe
Fix bare URL in PLAN.md
koppor Sep 10, 2026
5ab7fa8
Merge remote-tracking branch 'koppor/main' into godot-dock-layout
koppor Sep 10, 2026
af2810a
Merge remote-tracking branch 'origin/main' into godot-dock-layout
claude Sep 28, 2026
88d7455
Merge remote-tracking branch 'origin/main' into godot-dock-layout
claude Nov 13, 2026
d30c773
Merge remote-tracking branch 'origin/main' into godot-dock-layout
claude Nov 22, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
- We reworked the appearance preferences: you now choose a theme (e.g. "JabRef", "Primer") and a color scheme ("Follow System", "Light", "Dark") separately; the "Use System Preference" checkbox is gone. [#15625](https://github.com/JabRef/jabref/issues/15625)
- A custom theme (CSS file) is now applied on top of the selected theme instead of replacing it entirely. [#15625](https://github.com/JabRef/jabref/issues/15625)
- Custom themes now use the `-color-*` variables declared in the theme stylesheet (see `jabref-theme.css`); the previous `-jr-*` color variables (e.g. `-jr-theme`, `-jr-accent`) were removed, so existing custom CSS files that override them need to be adapted. [#15625](https://github.com/JabRef/jabref/issues/15625)
- The main window is now laid out in docks: the side pane shows groups, web search and OpenOffice/LibreOffice as tabs on the left (drag a tab to reorder, close it with its X), and the entry editor opens on the right instead of below the entry table. Checkboxes are drawn as filled boxes without a border. [JabRef/jabref-koppor#766](https://github.com/JabRef/jabref-koppor/pull/766)
- We improved performance when switching between libraries and working with large libraries in the main table and groups sidebar. [#17110](https://github.com/JabRef/jabref/pull/17110)
- The LibreOffice integration's bibliography generation for CSL styles is now more performant for a large number of entries. [#16555](https://github.com/JabRef/jabref/pull/16555)
- We now identify Crossref requests with a configured email address, allowing them to use Crossref's polite pool. [#16535](https://github.com/JabRef/jabref/pull/16535)
Expand Down
55 changes: 55 additions & 0 deletions PLAN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Godot-style dock layout prototype

Goal: a JabRef main window laid out like the Godot editor: dock tabs on the left, the library
in the middle, the entry editor as a dock on the right. Flat "dock" tab styling and borderless,
filled checkboxes. Prototype on top of `main`, PR on jabref-koppor.

## Design (decided)

- **Left dock** = plain JavaFX `TabPane` in `SidePane`, one `Tab` per visible `SidePaneType`
(icon graphic + title). Tabs are closable (close = remove from
`StateManager.getVisibleSidePaneComponents()`) and drag-reorderable
(`TabDragPolicy.REORDER`, reorder = update `SidePanePreferences.preferredPositions`).
No library (DockFX & co. are unmaintained; a TabPane is all Godot does visually).
- The header row of `SidePaneComponent` (title label + up/down/close buttons) goes away; the
groups toolbar buttons (filter / invert / union-intersection) move into the tab content top.
- **Right dock** = `EntryEditor` as the third item of the horizontal `SplitPane` in
`JabRefFrame` (`[sidePane | libraries | entryEditor]`); the vertical split is dropped.
Divider positions: left divider keeps `MAIN_WINDOW_SIDEPANE_WIDTH`; the editor divider
reuses `MAIN_WINDOW_EDITOR_HEIGHT` (renamed getter to "editor divider position", same key,
value is a ratio either way — default changed to ~0.6).
- **Theme**: style class `dock` on the dock `TabPane`s (left side pane, entry editor tabs):
flat tab strip, selected tab merges with the content background, no borders; checkboxes:
filled `-color-bg-tertiary` box, no border, accent when selected. Rules live in
`jabref-theme.css` (JabRef theme) + token-only rules in `internal/jabref-base.css`.

## Steps

- [x] 1. PLAN.md committed + branch pushed to koppor
- [x] 2. SidePane → TabPane of docks (SidePane, SidePaneViewModel, SidePaneComponent,
GroupsSidePaneComponent; SidePaneViewModelTest adapted)
- [x] 3. Entry editor to the right (JabRefFrame, CoreGuiPreferences, JabRefGUI)
- [x] 4. CSS: `.dock` tab styling + borderless checkboxes
- [x] 5. Compile + `:jabgui:test --tests '*SidePane*'` + Xvfb screenshot
- [x] 6. Draft PR on JabRef/jabref-koppor with screenshot: <https://github.com/JabRef/jabref-koppor/pull/766>
- [ ] 7. Follow-ups (not in this PR): layout preference classic/docked, closable editor dock
via View menu, remember selected dock tab

## Notes / state

- 2026-09-10: steps 1-4 done, `:jabgui:test --tests 'org.jabref.gui.sidepane.*'`, checkstyle and
LocalizationConsistencyTest green. l10n keys "Hide panel"/"Move panel up/down" removed (unused).
- Dock CSS lives in `internal/jabref-base.css` (token-only, applies to every theme); the checkbox
restyle only in `jabref-theme.css` (theme decision). Entry editor tabs get the `dock` class in
`EntryEditor.fxml`; their selected tab merges with `-color-bg-secondary`, side pane docks with
`-color-bg-sidepane`.
- Library tab strip (`tabbedPane` in JabRefFrame) also carries `dock`; `.side-pane` splits the
side pane colors (`-color-bg-sidepane`) from the center/editor (`-color-bg-secondary`).
- Xvfb-verified 2026-09-10 (display :83, isolated prefs): drag "Groups" before "Web search" →
`sidePaneComponentPreferredPositions` persisted; tab X → `webSearchVisible=false` persisted;
entry editor opens as right dock with its preview; Preferences checkboxes filled + borderless.
- Screenshots: branch `assets-godot-dock-layout` on jabref-koppor (dock-layout.png, checkboxes.png).
- CI on jabref-koppor: "Submodules not modified" compares against koppor `main`, which lagged
upstream by 45 commits (themes submodule bump) → merged origin/main into koppor main
(55c18ada35) from worktree 2026-09-09-koppor-main. heylogs wants `[JabRef/jabref-koppor#766](...)`.
- Walkthrough still finds the groups pane: id `groups-side-pane` sits on the tab content node.
20 changes: 10 additions & 10 deletions jabgui/src/main/java/org/jabref/gui/CoreGuiPreferences.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,22 @@ public class CoreGuiPreferences {
private final BooleanProperty windowMaximised;

private final DoubleProperty horizontalDividerPosition;
private final DoubleProperty verticalDividerPosition;
private final DoubleProperty entryEditorDividerPosition;

public CoreGuiPreferences(double positionX,
double positionY,
double sizeX,
double sizeY,
boolean windowMaximised,
double horizontalDividerPosition,
double verticalDividerPosition) {
double entryEditorDividerPosition) {
this.positionX = new SimpleDoubleProperty(positionX);
this.positionY = new SimpleDoubleProperty(positionY);
this.sizeX = new SimpleDoubleProperty(sizeX);
this.sizeY = new SimpleDoubleProperty(sizeY);
this.windowMaximised = new SimpleBooleanProperty(windowMaximised);
this.horizontalDividerPosition = new SimpleDoubleProperty(horizontalDividerPosition);
this.verticalDividerPosition = new SimpleDoubleProperty(verticalDividerPosition);
this.entryEditorDividerPosition = new SimpleDoubleProperty(entryEditorDividerPosition);
}

/// Creates object with default values
Expand All @@ -41,7 +41,7 @@ private CoreGuiPreferences() {
768, // Main window size y
true, // Main window maximized
0.15, // Horizontal divider position
0.65); // Vertical divider position
0.65); // Entry editor divider position (the editor docks on the right)
}

public static CoreGuiPreferences getDefault() {
Expand Down Expand Up @@ -120,15 +120,15 @@ public void setHorizontalDividerPosition(double horizontalDividerPosition) {
this.horizontalDividerPosition.set(horizontalDividerPosition);
}

public double getVerticalDividerPosition() {
return verticalDividerPosition.get();
public double getEntryEditorDividerPosition() {
return entryEditorDividerPosition.get();
}

public DoubleProperty getVerticalDividerPositionProperty() {
return verticalDividerPosition;
public DoubleProperty entryEditorDividerPositionProperty() {
return entryEditorDividerPosition;
}

public void setVerticalDividerPosition(double dividerPosition) {
this.verticalDividerPosition.set(dividerPosition);
public void setEntryEditorDividerPosition(double dividerPosition) {
this.entryEditorDividerPosition.set(dividerPosition);
}
}
5 changes: 1 addition & 4 deletions jabgui/src/main/java/org/jabref/gui/JabRefGUI.java
Original file line number Diff line number Diff line change
Expand Up @@ -439,10 +439,7 @@ private static void installControlsFxDecorationPane(PowerPane powerpane) {
}

public void onShowing(WindowEvent event) {
Platform.runLater(() -> {
mainFrame.updateHorizontalDividerPosition();
mainFrame.updateVerticalDividerPosition();
});
Platform.runLater(mainFrame::updateDividerPositions);

// Open last edited databases
if (uiCommands.stream().noneMatch(UiCommand.BlankWorkspace.class::isInstance)
Expand Down
121 changes: 50 additions & 71 deletions jabgui/src/main/java/org/jabref/gui/frame/JabRefFrame.java
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@

import java.io.IOException;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.function.Consumer;
import java.util.function.DoubleConsumer;
import java.util.function.Supplier;

import javafx.application.Platform;
Expand All @@ -21,7 +23,6 @@
import javafx.geometry.Orientation;
import javafx.scene.Node;
import javafx.scene.control.ContextMenu;
import javafx.scene.control.ScrollPane;
import javafx.scene.control.SeparatorMenuItem;
import javafx.scene.control.SplitPane;
import javafx.scene.control.Tab;
Expand Down Expand Up @@ -134,17 +135,15 @@ private enum PanelMode { MAIN_TABLE, MAIN_TABLE_AND_ENTRY_EDITOR }

private final JabRefFrameViewModel viewModel;
private final GuiPushToApplicationCommand pushToApplicationCommand;
/// Godot-style docks: `[side pane | libraries | entry editor]`, each dock keeps its width when the window resizes
private final SplitPane horizontalSplit = new SplitPane();
private final SidePane sidePane;
private final ScrollPane sidePaneScroll = new ScrollPane();
private final SplitPane verticalSplit = new SplitPane();
private final TabPane tabbedPane = new TabPane();
private final EntryEditor entryEditor;
private final ObjectProperty<PanelMode> panelMode = new SimpleObjectProperty<>(PanelMode.MAIN_TABLE);

// We need to keep a reference to the subscription, otherwise the binding gets garbage collected
private Subscription horizontalDividerSubscription;
private Subscription verticalDividerSubscription;
// We need to keep references to the subscriptions, otherwise the bindings get garbage collected
private final List<Subscription> dividerSubscriptions = new ArrayList<>();

public JabRefFrame(Stage mainStage,
DialogService dialogService,
Expand Down Expand Up @@ -290,91 +289,71 @@ private void initLayout() {
VBox head = new VBox(0, mainMenu, mainToolBar);
setTop(head);

verticalSplit.getItems().addAll(tabbedPane);
verticalSplit.setOrientation(Orientation.VERTICAL);
updateEditorPane();

horizontalSplit.getItems().addAll(verticalSplit);
tabbedPane.getStyleClass().add("dock");
horizontalSplit.getItems().addAll(tabbedPane);
horizontalSplit.setOrientation(Orientation.HORIZONTAL);
updateEditorPane();

sidePaneScroll.setContent(sidePane);
sidePaneScroll.setFitToWidth(true);
sidePaneScroll.setFitToHeight(true);
sidePaneScroll.setHbarPolicy(ScrollPane.ScrollBarPolicy.AS_NEEDED);
sidePaneScroll.setVbarPolicy(ScrollPane.ScrollBarPolicy.AS_NEEDED);
sidePaneScroll.getStyleClass().add("side-pane-scroll");

SplitPane.setResizableWithParent(sidePaneScroll, false);
sidePane.widthProperty().addListener(_ -> updateSidePane());
sidePane.getChildren().addListener((InvalidationListener) _ -> updateSidePane());
SplitPane.setResizableWithParent(sidePane, false);
SplitPane.setResizableWithParent(entryEditor, false);
sidePane.getTabs().addListener((InvalidationListener) _ -> updateSidePane());
updateSidePane();
setCenter(horizontalSplit);
}

private void updateSidePane() {
if (sidePane.getChildren().isEmpty()) {
unsubscribeHorizontalDivider();
horizontalSplit.getItems().remove(sidePaneScroll);
} else {
if (!horizontalSplit.getItems().contains(sidePaneScroll)) {
horizontalSplit.setVisible(false);
horizontalSplit.getItems().addFirst(sidePaneScroll);
Platform.runLater(() -> {
updateHorizontalDividerPosition();
horizontalSplit.setVisible(true);
});
}
if (sidePane.getTabs().isEmpty()) {
horizontalSplit.getItems().remove(sidePane);
updateDividerPositions();
} else if (!horizontalSplit.getItems().contains(sidePane)) {
horizontalSplit.setVisible(false);
horizontalSplit.getItems().addFirst(sidePane);
Platform.runLater(() -> {
updateDividerPositions();
horizontalSplit.setVisible(true);
});
}
}

private void updateEditorPane() {
if (panelMode.get() == PanelMode.MAIN_TABLE) {
if (verticalDividerSubscription != null) {
verticalDividerSubscription.unsubscribe();
}
verticalSplit.getItems().remove(entryEditor);
} else {
if (!verticalSplit.getItems().contains(entryEditor)) {
verticalSplit.getItems().addLast(entryEditor);
updateVerticalDividerPosition();
}
horizontalSplit.getItems().remove(entryEditor);
updateDividerPositions();
} else if (!horizontalSplit.getItems().contains(entryEditor)) {
horizontalSplit.getItems().addLast(entryEditor);
updateDividerPositions();
}
}

public void updateHorizontalDividerPosition() {
// Rapid toggling queues several runLater calls; a leftover listener would keep writing.
unsubscribeHorizontalDivider();
if (!mainStage.isShowing() || sidePane.getChildren().isEmpty()) {
/// Restores both dock dividers from the preferences and stores them back whenever the user drags one.
/// Inserting or removing a dock shifts the divider indexes, so the whole set is re-applied each time.
public void updateDividerPositions() {
dividerSubscriptions.forEach(Subscription::unsubscribe);
dividerSubscriptions.clear();
if (!mainStage.isShowing()) {
return;
}
horizontalSplit.setDividerPositions(preferences.getGuiPreferences().getHorizontalDividerPosition());
horizontalDividerSubscription = EasyBind.valueAt(horizontalSplit.getDividers(), 0)
.mapObservable(SplitPane.Divider::positionProperty)
.listenToValues((_, newValue) -> {
double position = newValue.doubleValue();
// 0 and 1 occur while the pane is added or removed, not as a user's choice
if (position > 0 && position < 1) {
preferences.getGuiPreferences().setHorizontalDividerPosition(position);
}
});
}

private void unsubscribeHorizontalDivider() {
if (horizontalDividerSubscription != null) {
horizontalDividerSubscription.unsubscribe();
horizontalDividerSubscription = null;
if (horizontalSplit.getItems().contains(sidePane)) {
bindDivider(horizontalSplit.getDividers().getFirst(),
preferences.getGuiPreferences().getHorizontalDividerPosition(),
preferences.getGuiPreferences()::setHorizontalDividerPosition);
}
if (horizontalSplit.getItems().contains(entryEditor)) {
bindDivider(horizontalSplit.getDividers().getLast(),
preferences.getGuiPreferences().getEntryEditorDividerPosition(),
preferences.getGuiPreferences()::setEntryEditorDividerPosition);
}
}

public void updateVerticalDividerPosition() {
if (mainStage.isShowing() && panelMode.get() == PanelMode.MAIN_TABLE_AND_ENTRY_EDITOR) {
verticalSplit.setDividerPositions(preferences.getGuiPreferences().getVerticalDividerPosition());
verticalDividerSubscription = EasyBind.valueAt(verticalSplit.getDividers(), 0)
.mapObservable(SplitPane.Divider::positionProperty)
.listenToValues((_, newValue) ->
preferences.getGuiPreferences()
.setVerticalDividerPosition(newValue.doubleValue()));
}
private void bindDivider(SplitPane.Divider divider, double position, DoubleConsumer store) {
divider.setPosition(position);
dividerSubscriptions.add(EasyBind.listen(divider.positionProperty(), (_, _, newValue) -> {
double newPosition = newValue.doubleValue();
// 0 and 1 occur while a dock is added or removed, not as a user's choice
if ((newPosition > 0) && (newPosition < 1)) {
store.accept(newPosition);
}
}));
}

/// The frame captures shortcuts before child views; a view that handles Search must receive it itself.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -680,15 +680,15 @@ public CoreGuiPreferences getGuiPreferences() {
getDouble(MAIN_WINDOW_HEIGHT, defaultValues.getSizeY()),
getBoolean(MAIN_WINDOW_MAXIMISED, defaultValues.isWindowMaximised()),
getDouble(MAIN_WINDOW_SIDEPANE_WIDTH, defaultValues.getHorizontalDividerPosition()),
getDouble(MAIN_WINDOW_EDITOR_HEIGHT, defaultValues.getVerticalDividerPosition()));
getDouble(MAIN_WINDOW_EDITOR_HEIGHT, defaultValues.getEntryEditorDividerPosition()));

bindDouble(coreGuiPreferences.positionXProperty(), MAIN_WINDOW_POS_X, defaultValues.getPositionX());
bindDouble(coreGuiPreferences.positionYProperty(), MAIN_WINDOW_POS_Y, defaultValues.getPositionY());
bindDouble(coreGuiPreferences.sizeXProperty(), MAIN_WINDOW_WIDTH, defaultValues.getSizeX());
bindDouble(coreGuiPreferences.sizeYProperty(), MAIN_WINDOW_HEIGHT, defaultValues.getSizeY());
bindBoolean(coreGuiPreferences.windowMaximisedProperty(), MAIN_WINDOW_MAXIMISED, defaultValues.isWindowMaximised());
bindDouble(coreGuiPreferences.horizontalDividerPositionProperty(), MAIN_WINDOW_SIDEPANE_WIDTH, defaultValues.getHorizontalDividerPosition());
bindDouble(coreGuiPreferences.getVerticalDividerPositionProperty(), MAIN_WINDOW_EDITOR_HEIGHT, defaultValues.getVerticalDividerPosition());
bindDouble(coreGuiPreferences.entryEditorDividerPositionProperty(), MAIN_WINDOW_EDITOR_HEIGHT, defaultValues.getEntryEditorDividerPosition());

return coreGuiPreferences;
}
Expand Down
Loading
Loading