You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You can view SQL Server help content when you are online (connected to the internet) or offline. Online help always shows the most up-to-date content. Offline help is static content that you previously downloaded from the online content or the Microsoft Download Center, or installed from disk.
29
28
30
-
In SQL Server Management Studio (SSMS) and Visual Studio (VS), you can choose to view online or offline help content in a browser or in a Help Viewer. This article explains how to install the Help Viewer, how to install offline help content, and how to view online or offline help for [!INCLUDE[ssSQL14_md](../includes/sssql14-md.md)], SQL Server 2016, and SQL Server 2017.
29
+
You can view up-to-date SQL Server help online in a browser window in SQL Server Management Studio (SSMS) by clicking **View Help** in the Help menu. You can use the SSMS Help Viewer to view help content that you downloaded from online sources or installed from disk. You can choose to view context-sensitive help (when you press F1 or click Help in a dialog box) in a browser or in the Help Viewer.
31
30
32
-
> [!NOTE]
33
-
> - F1 Help (context-sensitive help when you press F1 or click Help in a dialog box) is only available online. There are no downloadable offline help sources for F1 Help.
34
-
> - The Help Viewer does not support proxy settings, and does not support the ISO format.
31
+
This article describes tools that install the Help Viewer, how to install offline help content, and how to view help for [!INCLUDE[ssSQL14_md](../includes/sssql14-md.md)] and SQL Server 2016 / SQL Server 2017.
32
+
33
+
<[!NOTE>
34
+
<SQL Server 2016 and SQL Server 2017 content are now combined, although individual topics note what version they apply to. Most apply to both versions.
35
+
36
+
## Help Viewer
35
37
36
-
## Install the Help Viewer
37
-
The Help Viewer has two versions: v1.x supports SQL Server 2014 help, and v2.x supports SQL Server 2016 and SQL Server 2017 help. You can also use Help Viewer 2.x to view [!INCLUDE[ssSQL14_md](../includes/sssql14-md.md)] help, if you install the content from disk. The tools in the following table install Help Viewer.
38
+
The SSMS Help Viewer allows you to download, install, and view SQL Server help content from online sources or disk. Help Viewer has two versions: v1.x supports [!INCLUDE[ssSQL14_md](../includes/sssql14-md.md)] help, and v2.x supports SQL Server 2016/SQL Server 2017 help. The Help Viewer does not support proxy settings, and does not support the ISO format.
39
+
40
+
>[!NOTE]
41
+
>Help Viewer v2.x can also support [!INCLUDE[ssSQL14_md](../includes/sssql14-md.md)] help if you install the content from disk.
42
+
43
+
The following tools install Help Viewer.
38
44
39
45
|**Tool that installs Help Viewer**|**Help Viewer version installed**|
40
46
|---------|---------|
41
47
|[SQL Server Management Studio (latest version)](https://docs.microsoft.com/sql/ssms/download-sql-server-management-studio-ssms)| v2.x|
42
48
|[SQL Server Data Tools for Visual Studio 2015](https://docs.microsoft.com/sql/ssdt/download-sql-server-data-tools-ssdt)| v2.x|
43
-
|Visual Studio 2017 | v2.x (does not support SQL Server 2017 help)*|
49
+
|Visual Studio 2017 | v2.x (supports SQL Server 2016 help only)|
44
50
|SQL Server 2014 Management Studio| v1.x|
45
51
|Visual Studio prior to 2012| v1.x|
46
52
47
-
\* To install the Help Viewer with Visual Studio 2017, click the **Individual Components** tab in the Visual Studio installer, click **Help Viewer** in the **Code Tools** category, and then click **Install**.
48
-
49
53
> [!NOTE]
50
-
> - Installing SQL Server 2016 only installs Help Viewer 1.1, which does not support SQL Server 2016 or SQL Server 2017 help.
51
-
> - Installing SQL Server 2017 does not install any Help Viewer.
54
+
> - Installing SQL Server 2016 installs Help Viewer 1.1, which does not support SQL Server 2016/2017 help.
55
+
> - Installing SQL Server 2017 does not install Help Viewer.
52
56
53
-
## Use online help
57
+
## View online help
54
58
55
-
Online help always shows the most up-to-date content.
56
-
57
-
### View online help in SQL Server Management Studio
58
-
59
-
To view online help content in the latest version of SSMS, click **View Help** on the **Help** menu. Documentation displays in a browser.
59
+
Online help always shows the most up-to-date help content in a browser. To view online help in the latest version of SSMS, click **View Help** on the **Help** menu.
To view online help content with Help Viewer 1.x, do the following:
@@ -86,49 +77,41 @@ To view online help content with Help Viewer 1.x, do the following:
86
77
87
78
## Use offline help
88
79
89
-
This process downloads the latest help content for SQL Server 2016/SQL Server 2017, or help content from the Microsoft Download Center for SQL Server 2014, and installs it on your local machine. The installed help content is then available in the Help Viewer when you are offline.
80
+
This process downloads the latest available online help content for SQL Server 2016/2017 (or help content from the Microsoft Download Center for SQL Server 2014), and installs it on your computer. You can then view the content in the SSMS Help Viewer.
90
81
91
-
### Use SQL Server 2016/SQL Server 2017 offline help with Help Viewer v2.x
82
+
[!NOTE]
83
+
- SQL Server 2016 and SQL Server 2017 help are combined, although some topics note individual versions. Most topics apply to both.
84
+
- You can use Help Viewer 2.x to view [!INCLUDE[ssSQL14_md](../includes/sssql14-md.md)] help if you install the content from disk.
92
85
93
-
### Install the SQL Server 2016/SQL Server 2017 help content
86
+
### Help Viewer v2.x
94
87
95
-
This process installs the most up-to-date online help content at the time of the download.
88
+
This process installs the most up-to-date online help content available at the time of the download, and displays it in the Help Viewer.
96
89
97
-
1. In SSMS or VS, click **Add and Remove Help Content** on the Help menu.
98
-
2. Click the **Manage Content** tab.
99
-
3. To install the Help from the latest online source, click **Online** in the **Installation source** area.
90
+
1. In SSMS, click **Add and Remove Help Content** on the Help menu. The Help Viewer opens to the Manage Content tab.
91
+
2. To install from the latest online source, choose **Online** under Installation source:.
> In Visual Studio, the Help Viewer application may freeze (hang) while adding the documentation. For more information about this issue, see [Visual Studio Help Viewer freezes](https://msdn.microsoft.com/library/mt654096.aspx). To resolve the issue, edit the *%LOCALAPPDATA%\Microsoft\HelpViewer2.3\HlpViewer_SSMS16_en-US.settings\HlpViewer_VisualStudio15_en-US.settings* file to change the date in *Cache LastRefreshed="<mm/dd/yyyy> 00:00:00"* to some date in the future.
109
-
110
-
The table of contents in the left pane automatically updates to include the documentation you've added.
5. (Optional) The Local store path box on the Manage Content tab shows where the documentation is installed on the local computer. To move the documentation to a different location, click **Move**, enter a folder path in the **To** field of the Move Content dialog box, and then click **OK**.
110
+
6. To view the installed help in SSMS, press **CTRL + ALT + F1**, or choose **Add or Remove Content** from the Help menu, to launch the Help Viewer.
111
+
If the help table of contents is not visible, click **Contents** on the left. Click the pushpin on the Contents pane to keep the pane open.
After the content is moved, the new location is displayed in the **Local store path**.
119
-
120
-
>[!IMPORTANT]
121
-
> If a message appears indicating that the move operation has failed, close the message box, then close and reopen Help Viewer. The new location for the content should now appear in the Local store path.
122
-
123
-
### View the offline help with Help Viewer v2.x
124
-
125
-
1. In SSMS or VS, point to **Set Help Preference** under the Help menu, and choose **Launch in Help Viewer**.
126
-
2. When you are offline and click **View Help** on the **Help** menu, you can access the help content you installed by using the table of contents in the left pane of the Help Viewer.
127
-
128
113
## Use [!INCLUDE[ssSQL14_md](../includes/sssql14-md.md)] offline help with Help Viewer v1.x
129
114
130
-
### Install the SQL Server 2014 help content
131
-
132
115
1. Navigate to the [Product Documentation for Microsoft SQL Server 2014](https://www.microsoft.com/en-us/download/details.aspx?id=42557) download site and click **Download**.
133
116
2. Click **Save** in the message box to save the *SQLServer2014Documentation\_\*.exe* file to your computer.
134
117
@@ -152,15 +135,11 @@ This process installs the most up-to-date online help content at the time of the
0 commit comments