Added JabRef logo as tiff for Mac OS installer (retina support) #5759

[Gena928]

Fixes #5759
Created JabRef logo as tiff for Mac OS installer (retina support). Tiff file for installer and it's png images:
masOS install images.zip

Settings for icons in Mac dmg install package:

• JabRef & Applications icons are of 84 size (dmg file properties);
• font size of JabRef icon & Applications icon - 12 px;

Comments

• Change in CHANGELOG.md described (if applicable)
• Tests created for changes (if applicable)
• Manually tested changed features in running JabRef (always required)
• Screenshots added in PR description (for UI changes)
• Checked documentation: Is the information available and up to date? If not created an issue at https://github.com/JabRef/user-documentation/issues or, even better, submitted a pull request to the documentation repository.

[tobiasdiez]

Thanks. I think the file needs to be named background_dmg.tiff and be placed in https://github.com/JabRef/jabref/tree/master/buildres/mac

[tobiasdiez]

Thanks!

We run into a strange bug from gitversion which is why the build currently fails. I'll merge now and hope the master branch builds without problem. Can you please check the build from builds.jabref.org/master/ in about 30 min and make sure that the build version looks fine as well (I don't have a mac sadly).

[Gena928]

Good day,
I downloaded pkg and dmg files from your link and starter JabRef. Works fine, it doesn't crashes.

[tobiasdiez]

Perfect. I assume this also means that the dmg installer is shown correctly, right?

[Gena928]

Sorry, but it's still the same.

[tobiasdiez]

There was a problem in the build chain and the build wasn't updated. Can you please retry in 30 min. Thanks

[Siedlerchr]

Probably the same reason why the plist file doesn't get copied. Do we need to specify the resource folder somewhere?

[Gena928]

Hello again,
dmg file is the same. I.e. old design.

[tobiasdiez]

It's only now uploading...you can verify that you are testing the new file by looking at the "Last modified" date on https://builds.jabref.org/master/ (which is currently 2020-04-14)
Progress: https://github.com/JabRef/jabref/runs/597737609

[Siedlerchr]

Refs #5986 I just also pushed the --resource dir for mac switch

[Siedlerchr]

Let's wait the current build. If it works it's fine, otherwise I found this helpful guide:
https://docs.oracle.com/en/java/javase/14/jpackage/override-jpackage-resources.html#GUID-1B718F8B-B68D-4D46-B1DB-003D7729AAB6

[Gena928]

dmg file as of "2020-04-18 15:25" looks the same. I.e. black background color.
If I press Command + Shift + . I can see the content of package, and looks like our new image is not there.

The program works fine.

[Siedlerchr]

I just renamed the file according to the docs. Waiting for the new build.

[Gena928]

2020-04-18 15:58
The same dmg file. I.e. just black background without image.

[Siedlerchr]

I have created an issue at the jlink/jpackage gradle plugin repo:
beryx/badass-jlink-plugin#132

[tobiasdiez]

I think it should be lower case jabref, at least if I read https://github.com/openjdk/jdk/blob/4d487927adb6fa5c206198ed8ee46aa3ab2a526f/src/jdk.incubator.jpackage/macosx/classes/jdk/incubator/jpackage/internal/MacDmgBundler.java#L133-L137 correctly.

[Gena928]

dmg file as of "2020-04-18 22:09".
Looks the same. But when I show hidden files (Command + Shift + .) I see our background image in one of the folders.

A progress )).
Sorry, but I'm afraid I must ask a few questions. Let's say we solved the problem with background. But then:

• how we are going to add "Applications" icon to dmg file?
• how we are going to position JabRef icon & Applications icon?
  Those icons should be carefully positioned on a both sides of the arrow.
• how we are going to increase the size of JabRef icon and Applications icon?
  84 size is required. Otherwise it looks ugly.

I can do it manually, using Mac "Disk Utility", but is it possible to do it automatically?
I'm sorry, if I'm asking those questions too late. I've never done it before.

[tobiasdiez]

The position of the icon is hard-coded here:
https://github.com/openjdk/jdk/blob/master/src/jdk.incubator.jpackage/macosx/classes/jdk/incubator/jpackage/internal/resources/DMGsetup.scpt
So I guess the background needs to be designed around this (unfortunately)

[Siedlerchr]

@Gena928 No problem, this is new for us all. The jpackage tool is relatively new. The idea is relative simple, you provide the icons in the resource folders for the system like background and in the gradle file the locations are specified for each os:
You already have the svg file, so it should be possible to create a 84x84 icns version,

@tobiasdiez We can also modfiy the DMGgsetup script:
Using default package resource DMGsetup.scpt [DMG setup script] (add JabRef-dmg-setup.scpt to the resource-dir to customize).

From the log I saw that we also need images for the pgk build:

 Building PKG package for JabRef.
Using default package resource background_pkg.png [pkg background image] (add JabRef-background.png to the resource-dir to customize).
Using default package resource background_pkg.png [pkg background image] (add JabRef-background-darkAqua.png to the resource-dir to customize).

Using default package resource java.icns [volume icon] (add JabRef-volume.icns to the resource-dir to customize).

jabref/build.gradle

Lines 641 to 693 in 38e3aa7

	if (OperatingSystem.current().isWindows()) {
	// This requires WiX to be installed: https://github.com/wixtoolset/wix3/releases
	installerType = "msi"
	imageOptions = [
	'--icon', "${projectDir}/src/main/resources/icons/jabref.ico",
	]
	installerOptions = [
	'--vendor', 'JabRef',
	'--app-version', "${project.version}",
	'--verbose',
	'--win-upgrade-uuid', 'd636b4ee-6f10-451e-bf57-c89656780e36',
	'--win-dir-chooser',
	'--win-shortcut',
	'--temp', "$buildDir/installer",
	'--resource-dir', "${projectDir}/buildres/windows",
	'--file-associations', "${projectDir}/buildres/windows/bibtexAssociations.properties"
	]
	}
	if (OperatingSystem.current().isLinux()) {
	imageOptions = [
	'--icon', "${projectDir}/src/main/resources/icons/JabRef-icon-64.png",
	]
	installerOptions = [
	'--verbose',
	'--vendor', 'JabRef',
	'--app-version', "${project.version}",
	// '--temp', "$buildDir/installer",
	'--resource-dir', "${projectDir}/buildres/linux",
	'--linux-menu-group', 'Office;',
	'--linux-rpm-license-type', 'MIT',
	// '--license-file', "${projectDir}/LICENSE.md",
	'--description', 'JabRef is an open source bibliography reference manager. The native file format used by JabRef is BibTeX, the standard LaTeX bibliography format.',
	'--linux-shortcut',
	'--file-associations', "${projectDir}/buildres/linux/bibtexAssociations.properties"
	]
	}
	if (OperatingSystem.current().isMacOsX()) {
	imageOptions = [
	'--icon', "${projectDir}/src/main/resources/icons/jabref.icns",
	'--resource-dir', "${projectDir}/buildres/mac"
	]
	installerOptions = [
	'--verbose',
	'--vendor', 'JabRef',
	'--app-version', "${project.version}",
	'--file-associations', "${projectDir}/buildres/mac/bibtexAssociations.properties",
	'--resource-dir', "${projectDir}/buildres/mac"
	]
	}
	}