Skip to content

Commit 6b5aa81

Browse files
authored
Merge pull request #2500 from WilliamAntonRohm/W-deploy-batch-6
VS "deployment" fixes -- gerunds, capitalization, and formatting -- batch #6
2 parents ba58ba8 + dc0ca2d commit 6b5aa81

17 files changed

+166
-166
lines changed

docs/deployment/installchecks-element-bootstrapper.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ manager: douge
1818
ms.workload:
1919
- "multiple"
2020
---
21-
# <InstallChecks> Element (Bootstrapper)
21+
# <InstallChecks> element (bootstrapper)
2222
The `InstallChecks` element supports starting a variety of tests against the local computer to make sure that all of the appropriate prerequisites for an application have been installed.
2323

2424
## Syntax
2525

26-
```
26+
```xml
2727
<InstallChecks>
2828
<AssemblyCheck
2929
Property
@@ -142,7 +142,7 @@ The `InstallChecks` element supports starting a variety of tests against the loc
142142
## Example
143143
The following code example demonstrates the `InstallChecks` element as it is used in the product file for the [!INCLUDE[dnprdnshort](../code-quality/includes/dnprdnshort_md.md)].
144144

145-
```
145+
```xml
146146
<InstallChecks>
147147
<ExternalCheck Property="DotNetInstalled" PackageFile="dotnetchk.exe" />
148148
<RegistryCheck Property="IEVersion" Key="HKLM\Software\Microsoft\Internet Explorer" Value="Version" />
@@ -157,7 +157,7 @@ The `InstallChecks` element supports starting a variety of tests against the loc
157157
|`FailIf`|If any `FailIf` condition evaluates to true, the package will fail. The rest of the conditions will not be evaluated.|
158158
|`BypassIf`|If any `BypassIf` condition evaluates to true, the package will be bypassed. The rest of the conditions will not be evaluated.|
159159

160-
## Predefined Properties
160+
## Predefined properties
161161
The following table lists the `BypassIf` and `FailIf` elements:
162162

163163
|Property|Notes|Possible Values|
@@ -170,11 +170,11 @@ The `InstallChecks` element supports starting a variety of tests against the loc
170170

171171
For example, to block installation on a computer running Windows 95, use code such as the following:
172172

173-
```
173+
```xml
174174
<!-- Block install on Windows 95 -->
175175
    <FailIf Property="Version9X" Compare="VersionLessThan" Value="4.10" String="InvalidPlatform"/>
176176
```
177177

178-
## See Also
179-
[\<Commands> Element](../deployment/commands-element-bootstrapper.md)
180-
[Product and Package Schema Reference](../deployment/product-and-package-schema-reference.md)
178+
## See also
179+
[\<Commands> element](../deployment/commands-element-bootstrapper.md)
180+
[Product and package schema reference](../deployment/product-and-package-schema-reference.md)

docs/deployment/localizing-clickonce-applications.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ manager: douge
2424
ms.workload:
2525
- "multiple"
2626
---
27-
# Localizing ClickOnce Applications
27+
# Localize ClickOnce applications
2828
Localization is the process of making your application appropriate for a specific culture. This process involves translating user interface (UI) text to a region-specific language, using correct date and currency formatting, adjusting the size of controls on a form, and mirroring controls from right to left if necessary.
2929

3030
Localizing your application results in the creation of one or more satellite assemblies. Each assembly contains UI strings, images, and other resources specific to a given culture. (Your application's main executable file contains the strings for the default culture for your application.)
@@ -42,30 +42,30 @@ Localization is the process of making your application appropriate for a specifi
4242

4343
This method is the default in [!INCLUDE[vsprvs](../code-quality/includes/vsprvs_md.md)]. To use this method in [!INCLUDE[vsprvs](../code-quality/includes/vsprvs_md.md)], you do not have to do any additional work.
4444

45-
To use this method with MageUI.exe, you must set the culture for your application to **neutral** in MageUI.exe. Next, you must manually include all of the satellite assemblies in your deployment. In MageUI.exe, you can add the satellite assemblies by using the **Populate** button on the **Files** tab of your application manifest.
45+
To use this method with *MageUI.exe*, you must set the culture for your application to **neutral** in *MageUI.exe*. Next, you must manually include all of the satellite assemblies in your deployment. In *MageUI.exe*, you can add the satellite assemblies by using the **Populate** button on the **Files** tab of your application manifest.
4646

4747
The benefit of this approach is that it creates a single deployment and simplifies your localized deployment story. At run time, the appropriate satellite assembly will be used, depending on the default culture of the user's Windows operating system. A drawback of this approach is that it downloads all satellite assemblies whenever the application is installed or updated on a client computer. If your application has a large number of strings, or your customers have a slow network connection, this process can affect performance during application update.
4848

4949
> [!NOTE]
50-
> This approach assumes that your application adjusts the height, width, and position of controls automatically to accommodate different text string sizes in different cultures. Windows Forms contains a variety of controls and technologies that enable you to design your form to make it easily localizable, including the <xref:System.Windows.Forms.FlowLayoutPanel> and <xref:System.Windows.Forms.TableLayoutPanel> controls as well as the <xref:System.Windows.Forms.Control.AutoSize%2A> property. Also see [How to: Support Localization on Windows Forms Using AutoSize and the TableLayoutPanel Control](http://msdn.microsoft.com/library/1zkt8b33\(v=vs.110\)).
50+
> This approach assumes that your application adjusts the height, width, and position of controls automatically to accommodate different text string sizes in different cultures. Windows Forms contains a variety of controls and technologies that enable you to design your form to make it easily localizable, including the <xref:System.Windows.Forms.FlowLayoutPanel> and <xref:System.Windows.Forms.TableLayoutPanel> controls as well as the <xref:System.Windows.Forms.Control.AutoSize%2A> property. Also see [How to: Support localization on Windows forms using AutoSize and the TableLayoutPanel control](http://msdn.microsoft.com/library/1zkt8b33\(v=vs.110\)).
5151
52-
## Generate One Deployment for Each Culture
52+
## Generate one deployment for each culture
5353
In this deployment strategy, you generate multiple deployments. In each deployment, you include only the satellite assembly needed for a specific culture, and you mark the deployment as specific to that culture.
5454

5555
To use this method in [!INCLUDE[vsprvs](../code-quality/includes/vsprvs_md.md)], set the **Publish Language** property on the **Publish** tab to the desired region. [!INCLUDE[vsprvs](../code-quality/includes/vsprvs_md.md)] will automatically include the satellite assembly required for the region you select, and will exclude all other satellite assemblies from the deployment.
5656

57-
You can accomplish the same thing by using the MageUI.exe tool in the Microsoft [!INCLUDE[winsdklong](../deployment/includes/winsdklong_md.md)]. Use the **Populate** button on the **Files** tab of your application manifest to exclude all other satellite assemblies from the application directory, and then set the **Culture** field on the **Name** tab for your deployment manifest in MageUI.exe. These steps not only include the correct satellite assembly, but they also set the `language` attribute on the `assemblyIdentity` element in your deployment manifest to the corresponding culture.
57+
You can accomplish the same thing by using the *MageUI.exe* tool in the Microsoft [!INCLUDE[winsdklong](../deployment/includes/winsdklong_md.md)]. Use the **Populate** button on the **Files** tab of your application manifest to exclude all other satellite assemblies from the application directory, and then set the **Culture** field on the **Name** tab for your deployment manifest in *MageUI.exe*. These steps not only include the correct satellite assembly, but they also set the `language` attribute on the `assemblyIdentity` element in your deployment manifest to the corresponding culture.
5858

5959
After publishing the application, you must repeat this step for each additional culture your application supports. You must make sure that you publish to a different Web server directory or file share directory every time, because each application manifest will reference a different satellite assembly, and each deployment manifest will have a different value for the `language`attribute.
6060

61-
## Downloading Satellite Assemblies on Demand
61+
## Download satellite assemblies on demand
6262
If you decide to include all satellite assemblies in a single deployment, you can improve performance by using on-demand downloading, which enables you to mark assemblies as optional. The marked assemblies will not be downloaded when the application is installed or updated. You can install the assemblies when you need them by calling the <xref:System.Deployment.Application.ApplicationDeployment.DownloadFileGroup%2A> method on the <xref:System.Deployment.Application.ApplicationDeployment> class.
6363

6464
Downloading satellite assemblies on demand differs slightly from downloading other types of assemblies on demand. For more information and code examples on how to enable this scenario using the [!INCLUDE[winsdkshort](../debugger/debug-interface-access/includes/winsdkshort_md.md)] tools for [!INCLUDE[ndptecclick](../deployment/includes/ndptecclick_md.md)], see [Walkthrough: Downloading Satellite Assemblies on Demand with the ClickOnce Deployment API](../deployment/walkthrough-downloading-satellite-assemblies-on-demand-with-the-clickonce-deployment-api.md).
6565

6666
You can also enable this scenario in [!INCLUDE[vsprvs](../code-quality/includes/vsprvs_md.md)]. Also see [Walkthrough: Downloading Satellite Assemblies on Demand with the ClickOnce Deployment API Using the Designer](http://msdn.microsoft.com/library/ms366788\(v=vs.110\)) or [Walkthrough: Downloading Satellite Assemblies on Demand with the ClickOnce Deployment API Using the Designer](http://msdn.microsoft.com/library/ms366788\(v=vs.120\)).
6767

68-
## Testing Localized ClickOnce Applications Before Deployment
68+
## Testing localized ClickOnce applications before deployment
6969
A satellite assembly will be used for a Windows Forms application only if the <xref:System.Threading.Thread.CurrentUICulture%2A> property for the main thread of the application is set to the satellite assembly's culture. Customers in local markets will probably already be running a localized version of Windows with their culture set to the appropriate default.
7070

7171
You have three options for testing localized deployments before you make your application available to customers:
@@ -74,7 +74,7 @@ Localization is the process of making your application appropriate for a specifi
7474

7575
- You can set the <xref:System.Threading.Thread.CurrentUICulture%2A> property programmatically in your application. (This property must be set before you call the <xref:System.Windows.Forms.Application.Run%2A> method.)
7676

77-
## See Also
78-
[\<assemblyIdentity> Element](../deployment/assemblyidentity-element-clickonce-deployment.md)
79-
[ClickOnce Security and Deployment](../deployment/clickonce-security-and-deployment.md)
80-
[Globalizing Windows Forms](/dotnet/framework/winforms/advanced/globalizing-windows-forms)
77+
## See also
78+
[\<assemblyIdentity> element](../deployment/assemblyidentity-element-clickonce-deployment.md)
79+
[ClickOnce security and deployment](../deployment/clickonce-security-and-deployment.md)
80+
[Globalize Windows forms](/dotnet/framework/winforms/advanced/globalizing-windows-forms)

docs/deployment/package-element-bootstrapper.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ manager: douge
1818
ms.workload:
1919
- "multiple"
2020
---
21-
# &lt;Package&gt; Element (Bootstrapper)
21+
# &lt;Package&gt; element (bootstrapper)
2222
The `Package` element is the top-level XML element inside of a package file.
2323

2424
## Syntax
@@ -136,14 +136,14 @@ The `Package` element is the top-level XML element inside of a package file.
136136
</Package>
137137
```
138138

139-
## Elements and Attributes
139+
## Elements and attributes
140140
The `Package` element is required. It has the following attributes.
141141

142142
|Attribute|Description|
143143
|---------------|-----------------|
144144
|`Culture`|Required. Defines the culture for this package, which determines the language to be used. This attribute is a key into the `Strings` element, which lists culture-specific strings for product names and error messages during the installation.|
145145
|`Name`|Required. The name of the package displayed to the developer within a tool such as [!INCLUDE[vsprvs](../code-quality/includes/vsprvs_md.md)]. This attribute is a key into the `Strings` element, which should contain a `String` element with the `Name` and `Culture` properties set to match the `Name` and `Culture` properties of `Package`.|
146-
|`LicenseAgreement`|Optional. Specifies the name of the file in the distribution package which contains the End-User License Agreement (EULA). This file can be either plain text (.txt) or Rich Text Format. (.rtf)|
146+
|`LicenseAgreement`|Optional. Specifies the name of the file in the distribution package which contains the End-User License Agreement (EULA). This file can be either plain text (*.txt*) or Rich Text Format. (*.rtf*)|
147147

148148
## Example
149149
The following code example shows a complete package file for redistributing the [!INCLUDE[dnprdnlong](../code-quality/includes/dnprdnlong_md.md)].
@@ -183,5 +183,5 @@ The `Package` element is the top-level XML element inside of a package file.
183183
</Package>
184184
```
185185

186-
## See Also
187-
[Product and Package Schema Reference](../deployment/product-and-package-schema-reference.md)
186+
## See also
187+
[Product and package schema reference](../deployment/product-and-package-schema-reference.md)

docs/deployment/packagefiles-element-bootstrapper.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ manager: douge
1818
ms.workload:
1919
- "multiple"
2020
---
21-
# &lt;PackageFiles&gt; Element (Bootstrapper)
21+
# &lt;PackageFiles&gt; element (bootstrapper)
2222
The `PackageFiles` element contains `PackageFile` elements, which define the installation packages executed as a result of the `Command` element.
2323

2424
## Syntax
2525

26-
```
26+
```xml
2727
<PackageFiles
2828
CopyAllPackageFiles
2929
>
@@ -37,7 +37,7 @@ The `PackageFiles` element contains `PackageFile` elements, which define the ins
3737
</PackageFiles>
3838
```
3939

40-
## Elements and Attributes
40+
## Elements and attributes
4141
The `PackageFiles` element has the following attribute.
4242

4343
|Attribute|Description|
@@ -60,7 +60,7 @@ The `PackageFiles` element contains `PackageFile` elements, which define the ins
6060
## Example
6161
The following code example defines packages for the [!INCLUDE[dnprdnshort](../code-quality/includes/dnprdnshort_md.md)] redistributable package and its dependencies, such as the Windows Installer.
6262

63-
```
63+
```xml
6464
<PackageFiles>
6565
<PackageFile Name="instmsia.exe" HomeSite="InstMsiAExe" PublicKey="3082010A0282010100AA99BD39A81827F42B3D0B4C3F7C772EA7CBB5D18C0DC23A74D793B5E0A04B3F595ECE454F9A7929F149CC1A47EE55C2083E1220F855F2EE5FD3E0CA96BC30DEFE58C82732D08554E8F09110BBF32BBE19E5039B0B861DF3B0398CB8FD0B1D3C7326AC572BCA29A215908215E277A34052038B9DC270BA1FE934F6F335924E5583F8DA30B620DE5706B55A4206DE59CBF2DFA6BD154771192523D2CB6F9B1979DF6A5BF176057929FCC356CA8F440885558ACBC80F464B55CB8C96774A87E8A94106C7FF0DE968576372C36957B443CF323A30DC1BE9D543262A79FE95DB226724C92FD034E3E6FB514986B83CD0255FD6EC9E036187A96840C7F8E203E6CF050203010001"/>
6666
<PackageFile Name="WindowsInstaller-KB884016-v2-x86.exe" HomeSite="Msi30Exe" PublicKey="3082010A0282010100B22D8709B55CDF5599EB5262E7D3F4E34571A932BF94F20EE90DADFE9DC7046A584E9CA4D1D84441FB647E0F65EEC817DA4DDBD9D650B40C565B6C16884BBF03EE504883EC4F88939A51E394197FFAB397A5CE606D9FDD4C9338BDCD345971E686CEE98399A096B8EAE0445B1342B93A484E5472F70896E400C482017643AF61C2DBFAE5C5F00213DDF835B40F0D5236467443B1A2CA9CDD7E99F1351177FB1526018ECFE0B804782A15FD72C66076910CE74FB218181B6989B4F12F211B66EACA91C7460DB91758715856866523D10232AE64A06FDA5295FDFBDD8D34F5C10C35A347D7E91B6AFA0F45B4E8321D7019BDD1F9E5641FEB8737EA6FD40D838FFD0203010001"/>
@@ -69,7 +69,7 @@ The `PackageFiles` element contains `PackageFile` elements, which define the ins
6969
</PackageFiles>
7070
```
7171

72-
## See Also
73-
[\<Product> Element](../deployment/product-element-bootstrapper.md)
74-
[\<Package> Element](../deployment/package-element-bootstrapper.md)
75-
[Product and Package Schema Reference](../deployment/product-and-package-schema-reference.md)
72+
## See also
73+
[\<Product> element](../deployment/product-element-bootstrapper.md)
74+
[\<Package> element](../deployment/package-element-bootstrapper.md)
75+
[Product and package schema reference](../deployment/product-and-package-schema-reference.md)

docs/deployment/product-and-package-schema-reference.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ manager: douge
2828
ms.workload:
2929
- "multiple"
3030
---
31-
# Product and Package Schema Reference
31+
# Product and package schema reference
3232
A *product file* is an XML manifest that describes all of the external dependencies required by a [!INCLUDE[ndptecclick](../deployment/includes/ndptecclick_md.md)] application. Examples of external dependencies include the [!INCLUDE[dnprdnshort](../code-quality/includes/dnprdnshort_md.md)] and the Microsoft Data Access Components (MDAC). A package file is similar to a product file but is used to install the culture-dependent components of a dependency, such as localized assemblies, license agreements, and documentation.
3333

3434
The product and packages file consists of either a top-level `Product` or `Package` element, each of which contains the following elements.
@@ -44,7 +44,7 @@ A *product file* is an XML manifest that describes all of the external dependenc
4444
|[\<Strings> Element](../deployment/strings-element-bootstrapper.md)|Required element. Stores localized versions of the product name and error strings.|None|
4545

4646
## Remarks
47-
The package schema is consumed by Setup.exe, a stub program generated by the MS Build bootstrapping task that contains little hard-coded logic of its own. The schema drives every aspect of the installation process.
47+
The package schema is consumed by *Setup.exe*, a stub program generated by the MS Build bootstrapping task that contains little hard-coded logic of its own. The schema drives every aspect of the installation process.
4848

4949
`InstallChecks` the tests that setup.exe should perform for the existence of a given package. `PackageFiles` lists all of the packages that the setup process might have to install, should a given test fail. Each Command entry under Commands executes one of the tests described by `InstallChecks`, and specifies which `PackageFile` to run should the test fail. You can use the `Strings` element to localize product names and error messages, so that you can use one single installation binary to install your application for any number of languages.
5050

@@ -153,6 +153,6 @@ A *product file* is an XML manifest that describes all of the external dependenc
153153
</Product>
154154
```
155155

156-
## See Also
157-
[ClickOnce Deployment Manifest](../deployment/clickonce-deployment-manifest.md)
158-
[ClickOnce Application Manifest](../deployment/clickonce-application-manifest.md)
156+
## See also
157+
[ClickOnce deployment manifest](../deployment/clickonce-deployment-manifest.md)
158+
[ClickOnce application manifest](../deployment/clickonce-application-manifest.md)

0 commit comments

Comments
 (0)