diff options
Diffstat (limited to 'src/xsd')
-rw-r--r-- | src/xsd/util.xsd | 52 | ||||
-rw-r--r-- | src/xsd/wix.xsd | 73 |
2 files changed, 111 insertions, 14 deletions
diff --git a/src/xsd/util.xsd b/src/xsd/util.xsd index 1b649f48..c0a9e44a 100644 --- a/src/xsd/util.xsd +++ b/src/xsd/util.xsd | |||
@@ -701,19 +701,18 @@ | |||
701 | 701 | ||
702 | <xs:element name="Group"> | 702 | <xs:element name="Group"> |
703 | <xs:annotation> | 703 | <xs:annotation> |
704 | <xs:documentation>Group for all kinds of (usergroup) things. When it is not nested under a component it is included in the MSI so it can be referenced by other elements such as the GroupRef element under a User element (to add the User to the Group). When it is nested under a Component element, the Group will be created on install and can also be used for reference.</xs:documentation> | ||
704 | <xs:appinfo> | 705 | <xs:appinfo> |
706 | <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Component" /> | ||
705 | <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Fragment" /> | 707 | <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Fragment" /> |
706 | <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Module" /> | 708 | <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Module" /> |
707 | <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Package" /> | 709 | <xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Package" /> |
710 | <xse:seeAlso ref="GroupRef" /> | ||
708 | </xs:appinfo> | 711 | </xs:appinfo> |
709 | <xs:documentation> | ||
710 | Finds user groups on the local machine or specified Active Directory domain. The local machine will be | ||
711 | searched for the group first then fallback to looking in Active Directory. This element is not capable | ||
712 | of creating new groups but can be used to add new or existing users to an existing group. | ||
713 | </xs:documentation> | ||
714 | </xs:annotation> | 712 | </xs:annotation> |
715 | <xs:complexType> | 713 | <xs:complexType> |
716 | <xs:choice minOccurs="0" maxOccurs="unbounded"> | 714 | <xs:choice minOccurs="0" maxOccurs="unbounded"> |
715 | <xs:element ref="GroupRef" minOccurs="0" maxOccurs="unbounded" /> | ||
717 | <xs:any namespace="##other" processContents="lax"> | 716 | <xs:any namespace="##other" processContents="lax"> |
718 | <xs:annotation> | 717 | <xs:annotation> |
719 | <xs:documentation> | 718 | <xs:documentation> |
@@ -730,7 +729,7 @@ | |||
730 | </xs:attribute> | 729 | </xs:attribute> |
731 | <xs:attribute name="Name" type="xs:string" use="required"> | 730 | <xs:attribute name="Name" type="xs:string" use="required"> |
732 | <xs:annotation> | 731 | <xs:annotation> |
733 | <xs:documentation>A [Formatted](https://learn.microsoft.com/en-us/windows/win32/msi/formatted) string that contains the name of the group to be found.</xs:documentation> | 732 | <xs:documentation>A [Formatted](https://learn.microsoft.com/en-us/windows/win32/msi/formatted) string that contains the name of the group.</xs:documentation> |
734 | </xs:annotation> | 733 | </xs:annotation> |
735 | </xs:attribute> | 734 | </xs:attribute> |
736 | <xs:attribute name="Domain" type="xs:string"> | 735 | <xs:attribute name="Domain" type="xs:string"> |
@@ -738,6 +737,41 @@ | |||
738 | <xs:documentation>An optional [Formatted](https://learn.microsoft.com/en-us/windows/win32/msi/formatted) string that specifies the domain for the group.</xs:documentation> | 737 | <xs:documentation>An optional [Formatted](https://learn.microsoft.com/en-us/windows/win32/msi/formatted) string that specifies the domain for the group.</xs:documentation> |
739 | </xs:annotation> | 738 | </xs:annotation> |
740 | </xs:attribute> | 739 | </xs:attribute> |
740 | <xs:attribute name="RemoveOnUninstall" type="wxs:YesNoTypeUnion"> | ||
741 | <xs:annotation> | ||
742 | <xs:documentation>Indicates whether the group should be removed or left behind on uninstall.</xs:documentation> | ||
743 | </xs:annotation> | ||
744 | </xs:attribute> | ||
745 | <xs:attribute name="FailIfExists" type="wxs:YesNoTypeUnion"> | ||
746 | <xs:annotation> | ||
747 | <xs:documentation>Indicates if the install should fail if the group already exists.</xs:documentation> | ||
748 | </xs:annotation> | ||
749 | </xs:attribute> | ||
750 | <xs:attribute name="UpdateIfExists" type="wxs:YesNoTypeUnion"> | ||
751 | <xs:annotation> | ||
752 | <xs:documentation>Indicates if the group properties should be updated if the group already exists.</xs:documentation> | ||
753 | </xs:annotation> | ||
754 | </xs:attribute> | ||
755 | <xs:attribute name="CreateGroup" type="wxs:YesNoTypeUnion"> | ||
756 | <xs:annotation> | ||
757 | <xs:documentation>Indicates whether or not to create the group. Group creation can be skipped if all that is desired is to add group memberships.</xs:documentation> | ||
758 | </xs:annotation> | ||
759 | </xs:attribute> | ||
760 | <xs:attribute name="Vital" type="wxs:YesNoTypeUnion"> | ||
761 | <xs:annotation> | ||
762 | <xs:documentation>Indicates whether failure to create the group or add the group to another group fails the installation. The default value is "yes".</xs:documentation> | ||
763 | </xs:annotation> | ||
764 | </xs:attribute> | ||
765 | <xs:attribute name="Comment" type="xs:string"> | ||
766 | <xs:annotation> | ||
767 | <xs:documentation>Optional comment to set on the group.</xs:documentation> | ||
768 | </xs:annotation> | ||
769 | </xs:attribute> | ||
770 | <xs:attribute name="RemoveComment" type="wxs:YesNoTypeUnion"> | ||
771 | <xs:annotation> | ||
772 | <xs:documentation>Indicates whether remove the comment from the group. The default value is "no".</xs:documentation> | ||
773 | </xs:annotation> | ||
774 | </xs:attribute> | ||
741 | <xs:anyAttribute namespace="##other" processContents="lax"> | 775 | <xs:anyAttribute namespace="##other" processContents="lax"> |
742 | <xs:annotation> | 776 | <xs:annotation> |
743 | <xs:documentation> | 777 | <xs:documentation> |
@@ -751,7 +785,7 @@ | |||
751 | 785 | ||
752 | <xs:element name="GroupRef"> | 786 | <xs:element name="GroupRef"> |
753 | <xs:annotation> | 787 | <xs:annotation> |
754 | <xs:documentation>Used to join a user to a group</xs:documentation> | 788 | <xs:documentation>Used to join a user / group to a group</xs:documentation> |
755 | </xs:annotation> | 789 | </xs:annotation> |
756 | <xs:complexType> | 790 | <xs:complexType> |
757 | <xs:choice minOccurs="0" maxOccurs="unbounded"> | 791 | <xs:choice minOccurs="0" maxOccurs="unbounded"> |
@@ -1853,12 +1887,12 @@ | |||
1853 | <xs:attribute name="Id" type="xs:string" /> | 1887 | <xs:attribute name="Id" type="xs:string" /> |
1854 | <xs:attribute name="Name" type="xs:string" use="required"> | 1888 | <xs:attribute name="Name" type="xs:string" use="required"> |
1855 | <xs:annotation> | 1889 | <xs:annotation> |
1856 | <xs:documentation>A [Formatted])(https://learn.microsoft.com/en-us/windows/win32/msi/formatted) string that contains the name of the user account.</xs:documentation> | 1890 | <xs:documentation>A [Formatted](https://learn.microsoft.com/en-us/windows/win32/msi/formatted) string that contains the name of the user account.</xs:documentation> |
1857 | </xs:annotation> | 1891 | </xs:annotation> |
1858 | </xs:attribute> | 1892 | </xs:attribute> |
1859 | <xs:attribute name="Domain" type="xs:string"> | 1893 | <xs:attribute name="Domain" type="xs:string"> |
1860 | <xs:annotation> | 1894 | <xs:annotation> |
1861 | <xs:documentation>A [Formatted])(https://learn.microsoft.com/en-us/windows/win32/msi/formatted) string that contains the local machine or Active Directory domain for the user.</xs:documentation> | 1895 | <xs:documentation>A [Formatted](https://learn.microsoft.com/en-us/windows/win32/msi/formatted) string that contains the local machine or Active Directory domain for the user.</xs:documentation> |
1862 | </xs:annotation> | 1896 | </xs:annotation> |
1863 | </xs:attribute> | 1897 | </xs:attribute> |
1864 | <xs:attribute name="Password" type="xs:string"> | 1898 | <xs:attribute name="Password" type="xs:string"> |
diff --git a/src/xsd/wix.xsd b/src/xsd/wix.xsd index 4229352c..165f76e3 100644 --- a/src/xsd/wix.xsd +++ b/src/xsd/wix.xsd | |||
@@ -87,6 +87,7 @@ | |||
87 | <xs:element ref="Log" minOccurs="0" maxOccurs="1" /> | 87 | <xs:element ref="Log" minOccurs="0" maxOccurs="1" /> |
88 | <xs:element ref="PayloadGroup" /> | 88 | <xs:element ref="PayloadGroup" /> |
89 | <xs:element ref="PayloadGroupRef" /> | 89 | <xs:element ref="PayloadGroupRef" /> |
90 | <xs:element ref="Payloads" /> | ||
90 | <xs:element ref="RelatedBundle" /> | 91 | <xs:element ref="RelatedBundle" /> |
91 | <xs:element ref="Requires" /> | 92 | <xs:element ref="Requires" /> |
92 | <xs:element ref="SetVariable" /> | 93 | <xs:element ref="SetVariable" /> |
@@ -187,7 +188,7 @@ | |||
187 | <xs:attribute name="Id" type="xs:string"> | 188 | <xs:attribute name="Id" type="xs:string"> |
188 | <xs:annotation> | 189 | <xs:annotation> |
189 | <xs:documentation> | 190 | <xs:documentation> |
190 | _New in WiX v6: WiX v6 adds this attribute to the `Package` element._ | 191 | _New in WiX v6: WiX v6 adds this attribute to the `Bundle` element._ |
191 | A globally unique identiifer for the bundle in the world. It is recommended to use a prefix such as "CompanyName." to | 192 | A globally unique identiifer for the bundle in the world. It is recommended to use a prefix such as "CompanyName." to |
192 | create a namespace of sorts. By default, higher versioned upgrade lower versioned bundles with the same Id. Use this | 193 | create a namespace of sorts. By default, higher versioned upgrade lower versioned bundles with the same Id. Use this |
193 | attribute instead of the UpgradeCode attribute in new development. | 194 | attribute instead of the UpgradeCode attribute in new development. |
@@ -462,6 +463,7 @@ | |||
462 | <xs:element ref="BootstrapperApplicationDll" minOccurs="0" maxOccurs="1" /> | 463 | <xs:element ref="BootstrapperApplicationDll" minOccurs="0" maxOccurs="1" /> |
463 | <xs:element ref="Payload" /> | 464 | <xs:element ref="Payload" /> |
464 | <xs:element ref="PayloadGroupRef" /> | 465 | <xs:element ref="PayloadGroupRef" /> |
466 | <xs:element ref="Payloads" /> | ||
465 | <xs:any namespace="##other" processContents="lax"> | 467 | <xs:any namespace="##other" processContents="lax"> |
466 | <xs:annotation> | 468 | <xs:annotation> |
467 | <xs:documentation> | 469 | <xs:documentation> |
@@ -524,6 +526,7 @@ | |||
524 | <xs:choice minOccurs="0" maxOccurs="unbounded"> | 526 | <xs:choice minOccurs="0" maxOccurs="unbounded"> |
525 | <xs:element ref="Payload" /> | 527 | <xs:element ref="Payload" /> |
526 | <xs:element ref="PayloadGroupRef" /> | 528 | <xs:element ref="PayloadGroupRef" /> |
529 | <xs:element ref="Payloads" /> | ||
527 | <xs:any namespace="##other" processContents="lax"> | 530 | <xs:any namespace="##other" processContents="lax"> |
528 | <xs:annotation> | 531 | <xs:annotation> |
529 | <xs:documentation> | 532 | <xs:documentation> |
@@ -666,6 +669,7 @@ | |||
666 | <xs:choice minOccurs="0" maxOccurs="unbounded"> | 669 | <xs:choice minOccurs="0" maxOccurs="unbounded"> |
667 | <xs:element ref="Payload" /> | 670 | <xs:element ref="Payload" /> |
668 | <xs:element ref="PayloadGroupRef" /> | 671 | <xs:element ref="PayloadGroupRef" /> |
672 | <xs:element ref="Payloads" /> | ||
669 | <xs:any namespace="##other" processContents="lax"> | 673 | <xs:any namespace="##other" processContents="lax"> |
670 | <xs:annotation> | 674 | <xs:annotation> |
671 | <xs:documentation> | 675 | <xs:documentation> |
@@ -934,6 +938,7 @@ | |||
934 | <xs:element ref="SlipstreamMsp" /> | 938 | <xs:element ref="SlipstreamMsp" /> |
935 | <xs:element ref="Payload" /> | 939 | <xs:element ref="Payload" /> |
936 | <xs:element ref="PayloadGroupRef" /> | 940 | <xs:element ref="PayloadGroupRef" /> |
941 | <xs:element ref="Payloads" /> | ||
937 | <xs:element ref="MsiPackagePayload" /> | 942 | <xs:element ref="MsiPackagePayload" /> |
938 | <xs:element ref="Provides" /> | 943 | <xs:element ref="Provides" /> |
939 | <xs:any namespace="##other" processContents="lax"> | 944 | <xs:any namespace="##other" processContents="lax"> |
@@ -998,6 +1003,7 @@ | |||
998 | <xs:element ref="MsiProperty" /> | 1003 | <xs:element ref="MsiProperty" /> |
999 | <xs:element ref="Payload" /> | 1004 | <xs:element ref="Payload" /> |
1000 | <xs:element ref="PayloadGroupRef" /> | 1005 | <xs:element ref="PayloadGroupRef" /> |
1006 | <xs:element ref="Payloads" /> | ||
1001 | <xs:element ref="MspPackagePayload" /> | 1007 | <xs:element ref="MspPackagePayload" /> |
1002 | <xs:element ref="Provides" /> | 1008 | <xs:element ref="Provides" /> |
1003 | <xs:any namespace="##other" processContents="lax"> | 1009 | <xs:any namespace="##other" processContents="lax"> |
@@ -1045,6 +1051,7 @@ | |||
1045 | <xs:choice minOccurs="0" maxOccurs="unbounded"> | 1051 | <xs:choice minOccurs="0" maxOccurs="unbounded"> |
1046 | <xs:element ref="Payload" /> | 1052 | <xs:element ref="Payload" /> |
1047 | <xs:element ref="PayloadGroupRef" /> | 1053 | <xs:element ref="PayloadGroupRef" /> |
1054 | <xs:element ref="Payloads" /> | ||
1048 | <xs:element ref="MsuPackagePayload" /> | 1055 | <xs:element ref="MsuPackagePayload" /> |
1049 | <xs:element ref="Provides" /> | 1056 | <xs:element ref="Provides" /> |
1050 | <xs:any namespace="##other" processContents="lax"> | 1057 | <xs:any namespace="##other" processContents="lax"> |
@@ -1081,6 +1088,7 @@ | |||
1081 | <xs:choice minOccurs="0" maxOccurs="unbounded"> | 1088 | <xs:choice minOccurs="0" maxOccurs="unbounded"> |
1082 | <xs:element ref="Payload" /> | 1089 | <xs:element ref="Payload" /> |
1083 | <xs:element ref="PayloadGroupRef" /> | 1090 | <xs:element ref="PayloadGroupRef" /> |
1091 | <xs:element ref="Payloads" /> | ||
1084 | <xs:element ref="ExePackagePayload" /> | 1092 | <xs:element ref="ExePackagePayload" /> |
1085 | <xs:element ref="ExitCode" /> | 1093 | <xs:element ref="ExitCode" /> |
1086 | <xs:element ref="CommandLine" /> | 1094 | <xs:element ref="CommandLine" /> |
@@ -1169,6 +1177,7 @@ | |||
1169 | <xs:choice minOccurs="0" maxOccurs="unbounded"> | 1177 | <xs:choice minOccurs="0" maxOccurs="unbounded"> |
1170 | <xs:element ref="Payload" /> | 1178 | <xs:element ref="Payload" /> |
1171 | <xs:element ref="PayloadGroupRef" /> | 1179 | <xs:element ref="PayloadGroupRef" /> |
1180 | <xs:element ref="Payloads" /> | ||
1172 | <xs:element ref="BundlePackagePayload" /> | 1181 | <xs:element ref="BundlePackagePayload" /> |
1173 | <xs:element ref="ExitCode" /> | 1182 | <xs:element ref="ExitCode" /> |
1174 | <xs:element ref="CommandLine" /> | 1183 | <xs:element ref="CommandLine" /> |
@@ -1930,6 +1939,7 @@ | |||
1930 | <xs:element ref="MsuPackagePayload" /> | 1939 | <xs:element ref="MsuPackagePayload" /> |
1931 | <xs:element ref="Payload" /> | 1940 | <xs:element ref="Payload" /> |
1932 | <xs:element ref="PayloadGroupRef" /> | 1941 | <xs:element ref="PayloadGroupRef" /> |
1942 | <xs:element ref="Payloads" /> | ||
1933 | </xs:choice> | 1943 | </xs:choice> |
1934 | <xs:attribute name="Id" type="xs:string" use="required"> | 1944 | <xs:attribute name="Id" type="xs:string" use="required"> |
1935 | <xs:annotation> | 1945 | <xs:annotation> |
@@ -8973,10 +8983,10 @@ | |||
8973 | </xs:anyAttribute> | 8983 | </xs:anyAttribute> |
8974 | </xs:complexType> | 8984 | </xs:complexType> |
8975 | </xs:element> | 8985 | </xs:element> |
8976 | <xs:element name="Files"> | 8986 | <xs:element name="Payloads"> |
8977 | <xs:annotation> | 8987 | <xs:annotation> |
8978 | <xs:documentation> | 8988 | <xs:documentation> |
8979 | Authoring to define the set of files to be harvested for inclusion in a package. | 8989 | Authoring to define the set of files to be harvested for inclusion in a bundle. |
8980 | </xs:documentation> | 8990 | </xs:documentation> |
8981 | </xs:annotation> | 8991 | </xs:annotation> |
8982 | <xs:complexType> | 8992 | <xs:complexType> |
@@ -9011,6 +9021,59 @@ | |||
9011 | </xs:documentation> | 9021 | </xs:documentation> |
9012 | </xs:annotation> | 9022 | </xs:annotation> |
9013 | </xs:attribute> | 9023 | </xs:attribute> |
9024 | <xs:anyAttribute namespace="##other" processContents="lax"> | ||
9025 | <xs:annotation> | ||
9026 | <xs:documentation> | ||
9027 | Extensibility point in the WiX XML Schema. Schema extensions can register additional | ||
9028 | attributes at this point in the schema. | ||
9029 | </xs:documentation> | ||
9030 | </xs:annotation> | ||
9031 | </xs:anyAttribute> | ||
9032 | </xs:complexType> | ||
9033 | </xs:element> | ||
9034 | <xs:element name="Files"> | ||
9035 | <xs:annotation> | ||
9036 | <xs:documentation> | ||
9037 | Authoring to define the set of files to be harvested for inclusion in a package. | ||
9038 | </xs:documentation> | ||
9039 | </xs:annotation> | ||
9040 | <xs:complexType> | ||
9041 | <xs:choice minOccurs="0" maxOccurs="unbounded"> | ||
9042 | <xs:element ref="Exclude" /> | ||
9043 | <xs:any namespace="##other" processContents="lax"> | ||
9044 | <xs:annotation> | ||
9045 | <xs:documentation> | ||
9046 | Extensibility point in the WiX XML Schema. Schema extensions can register additional | ||
9047 | elements at this point in the schema. | ||
9048 | </xs:documentation> | ||
9049 | </xs:annotation> | ||
9050 | </xs:any> | ||
9051 | </xs:choice> | ||
9052 | <xs:attribute name="Include" type="xs:string" use="required"> | ||
9053 | <xs:annotation> | ||
9054 | <xs:documentation> | ||
9055 | A file-selection pattern that can include directory names, file names, and wildcards. | ||
9056 | |||
9057 | We recommend that patterns be fully-qualified, absolute paths, | ||
9058 | preferably via named bind path. You can also use preprocessor | ||
9059 | variables or unnamed bind paths to create absolute paths. | ||
9060 | |||
9061 | If the pattern is a relative path, it is interpreted as relative to either: | ||
9062 | - an unnamed bind path, if one or more is specified. | ||
9063 | - the source directory of the file containing the `Files` element, if no unnamed bind paths are specified. | ||
9064 | |||
9065 | Wildcards include typical `*.ext` globs and MSBuild-style `**` globs to indicate | ||
9066 | that directories should be recursed. Examples include: | ||
9067 | |||
9068 | | Pattern | Description | | ||
9069 | | ------- | ----------- | | ||
9070 | | `!(bindpath.ToBeHarvested)\**` | All files in the parent directory identified by the `ToBeHarvested` bind path and its subdirectories. | | ||
9071 | | `$(PayloadFiles)\bin\Release\**` | All files in the `bin\Release` subdirectory in the directory named by the `PayloadFiles` preprocessor variable and its subdirectories. | | ||
9072 | | `!(bindpath.arm64)\**.pdb` | All files with `.pdb` extension in the parent directory identified by the `arm64` bind path and its subdirectories. | | ||
9073 | | `**` | If an unnamed bind path was specified, all files in that directory and its subdirectories. If an unnamed bind path was _not_ specified, all files in directory of the source .wxs file and its subdirectories. | | ||
9074 | </xs:documentation> | ||
9075 | </xs:annotation> | ||
9076 | </xs:attribute> | ||
9014 | <xs:attribute name="Directory" type="xs:string"> | 9077 | <xs:attribute name="Directory" type="xs:string"> |
9015 | <xs:annotation> | 9078 | <xs:annotation> |
9016 | <xs:documentation> | 9079 | <xs:documentation> |
@@ -9040,7 +9103,7 @@ | |||
9040 | <xs:element name="Exclude"> | 9103 | <xs:element name="Exclude"> |
9041 | <xs:annotation> | 9104 | <xs:annotation> |
9042 | <xs:documentation> | 9105 | <xs:documentation> |
9043 | Using wildcards, defines the files from a parent `Files` element that should be excluded from harvesting. | 9106 | Using wildcards, defines the files from a parent `Files` or `Payloads` element that should be excluded from harvesting. |
9044 | </xs:documentation> | 9107 | </xs:documentation> |
9045 | </xs:annotation> | 9108 | </xs:annotation> |
9046 | <xs:complexType> | 9109 | <xs:complexType> |
@@ -9057,7 +9120,7 @@ | |||
9057 | <xs:attribute name="Files" type="xs:string" use="required"> | 9120 | <xs:attribute name="Files" type="xs:string" use="required"> |
9058 | <xs:annotation> | 9121 | <xs:annotation> |
9059 | <xs:documentation> | 9122 | <xs:documentation> |
9060 | Excludes files from the set of files harvested via the parent `Files` element. | 9123 | Excludes files from the set of files harvested via the parent `Files` or `Payloads` element. |
9061 | Inclusion and exclusion wildcards must match paths. For example, if you have a | 9124 | Inclusion and exclusion wildcards must match paths. For example, if you have a |
9062 | `Files` element with `Include="!(bindpath.ToBeHarvested)\**"` and want to | 9125 | `Files` element with `Include="!(bindpath.ToBeHarvested)\**"` and want to |
9063 | exclude one of the files, use an `Exclude` element with a `Files` attribute | 9126 | exclude one of the files, use an `Exclude` element with a `Files` attribute |