В этом кратком руководстве описывается, как создать и развернуть настроенную страницу распространения, содержащую настраиваемые сведения о поддержке. Для изготовителей оборудования (OEM) и сборщиков систем необходимость настройки страницы распространения обусловлена требованием предоставить сведения о поддержке на нескольких языках для разных регионов распространения.

На страницах распространения можно использовать таблицы стилей (CSS-файлы). Для получения дополнительных сведений об использовании особых таблиц CSS для настроенных страниц «Домашняя страница справки» и «Распространение» см. раздел «Инструкции: настройка домашней страницы справки и страницы распространения в документе Руководство по созданию справки (Help_Authoring.chm). Эти справочные материалы находятся в папке \SDKs, которая создается при установке предустановочным набором OPK (Windows OPK) и пакетом автоматической установки Windows (Windows AIK).

Примечание.

Руководство Help_Authoring.chm содержит несколько разделов, с которыми следует ознакомиться перед выполнением инструкций данного руководства. Самыми важными являются следующие два: Как Windows помогает работать и Настройка каталогов для создания и развертывания справки.

Шаблон страницы «Распространение» содержит область авторского содержимого, а также обязательный раздел «Сопровождение Microsoft». Воспользуйтесь этим примером кода в качестве отправной точки для создания собственной страницы распространения.

В этом кратком руководстве используется пример XML-кода со сведениями о вымышленной компании Fabrikam, которая используется исключительно в справочных целях. Для выполнения инструкций данного руководства замените имя компании Fabrikam и соответствующие данные, используя название своей компании и данные о ней.

Структура папок, используемая в этом кратком руководстве, использует подстановочные имена. HelpContent и HelpSetup можно заменить соответствующими именами для фактического содержимого.

Пример кода развертывания пользовательского содержимого справки и поддержки приведен в конце этого раздела как для изготовителя оборудования (OEM), так и для сценария развертывания в организации.

Папка \Samples, которая создается при установке Windows OPK или Windows AIK, содержит примеры пользовательских файлов справки для изготовителей оборудования (OEM) и использования в организации.

Предварительные требования

Для выполнения данного руководства требуется следующее:

  • Обслуживающий компьютер. Дополнительные сведения см. в разделе Создание обслуживающего компьютера.

  • Текстовый редактор с ограниченными возможностями форматирования, например Блокнот.

  • Руководство по созданию справки (Help_Authoring.chm). Оно находится на DVD-дисках Windows OPK и Windows AIK.

  • Лицензионная копия Windows® 7 на DVD-диске.

  • Следующие папки на обслуживающем компьютере:

    • C:\HelpContent\Escalation

    • C:\HelpContent\Escalation\Topics

    • C:\HelpContent\Escalation\Resources

    • C:\HelpSetup\en-US

Шаг 1. Добавление собственного содержимого

  1. Откройте папку C:\HelpContent\Escalation\Topics.

  2. Создайте новый текстовый файл.

  3. Скопируйте и вставьте в файл следующий код, а затем сохраните файл под именем Escalation.xml.

    <?xml version="1.0" encoding="utf-8"?>
    <conceptual contentType="Conceptual" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/maml/2004/10">
    <!--Insert a title for your support page here-->
    <title>Fabrikam Customer Support</title>
    <content>
       <!-- Insert your support information here -->
    <para>
    	<embedObject targetVerification="false">
    	<caption></caption>
    	<objectUri href="mshelp://oem/?id=Fabrikam.Windows.Client.F.PNG" mimeType="image/png">
    		<summary>Fabrikam logo.</summary>
    	</objectUri>
    	</embedObject>
    	</para>
    
    	<para>
    	North America:
    	<navigationLink>
    		<linkText>http://www.fabrikam.com/support</linkText>
    		<uri href="http://www.fabrikam.com/support">
    		<summary>Support site for North America.</summary>
    		</uri>
    	</navigationLink>
    	</para>
    
    	<para>
    	United Kingdom:
    	<navigationLink>
    		<linkText>http://www.fabrikam.co.uk/support</linkText>
    		<uri href="http://www.fabrikam.co.uk/support">
    		<summary>Support site for the United Kingdom.</summary>
    		</uri>
    	</navigationLink>
    	</para>
    
    	<para>
    	Germany:
    	<navigationLink>
    		<linkText>http://www.fabrikam.de/support</linkText>
    		<uri href="http://www.fabrikam.de/support">
    		<summary>Support site for Germany.</summary>
    		</uri>
    	</navigationLink>
    	</para>
    
    	<para>
    	France:
    	<navigationLink>
    		<linkText>http://www.fabrikam.fr/support</linkText>
    		<uri href="http://www.fabrikam.fr/support">
    		<summary>Support site for France.</summary>
    		</uri>
    	</navigationLink>
    	</para>
    	<para>Technical Support (North America): 1-555-123-4567</para>
    	<para>Technical Support (Worldwide): 1-123-456-7890 (Hours are 8:00 A.M. to 5:00 P.M. M-F Pacific Time)</para>
    	<para/>
    	<para>The example companies, organizations, products, domain names, e-mail addresses, logos, people, places, and events depicted herein are fictitious.  No association with any real company, organization, product, domain name, email address, logo, person, places, or events is intended or should be inferred.</para>
    
    <!-- Escalation Page Content End -->
    
    	<sections>
    		 <!--NOTE: The Microsoft escalation module MUST be included as part of your escalation page.  Do not delete the following section.-->
    		 <section replaceWith="mshelp://windows/?id=12345678-1234-1234-1234-123456789000#msft_escalation_module">
    			<title/>
    		 </section>
    	</sections>
       </content>
    </conceptual>
    
  4. Найдите текст <!--Insert a title for your support page here--> и замените его строкой Поддержка заказчиков Fabrikam.

  5. Найдите текст <!--Insert your support information here--> и вставьте сведения о поддержке, предоставляемой вашей компанией.

  6. Сохраните и закройте файл.

  7. Скопируйте файл рисунка (в формате PNG) для эмблемы Fabrikam в файл C:\HelpContent\Escalation\Resources\Fabrikam.Windows.Client.F.PNG

  8. Скопируйте таблицу стилей (CSS-файл) для страницы распространения Fabrikam в файл C:\HelpContent\Escalation\Resources\Fabrikam.Windows.Client.stylesheets.escalation.css.

Шаг 2. Создание файлов проекта

  1. Откройте папку C:\HelpContent\Escalation\.

  2. Создайте новый текстовый файл.

  3. Скопируйте и вставьте в файл следующий код, а затем сохраните файл под именем Escalation.h1c.

    <?xml version="1.0" encoding="utf-8"?>
    <HelpCollection Id="Escalation" DTDVersion="1.0" FileVersion="" LangId="1033" Copyright="(c) 2005 Microsoft Corporation. All rights reserved." Title="Escalation" xmlns="http://schemas.microsoft.com/help/collection/2004/11">
       
       <CompilerOptions CompileResult="H1S" CreateFullTextIndex="Yes" BreakerId="Microsoft.NLG.en.WordBreaker">
       </CompilerOptions>
       
       <VTopicDef File="Escalation.H1V" />
       
       <KeywordIndexDef File="AssetId.H1K" />
       <KeywordIndexDef File="BestBet.H1K" />
       <KeywordIndexDef File="LinkTerm.H1K" />
       <KeywordIndexDef File="SubjectTerm.H1K" />
       
       <ItemMoniker Name="!DefaultTOC" ProgId="HxDs.HxHierarchy" InitData="AnyString" />
       <ItemMoniker Name="!DefaultFullTextSearch" ProgId="HxDs.HxFullTextSearch" InitData="AnyString" />
       <ItemMoniker Name="!DefaultAssetIdIndex" ProgId="HxDs.HxIndex" InitData="AssetId" />
       <ItemMoniker Name="!DefaultBestBetIndex" ProgId="HxDs.HxIndex" InitData="BestBet" />
       <ItemMoniker Name="!DefaultAssociativeIndex" ProgId="HxDs.HxIndex" InitData="LinkTerm" />
       <ItemMoniker Name="!DefaultKeywordIndex" ProgId="HxDs.HxIndex" InitData="SubjectTerm" />
    </HelpCollection>
    
  4. Сохраните и закройте файл.

  5. Откройте папку C:\HelpContent\Escalation\.

  6. Создайте четыре новых текстовых файла со следующими именами.

    • AssetId.h1k

    • BestBet.h1k

    • LinkTerm.h1k

    • SubjectTerm.h1k

  7. Скопируйте следующий код и вставьте его в каждый из файлов, заменив значение атрибута Name соответствующим значением для каждого типа файлов.

    <?xml version="1.0" encoding="utf-8"?>
    <!DOCTYPE HelpIndex>
    <HelpIndex DTDVersion="1.0" Name="[ AssetId | _BestBet | LinkTerm | SubjectTerm]" />
    
  8. Сохраните и закройте файлы.

  9. Откройте папку C:\HelpContent\Escalation\.

  10. Создайте новый текстовый файл.

  11. Скопируйте и вставьте в файл следующий код, а затем сохраните файл под именем Escalation.h1v.

    <?xml version="1.0" encoding="utf-8"?>
    <VTopicSet DTDVersion="1.0" xmlns="http://schemas.microsoft.com/help/vtopic/2004/11">
       <Vtopic Url="topics\escalation.xml" RLTitle="Get customer support or other types of help">
    	<Attr Name="assetid" Value="fabrikam.windows.client.escalation" />
    	<Keyword Index="AssetId" Term="fabrikam.windows.client.escalation" />
    	<FTSText>help support assistance technical support customer service tech support live help phone support help and support center</FTSText>
       </Vtopic>
    	<VTopic Url="resources\Fabrikam.Windows.Client.F.PNG">
    	<Attr Name="assetid" Value="Fabrikam.Windows.Client.F.PNG" />
    	<Keyword Index="AssetId" Term="Fabrikam.Windows.Client.F.PNG" />
       </VTopic>
    </VTopicSet>
    

Шаг 3. Создание файлов уровня коллекции

  1. Откройте папку C:\HelpSetup\en-US\.

  2. Создайте новый текстовый файл.

  3. Скопируйте и вставьте в файл следующий код, а затем сохраните файл под именем Corporate.h1c или OEM.h1c.

    Перед сохранением следующего кода отредактируйте вхождение [OEM_ | Corporate_], удалив скобки и указав правильное имя в зависимости от того, являетесь ли вы изготовителем оборудования (OEM) или корпоративным клиентом.

    <?xml version="1.0"?>
    <HelpCollection xmlns="http://schemas.microsoft.com/help/collection/2004/11" DTDVersion="1.0" LangId="1033" Title="[OEM | Corporate] Collection">
    <TOCDef File="[OEM |  corporate].H1T" Id="InsertTOC:[OEM |  Corporate] "/>
    <KeywordIndexDef File=" [OEM_ | Corporate_ ]AassetIid.H1K"/>
    <KeywordIndexDef File="[OEM_ | Corporate_ ]SubjectTerm.H1K"/>
    <KeywordIndexDef File=" [OEM_ | Corporate_ ]BestBet.H1K"/>
    <KeywordIndexDef File="[OEM_ | Corporate_ ]LinkTerm.H1K"/>
    <ItemMoniker Name ="!DataSource" ProgId="HxDs.HxDataSource" InitData =""/>
    <ItemMoniker Name="!DefaultToc" ProgId="HxDs.HxHierarchy" InitData="AnyString"/>
    <ItemMoniker Name="!DefaultFullTextSearch" ProgId="HxDs.HxFullTextSearch" InitData="AnyString"/>
    <ItemMoniker Name="!DefaultAssetIdIndex" ProgId="HxDs.HxIndex" InitData="AssetId"/>
    <ItemMoniker Name="!DefaultKeywordIndex" ProgId="HxDs.HxIndex" InitData="SubjectTerm"/>
    <ItemMoniker Name="!DefaultAssociativeIndex" ProgId="HxDs.HxIndex" InitData="LinkTerm"/>
    <ItemMoniker Name="!DefaultBestBetIndex" ProgId="HxDs.HxIndex" InitData="BestBet"/>
    </HelpCollection>
    
  4. Сохраните и закройте файл.

  5. Откройте папку C:\HelpSetup\en-US\.

  6. Создайте четыре новых текстовых файла со следующими именами ([OEM | Corporate]) в зависимости от того, являетесь ли вы изготовителем оборудования (OEM) или корпоративным клиентом:

    • [OEM | Corporate]_AssetId.h1k

    • [OEM | Corporate]_BestBet.h1k

    • [OEM | Corporate]_LinkTerm.h1k

    • [OEM | Corporate]_SubjectTerm.h1k

    Скопируйте и вставьте в каждый файл следующий код. Замените значение атрибута Name соответствующим значением для каждого типа файла.

    <?xml version="1.0"?> <HelpIndex xmlns="http://schemas.microsoft.com/help/collection/2004/11" DTDVersion="1.0" Name="[AssetId | BestBet | LinkTerm | SubjectTerm]"> </HelpIndex>

  7. Откройте папку C:\HelpSetup\en-US\.

  8. Создайте новый текстовый файл.

  9. Скопируйте и вставьте в файл следующий код, а затем сохраните файл под именем Corporate.h1t или OEM.h1t.

    <?xml version="1.0"?> <HelpTOC xmlns="http://schemas.microsoft.com/help/collection/2004/11" DTDVersion = "1.0" Id = "Apv1_TOC" FileVersion = "1.0.0.0" LangId ="1033" ParentNodeIcon = "Book" PluginStyle = "Hierarchical" > <HelpTOCNode Url="mshelp://OEM/?tocid=TOCRoot"> <HelpTOCNode Url="mshelp://OEM/?tocid=Fabrikam_Information" Title="Fabrikam Information" > <HelpTOCNode Url="mshelp://oem/?id=Fabrikam.Windows.Client.helphome" Title="Fabrikam Home" /> <HelpTOCNode Url="mshelp://oem/?id=fabrikam.windows.client.escalation" Title="Fabrikam Support" /> </HelpTOCNode> </HelpTOCNode> </HelpTOC>

  10. Сохраните и закройте файл.

Шаг 4. Создание файлов откомпилированной справки

  1. Примечание.

    Перед тем как использовать следующий путь, отредактируйте [Windows OPK | Windows AIK], удалив скобки и указав требуемое расположение в зависимости от того, используется ли Windows OPK или Windows AIK.

    Откройте окно командной строки и перейдите в каталог «C:\Program Files\[Windows OPK | Windows AIK]\SDKs\Help and Support\AP Help Compiler\X86».

  2. Введите следующую команду:

    apcompnt.exe -p C:\ Helpcontent\escalation\Escalation.h1c -o C:\Helpsetup\en-US\Escalation.h1s
    
    H1S-файл будет создан в папке C:\Helpsetup\en-US.

Шаг 5. Создание файла HelpConfig.xml

  1. Создайте новый текстовый файл.

  2. Скопируйте и вставьте в файл следующий код, а затем сохраните файл как %WINDIR%\Help\HelpConfig.xml.

    При настройке в оперативном режиме эта папка находится на конечном компьютере. Активной установкой Windows называется установка Windows, под управлением которой компьютер работает в настоящий момент.

    При настройке в автономном режиме эта папка находится на обслуживающем компьютере. Автономная установка Windows представляет собой образ Windows, который не выполняется в текущий момент. Образ Windows может представлять собой WIM-файл или установку Windows, находящуюся на отдельном разделе.

    <oemHelpIns xmlns="urn:schemas.microsoft.com:oemhelpins"> <credentials domain="" userName="" password=""/> <content path="C:\HelpSetup\"/> <customization type="home" pageUrl="" cssUrl=""/> <customization type="escalation" pageUrl="mshelp://oem/?id=fabrikam.windows.client.escalation" cssUrl=""/> </oemHelpIns>

    Примечание.

    Для URL-адресов в файле конфигурации следует использовать форму mshelp://oem/?id=

    Корпоративному клиенту нужно заменить «oem» на «corporate» в pageurl.

    Этот файл HelpConfig использует стандартную таблицу стилей корпорации Майкрософт, применяемую для клиента центра справки и поддержки. Пользователям рекомендуется использовать именно эту таблицу стилей, так как такой подход сократит время запуска.

    Если нужно использовать собственную таблицу стилей, выполните для своего файла HelpConfig.xml следующие действия:

    <oemHelpIns xmlns="urn:schemas.microsoft.com:oemhelpins"> <credentials domain="" userName="" password=""/> <content path="C:\HelpSetup\"/> <customization type="home" pageUrl="" cssUrl=""/> <customization type="escalation" pageUrl="mshelp://oem/?id=fabrikam.windows.client.escalation" cssUrl="mshelp://oem/?id=Fabrikam.Windows.Client.stylesheets.escalation.css"/> </oemHelpIns>

    корпоративному клиенту нужно заменить «oem» на «corporate» в pageurl.

    Если нужно также настроить домашнюю страницу, добавьте URL-адрес своей домашней страницы и убедитесь, что файл конфигурации справки выглядит следующим образом:

    <oemHelpIns xmlns="urn:schemas.microsoft.com:oemhelpins"> <credentials domain="" userName="" password=""/> <content path="C:\HelpSetup\"/> <customization type="home" pageUrl="mshelp://oem/?id=Fabrikam.Windows.Client.helphome" cssUrl=""/> <customization type="escalation" pageUrl="mshelp://oem/?id=fabrikam.windows.client.escalation" cssUrl="mshelp://oem/?id=Fabrikam.Windows.Client.stylesheets.escalation.css"/> </oemHelpIns>

    Если нужно настроить собственную таблицу стилей для домашней страницы, добавьте URL-адрес CSS-файла (cssURL).

Дальнейшие действия

Добавление пользовательской справки в активный образ-образец с помощью OCSetup

  1. Загрузите конечный компьютер в режиме аудита.

    Из появившейся командной строки с повышенными привилегиями выполните команду %windir%\system32\Sysprep\sysprep.exe /audit

    Дополнительные сведения о режиме аудита см. в разделе Принципы работы Sysprep.

    Компьютер завершит работу и перезагрузится.

  2. Убедитесь, что вход выполнен под учетной записью с правами администратора.

  3. На конечном компьютере нажмите кнопку Пуск и последовательно выберите пункты Все программы, Стандартные и Командная строка.

    Откроется окно командной строки.

  4. В командной строке введите одну из следующих команд, чтобы выполнить OCSetup. (Выбор зависит от того, кем выполняется настройка - изготовителем оборудования (OEM) или корпорацией.)

    start /w OCSetup OEMHelpCustomization 
    
    - Или -

    start /w OCSetup CorporationHelpCustomization
    
  5. Удалите с компьютера файл HelpConfig.xml.

Добавление пользовательской справки в автономный образ-образец с помощью системы обслуживания образов развертывания и управления ими (DISM)

  1. Нажмите кнопку Пуск и последовательно выберите пункты Все программы, Windows OPK или Windows AIK, щелкните правой кнопкой мыши пункт Командная строка средств Windows PE и выберите пункт Запуск от имени администратора.

  2. Чтобы подключить автономный образ, введите следующую команду:

    DISM.exe /Mount-Wim /WimFile:C:\install.wim /index:1 /MountDir:Z:\wim_mount
    
    В этой команде Z:\wim_mount указывает папку подключения, C:\install.wim - имя и расположение WIM-файла, который нужно подключить, а 1 - номер конкретного тома в WIM-файле.

  3. Выполните одно из следующих действий.

    • Чтобы включить содержимое справки, настроенное изготовителем оборудования (OEM), введите следующую команду для запуска DISM.

      DISM.exe /image:Z:\wim_mount /Enable-Feature /FeatureName:OEMHelpCustomization 
      
    • Чтобы включить специализированное корпоративное содержимое, введите следующую команду.

      DISM.exe /image:Z:\wim_mount /Enable-Feature /FeatureName:CorporationHelpCustomization
      
    Система DISM сначала выполняет поиск файла HelpConfig.xml на компьютере, где запущено это средство, используя путь %WINDIR%\Help\HelpConfig.xml. Если файл HelpConfig.xml отсутствует в этом расположении, то DISM выполняет поиск в том же каталоге изменяемого подключенного образа.

Добавление пользовательской справки в активный образ-образец

Используйте одну из перечисленных ниже команд.

dism /online /enable-feature /featureName:OEMHelpCustomization

или

dism /online /enable-feature /featureName:CorporationHelpCustomization

Примечание.

Систему DISM также можно запустить в среде предустановки Windows, что позволяет изменять образ Windows, установленный на локальном жестком диске. В этом случае, предполагая, что ОС Windows установлена на диске C, удалите раздел в соответствующей командной строке шага 3, начиная с /image:<путь_к_образу> /WinDir:<путь_к_WinDIr>, и замените его следующей командой: //online.

Важно!

Не следует включать пользовательские пакеты справки в пакет Microsoft-Windows-Foundation. Не следует включать компоненты измененной справки CorporationHelpCustomization и OEMHelpCustomization в пакете Microsoft-Windows-Foundation. Данные компоненты следует включать, только если все правильные файлы и ресурсы справки находятся в образе Windows в правильных расположениях. Включение любого из этих компонентов при неправильно расположенных ресурсах справки может вызвать сбой установки Windows. Сведения о создании пользовательской справки Windows 7 см. в руководстве по созданию справки Windows.

Дополнительные сведения о среде предустановки Windows см. в разделе Работа с Windows PE.

Удаление пользовательской справки для активной и автономной установок

Используйте одну из перечисленных ниже команд.

dism /online /disable-feature /featureName:OEMHelpCustomization

- или -

dism /image:z:\wim_mount /disable-feature /featureName:OEMHelpCustomization

См. также