Visionneuse d’aide et aide en mode hors connexion SQL ServerSQL Server offline help and Help Viewer

S’APPLIQUE À : ouiSQL Server nonAzure SQL Database nonAzure SQL Data Warehouse nonParallel Data Warehouse APPLIES TO: yesSQL Server noAzure SQL Database noAzure SQL Data Warehouse noParallel Data Warehouse

Vous pouvez utiliser Microsoft Help Viewer pour télécharger et installer les packages d’aide SQL Server à partir de sources en ligne ou du disque local.You can use the Microsoft Help Viewer to download and install SQL Server help packages from online sources or local disk. Vous pouvez ensuite afficher le contenu hors connexion.You can then view the content offline. La visionneuse d’aide est installée avec différents outils.The Help Viewer is installed with several different tools. Cet article décrit les outils qui installent la visionneuse d’aide, comment installer le contenu de l’aide en mode hors connexion et comment afficher l’aide.This article describes the tools that install the Help Viewer, how to install offline help content, and how to view help.

Un accès à Internet est nécessaire pour télécharger le contenu de Help Viewer.Internet access is required to download the Help Viewer content. Vous pouvez ensuite migrer le contenu sur un ordinateur qui n’a pas accès à Internet.You can then migrate the content to a computer that does not have internet access.

Notes

Pour obtenir du contenu local pour les versions actuelles de SQL server, installez la version actuelle de SQL Server Management Studio SQL Server Management Studio 18.x.To get local content for the current versions of SQL server, install the current version of SQL Server Management Studio SQL Server Management Studio 18.x.

Quels outils installent les versions de la visionneuse d’aide ?What tools Install the Help Viewer versions?

Il existe deux versions majeures de la visionneuse d’aide Microsoft.There are two major versions of the Microsoft Help Viewer. Les versions 1.x et 2.x.Versions 1.x and 2.x. Chaque version prend en charge différentes versions de contenu SQL Server.Each version supports different versions of SQL Server content. Le format de la documentation en mode hors connexion a changé au fil du temps et les anciennes versions de Help Viewer ne prennent pas en charge les versions plus récentes de la documentation.The format of the offline books has changed over time, and the older versions of Help Viewer do not support the newer versions of the books.

Ensemble de contenuContent Set Outils qui installent la visionneuse d’aideTools that install Help Viewer Version de la visionneuse d’aideHelp Viewer version
Préversion de SQL Server 2019SQL Server 2019 Preview
SQL Server 2017SQL Server 2017
SQL Server 2016SQL Server 2016
Visual Studio 2019 (1)Visual Studio 2019 (1)
Visual Studio 2017 (1)Visual Studio 2017 (1)
SQL Server Management Studio 18.xSQL Server Management Studio 18.x
SQL Server Management Studio 17.xSQL Server Management Studio 17.x
SQL Server Data Tools pour Visual Studio 2015SQL Server Data Tools for Visual Studio 2015
Visual Studio 2015Visual Studio 2015
v2.3v2.3
V2.2V2.2
SQL Server 2014SQL Server 2014
SQL Server 2012SQL Server 2012
Programme d’installation de SQL Server 2016 (2)SQL Server 2016 Setup (2)
SQL Server 2014 Management StudioSQL Server 2014 Management Studio
Programme d’installation de SQL Server 2014 (2)SQL Server 2014 Setup (2)
SQL Server Management Studio 2012SQL Server Management Studio 2012
Programme d’installation de SQL Server 2012 (2)SQL Server 2012 Setup (2)
v1.xv1.x

(1) Pour installer la visionneuse d’aide avec Visual Studio 2019 ou 2017, sur l’onglet Composants individuels dans le programme d’installation de Visual Studio, sélectionnez Visionneuse d’aide sous Outils de code, puis cliquez sur Installer.(1) To install the Help Viewer with Visual Studio 2019 or 2017, on the Individual Components tab in the Visual Studio Installer, select Help Viewer under Code Tools, and then click Install.

(2) indique l’option « Composants de Documentation » dans le programme d’installation de SQL Server.(2) Indicates the "Documentation Components" option in SQL Server Setup.

Notes

  • SQL Server 2016 installe la visionneuse d’aide version 1.1, qui ne prend pas en charge le contenu d’aide de SQL Server 2016.SQL Server 2016 installs Help Viewer 1.1, which does not support SQL Server 2016 help content. Pour plus d’informations, consultez les Notes de mise à jour pour SQL Server 2016.For more information, see SQL Server 2016 Release Notes. Pour afficher le contenu de SQL Server 2016, vous avez besoin de la version 2.x de la visionneuse d’aide.To view SQL Server 2016 content you need the v2.x of the help viewer.
  • À partir de SQL Server 2017, la visionneuse d’aide ne peut pas être installée à partir du programme d’installation de SQL Server.Starting with SQL Server 2017 the Help Viewer cannot be installed from SQL Server Setup.

Utiliser la visionneuse d’aide version 2.xUse Help Viewer v2.x

Pour télécharger et installer le contenu de l’aide en mode hors connexion avec la visionneuse d’aide version 2.xTo download and install offline help content with Help Viewer v2.x

  1. Dans SSMS ou VS, cliquez sur Ajouter et supprimer le contenu d’aide dans le menu Aide.In SSMS or VS, click Add and Remove Help Content on the Help menu.

    HelpViewer2_Ajouter et supprimer le contenu

    La visionneuse d’aide s’ouvre et affiche l’onglet Gérer le contenu.The Help Viewer opens to the Manage Content tab.

  2. Pour installer le dernier package de contenu de l’aide, choisissez En ligne sous Source d’installation.To install the latest help content package, choose Online under Installation source.

    HelpViewer2_ManageContent_OnlineSource

    Notes

    Pour une installation à partir du disque (aide de SQL Server 2014), choisissez Disque sous Source d’installation et spécifiez l’emplacement du disque.To install from disk (SQL Server 2014 help), choose Disk under Installation source, and specify the disk location.

    L’option Chemin d’accès au stockage local sous l’onglet Gérer le contenu indique l’emplacement sur l’ordinateur local où sera installé le contenu.The Local store path on the Manage Content tab shows where on the local computer the content will be installed. Pour changer d’emplacement, cliquez sur Déplacer, entrez un chemin de dossier différent dans le champ Vers, puis cliquez sur OK.To change the location, click Move, enter a different folder path in the To field, and then click OK. Si l’installation de l’aide échoue après avoir modifié le chemin d’accès du magasin local, fermez et rouvrez la visionneuse d’aide.If the help installation fails after changing the Local store path, close and reopen the Help Viewer. Vérifiez que le nouvel emplacement apparaît dans le chemin d’accès du magasin local, puis recommencez l’installation.Ensure the new location appears in the Local store path and then try the installation again.

  3. Cliquez sur Ajouter en regard de chaque package de contenu (livre) que vous souhaitez installer.Click Add next to each content package (book) that you want to install. Pour installer tout le contenu de l’aide de SQL Server, ajoutez l’ensemble des 13 livres sous SQL Server.To install all SQL Server help content, add all 13 books under SQL Server.

  4. Cliquez sur Mettre à jour en bas à droite.Click Update at lower right. La table des matières de l’aide sur la gauche est automatiquement mise à jour avec les livres ajoutés.The help table of contents on the left automatically updates with the added books.

    HelpViewer2_ManageContent_AddContent

Notes

Les titres de nœud supérieur dans la table des matières SQL Server ne correspondent pas tous exactement aux noms des livres d’aide téléchargeables associés.Not all the top-node titles in the SQL Server table of contents exactly match the names of the corresponding downloadable help books. Les titres de la table des matières sont mappés aux noms des livres comme suit :The TOC titles map to the book names as follows:

(*) le contenu tiré de la première version en disponibilité générale de SQL Server 2017, ainsi que l’ancien contenu de la version 2016.(*) Content that is from the first general availability version of SQL Server 2017 content along with older 2016 content. Cette documentation sera supprimée, car la documentation complète de SQL Server versions 2016 et 2017 contient les modifications apportées depuis janvier 2019.These books will be removed as the separate and complete books for SQL Server 2016 and 2017 contain content edits as of January 2019.

Volet de contenuContents pane Livre SQL ServerSQL Server book
* Informations de référence sur le langage Analysis ServicesAnalysis services language reference Informations de référence sur le langage Analysis Services (MDX)Analysis Services (MDX) language reference
* Informations de référence sur le langage DAX (Data Analysis Expressions)Data Analysis Expressions (DAX) reference Informations de référence sur le langage DAX (Data Analysis Expressions)Data Analysis Expressions (DAX) reference
* Informations de référence sur le langage DMX (Data Mining Extensions)Data mining extensions (DMX) reference Informations de référence sur le langage DMX (Data Mining Extensions)Data mining extensions (DMX) reference
* Bien démarrer avec le Machine Learning dans SQL ServerGetting started with Machine learning in SQL Server Microsoft Machine Learning ServicesMicrosoft Machine learning Services
* Informations de référence sur Power Query MPower Query M Reference Informations de référence sur Power Query MPower Query M Reference
Documentation SQL Server 2016SQL Server 2016 Documentation Documentation SQL Server 2016SQL Server 2016 Documentation
Documentation SQL Server 2017SQL Server 2017 Documentation Documentation SQL Server 2017SQL Server 2017 Documentation
* Guides du développeur pour SQL ServerDeveloper Guides for SQL Server Référence du développeur SQL ServerSQL Server Developer Reference
* Télécharger SQL Server Management StudioDownload SQL Server Management Studio SQL Server Management StudioSQL Server Management Studio
* Page d’accueil pour la programmation client de Microsoft SQL ServerHomepage for client programming for Microsoft SQL Server Pilotes de connexion SQL ServerSQL Server Connection Drivers
* SQL Server sur LinuxSQL Server on Linux SQL Server sur LinuxSQL Server on Linux
* Documentation technique de SQL ServerSQL Server Technical Documentation Documentation technique de SQL Server (SSIS, SSRS, moteur de base de données, programme d’installation)SQL Server Technical Documentation (SSIS, SSRS, DB engine, setup)
* Outils et utilitaires pour Azure SQL DatabaseTools and utilities for Azure SQL Database Outils SQL ServerSQL Server tools
* Référence Transact-SQL (moteur de base de données)Transact-SQL Reference (Database Engine) Guide de référence Transact-SQLTransact-SQL Reference
* Références relatives au langage Xquery (SQL Server)XQuery Language Reference (SQL Server) Références relatives au langage Xquery (SQL Server)XQuery Language Reference (SQL Server)

Notes

Si la visionneuse d’aide se fige (se bloque) pendant l’ajout du contenu, remplacez la ligne Dernière actualisation du cache = « <jj/mm/aaaa> 00:00:00 » dans le fichier %LOCALAPPDATA%\Microsoft\HelpViewer2.x\HlpViewer_SSMSx_en-US.settings ou HlpViewer_VisualStudiox_en-US.settings par une date dans le futur.If the Help Viewer freezes (hangs) while adding content, change the Cache LastRefreshed="<mm/dd/yyyy> 00:00:00" line in the %LOCALAPPDATA%\Microsoft\HelpViewer2.x\HlpViewer_SSMSx_en-US.settings or HlpViewer_VisualStudiox_en-US.settings file to some date in the future. Pour plus d’informations sur ce problème, consultez La visionneuse d’aide Visual Studio se fige sur l’écran de démarrage.For more information about this issue, see Visual Studio Help Viewer freezes.

Pour afficher le contenu de l’aide en mode hors connexion dans SSMS avec la visionneuse d’aide version 2.xTo view offline help content in SSMS with Help Viewer v2.x

Pour afficher l’aide installée dans SSMS, appuyez sur Ctrl+Alt+F1 ou choisissez Ajouter ou supprimer du contenu dans le menu Aide pour lancer la visionneuse d’aide.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.

HelpViewer2_Ajouter et supprimer le contenu

La visionneuse d’aide s’ouvre et affiche l’onglet Gérer le contenu, avec la table des matières de l’aide installée dans le volet gauche.The Help Viewer opens to the Manage Content tab, with the installed help table of contents in the left pane. Cliquez sur les articles dans la table des matières pour les afficher dans le volet droit.Click articles in the table of contents to display them in the right pane.

Conseil

Si le volet de contenu n’est pas visible, cliquez sur Contenu dans la marge gauche.If the contents pane is not visible, click Contents on the left margin. Cliquez sur l’icône représentant une punaise pour garder le volet de contenu ouvert.Click the pushpin icon to keep the contents pane open.

Visionneuse d’aide version 2.x avec du contenu

Pour afficher le contenu de l’aide en mode hors connexion dans VS avec la visionneuse d’aide version 2.xTo view offline help content in VS with Help Viewer v2.x

Pour afficher l’aide installée dans Visual Studio :To view the installed help in Visual Studio:

  1. Pointez sur Définir les préférences pour l’aide dans le menu Aide, puis choisissez Lancer dans la visionneuse d’aide.Point to Set Help Preference on the Help menu and choose Launch in Help Viewer.

    Visionneuse d’aide dans VS, Définir les préférences pour l’aide

  2. Cliquez sur Afficher l’aide dans le menu Aide pour afficher le contenu dans la visionneuse d’aide.Click View Help in the Help menu to display the content in the Help Viewer.

    Afficher l’aide

    La table des matières de l’aide s’affiche sur la gauche et l’article d’aide sélectionnée sur la droite.The help table of contents shows on the left, and the selected help article on the right.

Utiliser la visionneuse d’aide version 1.xUse Help Viewer v1.x

Les versions antérieures de SSMS et VS utilisent la visionneuse d’aide version 1.x, qui prend en charge l’aide de SQL Server 2014 et 2012.Earlier versions of SSMS and VS use Help Viewer 1.x, which supports SQL Server 2014 and 2012 Help content.

Pour télécharger et installer le contenu de l’aide en mode hors connexion avec la visionneuse d’aide version 1.xTo download and install offline help content with Help Viewer v1.x

Ce processus utilise la visionneuse d’aide version 1.x pour télécharger l’aide de SQL Server 2014 à partir du Centre de téléchargement Microsoft et l’installer sur votre ordinateur.This process uses Help Viewer 1.x to download SQL Server 2014 help from the Microsoft Download Center and install it on your computer.

  1. Accédez au site de téléchargement Documentation du produit pour Microsoft SQL Server 2014 et cliquez sur Télécharger.Navigate to the Product Documentation for Microsoft SQL Server 2014 download site and click Download.

  2. Cliquez sur Enregistrer dans la zone de message pour enregistrer le fichier SQLServer2014Documentation_*.exe sur votre ordinateur.Click Save in the message box to save the SQLServer2014Documentation_*.exe file to your computer.

    Notes

    Pour les environnements protégés par un pare-feu et un proxy, enregistrez le fichier téléchargé sur un lecteur USB ou tout autre média amovible pouvant être amené dans l’environnement.For firewall and proxy restricted environments, save the download to a USB drive or other portable media that can be carried into the environment.

  3. Double-cliquez sur le fichier .exe pour décompresser le fichier de contenu d’aide, puis enregistrez le fichier dans un dossier local ou partagé.Double-click the .exe to unpack the help content file, and save the file to a local or shared folder.

  4. Ouvrez le Gestionnaire de bibliothèque d’aide en lançant SSMS ou VS et en cliquant sur Gérer les paramètres de l’aide dans le menu Aide.Open the Help Library Manager by launching SSMS or VS and clicking Manage Help Settings on the Help menu.

  5. Cliquez sur Installer du contenu à partir du disque et accédez au dossier dans lequel vous avez décompressé le fichier de contenu d’aide.Click Install content from disk, and browse to the folder where you unpacked the help content file.

    HelpLibraryManager_MainPage_InstallFromDisk

    HelpLibraryManager_InstallContentFromDisk_dialog1

    Important

    Pour éviter d’installer du contenu d’aide locale qui ne présente qu’une table des matières partielle, vous devez utiliser l’option Installer du contenu à partir du disque dans le Gestionnaire de bibliothèque d’aide.To avoid installing local help content that has only a partial table of contents, you must use the Install content from disk option in the Help Library Manager. Si vous avez utilisé l’option Installer du contenu à partir d’une source en ligne et que la visionneuse d’aide affiche une table des matières partielle, consultez ce billet de blog pour savoir comment résoudre ce problème.If you used Install content from online and the Help Viewer is displaying a partial table of contents, see this blog post for troubleshooting steps.

  6. Cliquez successivement sur le fichier HelpContentSetup.msha, sur Ouvrir, puis sur Suivant.Click the HelpContentSetup.msha file, click Open, and then click Next.

  7. Cliquez sur Ajouter en regard de la documentation que vous voulez installer, puis cliquez sur Mettre à jour.Click Add next to the documentation you want to install, and then click Update.

    HelpLibraryManager_InstallContentFromDisk_dialog2

  8. Cliquez sur Terminer, puis sur Quitter.Click Finish, and then click Exit.

Pour afficher le contenu de l’aide en mode hors connexion avec la visionneuse d’aide version 1.xTo view offline help content with Help Viewer v1.x

  1. Pour afficher l’aide installée, ouvrez le Gestionnaire de bibliothèque d’aide, cliquez sur Choisir l’aide en ligne ou locale, puis sur Utiliser l’aide locale.To view installed help, open Help Library Manager, click Choose online or local help, and then click I want to use local help.
  2. Ouvrez la visionneuse d’aide pour afficher le contenu en cliquant sur Afficher l’aide dans le menu Aide.Open the Help Viewer to see the content by clicking View Help on the Help menu. Le contenu que vous avez installé est répertorié dans le volet gauche.The content you installed is listed in the left pane.

HelpViewer1_withContentInstalled_ZoomedIn

Afficher l’aide en ligneView online help

L’aide en ligne affiche toujours le contenu le plus récent.Online help always shows the most up-to-date content.

Pour afficher l’aide en ligne de SQL Server dans SSMS 17.xTo view SQL Server online help in SSMS 17.x

Pour afficher l’aide en ligne de Visual Studio dans Visual StudioTo view Visual Studio online help in Visual Studio

  1. Pointez sur Définir les préférences pour l’aide dans le menu Aide, puis choisissez Lancer dans le navigateur ou Lancer dans la visionneuse d’aide.Point to Set Help Preference on the Help menu and choose either Launch in Browser or Launch in Help Viewer.
  2. Cliquez sur Afficher l’aide dans le menu Aide.Click View Help in the Help menu. La toute dernière aide de Visual Studio s’affiche dans l’environnement sélectionné.The latest Visual Studio help displays in the chosen environment.

Pour afficher l’aide en ligne avec la visionneuse d’aide version 1.xTo view online help with Help Viewer v1.x

  1. Ouvrez le Gestionnaire de bibliothèque d’aide en cliquant sur Gérer les paramètres de l’aide dans le menu Aide.Open the Help Library Manager by clicking Manage Help Settings on the Help menu.

  2. Dans la boîte de dialogue Gestionnaire de bibliothèque d’aide, cliquez sur Choisir l’aide en ligne ou locale.In the Help Library Manager dialog box, click Choose online or local help.

    HelpLibraryManager_MainPage_ChooseOnlineORLocal.png

  3. Cliquez sur Utiliser l’aide en ligne, sur OK, puis sur Quitter.Click I want to use online help, click OK, and then click Exit.

    HelpLibraryManager_ChooseOnlineORLocalHelp_OnlineHelpSelected_dialog

  4. Ouvrez la visionneuse d’aide pour afficher le contenu en cliquant sur Afficher l’aide dans le menu Aide.Open the Help Viewer to see the content by clicking View Help on the Help menu.

Afficher l’aide F1View F1 help

Quand vous appuyez sur F1, ou cliquez sur Aide ou l’icône ?When you press F1 or click Help or the ? dans une boîte de dialogue dans SSMS ou VS, un article d’aide en ligne contextuelle s’affiche dans le navigateur ou la visionneuse d’aide.icon in a dialog box in SSMS or VS, a context-sensitive online help article appears in the browser or Help Viewer.

Pour afficher l’aide F1To view F1 help

  1. Dans le menu Aide, cliquez sur Définir les préférences pour l’aide, puis choisissez Lancer dans le navigateur ou Lancer dans la visionneuse d’aide.In the Help menu, click Set Help Preference, and choose either Launch in Browser or Launch in Help Viewer.
  2. Appuyez sur F1 ou cliquez sur Aide ou sur ?Press F1, or click Help, or click ? dans les boîtes de dialogue là où ces options sont disponibles pour afficher les articles en ligne contextuelles dans l’environnement sélectionné.in dialog boxes where they are available, to see context-sensitive online articles in the chosen environment.

Notes

L’aide F1 fonctionne uniquement quand vous êtes connecté.F1 help only works when you are online. Il n’existe aucune source hors connexion pour l’aide F1.There are no offline sources for F1 help.

Systèmes sans accès à InternetSystems without internet access

Une fois que vous avez téléchargé la documentation en mode hors connexion sur un système ayant accès à Internet, vous pouvez exécuter les étapes suivantes pour migrer le contenu sur un système qui n’a pas accès à Internet.After you download offline books on a system that has internet access, you can use the following steps to migrate the content to a system that does not have internet access.

Notes

Vous devez installer un logiciel prenant en charge la visionneuse d’aide (par exemple, SQL Server Management Studio) sur le système hors connexion.Software that supports the Help Viewer, such as SQL Server Management Studio, must be installed on the offline system.

  1. Ouvrez la visionneuse d’aide (Ctrl + Alt + F1).Open Help Viewer (Ctrl + Alt + F1).
  2. Sélectionnez la documentation qui vous intéresse.Select the documentation you're interested in. Par exemple, utilisez le filtre SQL, puis sélectionnez la documentation technique de SQL Server.For example, filter by SQL and select the SQL Server Technical Documentation.
  3. Recherchez le chemin physique des fichiers sur disque, qui se trouve sous Chemin d’accès au stockage local.Identify the physical path of the files on disk, which can be found under Local store path.
  4. Accédez à cet emplacement à l’aide de l’Explorateur du système de fichiers.Navigate to this location using your file system explorer.
    1. L’emplacement par défaut est : C:\Program Files (x86)\Microsoft SQL Server\140\Tools\Binn\ManagementStudio\Extensions\ApplicationThe default location is: C:\Program Files (x86)\Microsoft SQL Server\140\Tools\Binn\ManagementStudio\Extensions\Application
  5. Sélectionnez les trois dossiers (ContentStore, Incoming, IndexStore) et copiez-les au même emplacement de votre système hors connexion.Select the three folders, ContentStore, Incoming, IndexStore and copy them to the same location on your offline system. Vous devrez peut-être utiliser un support intermédiaire, comme une clé USB ou un CD.You may need to use an interim media device such as a USB or CD.
  6. Une fois ces fichiers déplacés, lancez la visionneuse d’aide sur le système hors connexion pour accéder à la documentation technique SQL Server.Once these files have been moved, launch Help Viewer on the offline system and the SQL Server technical documentation will be available.

physical-location-of-offline-content.png

Étapes suivantesNext steps

Microsoft Help Viewer - Visual StudioMicrosoft Help Viewer - Visual Studio

info_tip Obtenir de l’aideGet Help