Skip to content

Commit 6383999

Browse files
committed
U improved docs
1 parent ffd5c5c commit 6383999

File tree

1 file changed

+57
-36
lines changed

1 file changed

+57
-36
lines changed

docs/macosx-specific-properties.md

Lines changed: 57 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -3,46 +3,60 @@
33
```xml
44
<macConfig>
55

6-
<!-- general properties -->
7-
<appId>app unique identifier</appId>
8-
<icnsFile>path/to/icon.icns</icnsFile>
9-
<generateDmg>true|false</generateDmg>
10-
<generatePkg>true|false</generatePkg>
11-
<relocateJar>true|false</relocateJar>
12-
13-
<!-- signing properties -->
14-
<developerId>singning identity</developerId>
15-
<entitlements>path/to/entitlements.plist</entitlements>
16-
<codesignApp>true|false</codesignApp>
17-
18-
<!-- properties used in DMG disk image generation -->
19-
<backgroundImage>path/to/png</backgroundImage>
20-
<windowX>x</windowX>
21-
<windowY>y</windowY>
22-
<windowWidth>width</windowWidth>
23-
<windowHeight>height</windowHeight>
24-
<iconSize>size</iconSize>
25-
<textSize>size</textSize>
26-
<iconX>x</iconX>
27-
<iconY>y</iconY>
28-
<appsLinkIconX>x</appsLinkIconX>
29-
<appsLinkIconY>y</appsLinkIconY>
30-
<volumeIcon>path/to/icns</volumeIcon>
31-
<volumeName>${name}</volumeName>
32-
6+
<!-- general properties -->
7+
<appId>app unique identifier</appId>
8+
<icnsFile>path/to/icon.icns</icnsFile>
9+
<generateDmg>true|false</generateDmg>
10+
<generatePkg>true|false</generatePkg>
11+
<relocateJar>true|false</relocateJar>
12+
13+
<!-- signing properties -->
14+
<developerId>singning identity</developerId>
15+
<entitlements>path/to/entitlements.plist</entitlements>
16+
<codesignApp>true|false</codesignApp>
17+
18+
<!-- properties used for DMG disk image generation -->
19+
<backgroundImage>path/to/png</backgroundImage>
20+
<windowX>x</windowX>
21+
<windowY>y</windowY>
22+
<windowWidth>width</windowWidth>
23+
<windowHeight>height</windowHeight>
24+
<iconSize>size</iconSize>
25+
<textSize>size</textSize>
26+
<iconX>x</iconX>
27+
<iconY>y</iconY>
28+
<appsLinkIconX>x</appsLinkIconX>
29+
<appsLinkIconY>y</appsLinkIconY>
30+
<volumeIcon>path/to/icns</volumeIcon>
31+
<volumeName>${name}</volumeName>
32+
33+
<!-- properties used for Info.plist file generation -->
34+
<infoPlist>
35+
<bundlePackageType>BNDL|APPL|FMWK</bundlePackageType>
36+
<additionalEntries>
37+
<![CDATA[
38+
<key>ThisIsABoolean</key>
39+
<true/>
40+
<key>ThisIsAString</key>
41+
<string>value</string>
42+
[...]
43+
]]>
44+
</addtionalEntries>
45+
</infoPlist>
46+
3347
</macConfig>
3448
```
3549

36-
| Property | Mandatory | Default value | Description |
37-
| -------------- | --------- | -------------- | ------------------------------------------------------------ |
38-
| `icnsFile` | :x: | `null` | Icon file. |
39-
| `generateDmg` | :x: | `true` | Enables DMG disk image file generation. |
40-
| `generatePkg` | :x: | `true` | Enables installation package generation. |
50+
| Property | Mandatory | Default value | Description |
51+
| -------------- | --------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------- |
52+
| `icnsFile` | :x: | `null` | Icon file. |
53+
| `generateDmg` | :x: | `true` | Enables DMG disk image file generation. |
54+
| `generatePkg` | :x: | `true` | Enables installation package generation. |
4155
| `relocateJar` | :x: | `true` | If `true`, Jar files are located in `Contents/Resources/Java` folder, otherwise they are located in `Contents/Resources` folder. |
42-
| `appId` | :x: | `${mainClass}` | App unique identifier. |
43-
| `developerId` | :x: | `null` | Signing identity. |
44-
| `entitlements` | :x: | `null` | Path to [entitlements](https://developer.apple.com/documentation/bundleresources/entitlements) file. |
45-
| `codesignApp` | :x: | `true` | If it is set to `false`, generated app will not be codesigned. |
56+
| `appId` | :x: | `${mainClass}` | App unique identifier. |
57+
| `developerId` | :x: | `null` | Signing identity. |
58+
| `entitlements` | :x: | `null` | Path to [entitlements](https://developer.apple.com/documentation/bundleresources/entitlements) file. |
59+
| `codesignApp` | :x: | `true` | If it is set to `false`, generated app will not be codesigned. |
4660

4761
## DMG generation properties
4862

@@ -63,3 +77,10 @@
6377
| `volumeName` | :x: | `${displayName}` | Volume name *(:warning: whitespaces are removed)*. |
6478

6579
![DMG properties explained](dmg-properties-explained.png)
80+
81+
## Info.plist generation properties
82+
83+
| Property | Mandatory | Default value | Description |
84+
| ------------------- | --------- | ------------- | ------------------------------------------- |
85+
| `bundlePackageType` | :x: | BNDL | Bundle package type: BNDL, APPL, FMWK. |
86+
| `additionalEntries` | :x: | `""` | String with `Info.plist`additional entries. |

0 commit comments

Comments
 (0)