ヘルプ ビューアーの管理者ガイドHelp Viewer administrator guide

ヘルプ ビューアーを使用すると、インターネット アクセスの有無に関係なく、ネットワーク環境のローカル ヘルプのインストールを管理できます。The Help Viewer allows you to manage local Help installations for network environments with or without internet access. ローカル ヘルプ コンテンツは、コンピューターごとに構成されます。Local help content is configured on a per machine basis. 既定では、ユーザーがローカル ヘルプのインストールを更新するには、そのユーザーに管理者権限が必要です。By default, users must have administrator rights to update their local Help installation.

ご利用のネットワーク環境でクライアントがインターネットにアクセスできる場合、ヘルプ コンテンツ マネージャーの実行可能ファイルを利用し、インターネットからローカル ヘルプ コンテンツを配置できます。If your network environment allows clients to access the internet, you can use the Help Content Manager executable to deploy local Help content from the internet. HlpCtntMgr.exe のコマンド ライン構文の詳細については、「ヘルプ コンテンツ マネージャーのコマンド ライン引数」を参照してください。For more information about HlpCtntMgr.exe command line syntax, see Command-Line Arguments for the Help Content Manager.

コンテンツの作成、イントラネット サービスのエンドポイントの作成、類似した種類のアクティビティの詳細については、ヘルプ ビューアー SDK を参照してください。For information about creating content, creating an intranet service endpoint, and similar types of activities, see the Help Viewer SDK.

ご利用のネットワーク環境にインターネット アクセスがない場合、ヘルプ ビューアーでは、イントラネットかネットワーク共有からローカル ヘルプ コンテンツを展開できます。If do not have internet access in your network environment, Help Viewer can deploy local Help content from the intranet or a network share. 次のような機能でレジストリ キーをオーバーライドし、Visual Studio IDE のヘルプ オプションを無効にすることもできます。You can also disable Visual Studio IDE Help options by using registry key overrides for functionality such as:

  • オンラインとオフラインのヘルプonline versus offline help

  • IDE の初回起動時のコンテンツ インストールcontent installation at first launch of the IDE

  • イントラネット コンテンツ サービスの指定specifying an intranet content service

  • コンテンツの管理managing content

インターネットからローカル ヘルプ コンテンツを配置するDeploying local Help content from the internet

ヘルプ コンテンツ マネージャー (HlpCtntMgr.exe) を利用し、インターネットからクライアント コンピューターにローカル ヘルプ コンテンツを配置できます。You can use Help Content Mananger (HlpCtntMgr.exe) to deploy local Help content from the internet to client computers. このコマンドの構文は次のとおりです。Use the following syntax:

\\%ProgramFiles(x86)%\Microsoft Help Viewer\v2.3\HlpCtntmgr.exe /operation \<*name*> /catalogname \<*catalog name*> /locale \<*locale*>

HlpCtntMgr.exe のコマンド ライン構文の詳細については、「ヘルプ コンテンツ マネージャーのコマンド ライン引数」を参照してください。For more information about HlpCtntMgr.exe command line syntax, see Command-Line Arguments for the Help Content Manager.

要件:Requirements:

  • クライアント コンピューターがインターネットにアクセスできる必要があります。Client computers must have access to the internet.

  • インストール後にユーザーがローカル ヘルプ コンテンツを更新、追加、または削除するには、そのユーザーに管理者権限が必要です。Users must have administrator rights to update, add, or remove the local Help content after it has been installed.

    注意事項:Caveats:

  • ヘルプの既定のソースはオンラインのままです。The default source for Help will still be online.

Example

次の例では、クライアント コンピューターに Visual Studio の英語のコンテンツをインストールします。The following example installs English content for Visual Studio to a client computer.

インターネットから英語のコンテンツをインストールするにはTo install English content from the internet
  1. [スタート] を選択し、[ファイル名を指定して実行] を選択します。Choose Start and then choose Run.

  2. 次のように入力します。Type the following:

    C:\Program Files (x86)\Microsoft Help Viewer\v2.3\hlpctntmgr.exe /operation install /catalogname VisualStudio15 /locale en-usC:\Program Files (x86)\Microsoft Help Viewer\v2.3\hlpctntmgr.exe /operation install /catalogname VisualStudio15 /locale en-us

  3. Enter キーを押します。Press Enter.

事前にインストールされたローカル ヘルプ コンテンツをクライアント コンピューターに配置するDeploying pre-installed local Help content on client computers

オンラインから 1 台のコンピューターに一連のコンテンツをインストールし、そのインストールされたコンテンツを他のコンピューターにコピーすることができます。You can install a set of content from online to one computer, and then copy that installed set of content to other computers.

要件:Requirements:

  • 最初にコンテンツをインストールするコンピューターでは、インターネットにアクセスできる必要があります。The computer you install the set of content to must have access to the internet.

  • インストール後にユーザーがローカル ヘルプ コンテンツを更新、追加、または削除するには、そのユーザーに管理者権限が必要です。Users must have administrator rights to update, add, or remove the local Help content after it has been installed.

    ヒント

    ユーザーに管理者権限がない場合は、ヘルプ ビューアーで [コンテンツの管理] タブを無効にすることをお勧めします。If users do not have administrator rights, it is recommended that you disable the Manage Content tab in the Help Viewer. 詳細については、「ヘルプ コンテンツ マネージャーのオーバーライド」を参照してください。For more information, see Help Content Manager Overrides.

注意事項:Caveats:

  • ヘルプの既定のソースはオンラインのままです。The default source for Help will still be online.

コンテンツ セットを作成するCreate the content set

基本コンテンツ セットを作成する前に、ターゲット コンピューターで Visual Studio のすべてのローカル コンテンツをアンインストールする必要があります。Before you can create the base content set, you must first uninstall all local Visual Studio content on the target computer.

ローカル ヘルプをアンインストールするにはTo uninstall local help

  1. ヘルプ ビューアーで、[コンテンツの管理] タブを選択します。In the Help Viewer, choose the Manage Content tab.

  2. Visual Studio ドキュメント セットに移動します。Navigate to the Visual Studio document set.

  3. 各サブ項目の横の [削除] を選択します。Choose Remove next to each sub-item.

  4. [更新] を選択し、アンインストールします。Choose Update to uninstall.

  5. %ProgramData%\Microsoft\HelpLibrary2\Catalogs\VisualStudio15 に移動し、フォルダーに catalogType.xml ファイルだけが含まれていることを確認します。Browse to %ProgramData%\Microsoft\HelpLibrary2\Catalogs\VisualStudio15 and verify that the folder only contains the file catalogType.xml.

    前にインストールされた Visual Studio のローカル ヘルプ コンテンツをすべて削除したら、基本コンテンツ セットをダウンロードする準備が整いました。Once you have removed all previously installed local Visual Studio Help content, you are ready to download the base content set.

コンテンツをダウンロードするにはTo download the content

  1. ヘルプ ビューアーで、[コンテンツの管理] タブを選択します。In the Help Viewer, choose the Manage Content tab.

  2. [推奨されるドキュメント] または [利用可能なドキュメント] で、ダウンロードするドキュメント セットに移動し、[追加] を選択します。Under Recommended Documentation or Available Documentation, navigate to the documentation sets you want to download and then choose Add.

  3. [更新] を選択します。Choose Update.

    次に、クライアント コンピューターに配置できるように、コンテンツをパッケージ化する必要があります。Next, you need to package the content so it can be deployed to client computers.

コンテンツをパッケージ化するにはTo package the content

  1. 後の配置でコンテンツをコピーするフォルダーを作成します。Create a folder to copy the content to for later deployment. たとえば、C:\VSHelp とします。For example: C:\VSHelp.

  2. 管理者のアクセス許可で cmd.exe を開きます。Open cmd.exe with Administrator permissions.

  3. 手順 1 で作成したフォルダーに移動します。Navigate to the folder you created in step 1.

  4. 次のように入力します。Type the following:

    Xcopy %ProgramData%\Microsoft\HelpLibrary2 <foldername>\ /y /e /k /oXcopy %ProgramData%\Microsoft\HelpLibrary2 <foldername>\ /y /e /k /o

    例: Xcopy %ProgramData%\Microsoft\HelpLibrary2 c:\VSHelp\ /y /e /k /oFor example: Xcopy %ProgramData%\Microsoft\HelpLibrary2 c:\VSHelp\ /y /e /k /o

コンテンツの配置Deploying the content

コンテンツを配置するにはTo deploy the content

  1. ネットワーク共有を作成し、その場所にヘルプ コンテンツをコピーします。Create a network share and copy the help content to that location.

    たとえば、C:\VSHelp のコンテンツを \\myserver\VSHelp にコピーします。For example, copy the content in C:\VSHelp to \\myserver\VSHelp.

  2. ヘルプ コンテンツの配置スクリプトを含める .bat ファイルを作成します。Create a .bat file to contain the deployment script for the help content. クライアントがプッシュの一部として、削除されるファイルのいずれかに読み取りロックを設定している可能性があるため、更新をプッシュする前にクライアントをシャットダウンする必要があります。Since the client could possibly have a read lock on any of the files being deleted as part of the push, you should have the client shut down prior to pushing updates. 例:For example:

    REM - copy pre-ripped content to ProgramData  
    Xcopy %~dp0HelpLibrary2 %SYSTEMDRIVE%\ProgramData\Microsoft\HelpLibrary2\ /y /e /k /o  
    if ERRORLEVEL 1 ECHO *** ERROR COPYING Help Library files to ProgramData (%ERRORLEVEL%)
    
  3. ヘルプ コンテンツをインストールするローカル コンピューターで .bat ファイルを実行します。Run the .bat file on the local machines that you want to install the Help content on.

関連項目See also

ヘルプ コンテンツ マネージャーのコマンド ライン引数Command-Line Arguments for the Help Content Manager
ヘルプ コンテンツ マネージャーのオーバーライドHelp Content Manager Overrides
Microsoft Help ViewerMicrosoft Help Viewer
ヘルプ ビューアー SDKHelp Viewer SDK