Skip to content
/ wix Public

XSD improvements #697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
robmen merged 3 commits into from
Mar 5, 2026
Merged

XSD improvements #697

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8c20009
Split XSDs into individual XSD fragments per element and type
robmen Mar 4, 2026
de93eed
Mark Firewall Enabled attribute new to WiX v5
robmen Mar 4, 2026
a55bb54
Remove duplicated project
robmen Mar 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 0 additions & 2 deletions src/ext/Bal/bal_t.proj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@

<ProjectReference Include="test\examples\examples.proj" />

<ProjectReference Include="test\WixToolsetTest.BootstrapperApplications\WixToolsetTest.BootstrapperApplications.csproj" />

<!--
Currently there are no unskipped unit tests in this project. Should that change,
we'll need to update the native test framework or figure out something else.
Expand Down
760 changes: 0 additions & 760 deletions src/xsd/bal.xsd
View file
Open in desktop

This file was deleted.

15 changes: 15 additions & 0 deletions src/xsd/bal/BAFactoryAssembly.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<attribute name="BAFactoryAssembly" type="wxs:YesNoTypeUnion" version="4" deprecated="true">
<annotation>
<documentation>
When set to "yes", WixDotNetCoreBootstrapperApplicationHost will load the DLL and instantiate the type with the BootstrapperApplicationFactoryAttribute.
The DLL must have been built referencing the WixToolset.Dnc.HostGenerator source generator NuGet package.
The .NET Core project must have been published, not just built.
Only one payload may be marked with this attribute set to "yes".

_In WiX v5, move the Payload/@SourceFile attribute to be the BootstrapperApplication/@SourceFile attribute and remove the Payload element._
</documentation>
<appinfo>
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Payload" />
</appinfo>
</annotation>
</attribute>
11 changes: 11 additions & 0 deletions src/xsd/bal/BAFunctions.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<attribute name="BAFunctions" type="wxs:YesNoTypeUnion">
<annotation>
<documentation>
When set to "yes", WixStdBA will load the DLL and work with it to handle BA messages.
Only one payload may be marked with this attribute set to "yes".
</documentation>
<appinfo>
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Payload" />
</appinfo>
</annotation>
</attribute>
46 changes: 46 additions & 0 deletions src/xsd/bal/BootstrapperApplicationPrerequisiteInformation.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<element name="BootstrapperApplicationPrerequisiteInformation" version="5">
<annotation>
<documentation>
Adds license information for a prereq package, should only be used when unable to add the license attributes to the package directly.
</documentation>
<appinfo>
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Bundle" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Fragment" />
</appinfo>
</annotation>
<complexType>
<choice minOccurs="0" maxOccurs="unbounded">
<any namespace="##other" processContents="lax">
<annotation>
<documentation>
Extensibility point in the WiX XML Schema. Schema extensions can register additional
elements at this point in the schema.
</documentation>
</annotation>
</any>
</choice>
<attribute name="PackageId" type="xs:string" use="required">
<annotation>
<documentation>Id of the target package.</documentation>
</annotation>
</attribute>
<attribute name="LicenseFile" type="xs:string">
<annotation>
<documentation>Source file of the license. May not be used with LicenseUrl.</documentation>
</annotation>
</attribute>
<attribute name="LicenseUrl" type="xs:string">
<annotation>
<documentation>Source url of the license. May not be used with LicenseFile.</documentation>
</annotation>
</attribute>
<anyAttribute namespace="##other" processContents="lax">
<annotation>
<documentation>
Extensibility point in the WiX XML Schema. Schema extensions can register additional
attributes at this point in the schema.
</documentation>
</annotation>
</anyAttribute>
</complexType>
</element>
16 changes: 16 additions & 0 deletions src/xsd/bal/CommandLineVariables.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<attribute name="CommandLineVariables">
<annotation>
<documentation>
This value determines whether case sensitivity is used to match overridable variables specified on the command line. The default is "caseSensitive".
</documentation>
<appinfo>
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Bundle" />
</appinfo>
</annotation>
<simpleType>
<restriction base="xs:NMTOKEN">
<enumeration value="caseSensitive" />
<enumeration value="caseInsensitive" />
</restriction>
</simpleType>
</attribute>
45 changes: 45 additions & 0 deletions src/xsd/bal/Condition.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<element name="Condition">
<annotation>
<documentation>
Conditions for a bundle using WixStdBA.
</documentation>
<appinfo>
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Bundle" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Fragment" />
</appinfo>
</annotation>
<complexType>
<choice minOccurs="0" maxOccurs="unbounded">
<any namespace="##other" processContents="lax">
<annotation>
<documentation>
Extensibility point in the WiX XML Schema. Schema extensions can register additional
elements at this point in the schema.
</documentation>
</annotation>
</any>
</choice>
<attribute name="Message" type="xs:string" use="required">
<annotation>
<documentation>
Set the value to the text to display when the condition fails and the installation must be terminated.
</documentation>
</annotation>
</attribute>
<attribute name="Condition" type="xs:string" use="required">
<annotation>
<documentation>
The condition that must evaluate to true for the installation to continue.
</documentation>
</annotation>
</attribute>
<anyAttribute namespace="##other" processContents="lax">
<annotation>
<documentation>
Extensibility point in the WiX XML Schema. Schema extensions can register additional
attributes at this point in the schema.
</documentation>
</annotation>
</anyAttribute>
</complexType>
</element>
14 changes: 14 additions & 0 deletions src/xsd/bal/DisplayFilesInUseDialogCondition.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<attribute name="DisplayFilesInUseDialogCondition" type="xs:string">
<annotation>
<documentation>
Specifies whether the bundle allows the Files In Use dialog to be displayed for the MSI or MSP package. If not
specified (the default) or the condition evaluates to true, the Files In Use dialog prompts the user during full
bundle UI to close applications to release the file. Otherwise, the dialog is not displayed and the package might
require a restart when files are in use.
</documentation>
<appinfo>
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsiPackage" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MspPackage" />
</appinfo>
</annotation>
</attribute>
14 changes: 14 additions & 0 deletions src/xsd/bal/DisplayInternalUICondition.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<attribute name="DisplayInternalUICondition" type="xs:string">
<annotation>
<documentation>
Specifies whether the bundle will show the UI authored into the msi package. If not specified or the condition evaluates
to false, all information is routed to the bootstrapper application to provide a unified installation experience.
Otherwise, the UI authored into the msi package will be displayed on top of any bootstrapper application UI.
WixStdBA doesn't support EmbeddedUI.
</documentation>
<appinfo>
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsiPackage" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MspPackage" />
</appinfo>
</annotation>
</attribute>
48 changes: 48 additions & 0 deletions src/xsd/bal/ManagedBootstrapperApplicationPrereqInformation.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<element name="ManagedBootstrapperApplicationPrereqInformation" version="4" deprecated="true">
<annotation>
<documentation>
Adds license information for a prereq package, should only be used when unable to add the license attributes to the package directly.

_Deprecated in WiX v5; use BootstrapperApplicationPrerequisiteInformation instead._
</documentation>
<appinfo>
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Bundle" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Fragment" />
</appinfo>
</annotation>
<complexType>
<choice minOccurs="0" maxOccurs="unbounded">
<any namespace="##other" processContents="lax">
<annotation>
<documentation>
Extensibility point in the WiX XML Schema. Schema extensions can register additional
elements at this point in the schema.
</documentation>
</annotation>
</any>
</choice>
<attribute name="PackageId" type="xs:string" use="required">
<annotation>
<documentation>Id of the target package.</documentation>
</annotation>
</attribute>
<attribute name="LicenseFile" type="xs:string">
<annotation>
<documentation>Source file of the license. May not be used with LicenseUrl.</documentation>
</annotation>
</attribute>
<attribute name="LicenseUrl" type="xs:string">
<annotation>
<documentation>Source url of the license. May not be used with LicenseFile.</documentation>
</annotation>
</attribute>
<anyAttribute namespace="##other" processContents="lax">
<annotation>
<documentation>
Extensibility point in the WiX XML Schema. Schema extensions can register additional
attributes at this point in the schema.
</documentation>
</annotation>
</anyAttribute>
</complexType>
</element>
12 changes: 12 additions & 0 deletions src/xsd/bal/Overridable.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<attribute name="Overridable" type="wxs:YesNoTypeUnion">
<annotation>
<documentation>
When set to "yes", lets the user override the variable's default value by specifying another value on the command line,
in the form Variable=Value. Otherwise, WixStdBA won't overwrite the default value and will log
"Ignoring attempt to set non-overridable variable: 'BAR'."
</documentation>
<appinfo>
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Variable" />
</appinfo>
</annotation>
</attribute>
15 changes: 15 additions & 0 deletions src/xsd/bal/PrereqLicenseFile.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<attribute name="PrereqLicenseFile" type="xs:string">
<annotation>
<documentation>
Source file of the RTF license file.
There may only be one package in the bundle that has either the PrereqLicenseFile attribute or the PrereqLicenseUrl attribute.
</documentation>
<appinfo>
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="BundlePackage" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="ExePackage" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsiPackage" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MspPackage" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsuPackage" />
</appinfo>
</annotation>
</attribute>
15 changes: 15 additions & 0 deletions src/xsd/bal/PrereqLicenseUrl.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<attribute name="PrereqLicenseUrl" type="xs:string">
<annotation>
<documentation>
URL target of the license link.
There may only be one package in the bundle that has either the PrereqLicenseFile attribute or the PrereqLicenseUrl attribute.
</documentation>
<appinfo>
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="BundlePackage" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="ExePackage" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsiPackage" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MspPackage" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsuPackage" />
</appinfo>
</annotation>
</attribute>
14 changes: 14 additions & 0 deletions src/xsd/bal/PrereqPackage.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<attribute name="PrereqPackage" type="wxs:YesNoTypeUnion">
<annotation>
<documentation>
When set to "yes", the Prereq BA will plan the package to be installed if its InstallCondition is "true" or empty.
</documentation>
<appinfo>
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="BundlePackage" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="ExePackage" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsiPackage" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MspPackage" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsuPackage" />
</appinfo>
</annotation>
</attribute>
44 changes: 44 additions & 0 deletions src/xsd/bal/PrimaryPackageType.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<attribute name="PrimaryPackageType">
<annotation>
<documentation>Used by WixInternalUIBootstrapperApplication to determine which package is the primary package. The default value is "default".</documentation>
<appinfo>
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="BundlePackage" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="ExePackage" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsiPackage" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MspPackage" />
<parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="MsuPackage" />
</appinfo>
</annotation>
<simpleType>
<restriction base="xs:NMTOKEN">
<enumeration value="default">
<annotation>
<documentation>
This package is used unless there is a package for the runtime machine's architecture.
</documentation>
</annotation>
</enumeration>
<enumeration value="x86">
<annotation>
<documentation>
This package is used when the runtime machine's OS is x86 (IMAGE_FILE_MACHINE_I386).
</documentation>
</annotation>
</enumeration>
<enumeration value="x64">
<annotation>
<documentation>
This package is used when the runtime machine's OS is x64 (IMAGE_FILE_MACHINE_AMD64).
</documentation>
</annotation>
</enumeration>
<enumeration value="arm64">
<annotation>
<documentation>
This package is used when the runtime machine's OS is ARM64 (IMAGE_FILE_MACHINE_ARM64).
</documentation>
</annotation>
</enumeration>
</restriction>
</simpleType>
</attribute>
Loading