Средство просмотра справки Microsoft — Microsoft Help Viewer

Средство просмотра справки Microsoft

Разработчики)	Microsoft
Операционная система	Майкрософт Виндоус
Предшественник	Справка Microsoft 2
Тип	Справочная система

Microsoft Help Viewer (HV) — это автономная справочная система (локальная справка), разработанная Microsoft, которая поставляется с Visual Studio 2010 и связанной с ней библиотекой MSDN , в дополнение к версиям Microsoft Windows, включая Windows 8 и последующие версии .

Microsoft Help Viewer 1.x заменяет Microsoft Help 2, которая является справочной системой, используемой Microsoft Visual Studio 2002/2003/2005/2008 и Office 2007 . Он поставляется с VS 2010. Microsoft Help Viewer 2.x обратно совместим с 1.x и поставляется с операционной системой, а также с VS 2012+.

Хотя во время разработки Microsoft Help Viewer назывался MS Help 3.x , это полностью новый продукт, технически не связанный с Microsoft Help 2 . С ростом потребности в общей справочной системе на основе Unicode, она стала справочной системой по умолчанию для Windows 10 .

СОДЕРЖАНИЕ

История

• Январь 2008 — апрель Рейган [MS PM] пишет, что Microsoft заменит Microsoft Help 2 .
• Апрель 2009 — На конференции WritersUA 2009 апрель Рейган и Ананд Раман объявили, что Microsoft Help 3 будет поставляться вместе с Visual Studio 2010 .
• Ноябрь 2009 г. — предварительный просмотр новой автономной справки, поставляемой с VS 2010 Beta 2.
• Январь 2010 г. — официальное название изменено с Microsoft Help 3.0 на Microsoft Help Viewer 1.0.
• Апрель 2010 г. — Microsoft Help Viewer 1.0 является RTM (Release to Manufacturing) как часть выпуска Visual Studio 2010.
• Март 2011 г. — Microsoft Help Viewer 1.1 поставляется с пакетом обновления 1 для Visual Studio 2010.
• Август 2012 г. — Microsoft Help Viewer 2.0 поставляется с Visual Studio 2012 и ОС Windows 8.

Средство просмотра HelpPane находится в Windows 10. Версия 2.3.

Пользовательский опыт

Пользовательский опыт для Microsoft просмотра справки 1.x является то , что темы могут быть просмотрены в любой установленной веб — браузер — это отдельное приложение, например, в проводнике Microsoft Document включены Microsoft Help 2, не является необходимым. Модель на основе браузера призвана обеспечить более легкую навигацию, загрузку и чтение, чем предыдущие модели средств просмотра справки.

Visual Studio 2010 включает в себя апплет панели задач в области уведомлений Windows (на панели задач), который выбирает между просмотром автономной справки и интерактивной справки в браузере при нажатии клавиши F1 и переводит URI раздела справки на соответствующую страницу темы. Он также включает приложение «менеджер библиотеки» для управления загрузкой, установкой и удалением разделов справки в системе, а также для выбора того, следует ли отдавать предпочтение онлайн-справке при подключении к Интернету.

Microsoft Help Viewer 2.0 использует библиотеку времени выполнения COM, поэтому апплет панели задач больше не используется. Формат без изменений. API среды выполнения доступен через библиотеки DLL .NET, используемые в VS2012 и Windows 8; они эквивалентны, за исключением изменения названия. VS2012 поставляется с более сложным набором инструментов (HlpViewer и HlpCtntMgr), в то время как Windows 8 имеет только программу HelpPane с одной панелью.

Формат файла

Файлы справки из Microsoft Help Viewer имеют расширение .mshc . Это обычные Zip-файлы, содержащие HTML-документы. Для навигации предусмотрены специальные метатеги, а также есть поддержка для подписания пакета справки.

Руководство по окну справки для администраторов 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 you 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 с помощью переопределений разделов реестра. Таким образом можно настроить следующие возможности: You can also disable Visual Studio IDE Help options by using registry key overrides for functionality such as:

подключенная и автономная справка; online versus offline help

установка содержимого при первом запуске интегрированной среды разработки; content installation at first launch of the IDE

указание службы содержимого в интрасети; specifying an intranet content service

управление содержимым. managing content

Развертывание локального содержимого справки из Интернета Deploy local Help content from the internet

Диспетчер содержимого справки (HlpCtntMgr.exe) можно использовать для локального развертывания содержимого справки из Интернета на клиентских компьютерах. You can use Help Content Manager (HlpCtntMgr.exe) to deploy local Help content from the internet to client computers. Используйте следующий синтаксис: Use the following syntax:

Дополнительные сведения о синтаксисе командной строки HlpCtntMgr.exe см. в разделе аргументы командной строки для диспетчера содержимого справки. For more information about HlpCtntMgr.exe command line syntax, see Command-line arguments for the Help Content Manager.

Клиентские компьютеры должны иметь доступ к Интернету. 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.

• Источником справки по умолчанию по-прежнему будет Интернет. 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

Нажмите кнопку Пуск , а затем выберите выполнить. Choose Start and then choose Run.

Введите следующее: Type the following:

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

Нажмите клавишу ВВОД. Press Enter.

Развертывание предустановленного локального содержимого справки на клиентских компьютерах Deploy pre-installed local Help content on client computers

Можно установить набор содержимого из сети на один компьютер, а затем скопировать этот установленный набор содержимого на другие компьютеры. You can install a set of content from online to one computer, and then copy that installed set of content to other computers.

Компьютер, где устанавливается набор содержимого, должен иметь доступ к Интернету. 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.

• Источником справки по умолчанию по-прежнему будет Интернет. 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

В средстве просмотра справки выберите вкладку Управление содержимым. In the Help Viewer, choose the Manage Content tab.

Перейдите к набору документов Visual Studio. Navigate to the Visual Studio document set.

Нажмите кнопку Удалить рядом с каждым вложенным элементом. Choose Remove next to each sub-item.

Выберите Обновить, чтобы выполнить удаление. Choose Update to uninstall.

Перейдите к папку%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

В средстве просмотра справки выберите вкладку Управление содержимым. In the Help Viewer, choose the Manage Content tab.

В разделе Рекомендуемая документация или Доступная документация перейдите к наборам документации, которые требуется скачать, и затем выберите Добавить. Under Recommended Documentation or Available Documentation, navigate to the documentation sets you want to download and then choose Add.

Выберите Обновить. Choose Update.

После этого потребуется упаковать содержимое, чтобы его можно было развертывать на клиентских компьютерах. Next, you need to package the content so it can be deployed to client computers.

Упаковка содержимого To package the content

Создайте папку, чтобы скопировать содержимое для дальнейшего развертывания. Create a folder to copy the content to for later deployment. Например: C:\VSHelp. For example: C:\VSHelp.

Откройте cmd.exe с разрешениями администратора. Open cmd.exe with Administrator permissions.

Перейдите к папке, созданной на шаге 1. Navigate to the folder you created in step 1.

Введите следующее: Type the following:

Xcopy %ProgramData%\Microsoft\HelpLibrary2 \ \ /y /e /k /o

Пример: Xcopy %ProgramData%\Microsoft\HelpLibrary2 c:\VSHelp\ /y /e /k /o For example: Xcopy %ProgramData%\Microsoft\HelpLibrary2 c:\VSHelp\ /y /e /k /o

Развертывание содержимого Deploy the content

Создайте сетевую папку и скопируйте содержимое справки в это место. Create a network share and copy the help content to that location.

Например, скопируйте содержимое в C:\VSHelp в \ \мисервер\вшелп. For example, copy the content in C:\VSHelp to \\myserver\VSHelp.

Создайте 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:

Запустите bat файл на локальных компьютерах, на которых требуется установить содержимое справки. Run the .bat file on the local machines that you want to install the Help content on.

Установка окна справки (Майкрософт) Microsoft Help Viewer installation

В ряде продуктов, включая Visual Studio и SQL Server, содержимое справки может выводиться в окне справки (Майкрософт). Several products can display Help content in Microsoft Help Viewer, including Visual Studio and SQL Server.

Окно справки — это дополнительный компонент установки Visual Studio. Help Viewer is an optional installation component of Visual Studio. Чтобы установить его посредством Visual Studio Installer, выполните указанные ниже действия. To install it through Visual Studio Installer, follow these steps:

Откройте Visual Studio Installer из меню «Пуск» или, если среда Visual Studio открыта, выберите Сервис > Получить средства и компоненты, чтобы открыть Visual Studio Installer. Open Visual Studio Installer from the Start menu or, if you have Visual Studio open, you can choose Tools > Get Tools and Features to open Visual Studio Installer.

Перейдите на вкладку Отдельные компоненты и выберите в разделе Средства для работы с кодом элемент Окно справки. Choose the Individual Components tab, then select Help Viewer under the Code tools section.

Нажмите кнопку Изменить, чтобы начать установку окна справки (Майкрософт). Choose the Modify button to start the installation of Microsoft Help Viewer.

Окно справки (Майкрософт) можно также легко установить с помощью поля поиска: Another way to easily install Microsoft Help Viewer is through the search box:

Нажмите клавиши CTRL + Q , а затем введите или введите в поле поиска окно справки . Press Ctrl+Q and then type or enter help viewer in the search box.

Выберите результат Окно справки (отдельный компонент). Choose the result called Help Viewer (Individual Component).

В открывшемся диалоговом окне нажмите кнопку Установить. In the dialog box that opens, choose the Install button.