Skip to content

Commit 9207275

Browse files
CZEMacLeodCZEMacLeod
committed
Update documentation
1 parent 8f0927b commit 9207275

7 files changed

Lines changed: 88 additions & 21 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
[![Build Status](https://dev.azure.com/flexviews/MSBuild.SDKs.SystemWeb/_apis/build/status/CZEMacLeod.MSBuild.SDK.SystemWeb?branchName=main)](https://dev.azure.com/flexviews/MSBuild.SDKs.SystemWeb/_build/latest?definitionId=69&branchName=main)
44
[![Docs](https://img.shields.io/badge/Documentation-docs-lightgrey?logo=github)](https://czemacleod.github.io/MSBuild.SDK.SystemWeb/)
5+
[![pages-build-deployment](https://github.com/CZEMacLeod/MSBuild.SDK.SystemWeb/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/CZEMacLeod/MSBuild.SDK.SystemWeb/actions/workflows/pages/pages-build-deployment)
56

67
This MSBuild SDK is designed to allow for the easy creation and use of SDK (shortform) projects targeting ASP.NET 4.x using System.Web.
78

‎docs/RazorLibrary.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,51 @@ For more information see
3636

3737
[![Source](https://img.shields.io/badge/github-source-lightgrey?logo=github)](https://github.com/CZEMacLeod/MSBuild.SDK.SystemWeb)
3838
[![Docs](https://img.shields.io/badge/github_pages-docs-lightgrey?logo=github)](https://czemacleod.github.io/MSBuild.SDK.SystemWeb/)
39+
40+
## Properties
41+
42+
### Common Properties
43+
44+
| Property | Default value | Description |
45+
| -------- | ------------- | ----------- |
46+
| `ExcludeDefaultSDKPackages` | false | Do not include the default packages `Microsoft.Net.Compilers.Toolset` and `Microsoft.CodeDom.Providers.DotNetCompilerPlatform` |
47+
| `ApplySDKDefaultPackageVersions` | true* | Apply default version numbers to packages unless using a Central Package Management system |
48+
49+
*Version numbers are not applied if you are using `Microsoft.Build.CentralPackageVersions` version 2.1.1 or higher. Remember to include the packages in your central package versions file.
50+
51+
52+
### Specific Properties
53+
54+
| Property | Default value | Description |
55+
| -------- | ------------- | ----------- |
56+
| `MvcBuildViews` | true if Configuration is Release<br/>false otherwise | Whether to invoke the AspNetCompiler automatically after build |
57+
| `EnableWebFormsDefaultItems` | Same as `EnableDefaultItems` | Whether to automatically include WebForms files as content<br><ul><li> *.asax</li><li> *.ascx</li><li> *.ashx</li><li> *.asmx</li><li> *.aspx</li><li> *.master</li><li> *.svc</li></ul> |
58+
| `OverwriteAppConfigWithBindingRedirects` | false | If set, then any [automatically generated binding redirects](Binding_Redirects/Autogenerating-Binding-Redirects.md) will be copied into your web.config and `RazorAppConfigFiles` files. |
59+
60+
### Deprecated Properties
61+
| Property | Default value | Description |
62+
| -------- | ------------- | ----------- |
63+
| `ExcludeDefaultRazorPackages` | false | Use `ExcludeDefaultSDKPackages` instead |
64+
65+
## Automatic Default Packages
66+
67+
### Common Packages
68+
69+
| Package | Default Version | Property |
70+
| ------- | --------------- | -------- |
71+
| `Microsoft.Net.Compilers.Toolset` | 4.5.0 | `MicrosoftNetCompilersToolset_Version` |
72+
| `Microsoft.CodeDom.Providers.DotNetCompilerPlatform` | 3.6.0 | `MicrosoftCodeDomProvidersDotNetCompilerPlatform_Version` |
73+
74+
### Specific Packages
75+
76+
| Package | Default Version | Property |
77+
| ------- | --------------- | -------- |
78+
| `RazorGenerator.MsBuild` | 2.5.0 | `RazorGeneratorMSBuild_Version` |
79+
| `RazorGenerator.MVC` | 2.4.9 | `RazorGeneratorMVC_Version` |
80+
| `Microsoft.AspNet.Mvc` | 5.2.9 | `MicrosoftAspNetMvc_Version` |
81+
82+
## Items
83+
84+
| Item Name | Default | Description |
85+
| --------- | ------- | ----------- |
86+
| `RazorAppConfigFiles` | `Views/web.config`<br>`Areas/**/web.config` | List of config files that will be updated with binding redirects |

‎docs/SDK.md‎

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ When using an MSBuild Project SDK obtained via NuGet (such as the SDKs in this r
1313
Either append the version (as shown in the nuget shield above) to the package name:
1414

1515
```xml
16-
<Project Sdk="MSBuild.SDK.SystemWeb/4.0.82">
16+
<Project Sdk="MSBuild.SDK.SystemWeb/4.0.83">
1717
...
1818
```
1919

@@ -22,7 +22,7 @@ Or omit the version from the SDK attribute and specify it in the version in `glo
2222
```json
2323
{
2424
"msbuild-sdks": {
25-
"MSBuild.SDK.SystemWeb" : "4.0.82"
25+
"MSBuild.SDK.SystemWeb" : "4.0.83"
2626
}
2727
}
2828
```
@@ -31,13 +31,37 @@ You can also use the [templates](Templates.md) to easily create new projects.
3131

3232
## Properties
3333

34+
### Common Properties
35+
3436
| Property | Default value | Description |
3537
| -------- | ------------- | ----------- |
36-
| ExcludeASPNetCompilers | false | Do not include the default packages `Microsoft.Net.Compilers.Toolset` and `Microsoft.CodeDom.Providers.DotNetCompilerPlatform` |
37-
| MicrosoftNetCompilersToolset_Version | 3.8.0 | Version number of the package `Microsoft.Net.Compilers.Toolset` to include* |
38-
| MicrosoftCodeDomProvidersDotNetCompilerPlatform_Version | 3.6.0 | Version number of the packge `Microsoft.CodeDom.Providers.DotNetCompilerPlatform` to include* |
39-
| OverwriteAppConfigWithBindingRedirects | false | If set, then any [automatically generated binding redirects](Binding_Redirects/Autogenerating-Binding-Redirects.md) will be copied into your web.config file. |
40-
| MvcBuildViews | true if Configuration is Release<br/>false otherwise | Whether to invoke the AspNetCompiler automatically after build |
41-
| EnableWebFormsDefaultItems | Same as `EnableDefaultItems` | Whether to automatically include WebForms files as content<br><ul><li> *.asax</li><li> *.ascx</li><li> *.ashx</li><li> *.asmx</li><li> *.aspx</li><li> *.master</li><li> *.svc</li></ul> |
38+
| `ExcludeDefaultSDKPackages` | false | Do not include the default packages `Microsoft.Net.Compilers.Toolset` and `Microsoft.CodeDom.Providers.DotNetCompilerPlatform` |
39+
| `ApplySDKDefaultPackageVersions` | true* | Apply default version numbers to packages unless using a Central Package Management system |
40+
| `GeneratedBindingRedirectsAction` | None | Set the desired default behavior of what to do with SuggestedBindingRedirects if not yet set.<br>See [automatically generated binding redirects](Binding_Redirects/Autogenerating-Binding-Redirects.md)<br><ul><li>`None` - Do nothing except show the warning</li><li>`Preview` - Creates new Web.BindingRedirects.config file showing proposed changes</li><li>`Overwrite` - Updates the $(AppConfig) aka web.config in the project root</li></ul> |
4241

4342
*Version numbers are not applied if you are using `Microsoft.Build.CentralPackageVersions` version 2.1.1 or higher. Remember to include the packages in your central package versions file.
43+
44+
### Specific Properties
45+
46+
| Property | Default value | Description |
47+
| -------- | ------------- | ----------- |
48+
| `MvcBuildViews` | true if Configuration is Release<br/>false otherwise | Whether to invoke the AspNetCompiler automatically after build |
49+
| `EnableWebFormsDefaultItems` | Same as `EnableDefaultItems` | Whether to automatically include WebForms files as content<br><ul><li> *.asax</li><li> *.ascx</li><li> *.ashx</li><li> *.asmx</li><li> *.aspx</li><li> *.master</li><li> *.svc</li></ul> |
50+
| `SetRoslynToolPath` | true if `RoslynToolPath` is empty | Sets `RoslynToolPath` to the version included in `Microsoft.Net.Compilers.Toolset` to allow compiling .aspx files etc. using a newer langversion** |
51+
52+
** You will have to adjust your web.config to change the `system.codedom/compilers/compiler` `compilerOptions` attribute to set the langversion - it won't automatically use the `LangVersion` property from your project file.
53+
54+
### Deprecated Properties
55+
| Property | Default value | Description |
56+
| -------- | ------------- | ----------- |
57+
| `ExcludeASPNetCompilers` | false | Use `ExcludeDefaultSDKPackages` instead |
58+
| `OverwriteAppConfigWithBindingRedirects` | false | If set, will set `GeneratedBindingRedirectsAction` to `Overwrite` then any will be copied into your web.config file. |
59+
60+
## Automatic Default Packages
61+
62+
### Common Packages
63+
64+
| Package | Default Version | Property |
65+
| ------- | --------------- | -------- |
66+
| `Microsoft.Net.Compilers.Toolset` | 4.5.0 | `MicrosoftNetCompilersToolset_Version` |
67+
| `Microsoft.CodeDom.Providers.DotNetCompilerPlatform` | 3.6.0 | `MicrosoftCodeDomProvidersDotNetCompilerPlatform_Version` |

‎docs/Templates.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,6 @@ You need to have enabled the Preview feature to show [.NET CLI Templates in Visu
7777
![Visual Studio New Project Dialog](https://raw.githubusercontent.com/CZEMacLeod/MSBuild.SDK.SystemWeb/main/src/MSBuild.SDK.SystemWeb.Templates/images/create-new-project.png)
7878

7979
You can find the new templates easily by selecting `System.Web` from the Project Type dropdown.
80+
81+
### Visual Studio 2022
82+
Same as VS2019 except the feature should automatically be enabled as it is no longer in preview.

‎docs/docs.csproj‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,4 @@
66
<ItemGroup>
77
<Content Include="**\*.md" />
88
</ItemGroup>
9-
<ItemGroup>
10-
<Folder Include="Known_Limitations\" />
11-
</ItemGroup>
12-
<ItemGroup>
13-
<None Include="RazorLibrary.md">
14-
<PackagePath>\</PackagePath>
15-
<Pack>true</Pack>
16-
</None>
17-
</ItemGroup>
189
</Project>

‎src/MSBuild.SDK.SystemWeb.RazorLibrary/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ When using an MSBuild Project SDK obtained via NuGet (such as the SDKs in this r
1414
Either append the version to the package name:
1515

1616
```xml
17-
<Project Sdk="MSBuild.SDK.SystemWeb.RazorLibrary/4.0.82">
17+
<Project Sdk="MSBuild.SDK.SystemWeb.RazorLibrary/4.0.83">
1818
...
1919
```
2020

@@ -23,7 +23,7 @@ Or omit the version from the SDK attribute and specify it in the version in `glo
2323
```json
2424
{
2525
"msbuild-sdks": {
26-
"MSBuild.SDK.SystemWeb.RazorLibrary" : "4.0.82"
26+
"MSBuild.SDK.SystemWeb.RazorLibrary" : "4.0.83"
2727
}
2828
}
2929
```

‎src/MSBuild.SDK.SystemWeb/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ When using an MSBuild Project SDK obtained via NuGet (such as the SDKs in this r
1313
Either append the version to the package name:
1414

1515
```xml
16-
<Project Sdk="MSBuild.SDK.SystemWeb/4.0.82">
16+
<Project Sdk="MSBuild.SDK.SystemWeb/4.0.83">
1717
...
1818
```
1919

@@ -22,7 +22,7 @@ Or omit the version from the SDK attribute and specify it in the version in `glo
2222
```json
2323
{
2424
"msbuild-sdks": {
25-
"MSBuild.SDK.SystemWeb" : "4.0.82"
25+
"MSBuild.SDK.SystemWeb" : "4.0.83"
2626
}
2727
}
2828
```

0 commit comments

Comments
 (0)