Skip to content

Fix JabRef icon top banner in wix installer dialog#15202

Merged
Siedlerchr merged 16 commits into
mainfrom
wix2
Feb 25, 2026
Merged

Fix JabRef icon top banner in wix installer dialog#15202
Siedlerchr merged 16 commits into
mainfrom
wix2

Conversation

@Siedlerchr

@Siedlerchr Siedlerchr commented Feb 23, 2026

Copy link
Copy Markdown
Member
grafik

Related issues and pull requests

Closes #14965

PR Description

Steps to test

Checklist

  • I own the copyright of the code submitted and I license it under the MIT license
  • I manually tested my changes in running JabRef (always required)
  • [.] I added JUnit tests for changes (if applicable)
  • I added screenshots in the PR description (if change is visible to the user)
  • [/] I added a screenshot in the PR description showing a library with a single entry with me as author and as title the issue number
  • I described the change in CHANGELOG.md in a way that can be understood by the average user (if change is visible to the user)
  • [.] I checked the user documentation for up to dateness and submitted a pull request to our user documentation repository

@Siedlerchr Siedlerchr added the dev: binaries Binary builds should be uploaded to builds.jabref.org label Feb 23, 2026
@qodo-free-for-open-source-projects

Copy link
Copy Markdown
Contributor

Review Summary by Qodo

Enable WiX banner in Windows installer configuration

🐞 Bug fix

Grey Divider

Walkthroughs

Description
• Uncommented WixUIBannerBmp variable in Windows installer configuration
• Changed forward slashes to backslashes in banner file path
• Enables custom banner display in WiX installer UI
Diagram
flowchart LR
  A["WixUIBannerBmp commented out"] -- "uncomment and fix path" --> B["WixUIBannerBmp enabled with correct path"]
Loading

Grey Divider

File Changes

1. jabgui/buildres/windows/main.wxs 🐞 Bug fix +1/-1

Enable WiX banner with corrected path separator

• Uncommented the WixUIBannerBmp WixVariable declaration
• Changed file path separator from forward slashes to backslashes for Windows compatibility
• Enables custom banner image display in WiX installer UI

jabgui/buildres/windows/main.wxs


Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

qodo-free-for-open-source-projects Bot commented Feb 23, 2026

Copy link
Copy Markdown
Contributor

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (1) 📎 Requirement gaps (0)

Grey Divider


Action required

1. WixVariable tag not closed📘 Rule violation ✓ Correctness
Description
The new ` element is opened but never closed/self-closed, making main.wxs` not well-formed XML and
likely breaking the WiX build. This diverges from established file conventions and reduces
reviewability/maintainability.
Code

jabgui/buildres/windows/main.wxs[104]

+    <WixVariable Id="WixUIBannerBmp" Value="$(var.JpConfigDir)\JabRefTopBanner.bmp">
Evidence
PR Compliance ID 8 requires preserving existing coding conventions; introducing malformed XML breaks
established conventions and can cause build failures. The modified line adds a non-self-closed ``
element with no corresponding closing tag in the immediate file context.

AGENTS.md
jabgui/buildres/windows/main.wxs[104-106]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`jabgui/buildres/windows/main.wxs` introduces a `&amp;lt;WixVariable ...&amp;gt;` start tag but does not close it, making the XML invalid and likely breaking the WiX build.
## Issue Context
WiX variable declarations are typically self-closing elements (e.g., `&amp;lt;WixVariable ... /&amp;gt;`). The current code has no `&amp;lt;/WixVariable&amp;gt;` later in the file context.
## Fix Focus Areas
- jabgui/buildres/windows/main.wxs[104-106]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools



Remediation recommended

2. Mixed path separators 🐞 Bug ⛯ Reliability
Description
The same $(var.JpConfigDir) is combined using '/' in the include directive but '\\' for the banner
path, which is inconsistent and can be brittle depending on tooling/path normalization.
Code

jabgui/buildres/windows/main.wxs[104]

+    <WixVariable Id="WixUIBannerBmp" Value="$(var.JpConfigDir)\JabRefTopBanner.bmp">
Evidence
This file already establishes a convention of using forward slashes with $(var.JpConfigDir). The new
banner path uses a backslash, creating an inconsistency in how paths are constructed from the same
variable.

jabgui/buildres/windows/main.wxs[15-15]
jabgui/buildres/windows/main.wxs[104-104]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`main.wxs` mixes `/` and `\\` when appending to `$(var.JpConfigDir)`. This inconsistency can lead to hard-to-debug path issues in some build environments and reduces maintainability.
### Issue Context
The file already uses `$(var.JpConfigDir)/...` for the preprocessor include.
### Fix Focus Areas
- jabgui/buildres/windows/main.wxs[15-15]
- jabgui/buildres/windows/main.wxs[104-104]
### Suggested change
After fixing the XML closure, consider changing the banner value to:

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

ⓘ The new review experience is currently in Beta. Learn more

Grey Divider

Qodo Logo

Comment thread jabgui/buildres/windows/main.wxs Outdated
<?endif?>

<!-- <WixVariable Id="WixUIBannerBmp" Value="$(var.JpConfigDir)/JabRefTopBanner.bmp"> -->
<WixVariable Id="WixUIBannerBmp" Value="$(var.JpConfigDir)\JabRefTopBanner.bmp">

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Action required

1. wixvariable tag not closed 📘 Rule violation ✓ Correctness

The new <WixVariable ...> element is opened but never closed/self-closed, making main.wxs not
well-formed XML and likely breaking the WiX build. This diverges from established file conventions
and reduces reviewability/maintainability.
Agent Prompt
## Issue description
`jabgui/buildres/windows/main.wxs` introduces a `<WixVariable ...>` start tag but does not close it, making the XML invalid and likely breaking the WiX build.

## Issue Context
WiX variable declarations are typically self-closing elements (e.g., `<WixVariable ... />`). The current code has no `</WixVariable>` later in the file context.

## Fix Focus Areas
- jabgui/buildres/windows/main.wxs[104-106]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

@Siedlerchr Siedlerchr closed this Feb 23, 2026
@Siedlerchr Siedlerchr reopened this Feb 24, 2026
@qodo-free-for-open-source-projects

Copy link
Copy Markdown
Contributor

Review Summary by Qodo

Enable WixUI banner in Windows installer configuration

🐞 Bug fix

Grey Divider

Walkthroughs

Description
• Uncommented WixUIBannerBmp variable in Windows installer configuration
• Changed forward slashes to backslashes in file path for Windows compatibility
Diagram
flowchart LR
  A["WixUIBannerBmp commented out"] -- "uncomment and fix path" --> B["WixUIBannerBmp enabled with correct path"]
Loading

Grey Divider

File Changes

1. jabgui/buildres/windows/main.wxs 🐞 Bug fix +1/-1

Enable WixUI banner with corrected path

• Uncommented the WixUIBannerBmp variable declaration
• Changed file path from forward slashes to backslashes for Windows compatibility
• Updated path from $(var.JpConfigDir)/JabRefTopBanner.bmp to
 $(var.JpConfigDir)\JabRefTopBanner.bmp

jabgui/buildres/windows/main.wxs


Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

qodo-free-for-open-source-projects Bot commented Feb 24, 2026

Copy link
Copy Markdown
Contributor

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

ⓘ The new review experience is currently in Beta. Learn more

Grey Divider

Qodo Logo

@testlens-app

This comment has been minimized.

try from packages subdir
* upstream/wix2:
  from packages subdir
  try with other dir

# Conflicts:
#	jabgui/buildres/windows/main.wxs
@testlens-app

This comment has been minimized.

@testlens-app

This comment has been minimized.

@testlens-app

This comment has been minimized.

@testlens-app

This comment has been minimized.

@testlens-app

This comment has been minimized.

* refs/heads/main:
  Increase max assignments from 2 to 3
  Chore(deps): Bump io.zonky.test:embedded-postgres in /versions (#15213)
  Chore(deps): Bump jablib/src/main/resources/csl-styles (#15211)
  New Crowdin updates (#15208)
  Fix: Prevent creating empty or duplicate fields  (#15168)
  chore(deps): update jackson monorepo to v3.1.0 (#15203)
  Update KeywordEditor to work with escaping (#14929)
  Chore(deps): Bump com.dlsc.gemsfx:gemsfx in /versions (#15205)
  Chore(deps): Bump tools.jackson:jackson-bom in /versions (#15206)
  Fix: Reset External File Type to default (#15167)
  docs: fix link formatting in ADR 0012 (#15201)
@testlens-app

This comment has been minimized.

@Siedlerchr Siedlerchr enabled auto-merge February 25, 2026 22:20
@Siedlerchr Siedlerchr changed the title try again with wix banner Fix JabRef icon top banner in wix installler dialog Feb 25, 2026
@Siedlerchr Siedlerchr changed the title Fix JabRef icon top banner in wix installler dialog Fix JabRef icon top banner in wix installer dialog Feb 25, 2026
@Siedlerchr Siedlerchr added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Feb 25, 2026
@testlens-app

This comment has been minimized.

@testlens-app

testlens-app Bot commented Feb 25, 2026

Copy link
Copy Markdown

✅ All tests passed ✅

🏷️ Commit: 671963e
▶️ Tests: 11198 executed
⚪️ Checks: 54/54 completed


Learn more about TestLens at testlens.app.

@Siedlerchr Siedlerchr added this pull request to the merge queue Feb 25, 2026
@github-actions

Copy link
Copy Markdown
Contributor

The build of this PR is available at https://builds.jabref.org/pull-15202/.

@github-actions github-actions Bot added the status: to-be-merged PRs which are accepted and should go into the merge-queue. label Feb 25, 2026
Merged via the queue into main with commit 436a590 Feb 25, 2026
55 checks passed
@Siedlerchr Siedlerchr deleted the wix2 branch February 25, 2026 23:23
RakockiW pushed a commit to RakockiW/jabref that referenced this pull request Mar 1, 2026
* try again with wix banner

* try again with wix banner

* try with other dir

* from packages subdir

try from packages subdir

* move JabRefTopBanner.bmp to main dir

* verbose

* temp dir

* copy over banner

* copy over banner

* cahngelog

* cahngelog

* remove verbose and temp
priyanshu16095 pushed a commit to priyanshu16095/jabref that referenced this pull request Mar 3, 2026
* try again with wix banner

* try again with wix banner

* try with other dir

* from packages subdir

try from packages subdir

* move JabRefTopBanner.bmp to main dir

* verbose

* temp dir

* copy over banner

* copy over banner

* cahngelog

* cahngelog

* remove verbose and temp
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dev: binaries Binary builds should be uploaded to builds.jabref.org status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers status: to-be-merged PRs which are accepted and should go into the merge-queue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Windows installer doesn't show JabRef icon

2 participants