Skip to content

Commit a1df184

Browse files
authored
Merge pull request #1770 from v-thepet/pr2
pr2 for USER STORY 1202398
2 parents 82c32fd + a4a0a09 commit a1df184

File tree

38 files changed

+1595
-1610
lines changed

38 files changed

+1595
-1610
lines changed

docs/ide/adding-visual-studio-editor-support-for-other-languages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ All of these file types have the features described earlier even if support for
7878
|*\Syntaxes*|The grammar folder. Contains the grammar *.json* files for the language, such as *Matlab.json*.|
7979
|*\Snippets*|The snippets folder. Contains snippets for the language.|
8080

81-
In Windows, *%userprofile%* resolves to the path: *c:\Users\\*\<user name>*.* If the extensions folder does not exist on your system, you will need to create it. If the folder already exists, it will be hidden.
81+
In Windows, *%userprofile%* resolves to the path: *c:\Users\\\<user name>*. If the extensions folder does not exist on your system, you will need to create it. If the folder already exists, it will be hidden.
8282

8383
For details about how to create TextMate Grammars, see [TextMate - Introduction to Language Grammars: How to add source code syntax highlighting embedded in HTML](https://developmentality.wordpress.com/2011/02/08/textmate-introduction-to-language-grammars/) and [Notes on how to create a Language Grammar and Custom Theme for a Textmate Bundle](https://benparizek.com/notebook/notes-on-how-to-create-a-language-grammar-and-custom-theme-for-a-textmate-bundle).
8484

docs/ide/code-generation-in-visual-studio.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ There are numerous ways that Visual Studio can help you generate, fix, and refac
2525
> [!NOTE]
2626
> Each language service in Visual Studio provides its own code generation capabilities, so some features are only available in C#, and some are available in both C# and Visual Basic.
2727
28-
## See also
28+
### See also
2929

30-
[Code Snippets](../ide/code-snippets.md)
30+
[Code snippets](../ide/code-snippets.md)
3131
[Quick Actions](../ide/quick-actions.md)
3232
[Refactoring](../ide/refactoring-in-visual-studio.md)
33-
[Code Generation and T4 Text Templates](../modeling/code-generation-and-t4-text-templates.md)
33+
[Code generation and T4 text templates](../modeling/code-generation-and-t4-text-templates.md)

docs/ide/code-snippet-functions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ manager: ghogen
2020
ms.workload:
2121
- "multiple"
2222
---
23-
# Code Snippet functions
23+
# Code snippet functions
2424

25-
There are three functions available to use with C# code snippets. Functions are specified in the [Function](../ide/code-snippets-schema-reference.md#function) element of the code snippet. For information on creating code snippets, see [Code Snippets](../ide/code-snippets.md).
25+
There are three functions available to use with C# code snippets. Functions are specified in the [Function](../ide/code-snippets-schema-reference.md#function) element of the code snippet. For information on creating code snippets, see [Code snippets](../ide/code-snippets.md).
2626

2727
## Functions
2828

@@ -158,5 +158,5 @@ This example shows how to use the `SimpleTypeName` function. When this snippet i
158158

159159
## See also
160160

161-
[Function Element](../ide/code-snippets-schema-reference.md#function)
162-
[Code Snippets Schema Reference](../ide/code-snippets-schema-reference.md)
161+
[Function element](../ide/code-snippets-schema-reference.md#function)
162+
[Code snippets schema reference](../ide/code-snippets-schema-reference.md)

docs/ide/code-snippets-schema-reference.md

Lines changed: 141 additions & 156 deletions
Large diffs are not rendered by default.

docs/ide/code-snippets.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Code Snippets | Microsoft Docs"
2+
title: "Code snippets | Microsoft Docs"
33
ms.custom: ""
44
ms.date: "11/04/2016"
55
ms.reviewer: ""
@@ -94,7 +94,7 @@ If you change `newPropertyValue` to `m_property`, then every instance of `newPro
9494

9595
[Walkthrough: Creating a code snippet](../ide/walkthrough-creating-a-code-snippet.md)
9696
[How to: Distribute code snippets](../ide/how-to-distribute-code-snippets.md)
97-
[Best practices for Using code snippets](../ide/best-practices-for-using-code-snippets.md)
97+
[Best practices for using code snippets](../ide/best-practices-for-using-code-snippets.md)
9898
[Troubleshooting snippets](../ide/troubleshooting-snippets.md)
9999
[C# code snippets](../ide/visual-csharp-code-snippets.md)
100100
[Visual C++ code snippets](../ide/visual-cpp-code-snippets.md)

docs/ide/code-styles-and-quick-actions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ ms.workload:
2020

2121
Code style preferences can be set for your C# and Visual Basic projects by opening the **Options** dialog box from the **Tools** menu. Select **Text Editor** > **C#** or **Basic** > **Code Style** > **General**. Options set in this window are applicable to the local machine. Each item in the list will show a preview of the preference when selected, as shown below.
2222

23-
![Code Style options](media/code-style-quick-actions-dialog.png)
23+
![Code style options](media/code-style-quick-actions-dialog.png)
2424

2525
For each item, you can set the **Preference** and **Severity** values using the drop downs on each line. Severity can be set to **None**, **Suggestion**, **Warning**, or **Error**. If you want to enable [Quick Actions](../ide/quick-actions.md) for a code style, ensure that the **Severity** setting is set to something other than **None**. The Quick Actions light bulb icon ![Small Light Bulb Icon](media/vs2015_lightbulbsmall.png) will appear when a non-preferred style is used, and you can choose an option on the Quick Actions list to automatically rewrite code to the preferred style.
2626

27-
Code Style settings for .NET can also be managed with an [EditorConfig](../ide/editorconfig-code-style-settings-reference.md) file. In this case, the settings in the EditorConfig file take precedence over options selected in the **Options** dialog box. You can use an EditorConfig file to enforce and configure the coding style for your entire repo or project.
27+
Code style settings for .NET can also be managed with an [EditorConfig](../ide/editorconfig-code-style-settings-reference.md) file. In this case, the settings in the EditorConfig file take precedence over options selected in the **Options** dialog box. You can use an EditorConfig file to enforce and configure the coding style for your entire repo or project.
2828

29-
## See also
29+
### See also
3030

3131
[Quick Actions](../ide/quick-actions.md)
3232
[.NET coding convention settings for EditorConfig](../ide/editorconfig-code-style-settings-reference.md)

docs/ide/codeindex-command.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "CodeIndex Command | Microsoft Docs"
2+
title: "CodeIndex command | Microsoft Docs"
33
ms.custom: ""
44
ms.date: "11/04/2016"
55
ms.reviewer: ""
@@ -20,10 +20,10 @@ manager: ghogen
2020
ms.workload:
2121
- "multiple"
2222
---
23-
# CodeIndex Command
23+
# CodeIndex command
2424
Use the **CodeIndex** command to manage code indexing on Team Foundation Server. For example, you might want to reset the index to fix CodeLens information, or turn off indexing to investigate server performance issues.
2525

26-
**Required Permissions**
26+
**Required permissions**
2727

2828
To use the **CodeIndex** command, you must be a member of the **Team Foundation Administrators** security group. See [Permissions and groups defined for Team Services and TFS](https://www.visualstudio.com/docs/setup-admin/permissions).
2929

docs/ide/command-line-arguments-for-the-help-content-manager.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Command-Line Arguments for the Help Content Manager | Microsoft Docs"
2+
title: "Command-line arguments for the Help Content Manager | Microsoft Docs"
33
ms.custom: ""
44
ms.date: "11/01/2017"
55
ms.reviewer: ""
@@ -16,8 +16,8 @@ manager: ghogen
1616
ms.workload:
1717
- "multiple"
1818
---
19-
# Command-Line Arguments for the Help Content Manager
20-
You can specify how to deploy and manage local Help content by using command-line arguments for Help Content Manager (HlpCtntMgr.exe). You must run scripts for this command-line tool with administrator permissions, and you can't run these scripts as a service. You can perform the following tasks by using this tool:
19+
# Command-line arguments for the Help Content Manager
20+
You can specify how to deploy and manage local Help content by using command-line arguments for Help Content Manager (*HlpCtntMgr.exe*). You must run scripts for this command-line tool with administrator permissions, and you can't run these scripts as a service. You can perform the following tasks by using this tool:
2121

2222
- Add or update local Help content from a disk or the cloud.
2323

@@ -39,28 +39,28 @@ For example:
3939
hlpctntmgr.exe /operation install /catalogname VisualStudio15 /locale en-us /sourceuri d:\productDocumentation\HelpContentSetup.msha
4040
```
4141

42-
## Switches and Arguments
42+
## Switches and arguments
4343
The following table defines the switches and arguments that you can use for the command-line tool for Help Content Manager:
4444

4545
|Switch|Required?|Arguments|
4646
|------------|---------------|---------------|
47-
|/operation|Yes|- **Install**--Adds books from the specified installation source to the local content store.<br /> This switch requires the /booklist argument, the /sourceURI argument, or both. If you don't specify the /sourceURI argument, the default Visual Studio URI is used as the installation source. If you don't specify the /booklist argument, all books on the /sourceUri are installed.<br />- **Uninstall**--Removes the books that you specify from the local content store.<br /> This switch requires the /booklist argument or the /sourceURI argument. If you specify the /sourceURI argument, all books are removed, and the /booklist argument is ignored.<br />- **Move**--Moves the local store to the path that you specify. The default local store path is set as a directory under %ProgramData%<br /> This switch requires the /locationPath and /catalogName arguments. Error messages will be logged in the event log if you specify a path that isn't valid or if the drive doesn't contain enough free space to hold the content.<br />- **Refresh**--Updates topics that have changed since they were installed or most recently updated.<br /> This switch requires the /sourceURI argument.|
47+
|/operation|Yes|- **Install**--Adds books from the specified installation source to the local content store.<br /> This switch requires the /booklist argument, the /sourceURI argument, or both. If you don't specify the /sourceURI argument, the default Visual Studio URI is used as the installation source. If you don't specify the /booklist argument, all books on the /sourceUri are installed.<br />- **Uninstall**--Removes the books that you specify from the local content store.<br /> This switch requires the /booklist argument or the /sourceURI argument. If you specify the /sourceURI argument, all books are removed, and the /booklist argument is ignored.<br />- **Move**--Moves the local store to the path that you specify. The default local store path is set as a directory under *%ProgramData%*<br /> This switch requires the /locationPath and /catalogName arguments. Error messages will be logged in the event log if you specify a path that isn't valid or if the drive doesn't contain enough free space to hold the content.<br />- **Refresh**--Updates topics that have changed since they were installed or most recently updated.<br /> This switch requires the /sourceURI argument.|
4848
|/catalogName|Yes|Specifies the name of the content catalog.|
4949
|/locale|No|Specifies the product locale that's used to view and manage content for the current instance of the Help viewer. For example, you specify `EN-US` for English-United States.<br /><br /> If you don't specify a locale, the locale of the operating system is used. If that locale can't be determined, `EN-US` is used.<br /><br /> If you specify a locale that isn't valid, an error message is logged in the event log.|
50-
|/e|No|Elevates the Help Content Manager to Administrative priviledges if the current user has administrative credentials.|
51-
|/sourceURI|No|Specifies the URL from which content is installed (Service API) or the path to the content installation file (.msha). The URL can point to the Product Group (top-level node) or to the Product Books (leaf-level node) in a Visual Studio 2010 style endpoint. You don't need to include a slash (/) at the end of the URL. If you do include a trailing slash, it will be handled appropriately.<br /><br /> An error message is logged in the event log if you specify a file that isn't found, isn't valid, or isn't accessible or if a connection to the Internet isn't available or is interrupted while content is being managed.|
50+
|/e|No|Elevates the Help Content Manager to Administrative privileges if the current user has administrative credentials.|
51+
|/sourceURI|No|Specifies the URL from which content is installed (Service API) or the path to the content installation file (*.msha*). The URL can point to the Product Group (top-level node) or to the Product Books (leaf-level node) in a Visual Studio 2010 style endpoint. You don't need to include a slash (/) at the end of the URL. If you do include a trailing slash, it will be handled appropriately.<br /><br /> An error message is logged in the event log if you specify a file that isn't found, isn't valid, or isn't accessible or if a connection to the internet isn't available or is interrupted while content is being managed.|
5252
|/vendor|No|Specifies the vendor for the product content that will be removed (for example, `Microsoft`). The default argument for this switch is Microsoft.|
53-
|/productName|No|Specifies the product name for the books that will be removed. The product name is identified in the helpcontentsetup.msha or books.html files that shipped with the content. You can remove books from only one product at a time. To remove books from multiple products, you must perform multiple installations.|
53+
|/productName|No|Specifies the product name for the books that will be removed. The product name is identified in the *helpcontentsetup.msha* or *books.html* files that shipped with the content. You can remove books from only one product at a time. To remove books from multiple products, you must perform multiple installations.|
5454
|/booklist|No|Specifies the names of the books to be managed, separated by spaces. Values must match the book names as listed on the installation media.<br /><br /> If you don't specify this argument, all recommended books for the specified product in the /sourceURI are installed.<br /><br /> If the name of a book contains one or more spaces, surround it with double quotes (") so that the list is delimited appropriately.<br /><br /> Error messages will be logged if you specify a /sourceURI that isn't valid or isn't reachable.|
5555
|/skuId|No|Specifies the stock keeping unit (SKU) of the product from the installation source, and filters books that the /SourceURI switch identifies.|
56-
|/membership|No|- **Minimum**-- Installs a minimum set of Help content based on the SKU that you specify by using the /skuId switch. The mapping between the SKU and the content set is exposed in the Service API.<br />- **Recommended**—Installs a set of recommended books for the SKU that you specify by using the /skuId argument. The Installation source is the service API or .MSHA.<br />- **Full**-- Installs the entire set of books for the SKU that you specify by using the /skuId argument. The Installation source is the service API or .MSHA.|
56+
|/membership|No|- **Minimum**-- Installs a minimum set of Help content based on the SKU that you specify by using the /skuId switch. The mapping between the SKU and the content set is exposed in the Service API.<br />- **Recommended**—Installs a set of recommended books for the SKU that you specify by using the /skuId argument. The Installation source is the service API or *.MSHA*.<br />- **Full**-- Installs the entire set of books for the SKU that you specify by using the /skuId argument. The Installation source is the service API or *.MSHA*.|
5757
|/locationpath|No|Specifies the default folder for local Help content. You must use this switch only to install or move content. If you specify this switch, you must also specify the /silent switch.|
58-
|/silent|No|Installs or removes Help content without prompting the user or displaying any UI, including the icon in the status notification area. Output is logged to a file in the %Temp% directory. **Important:** To install content silently, you must use digitally signed .cab files, not .mshc files.|
59-
|/launchingApp|No|Defines the application and catalog context when the Help viewer is launched without the parent application. The arguments for this switch are *CompanyName*, *ProductName*, and *VersionNumber* (for example, `/launchingApp Microsoft,VisualStudio,15.0`).<br /><br /> This is required for installing content with the /silent parameter."|
58+
|/silent|No|Installs or removes Help content without prompting the user or displaying any UI, including the icon in the status notification area. Output is logged to a file in the *%Temp%* directory. **Important:** To install content silently, you must use digitally signed *.cab* files, not *.mshc* files.|
59+
|/launchingApp|No|Defines the application and catalog context when the Help viewer is launched without the parent application. The arguments for this switch are *CompanyName*, *ProductName*, and *VersionNumber* (for example, `/launchingApp Microsoft,VisualStudio,15.0`).<br /><br /> This is required for installing content with the /silent parameter.|
6060
|/wait *Seconds*|No|Pauses install, uninstall, and refresh operations. If an operation is already in progress for the catalog, the process will wait up to the given number of seconds to continue. Use 0 to wait indefinitely.|
6161
|/?|No|Lists the switches and their descriptions for the command-line tool for Help Content Manager.|
6262

63-
### Exit Codes
63+
### Exit codes
6464
When you run the command-line tool for the Help Content Manager in silent mode, it returns the following exit codes:
6565

6666
```
@@ -86,6 +86,6 @@ UpdateAlreadyRunning = 1300 - (Signals that the update didn't run because anothe
8686
```
8787

8888
## See also
89-
[Help Viewer Administrator Guide](../ide/help-viewer-administrator-guide.md)
90-
[Help Content Manager Overrides](../ide/help-content-manager-overrides.md)
89+
[Help Viewer administrator guide](../ide/help-viewer-administrator-guide.md)
90+
[Help Content Manager overrides](../ide/help-content-manager-overrides.md)
9191
[Microsoft Help Viewer](../ide/microsoft-help-viewer.md)

0 commit comments

Comments
 (0)