Skip to content

Commit 6d6271c

Browse files
FireGiantDocsFireGiantDocs
committed
Update to WiX v6
1 parent 09bff41 commit 6d6271c

File tree

7 files changed

+113
-11
lines changed

7 files changed

+113
-11
lines changed

‎src/content/docs/wix/schema/iis/certificate.mdx‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,15 @@ Used to install and uninstall certificates.
8181
required: true
8282
}}
8383
>
84-
This attribute's value must be one of the following:
84+
This attribute controls which Certificate Store Location will be used for the Certificate.
85+
See [MSDN documentation](https://learn.microsoft.com/en-us/windows/win32/seccrypto/system-store-locations) for more information. This attribute's value must be one of the following:
8586
- *currentUser*
8687
- *localMachine*
88+
- *services*
89+
- *users*
90+
- *userPolicy*
91+
- *localMachinePolicy*
92+
- *localMachineEnterprise*
8793
</BlockReference>
8894

8995
<BlockReference

‎src/content/docs/wix/schema/util/group.mdx‎

Lines changed: 82 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,31 @@ import BlockWrapper from '@components/BlockWrapper.astro';
66
import BlockReference from '@components/BlockReference.astro';
77
import BlockDefList from '@components/BlockDefList.astro';
88

9-
Finds user groups on the local machine or specified Active Directory domain. The local machine will be
10-
searched for the group first then fallback to looking in Active Directory. This element is not capable
11-
of creating new groups but can be used to add new or existing users to an existing group.
9+
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.
1210

1311

1412
## Attributes
1513

1614
<BlockWrapper>
1715

16+
<BlockReference
17+
content={{
18+
title: "Comment",
19+
type: "string"
20+
}}
21+
>
22+
Optional comment to set on the group.
23+
</BlockReference>
24+
25+
<BlockReference
26+
content={{
27+
title: "CreateGroup",
28+
type: "wxs:YesNoTypeUnion"
29+
}}
30+
>
31+
Indicates whether or not to create the group. Group creation can be skipped if all that is desired is to add group memberships.
32+
</BlockReference>
33+
1834
<BlockReference
1935
content={{
2036
title: "Domain",
@@ -24,6 +40,15 @@ Finds user groups on the local machine or specified Active Directory domain. The
2440
An optional [Formatted](https://learn.microsoft.com/en-us/windows/win32/msi/formatted) string that specifies the domain for the group.
2541
</BlockReference>
2642

43+
<BlockReference
44+
content={{
45+
title: "FailIfExists",
46+
type: "wxs:YesNoTypeUnion"
47+
}}
48+
>
49+
Indicates if the install should fail if the group already exists.
50+
</BlockReference>
51+
2752
<BlockReference
2853
content={{
2954
title: "Id",
@@ -40,15 +65,64 @@ Finds user groups on the local machine or specified Active Directory domain. The
4065
required: true
4166
}}
4267
>
43-
A [Formatted](https://learn.microsoft.com/en-us/windows/win32/msi/formatted) string that contains the name of the group to be found.
68+
A [Formatted](https://learn.microsoft.com/en-us/windows/win32/msi/formatted) string that contains the name of the group.
69+
</BlockReference>
70+
71+
<BlockReference
72+
content={{
73+
title: "RemoveComment",
74+
type: "wxs:YesNoTypeUnion"
75+
}}
76+
>
77+
Indicates whether remove the comment from the group. The default value is "no".
78+
</BlockReference>
79+
80+
<BlockReference
81+
content={{
82+
title: "RemoveOnUninstall",
83+
type: "wxs:YesNoTypeUnion"
84+
}}
85+
>
86+
Indicates whether the group should be removed or left behind on uninstall.
87+
</BlockReference>
88+
89+
<BlockReference
90+
content={{
91+
title: "UpdateIfExists",
92+
type: "wxs:YesNoTypeUnion"
93+
}}
94+
>
95+
Indicates if the group properties should be updated if the group already exists.
96+
</BlockReference>
97+
98+
<BlockReference
99+
content={{
100+
title: "Vital",
101+
type: "wxs:YesNoTypeUnion"
102+
}}
103+
>
104+
Indicates whether failure to create the group or add the group to another group fails the installation. The default value is "yes".
44105
</BlockReference>
45106

46107
</BlockWrapper>
47108

109+
## Children
110+
111+
<BlockDefList content={[
112+
{
113+
title: "GroupRef",
114+
link: "../groupref/"
115+
}
116+
]}
117+
/>
48118

49119
## Parents
50120

51121
<BlockDefList content={[
122+
{
123+
title: "Component (Wxs extension)",
124+
link: "../../wxs/component/"
125+
},
52126
{
53127
title: "Fragment (Wxs extension)",
54128
link: "../../wxs/fragment/"
@@ -62,4 +136,7 @@ Finds user groups on the local machine or specified Active Directory domain. The
62136
link: "../../wxs/package/"
63137
}
64138
]}
65-
/>
139+
/>
140+
141+
## See also
142+
[GroupRef](../groupref/)

‎src/content/docs/wix/schema/util/groupref.mdx‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import BlockWrapper from '@components/BlockWrapper.astro';
66
import BlockReference from '@components/BlockReference.astro';
77
import BlockDefList from '@components/BlockDefList.astro';
88

9-
Used to join a user to a group
9+
Used to join a user / group to a group
1010

1111

1212
## Attributes
@@ -29,6 +29,10 @@ Used to join a user to a group
2929
## Parents
3030

3131
<BlockDefList content={[
32+
{
33+
title: "Group",
34+
link: "../group/"
35+
},
3236
{
3337
title: "User",
3438
link: "../user/"

‎src/content/docs/wix/schema/util/user.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ User for all kinds of things. When it is not nested under a component it is incl
5555
type: "string"
5656
}}
5757
>
58-
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.
58+
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.
5959
</BlockReference>
6060

6161
<BlockReference
@@ -101,7 +101,7 @@ User for all kinds of things. When it is not nested under a component it is incl
101101
required: true
102102
}}
103103
>
104-
A [Formatted])(https://learn.microsoft.com/en-us/windows/win32/msi/formatted) string that contains the name of the user account.
104+
A [Formatted](https://learn.microsoft.com/en-us/windows/win32/msi/formatted) string that contains the name of the user account.
105105
</BlockReference>
106106

107107
<BlockReference

‎src/content/docs/wix/schema/wxs/bundle.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ The root element for creating bundled packages.
134134
type: "string"
135135
}}
136136
>
137-
_New in WiX v6: WiX v6 adds this attribute to the `Package` element._
137+
_New in WiX v6: WiX v6 adds this attribute to the `Bundle` element._
138138
A globally unique identiifer for the bundle in the world. It is recommended to use a prefix such as "CompanyName." to
139139
create a namespace of sorts. By default, higher versioned upgrade lower versioned bundles with the same Id. Use this
140140
attribute instead of the UpgradeCode attribute in new development.

‎src/content/docs/wix/schema/wxs/component.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,10 @@ Component for parent Directory
372372
title: "FirewallException (Firewall extension)",
373373
link: "../../firewall/firewallexception/"
374374
},
375+
{
376+
title: "Group (Util extension)",
377+
link: "../../util/group/"
378+
},
375379
{
376380
title: "HarvestFile (Buildtools extension)",
377381
link: "../../buildtools/harvestfile/"

‎src/content/docs/wix/schema/wxs/relatedbundle.mdx‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Defines a related bundle for the parent Bundle.
2828

2929
<BlockReference
3030
content={{
31-
title: "Id",
31+
title: "Code",
3232
type: "Guid",
3333
typeLink: "../guid/",
3434
typeTitle: "Values of this type will look like: \"01234567-89AB-CDEF-0123-456789ABCDEF\" or \"{01234567-89AB-CDEF-0123-456789ABCDEF}\". Also allows \"PUT-GUID-HERE\" for use in examples.",
@@ -38,6 +38,17 @@ Defines a related bundle for the parent Bundle.
3838
The identifier of the RelatedBundle group.
3939
</BlockReference>
4040

41+
<BlockReference
42+
content={{
43+
title: "Id",
44+
type: "Guid",
45+
typeLink: "../guid/",
46+
typeTitle: "Values of this type will look like: \"01234567-89AB-CDEF-0123-456789ABCDEF\" or \"{01234567-89AB-CDEF-0123-456789ABCDEF}\". Also allows \"PUT-GUID-HERE\" for use in examples."
47+
}}
48+
>
49+
Deprecated: Use the Code attribute instead.
50+
</BlockReference>
51+
4152
</BlockWrapper>
4253

4354

0 commit comments

Comments
 (0)