Search code examples
sql-serverssmsssms-16

How to enable local (i.e. offline) help in SSMS 2016?


Let's have simple

SELECT 'a'

Whenever I press F1 on SELECT keyword, standalone installed SSMS 2016 launches web browser to display online help.

I want F1 to open local help for SELECT keyword.

What I have done so far:

  1. Menu Help > Add or Remove Help Content, added books SQL Shared Language reference, Books Online, Developer Reference so help page for SELECT (Transact-SQL) is now available in help index.

  2. Migrated help repository from C: to some more convenient place.

What else needs to be done?
Maybe checking option "I want to use local help" in help settings? But it is not present any more in SSMS 2016.

I also examined the Registry and was hunting for proper registry key(s) listening to SSMS using Process Monitor tool, but the SSMS did not seem to read anything resembling online/offline option at the moment of pressing F1.


Solution

  • SSMS 2016 help is broken. See these connect items, which you can vote for:

    https://connect.microsoft.com/SQLServer/feedback/details/2826366/f1-help-in-ssms-2016-always-opens-online-content-ignores-local-help-library

    and

    https://connect.microsoft.com/SQLServer/feedback/details/2828609/ssms-2016-help-viewer-1-1-pops-up-help-docs-never-found


    UPDATE: the issue came fixed in SSMS 2016.4.1. From download page:

    Fixed an issue where the F1 Help always opened online content. Users can now select whether they prefer online or offline help via the "Set Help Preference" in the Help menu.
    Microsoft Connect item #2826366