Skip to content

Commit b1bf6f2

Browse files
laim2003hohwille
laim2003
and
hohwille
authored
#1227 Added more detailed setup instructions to MSI installer (#2094)
Co-authored-by: Jörg Hohwiller <hohwille@users.noreply.github.com>
1 parent 3c2f6c0 commit b1bf6f2

6 files changed

Lines changed: 42 additions & 6 deletions

File tree

‎.github/workflows/release.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ jobs:
5858
dotnet tool install --global wix --version 5.0.2
5959
wix extension add WixToolset.UI.wixext/5.0.2
6060
wix extension add WixToolset.Util.wixext/5.0.2
61-
wix build Package.wxs WixUI_IDEasySetup.wxs -loc Package.en-us.wxl -ext WixToolset.UI.wixext -ext WixToolset.Util.wixext -o ideasy.msi
61+
wix build Package.wxs WixUI_IDEasySetup.wxs WixUI_FirstStepsDlg.wxs -loc Package.en-us.wxl -ext WixToolset.UI.wixext -ext WixToolset.Util.wixext -o ideasy.msi
6262
- name: Upload unsigned MSI
6363
if: runner.os == 'Windows'
6464
id: upload-msi

‎CHANGELOG.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ Release with new features and bugfixes:
88

99
* https://github.com/devonfw/IDEasy/issues/1056[#1056]: Improve MSI license display by generating formatted RTF from AsciiDoc
1010
* https://github.com/devonfw/IDEasy/issues/2052[#2052]: Split issue statistics in 2 pie-charts
11-
* https://github.com/devonfw/IDEasy/issues/822[#822] : Added Cwd path limit in shell
11+
* https://github.com/devonfw/IDEasy/issues/822[#822]: Added Cwd path limit in shell
12+
* https://github.com/devonfw/IDEasy/issues/1227[#1227]: Added Setup instrcutions to the Windows installer
1213

1314
The full list of changes for this release can be found in https://github.com/devonfw/IDEasy/milestone/46?closed=1[milestone 2026.07.001].
1415

‎windows-installer/Package.en-us.wxl‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,10 @@ This file contains the declaration of all the localizable strings.
1313
<String Id="SelectInstallLocationText" Value="Select your preferred installation location:"/>
1414
<String Id="InstallUserHomeOption" Value="Install in Home Directory - [USERFOLDER]projects"/>
1515
<String Id="InstallCustomOption" Value="Install in Custom Directory - e.g., [ROOTDRIVE]projects"/>
16+
<String Id="ExitDialogTitle" Value="{\WixUI_Font_Title}IDEasy Installed Successfully" />
17+
<String Id="FirstStepsDlg_Title" Value="[ProductName] Setup" />
18+
<String Id="FirstStepsDlgTitle" Value="{\WixUI_Font_Title}First Steps" />
19+
<String Id="FirstStepsDlgDescription" Value="Follow these steps to get started with IDEasy." />
20+
<String Id="OpenDocumentationBtn" Value="Open Documentation" />
21+
<String Id="IntroductoryMessage" Value="Thank you for using IDEasy.&#xA;&#xA;Open a new terminal and run the following commands:&#xA;&#xA; Create your first project:&#xA; ide create &lt;project-name&gt;&#xA;&#xA; Or view the full list of available commands:&#xA; ide help&#xA;&#xA;Click 'Open Documentation' for more detailed setup instructions." />
1622
</WixLocalization>

‎windows-installer/Package.wxs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,10 @@
7070
<Custom Action='RunUninstallAction' Condition="Installed AND NOT UPGRADINGPRODUCTCODE" After="InstallInitialize" />
7171
</InstallExecuteSequence>
7272

73+
<!-- Open documentation URL from FirstStepsDialog -->
74+
<Property Id="WixShellExecTarget" Value="https://github.com/devonfw/IDEasy/blob/main/documentation/setup.adoc" />
75+
<CustomAction Id="OpenDocumentationAction" BinaryRef="Wix4UtilCA_X64" DllEntry="WixShellExec" Execute="immediate" Return="ignore" />
76+
7377
<!-- Custom UI Reference -->
7478
<ui:WixUI Id="WixUI_InstallDirCustom" InstallDirectory="INSTALLFOLDER" />
7579
</Package>

‎windows-installer/WixUI_FirstStepsDlg.wxs‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
2+
<Fragment>
3+
<UI>
4+
<Dialog Id="FirstStepsDialog" Width="370" Height="270" Title="!(loc.FirstStepsDlg_Title)">
5+
6+
<!-- Header -->
7+
<Control Id="BannerBitmap" Type="Bitmap" X="0" Y="0" Width="370" Height="44" TabSkip="no" Text="!(loc.InstallDirDlgBannerBitmap)" />
8+
<Control Id="BannerLine" Type="Line" X="0" Y="44" Width="370" Height="0" />
9+
<Control Id="Title" Type="Text" X="15" Y="6" Width="200" Height="15" Transparent="yes" NoPrefix="yes" Text="!(loc.FirstStepsDlgTitle)" />
10+
<Control Id="Description" Type="Text" X="25" Y="23" Width="280" Height="15" Transparent="yes" NoPrefix="yes" Text="!(loc.FirstStepsDlgDescription)" />
11+
12+
<!-- Content: setup instructions -->
13+
<Control Id="Instructions" Type="Text" X="20" Y="55" Width="330" Height="170" NoPrefix="no" Text="!(loc.IntroductoryMessage)" />
14+
15+
<!-- Footer -->
16+
<Control Id="BottomLine" Type="Line" X="0" Y="234" Width="370" Height="0" />
17+
<Control Id="OpenDocumentation" Type="PushButton" X="20" Y="243" Width="110" Height="17" Text="!(loc.OpenDocumentationBtn)">
18+
<Publish Event="DoAction" Value="OpenDocumentationAction" />
19+
</Control>
20+
<Control Id="Finish" Type="PushButton" X="236" Y="243" Width="56" Height="17" Default="yes" Text="!(loc.WixUIFinish)" />
21+
</Dialog>
22+
</UI>
23+
</Fragment>
24+
</Wix>

‎windows-installer/WixUI_IDEasySetup.wxs‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@
2727
<DialogRef Id="ProgressDlg" />
2828
<DialogRef Id="ResumeDlg" />
2929
<DialogRef Id="UserExit" />
30+
<DialogRef Id="FirstStepsDialog" />
3031

31-
<Publish Dialog="ExitDialog" Control="Finish" Event="EndDialog" Value="Return" Order="999" />
32+
<Publish Dialog="ExitDialog" Control="Finish" Event="NewDialog" Value="FirstStepsDialog" Order="999" />
3233

3334
<Publish Dialog="WelcomeDlg" Control="Next" Event="NewDialog" Value="LicenseAgreementDlg" Condition="NOT Installed" />
3435
<Publish Dialog="WelcomeDlg" Control="Next" Event="NewDialog" Value="VerifyReadyDlg" Condition="Installed AND PATCH" />
@@ -38,7 +39,7 @@
3839

3940
<Publish Dialog="InstallPathDlg" Control="Back" Event="NewDialog" Value="LicenseAgreementDlg" />
4041
<Publish Dialog="InstallPathDlg" Control="Next" Event="NewDialog" Value="VerifyReadyDlg" Order="2" />
41-
42+
4243
<Publish Dialog="VerifyReadyDlg" Control="Back" Event="NewDialog" Value="InstallPathDlg" Order="1" Condition="NOT Installed" />
4344
<Publish Dialog="VerifyReadyDlg" Control="Back" Event="NewDialog" Value="MaintenanceTypeDlg" Order="2" Condition="Installed AND NOT PATCH" />
4445
<Publish Dialog="VerifyReadyDlg" Control="Back" Event="NewDialog" Value="WelcomeDlg" Order="2" Condition="Installed AND PATCH" />
@@ -48,16 +49,16 @@
4849
<Publish Dialog="MaintenanceTypeDlg" Control="RemoveButton" Event="NewDialog" Value="VerifyReadyDlg" />
4950
<Publish Dialog="MaintenanceTypeDlg" Control="Back" Event="NewDialog" Value="MaintenanceWelcomeDlg" />
5051

52+
<Publish Dialog="FirstStepsDialog" Control="Finish" Event="EndDialog" Value="Return" Order="999" />
53+
5154
<Property Id="ARPNOMODIFY" Value="1" />
52-
5355
</UI>
5456

5557
<UIRef Id="WixUI_Common" />
5658
</Fragment>
5759

5860
<Fragment>
5961
<UI>
60-
6162
<Dialog Id="InstallPathDlg" Width="370" Height="270" Title="!(loc.InstallPathDlg_Title)">
6263

6364
<Control Id="Description" Type="Text" X="25" Y="23" Width="280" Height="15" Transparent="yes" NoPrefix="yes" Text="!(loc.InstallPathDlgDescription)" />

0 commit comments

Comments
 (0)