Microsoft Help Viewer SDK

tento článek obsahuje následující úlohy pro Visual Studio integrátorů Help vieweru:

  • Vytvoření tématu (podpora F1)

  • Vytvoření balíčku s obsahem brandingu v prohlížeči nápovědy

  • Nasazení sady článků

  • přidání helpu do prostředí Visual Studio (integrovaný nebo izolovaný režim)

  • Další materiály

Vytvoření tématu (podpora F1)

V této části najdete Přehled součástí prezentovaného tématu, požadavky na téma, krátký popis postupu vytvoření tématu (včetně požadavků na podporu F1) a nakonec příklad tématu s jeho vykresleným výsledkem.

Přehled témat v programu Help Viewer

Když je pro vykreslování k dispozici téma, aplikace Help Viewer získá prvky balíčku, které jsou spojeny s tématem v době instalace nebo Poslední aktualizace, společně s tématem XHTML a zkombinuje dvě k výsledku v zobrazení prezentovaného obsahu (branding data + data tématu). Brandingový balíček obsahuje loga, podporu pro chování obsahu a text brandingu (Copyright atd.). Další informace o prvcích balíčku brandingu najdete níže v části "vytvoření balíčku branding" níže. V případě, že se k tématu nevztahují žádné balíčky brandingu, aplikace Help Viewer použije záložní balíček brandingu umístěný v kořenovém adresáři aplikace Help Viewer (Branding_en-US. mshc).

Požadavky na téma v prohlížeči nápovědy

Aby se obsah obsahu nezpracovaných témat správně vykreslil v aplikaci Help Viewer, musí být W3C Basic 1,1 XHTML.

Téma obvykle obsahuje dvě části:

  • Metadata (viz Referenční dokumentace metadat obsahu): data o tématu, například téma jedinečné ID, hodnota klíčového slova, ID obsahu tématu, ID nadřazeného uzlu atd.

  • Obsah těla: kompatibilní se standardem W3C Basic 1,1 XHTML, který zahrnuje chování podporovaného obsahu (sbalitelná oblast, fragment kódu atd.) Zobrazí se úplný seznam.

Visual Studio Ovládací prvky podporované balíčkem pro branding:

  • Odkazy

  • CodeSnippet

  • CollapsibleArea

  • Zděděný člen

  • LanguageSpecificText

Podporované řetězce jazyka (bez rozlišení velkých a malých písmen):

  • javascript

  • CSharp nebo c #

  • cplusplus nebo VisualC + + nebo c++

  • skript

  • VisualBasic nebo VB

  • f # nebo FSharp nebo FS

  • jiný – řetězec, který představuje název jazyka

Vytvoření tématu v programu Help Viewer

Vytvořte nový dokument XHTML s názvem ContosoTopic4.htm a přidejte značku title (níže).

<html>
<head>
<title>Contoso Topic 4</title>
</head>

<body>

</body>
</html>

Dále přidejte data a definujte, jak se má téma prezentovat (vlastní značka nebo ne), jak odkazovat na toto téma pro F1, kde toto téma existuje v rámci obsahu, jeho ID (odkazování podle jiných témat) atd. Úplný seznam podporovaných metadat naleznete v tabulce metadata obsahu.

  • v tomto případě použijeme náš vlastní balíček brandingu, což je varianta balíčku Visual Studio Help vieweru.

  • Přidejte hodnoty meta Name a value pro F1 ("Microsoft. help. F1" content = "ContosoTopic4"), které budou odpovídat zadané hodnotě F1 v kontejneru vlastností IDE. (Další informace najdete v části podpory F1.) Toto je hodnota, která se shoduje s voláním F1 z rozhraní IDE pro zobrazení tohoto tématu v případě, že je v integrovaném vývojovém prostředí zvolena klávesa F1.

  • Přidejte ID tématu. Toto je řetězec, který se používá v jiných tématech pro propojení s tímto tématem. Je to ID programu Help Viewer pro toto téma.

  • Pro obsah přidejte nadřazený uzel tohoto tématu a definujte, kde se bude tento uzel obsahu tématu zobrazovat.

  • V části obsah přidejte pořadí uzlů tohoto tématu. Pokud má nadřazený uzel n počet podřízených uzlů, definujte v pořadí podřízených uzlů umístění tohoto tématu. Toto téma má například počet 4 podřízených témat.

Příklad oddílu metadata:

<html>
<head>
<title>Contoso Topic 4</title>

<meta name="SelfBranded" content="false" />
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <meta name="Microsoft.Help.Id" content="ContosoTopic4" />
<meta name="Microsoft.Help.F1" content=" ContosoTopic4" />
    <meta name="Language" content="en-us" />
<meta name="Microsoft.Help.TocParent" content="ContosoTopic0" />
<meta name="Microsoft.Help.TocOrder" content="4" />

</head>

<body>

</body>
</html>

Tělo tématu

Tělo (bez záhlaví a zápatí) tématu bude obsahovat odkazy na stránky, oddíl poznámky, sbalitelnou oblast, fragment kódu a oddíl textu pro konkrétní jazyk. Informace o oblastech prezentovaného tématu najdete v části branding.

  1. Přidat značku nadpisu tématu: <div class="title">Contoso Topic 4</div>

  2. Přidat oddíl Poznámky: <div class="alert"> add your table tag and text </div>

  3. Přidat sbalitelnou oblast: <CollapsibleArea Expanded="1" Title="Collapsible Area Test Heading"> add text </CollapsibleArea>

  4. Přidat fragment kódu: <CodeSnippet EnableCopyCode="true" Language="CSharp" ContainsMarkup="false" DisplayLanguage="C#" > a block of code </CodeSnippet>

  5. Přidat text specifický pro jazyk kódu: <LanguageSpecificText devLangcs="CS" devLangvb="VB" devLangcpp="C++" devLangnu="F#" /> Všimněte si, že devLangnu= je možné zadat jiné jazyky. Například devLangnu="Fortran" zobrazí FORTRAN, když fragment kódu DisplayLanguage = FORTRAN

  6. Přidat odkazy na stránky: <a href="ms-xhelp:///?Id=ContosoTopic1">Main Topic</a>

Poznámka

Poznámka: pro nepodporovaný nový "jazyk zobrazení" (příklad, verze F #, COBOL, FORTRAN) ve fragmentu kódu bude monochromatický.

Příklad tématu Help Viewer Kód ukazuje, jak definovat metadata, fragment kódu, sbalitelnou oblast a text specifický pro jazyk.

<?xml version="1.0" encoding="utf-8"?>
<html>
<head>
<title>Contoso Topic 4</title>

    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <meta name="Microsoft.Help.Id" content="ContosoTopic4" />
<meta name="Microsoft.Help.F1" content=" ContosoTopic4" />
    <meta name="Language" content="en-us" />
<meta name="Microsoft.Help.TocParent" content="ContosoTopic0" />
<meta name="Microsoft.Help.TocOrder" content="4" />
<meta name="SelfBranded" content="false" />
</head>

<body>
<div class="title">Contoso Topic 4</div>

  <div id="header">
<table id="bottomTable" cellpadding="0" cellspacing="0"  width="100%">
        <tr id="headerTableRow2"><td align="left">
            <span id="nsrTitle">Contoso Topic 1</span>
          </td>
<td align="right">
</td></tr>
<tr id="headerTableRow1"><td align="left">
            <span id="runningHeaderText">Contoso Widgets & Sprockets</span>
          </td></tr>
      </table>
</div>

<h2>Table of Contents</h2>

<ul class="toc">
<li class="tocline1"><a href="#introduction" target="_self">1.0 Introduction</a></li>
<li class="tocline1"><a href="#seealso" target="_self">See Also</a></li>
</ul>

<div class="topic">

<div id="mainSection">
<div id="mainBody">

<a name="introduction"></a>
<h2>1.0 Introduction</h2>
<p>[This documentation is for sample purposes only.]</p>

<p>Contoso Topic 1 contains examples of:
<ul>
<li>Collapsible Area</li>
<li>Bookmark ("See also")</li>
<li>Code Snippets from Branding Package</li>
</ul>
 </p>
<div class="alert"><table><tr><th>
<strong>Note </strong></th></tr>
<tr><td>
<p>This is an example of a <span class="label">Note </span>section.
Call out important items for your reader in this <span class="label">Note </span>box.
</p></td></tr>
</table>
</div>
</div>

<CollapsibleArea Expanded="1" Title="Collapsible Area Test Heading">

            <a id="sectionToggle0"><!----></a>

<div>
Example of Collapsible Area
<br/>
Lorem ipsum dolor sit amet...
</div>
</CollapsibleArea>

<div id="snippetGroup" >
<CodeSnippet EnableCopyCode="true" Language="VisualBasic" ContainsMarkup="false" DisplayLanguage="Visual Basic" >
Private Sub ToolStripRenderer1_RenderGrip(sender as Object, e as ToolStripGripRenderEventArgs) _ Handles ToolStripRenderer1.RenderGrip
Dim messageBoxVB as New System.Text.StringBuilder()
    messageBoxVB.AppendFormat("{0} = {1}", "GripBounds", e.GripBounds)
    messageBoxVB.AppendLine()
 ...
    MessageBox.Show(messageBoxVB.ToString(),"RenderGrip Event")
End Sub
</CodeSnippet>

<CodeSnippet EnableCopyCode="true" Language="CSharp" ContainsMarkup="false" DisplayLanguage="C#" >
private void ToolStripRenderer1_RenderGrip(Object sender, ToolStripGripRenderEventArgs e)
{
System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "GripBounds", e.GripBounds );
messageBoxCS.AppendLine();
...
MessageBox.Show(messageBoxCS.ToString(), "RenderGrip Event" );
}
</CodeSnippet>

<CodeSnippet EnableCopyCode="true" Language="fsharp" ContainsMarkup="false" DisplayLanguage="F#" >
some F# code
</CodeSnippet>
</div>

<h4 class="subHeading">Example of code specific text</h4>Language = <LanguageSpecificText devLangcs="CS" devLangvb="VB" devLangcpp="C++" devLangnu="F#" />

<a name="seealso"></a>
<h1 class="heading">See Also</h1>

    <div id="seeAlsoSection" class="section">
    <div class="seeAlsoStyle">
        <a href="ms-xhelp:///?Id=ContosoTopic1">Main Topic</a>
    </div>
 </div>
</div>
</div>
</body>
</html>

Podpora F1

v Visual Studio vygeneruje klávesa F1 hodnoty zadané z umístění kurzoru v rámci rozhraní IDE a naplní "kontejner objektů a dat" dodanými hodnotami (na základě umístění kurzoru). Když je ukazatel nad funkcí x, je funkce x aktivní/v zaostření a naplní kontejner objektů a hodnot. když je vybraná klávesa f1, naplní se kontejner objektů a Visual Studio f1, aby bylo možné zjistit, zda je výchozí zdroj nápověda místní nebo online (online je výchozí). pak vytvoří příslušný řetězec na základě nastavení uživatelů (online je výchozí nastavení) – spuštění prostředí (další informace najdete v příručce pro správce nápovědy k parametrům spuštění exe) s parametry pro místní nápovědu a klíčová slova v kontejneru objektů a dat, nebo adresu URL MSDN s klíčovým slovem v seznamu parametrů.

Pokud jsou vraceny tři řetězce pro F1, označované jako řetězec s více hodnotami, vezměte první výraz, vyhledejte nalezený a pokud se najde, jsme hotovi. Pokud ne, přejděte k dalšímu řetězci. Otázky objednávky. Prezentace klíčových slov s více hodnotami by měla být nejdelší řetězec na nejkratší řetězec. Pokud to chcete ověřit v případě klíčových slov s více hodnotami, podívejte se na řetězec adresy URL online F1, který bude obsahovat zvolené klíčové slovo.

v Visual Studio 2012 jsme záměrně provedli silnější dělení mezi online a offline, takže pokud bylo nastavení uživatele pro online, pak jsme jednoduše předali požadavek F1 přímo na naši online dotazovací službu na webu MSDN místo směrování prostřednictvím agenta knihovny pro nápovědu, který měl v Visual Studio 2010. Pak se pak spoléhá na stav "nainstalovaného obsahu dodavatele = true" a určí, jestli se v daném kontextu něco liší. Pokud je hodnota true, pak tuto logiku analýzy a směrování provádíme v závislosti na tom, co chcete pro vaše zákazníky podpořit. Pokud je hodnota false, stačí přejít na web MSDN. Pokud je nastavení uživatele místní, pak všechna volání přejdou do místního modulu nápovědy.

Flow Diagram F1:

Průběh F1

Když je zdroj obsahu výchozí nápovědy aplikace Help Viewer nastaven na hodnotu online (spustit v prohlížeči):

  • Visual Studio Funkce partner (VSP) emitují hodnotu do kontejneru vlastností F1 (prefix kontejneru objektů a adresy URL online pro předponu, která se nachází v registru): F1 pošle prohlížeči adresu URL a parametry VSP.

  • funkce Visual Studio (editor jazyka, Visual Studio konkrétní položky nabídky atd.): F1 pošle do prohlížeče adresu URL Visual Studio.

Když je zdroj obsahu výchozí nápovědy aplikace Help Viewer nastavený na místní (spustit v aplikaci Help Viewer):

  • Funkce VSP, kde se shoduje klíčové slovo mezi kontejnerem vlastností F1 a indexem místního úložiště (tj. předpona kontejneru vlastností. klíčové slovo = hodnota nalezená v místním indexu úložiště): F1 vykreslí téma v programu Help Viewer.

  • Visual Studio funkce (žádná možnost pro parametr VSP pro přepsání kontejneru objektů a dat vygenerovaných z funkcí Visual Studio): F1 vykreslí Visual Studio téma v programu Help Viewer.

Nastavte následující hodnoty registru, aby se pro obsah Nápověda dodavatele povolila možnost F1 Fallback. Příkaz F1 Fallback znamená, že aplikace Help Viewer je nastavená tak, aby hledala obsah nápovědy pro F1 online, a obsah dodavatele se instaluje místně na pevný disk uživatele. V programu Help Viewer by se měla zobrazovat informace o místní nápovědě k obsahu, i když je výchozí nastavení pro online nápovědu.

  1. V klíči registru Help 2,3 nastavte hodnotu VendorContent :

    • Pro 32 operační systémy:

      HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Help\v2.3\Catalogs\VisualStudio15

      "VendorContent" = DWORD: 00000001

    • Pro 64 operační systémy:

      HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15

      "VendorContent" = DWORD: 00000001

  2. Zaregistrujte obor názvů partnera v klíči registru Help 2,3:

    • Pro 32 operační systémy:

      \ Obor názvů > HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Help\v2.3\Partner<

      "umístění" = "offline"

    • Pro 64 operační systémy:

      \ Obor názvů > HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Partner<

      "umístění" = "offline"

Základní analýza oboru názvů Native

Pokud chcete zapnout analýzu základního nativního oboru názvů, přidejte v registru novou hodnotu DWORD s názvem BaseNativeNamespaces a nastavte její hodnotu na 1 (pod klíč katalogu, který chtějí podporovat). Pokud například chcete použít Visual Studio, můžete přidat klíč do cesty:

HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15

Při použití klíčového slova F1 ve formátu HEADER/METHOD se parsuje znak "/", což vede k následujícímu konstruktoru:

  • HLAVIČKA: bude obor názvů, který lze použít k registraci v registru.

  • METODA: To se stane klíčovým slovem, které se předává.

Pokud například použijete vlastní knihovnu s názvem CustomLibrary a metodu s názvem MyTestMethod, bude požadavek F1 naformátován jako CustomLibrary/MyTestMethod .

Uživatel pak může zaregistrovat CustomLibrary jako obor názvů v rámci partnerského podregistru a zadat klíč umístění, který si přeje, a klíčové slovo předané dotazu bude MyTestMethod.

Povolení nástroje pro ladění nápovědy v integrovaném vývojovém prostředí (IDE)

Přidejte následující klíč a hodnotu registru:

HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\15.0\Dynamic Help

HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\16.0\Dynamic Help

Hodnota: Zobrazit výstup ladění v maloobchodních datech: ANO

V integrovaném vývojovém prostředí (IDE) v položce nabídky Nápověda vyberte Ladit kontext nápovědy.

Metadata obsahu

V následující tabulce je libovolný řetězec, který se zobrazí mezi hranatými závorkami, zástupný symbol, který musí být nahrazen rozpoznanou hodnotou. Například v <meta name="Microsoft.Help.Locale" content="[language code]" /> souboru musí být "[kód jazyka] nahrazen hodnotou, například "en-us".

Vlastnost (reprezentace HTML) Popis
< meta name="Microsoft.Help.Locale" content="[language-code]" /> Nastaví národní prostředí pro toto téma. Pokud se tato značka používá v tématu, musí se použít jenom jednou a musí se vložit nad všechny ostatní značky nápovědy Microsoftu. Pokud se tato značka nepoužít, text textu tématu se indexuje pomocí jističe slov přidruženého k národního prostředí produktu, pokud je zadaný. Jinak se použije jistič slov en-us. Tato značka odpovídá dokumentu ISOC RFC 4646. Pokud chcete zajistit, aby nápověda microsoftu správně funguje, použijte tuto vlastnost místo obecného atributu jazyka.
< meta name="Microsoft.Help.TopicLocale" content="[language-code]" /> Nastaví národní prostředí pro toto téma, pokud se používají také jiná národní prostředí. Pokud se tato značka používá v tématu, musí se použít jenom jednou. Tuto značku použijte, pokud katalog obsahuje obsah ve více než jednom jazyce. Více témat v katalogu může mít stejné ID, ale každé z nich musí zadat jedinečnou hodnotu TopicLocale. Téma, které určuje TopicLocale, které odpovídá národního prostředí katalogu, je téma, které se zobrazuje v obsahu. Všechny jazykové verze tématu se ale zobrazují ve výsledcích hledání.
< title>[Title]</title> Určuje název tohoto tématu. Tato značka je povinná a musí se v tématu používat jenom jednou. Pokud text tématu neobsahuje oddíl title, zobrazí se tento Název v tématu a <div> v obsahu.
< meta name=" Microsoft.Help.Keywords" content="[aKeywordPhrase]"/> Určuje text odkazu, který se zobrazí v podokně indexu v prohlížeči nápovědy. Po kliknutí na odkaz se zobrazí téma. Pro téma můžete zadat více klíčových slov indexu, nebo můžete tuto značku vynechat, pokud nechcete, aby se odkazy na toto téma v indexu objevily. Klíčová slova "K" z předchozích verzí nápovědy lze převést na tuto vlastnost.
< meta name="Microsoft.Help.Id" content="[TopicID]"/> Nastaví identifikátor pro toto téma. Tato značka je povinná a musí se v tématu používat jenom jednou. ID musí být jedinečné mezi tématy v katalogu, která mají stejné nastavení národního prostředí. V jiném tématu můžete vytvořit odkaz na toto téma pomocí tohoto ID.
< meta name="Microsoft.Help.F1" content="[System.Windows.Controls.Primitives.IRecyclingItemContainerGenerator]"/> Určuje klíčové slovo F1 pro toto téma. Pro téma můžete zadat více klíčových slov F1, nebo můžete tuto značku vynechat, pokud nechcete, aby se toto téma zobrazovat, když uživatel aplikace stiskne klávesu F1. Obvykle je pro téma určeno pouze jedno klíčové slovo F1. Klíčová slova "F" z předchozích verzí nápovědy lze převést na tuto vlastnost.
< meta name="Description" content="[topic description]" /> Poskytuje krátký souhrn obsahu v tomto tématu. Pokud se tato značka používá v tématu, musí se použít jenom jednou. K této vlastnosti se přistupuje přímo z knihovny dotazů. Není uložený v indexových souborech.
meta name="Microsoft.Help.TocParent" content="[parent_Id]"/> Určuje nadřazené téma tohoto tématu v obsahu. Tato značka je povinná a musí se v tématu používat jenom jednou. Hodnota je Microsoft.Help.Id nadřazené položky. Téma může mít v obsahu jenom jedno umístění. "-1" se považuje za ID tématu kořenového adresáře toc. V Visual Studio 2013 systému je tato stránka domovskou stránkou prohlížeče nápovědy. To je stejný důvod, proč jsme do některých témat konkrétně přidávají TocParent=-1, aby se zajistilo, že se zobrazí na nejvyšší úrovni. Domovská stránka prohlížeče nápovědy je systémová stránka, takže ji není možné nahradit. Pokud se sp pokusí přidat stránku s ID -1, může se přidat do sady obsahu, ale Prohlížeč nápovědy bude vždy používat systémovou stránku – domovská stránka help vieweru
< meta name="Microsoft.Help.TocOrder" content="[positive integer]"/> Určuje, kde se toto téma v obsahu zobrazuje vzhledem k jeho partnerským tématům. Tato značka je povinná a musí se v tématu používat jenom jednou. Hodnota je celé číslo. Nad tématem, které určuje celé číslo s vyšší hodnotou, se zobrazí téma, které určuje celé číslo s vyšší hodnotou.
< meta name="Microsoft.Help.Product" content="[product code]"/> Určuje produkt, který popisuje toto téma. Pokud se tato značka používá v tématu, musí se použít jenom jednou. Tyto informace lze také dodat jako parametr, který se předává indexeru nápovědy.
< meta name="Microsoft.Help.ProductVersion" content="[version number]"/> Určuje verzi produktu, kterou popisuje toto téma. Pokud se tato značka používá v tématu, musí se použít jenom jednou. Tyto informace lze také dodat jako parametr, který se předává indexeru nápovědy.
< meta name="Microsoft.Help.Category" content="[string]"/> Používá se v produktech k identifikaci pododdílů obsahu. Můžete identifikovat více pododdílů tématu, nebo můžete tuto značku vynechat, pokud nechcete, aby odkazy identifikovaly jakékoli pododdíly. Tato značka se používá k ukládání atributů targetOS a TargetFrameworkMoniker při převodu tématu ze starší verze nápovědy. Formát obsahu je AttributeName:AttributeValue.
< meta name="Microsoft.Help.TopicVersion content="[topic version number]"/> Určuje tuto verzi tématu, pokud v katalogu existuje více verzí. Vzhledem k tomu, že Microsoft.Help.Id nezaručuje jedinečnost, je tato značka vyžadována, pokud v katalogu existuje více než jedna verze tématu, například když katalog obsahuje téma pro .NET Framework 3.5 a téma pro .NET Framework 4 a oba mají stejné Microsoft.Help.Id.
< meta name="SelfBranded" content="[TRUE or FALSE]"/> Určuje, jestli toto téma používá balíček brandingu pro spuštění Správce knihovny nápovědy nebo balíček brandingu, který je specifický pro toto téma. Tato značka musí mít hodnotu TRUE nebo FALSE. Pokud má hodnotu TRUE, balíček brandingu pro přidružené téma přepíše balíček brandingu, který se nastaví při spuštění Správce knihovny nápovědy, aby se téma vykresloval podle zamýšleného nastavení, i když se liší od vykreslování jiného obsahu. Pokud má hodnotu FALSE, aktuální téma se vykreslí podle balíčku brandingu, který se nastaví při spuštění Správce knihovny nápovědy. Ve výchozím nastavení správce knihovny nápovědy předpokládá, že vlastní branding má hodnotu false, pokud není proměnná SelfBranded deklarována jako TRUE. Proto není nutné deklarovat <meta name="SelfBranded" content="FALSE"/> .

Vytvoření balíčku brandingu

Verze Visual Studio zahrnuje řadu různých produktů Visual Studio, včetně izolovaných a integrovaných prostředí pro Visual Studio partnery. Každý z těchto produktů vyžaduje do určité míry podporu brandingu obsahu nápovědy, která je pro produkt jedinečná. Například témata Visual Studio konzistentní prezentaci značky, zatímco aplikace SQL Studio, která zabaluje ISO Shell, vyžaduje vlastní jedinečnou značku obsahu nápovědy pro každé téma. Partner integrovaného prostředí může chtít, aby témata nápovědy byla v rámci nadřazeného obsahu Visual Studio obsahu nápovědy k produktu při zachování vlastního brandingu témat.

Balíčky brandingu jsou nainstalovány produktem, který obsahuje Prohlížeč nápovědy. Pro Visual Studio produkty:

  • V kořenovém adresáři aplikace Help Viewer 2.3 je nainstalován záložní balíček brandingu (Branding_ .ms the ms the help viewer 2.3) pomocí jazykové sady Help <locale> Viewer (například C:\Program Files (x86)\Microsoft Help Viewer\v2.3). Používá se v případech, kdy není nainstalovaný balíček značky produktu (nebyl nainstalován žádný obsah) nebo když je nainstalovaný balíček značky poškozený. Při Visual Studio kořenového brandingu aplikace se ignorují základní prvky (logo a zpětná vazba).

  • Když Visual Studio obsah nainstalovaný ze služby balíčků obsahu, nainstaluje se také balíček brandingu (při první instalaci obsahu). Pokud dojde k aktualizaci balíčku brandingu, aktualizace se nainstaluje při příští aktualizaci obsahu nebo při další akci instalace balíčku.

Tato Microsoft Help Viewer podporuje branding témat na základě metadat témat.

  • Kde metadata tématu definují vlastní značku = true, vykreslují téma tak, jak je, nedělat nic (pokud jde o branding).

  • Kde metadata tématu definují značku sebe sama = false, použijte balíček brandingu přidružený k hodnotě metadat TopicVendor.

  • Kde metadata tématu definují name="Microsoft.Help.TopicVendor" content= , použijte balíček < branding package name in vendor MSHA> brandingu definovaný v hodnotě obsahu.

  • V Visual Studio katalogu se používá prioritní použití balíčků brandingu. Nejprve Visual Studio výchozí branding, a pokud je definovaná v metadatech tématu a podporována přidruženým balíčkem brandingu (jak je definováno v instalačním souboru msha), použije se branding definovaný dodavatelem jako přepsání.

Prvky brandingu obvykle spadají do tří hlavních kategorií:

  • Elementy záhlaví (příklady zahrnují odkaz na zpětnou vazbu, text podmíněného právní omezení, logo)

  • Chování obsahu (příklady zahrnují rozbalení/sbalení ovládacích prvků textu a prvky fragmentu kódu)

  • Prvky zápatí (příklad autorského práva)

K položkám, které se považují za značky, patří (podrobné v této specifikaci):

  • Logo pro katalog/produkt (například Visual Studio)

  • Odkaz na zpětnou vazbu a e-mailové prvky

  • Text právního omezení

  • Text copyrightu

podpůrné soubory v balíčku nápovědy pro Visual Studio Help Viewer zahrnují:

  • Grafika (loga, ikony atd.)

  • Soubory skriptu Branding.js podporující chování obsahu

  • Branding.xml – řetězce, které se konzistentně používají v rámci obsahu katalogu. poznámka: pro Visual Studio prvky lokalizace textu v branding.xml přidejte _locID = " <unique value> ".

  • Branding. CSS – definice stylů pro konzistenci prezentace

  • Tisk. CSS – definice stylů pro konzistentní tištěnou prezentaci

Jak je uvedeno výše, balíčky branding jsou spojené s tématem:

  • Pokud jsou v metadatech definované SelfBranded = false, téma zdědí balíček brandingu katalogu.

  • Nebo pokud je SelfBranded = false a v MSHA je definovaný jedinečný balíček brandingu a dostupný při instalaci obsahu

Pro VSPs implementující vlastní balíčky brandingu (obsah VSP, SelfBranded = true) je možné pokračovat, pokud chcete začít s záložním balíčkem branding (nainstalovaným v aplikaci Help Viewer) a podle potřeby změnit název souboru. Soubor Branding_ <locale> . mshc je soubor zip s příponou souboru, který se změnil na. mshc, takže jednoduše změňte příponu. mshc pro .zip a extrakci obsahu. Níže najdete informace o brandingu prvků balíčku a podle potřeby je upravte (například můžete změnit logo na logo VSP a odkaz na logo v souboru Branding.xml, aktualizovat Branding.xml na základě standardu VSP atd.).

Po dokončení všech úprav vytvořte soubor ZIP obsahující požadované prvky brandingu a změňte rozšíření na. mshc.

K přidružení vlastního balíčku brandingu vytvořte MSHA, který obsahuje odkaz na soubor mshc brandingu spolu s obsahem mshc (obsahujícím témata). Postup vytvoření základní MSHA najdete pod textem "MSHA".

Branding.xml soubor obsahuje seznam prvků, které se používají pro konzistentní vykreslování konkrétních položek v tématu, když téma obsahuje <meta name="Microsoft.Help.SelfBranded" content="false"/> . seznam Visual Studio prvků v souboru Branding.xml je uveden níže. Tento seznam je určený k použití jako šablona pro přijímání prostředí ISO Shell, kde tyto prvky (například logo, zpětná vazba a copyright) upraví tak, aby splňovaly vlastní požadavky na značku produktu.

Poznámka: proměnné zaznamenané "{n}" mají závislosti kódu – odebrání nebo změna těchto hodnot způsobí chyby a možnou chybu aplikace. identifikátory lokalizace (například _locID = "codesnippet. n") jsou zahrnuté do balíčku Visual Studio brandinging.

Branding.xml

Element Popis
Zapnut CollapsibleArea
Použije Rozbalit sbalí text ovládacího prvku obsahu.
Prvek Hodnota
ExpandText Rozbalit
CollapseText Sbalit
Zapnut CodeSnippet
Použije Text ovládacího prvku fragmentu kódu Poznámka: obsah fragmentu kódu s "neprůlomovým" místem bude změněn na mezeru.
Prvek Hodnota
CopyToClipboard Kopírovat do schránky
ViewColorizedText Zobrazit barevné barvy
CombinedVBTabDisplayLanguage Visual Basic (ukázka)
VBDeclaration Deklarace
VBUsage Využití
Zapnut Zpětná vazba, zápatí a logo
Použije Poskytněte řízení zpětné vazby zákazníkovi, aby vám poskytl zpětnou vazbu k aktuálnímu tématu prostřednictvím e-mailu. Text copyrightu pro obsah Definice loga.
Prvek Hodnota (tyto řetězce lze upravit tak, aby splňovala požadavky na přijetí obsahu.)
Úprava © 2013 Microsoft Corporation. All rights reserved.
SendFeedback <a href="{0}" {1}>Pošlete nám svůj názor </a> na toto téma společnosti Microsoft.
FeedbackLink
LogoTitle Visual Studio 2013
LogoFileName vs_logo_bk.gif
LogoFileNameHC vs_logo_wh.gif
Zapnut Právní omezení
Použije Sada omezení specifických pro velká a malá písmena pro Strojově přeložený obsah.
Prvek Hodnota
MT_Editable Tento článek byl Strojově přeložený. Pokud máte připojení k Internetu, zvolte "zobrazit toto téma online" pro zobrazení této stránky v upravitelném režimu spolu s původním anglickým obsahem.
MT_NonEditable Tento článek byl Strojově přeložený. Pokud máte připojení k Internetu, zvolte "zobrazit toto téma online" pro zobrazení této stránky v upravitelném režimu spolu s původním anglickým obsahem.
MT_QualityEditable Tento článek byl přeložen ručně. Pokud máte připojení k Internetu, zvolte "zobrazit toto téma online" pro zobrazení této stránky v upravitelném režimu spolu s původním anglickým obsahem.
MT_QualityNonEditable Tento článek byl přeložen ručně. Pokud máte připojení k Internetu, zvolte "zobrazit toto téma online" pro zobrazení této stránky v upravitelném režimu spolu s původním anglickým obsahem.
MT_BetaContents Tento článek byl STROJOVĚ PŘELOŽEN pro předběžnou verzi. Pokud máte připojení k Internetu, zvolte "zobrazit toto téma online" pro zobrazení této stránky v upravitelném režimu spolu s původním anglickým obsahem.
MT_BetaRecycledContents Tento článek byl ručně přeložen pro předběžnou verzi. Pokud máte připojení k internetu, vyberte Zobrazit toto téma online a zobrazte tuto stránku v režimu úprav s původním anglickým obsahem současně.
Funkce: LinkTable
Použít: Podpora pro online odkazy na témata
Prvek Hodnota
LinkTableTitle Propojit tabulku
Text TopicEnuLinkText Prohlédněte si </a> anglickou verzi tohoto tématu, která je k dispozici na vašem počítači.
TopicOnlineLinkText Zobrazit toto téma <a href="{0}" {1}> online</a>
OnlineText Online
Funkce: Ovládací prvek Zvuk videa
Použít: Zobrazení prvků a textu pro obsah videa
Prvek Hodnota
MultiMediaNotSupported Internet Explorer pro podporu obsahu musí být nainstalovaná verze 9 nebo {0} vyšší.
VideoText zobrazení videa
AudioText streamování zvuku
OnlineVideoLinkText <p>Pokud chcete zobrazit video přidružené k tomuto tématu, klikněte {0} <a href="{1}"> {2} </a> sem.</p>
OnlineAudioLinkText <p>Pokud chcete naslouchat zvuku přidruženému k tomuto tématu, klikněte {0} <a href="{1}"> {2} </a> sem.</p>
Funkce: Ovládací prvek Obsah nenainstalovaný
Použít: Textové prvky (řetězce) používané pro vykreslení contentnotinstalled.htm
Prvek Hodnota
ContentNotInstalledTitle Ve vašem počítači se nenašel žádný obsah.
ContentNotInstalledDownloadContentText <p>Pokud chcete stáhnout obsah do počítače, <a href="{0}" {1}> klikněte na kartu </a> Spravovat.</p>
ContentNotInstalledText <p>Na vašem počítači se neinstaluje žádný obsah. Informace o instalaci obsahu místní nápovědy najdete u správce.</p>
Funkce: Ovládací prvek Téma se nenašlo
Použít: Textové prvky (řetězce) používané pro vykreslení topicnotfound.htm
Prvek Hodnota
TopicNotFoundTitle V počítači nelze najít požadované téma.
TopicNotFoundViewOnlineText <p>Téma, o které jste požádali, se ve vašem počítači nenašlo, ale můžete <a href="{0}" {1}> si ho prohlédnout </a> online.</p>
TopicNotFoundDownloadContentText <p>V navigačním podokně najdete odkazy na podobná témata nebo kliknutím <a href="{0}" {1}> na kartu Spravovat </a> stáhněte obsah do počítače.</p>
Text TopicNotFoundText <p>Požadované téma se ve vašem počítači nenašlo.</p>
Funkce: Poškozený ovládací prvek tématu
Použít: Textové prvky (řetězce) používané pro vykreslení topiccorrupted.htm
Prvek Hodnota
TémaCorruptedTitle Požadované téma se nepodařilo zobrazit.
TopicCorruptedViewOnlineText <p>Prohlížeč nápovědy nemůže zobrazit požadované téma. V obsahu tématu nebo v podkladové systémové závislosti může dojít k chybě.</p>
Funkce: Ovládací prvek Domovská stránka
Použít: Text podporující zobrazení obsahu uzlu nejvyšší úrovně v Help Vieweru.
Prvek Hodnota
HomePageTitle Domovská stránka help vieweru
HomePageIntroduction <p>Vítá vás Microsoft Help Viewer, který je základním zdrojem informací pro každého, kdo používá nástroje, produkty, technologie a služby Microsoftu. Prohlížeč nápovědy poskytuje přístup k návodům a referenčním informacím, ukázkovému kódu, technickým článkům a další informace. Pokud chcete najít obsah, který potřebujete, projděte si obsah, použijte fulltextové vyhledávání nebo procházejte obsah pomocí indexu klíčových slov.</p>
HomePageContentInstallText <p><br />Na <a href="{0}" {1}> kartě Spravovat </a> obsah můžete provést následující akce: Přidání <ul> <li> obsahu do počítače. </li> <li> Zkontrolujte aktualizace místního obsahu. </li> <li> Odeberte obsah z počítače.</li></ul></p>
HomePageInstalledBooks Nainstalované knihy
HomePageNoBooksInstalled Ve vašem počítači se nenašel žádný obsah.
HomePageHelpSettings Nápověda k obsahu Nastavení
HomePageHelpSettingsText <p>Aktuální nastavení je místní nápověda. Prohlížeč nápovědy zobrazuje obsah, který jste nainstalovali do počítače. <br /> Pokud chcete změnit zdroj obsahu nápovědy, v řádku nabídek Visual Studio Nápověda, <span style="{0}"> Nastavte předvolby nápovědy </span> .<br /></p>
Mb MB

branding.js

Soubor branding.js obsahuje JavaScript používaný prvky brandingu Visual Studio Help Viewer. Níže je seznam prvků brandingu a podpůrné funkce JavaScriptu. Všechny řetězce, které se mají lokalizovat pro tento soubor, jsou definované v části Lokalizovatelné řetězce v horní části tohoto souboru. Soubor ICL byl vytvořen pro lokalovací řetězce v branding.js souboru.

Funkce brandingu JavaScript – funkce Popis
Var... Definování proměnných
Získání jazyka uživatelského kódu setUserPreferenceLang Mapuje index # na jazyk kódu.
Nastavení a získání hodnot souborů cookie getCookie, setCookie
Zděděný člen changeMembersLabel Rozbalení/sbalení zděděného členu
When SelfBranded=False Onload Přečtěte si řetězec dotazu a zkontrolujte, jestli se jedná o požadavek na tisk. Nastavte všechny kódové sady tak, aby se zaměřoval na kartu upřednostňovanou uživatelem. Pokud se jedná o požadavek na tisk, nastavte isPrinterFriendly na true. Zkontrolujte režim vysokého kontrastu.
Fragment kódu addSpecificTextLanguageTagSet
getIndexFromDevLang
Karta Změnit
setCodesnippetLang
setCurrentLang
CopyToClipboard (Kopírovat na panel)
Sbalitelnáoblast addToCollapsibleControlSet zapíše všechny sbalitelné objekty ovládacího prvku do seznamu.
CA_Click Na základě stavu sbalitelné oblasti definuje, který obrázek a text se má prezentovat.
Podpora kontrastu pro logo isBlackBackground() Volá se k určení, jestli je pozadí černé. Přesné pouze v režimu vysokého kontrastu.
isHighContrast() Použití barevného rozpětí k detekci režimu vysokého kontrastu
onHighContrast(černá) Volá se při zjištění vysokého kontrastu.
Funkce LST
addToLanSpecTextIdSet(id)
updateLST(currentLang)
getDevLangFromCodeSnippet(lang)
Funkce MultiMedia caption(begin, end, text, style)
findAllMediaControls(normalizedId)
getActivePlayer(normalizedId)
captionsOnOff(id)
toSeconds(t)
getAllComments(node)
styleRectify(styleName, styleValue)
showCC(id)
subtitle(id)

SOUBORY JPG

Balíček brandingu obsahuje sadu souborů HTM, které podporují scénáře pro předávání klíčových informací uživatelům obsahu nápovědy, například domovskou stránku, která obsahuje oddíl popisující, které sady obsahu se instalují, a stránky, které uživateli sdělují, že témata nelze najít v místní sadě témat. Tyto soubory JPG je možné upravit pro každý produkt. Dodavatelé ISO Shellu jsou schopni přijmout výchozí balíček brandingu a změnit chování a obsah těchto stránek tak, aby jejich potřeby byly vhodné. Tyto soubory odkazují na příslušný balíček brandingu, aby značky značky dostaly odpovídající obsah z branding.xml souboru.

Soubor Použití Zobrazený zdroj obsahu
homepage.htm Jedná se o stránku, která zobrazuje aktuálně nainstalovaný obsah, a všechny další zprávy, které jsou vhodné k tomu, aby se uživateli prezentují o jeho obsahu. Tento soubor má další atribut metadat "Microsoft.Help.Id" content="-1", který umístí tento obsah na začátek obsahu místního obsahu.
<META_HOME_PAGE_TITLE_ADD /> Branding.xml, značka <HomePageTitle>
<HOME_PAGE_INTRODUCTION_SECTION_ADD /> Branding.xml, značka <HomePageIntroduction>
<HOME_PAGE_CONTENT_INSTALL_SECTION_ADD /> Branding.xml, značka <HomePageContentInstallText>
<HOME_PAGE_BOOKS_INSTALLED_SECTION_ADD /> Oddíl nadpisu Branding.xml <HomePageInstalledBooks> značku , data vygenerovaná z aplikace, pokud <HomePageNoBooksInstalled> nejsou nainstalované žádné knihy.
<HOME_PAGE_SETTINGS_SECTION_ADD /> Oddíl nadpisu Branding.xml značku <HomePageHelpSettings> , text oddílu <HomePageHelpSettingsText> .
topiccorrupted.htm Pokud téma existuje v místní sadě, ale z nějakého důvodu nelze zobrazit (poškozený obsah).
<META_TOPIC_CORRUPTED_TITLE_ADD /> Branding.xml, značka <TopicCorruptedTitle>
<TOPIC_CORRUPTED_SECTION_ADD /> Branding.xml, značka <TopicCorruptedViewOnlineText>
topicnotfound.htm Pokud se téma v místní sadě obsahu nenachádí, není k dispozici online
<META_TOPIC_NOT_FOUND_TITLE_ADD /> Branding.xml, značka <TopicNotFoundTitle>
<META_TOPIC_NOT_FOUND_ID_ADD /> Branding.xml, značka <TopicNotFoundViewOnlineText> + <TopicNotFoundDownloadContentText>
<TOPIC_NOT_FOUND_SECTION_ADD /> Branding.xml, značka <TopicNotFoundText>
contentnotinstalled.htm Pokud pro produkt není nainstalovaný žádný místní obsah.
<META_CONTENT_NOT_INSTALLED_TITLE_ADD /> Branding.xml, značka <ContentNotInstalledTitle>
<META_CONTENT_NOT_INSTALLED_ID_ADD /> Branding.xml, značka <ContentNotInstalledDownloadContentText>
<CONTENT_NOT_INSTALLED_SECTION_ADD /> Branding.xml, značka <ContentNotInstalledText>

Soubory CSS

Balíček Visual Studio help viewer brandingu obsahuje dva soubory CSS, které podporují konzistentní prezentaci obsahu Visual Studio nápovědy:

  • Branding.css – obsahuje elementy css pro vykreslování, kde SelfBranded=false

  • Printer.css – obsahuje elementy css pro vykreslování, kde SelfBranded=false

Soubory Branding.Visual Studio css zahrnují definice pro prezentaci témat (upozornění je, že se soubor branding.css obsažený v souboru Branding_ .ms css ze služby <locale> balíčků může změnit).

Grafické soubory

Visual Studio obsah zobrazuje logo Visual Studio a další grafiku. úplný seznam grafických souborů v balíčku nápovědy pro Visual Studio Help Viewer je uveden níže.

Soubor Použití Příklady
clear.gif Slouží k vykreslení sbalitelné oblasti.
footer_slice.gif Prezentace zápatí
info_icon.gif Používá se při zobrazování informací. Disclaimer
online_icon.gif Tato ikona má být přidružena k online odkazům.
tabLeftBD.gif Slouží k vykreslení kontejneru fragmentů kódu
tabRightBD.gif Slouží k vykreslení kontejneru fragmentů kódu
vs_logo_bk.gif Používá se k odkazům na symbol normálního kontrastu, jak jsou definovány v Branding.xml značce <LogoFileName> . u Visual Studio produktů je vs_logo_bk.gif název loga.
vs_logo_wh.gif Používá se pro odkazy na logo s vysokým kontrastem, jak jsou definovány v Branding.xml značce <LogoFileNameHC> . u Visual Studio produktů je vs_logo_wh.gif název loga.
ccOff.png Grafika titulků
ccOn.png Grafika titulků
ImageSprite.png Slouží k vykreslení sbalitelné oblasti. Rozbalení nebo sbalení grafiky

Nasazení sady témat

Toto je jednoduchý a rychlý kurz pro vytvoření sady pro nasazení obsahu aplikace Help Viewer sestávající ze souboru MSHA a sady kabin nebo MSHCs obsahující témata. MSHA je soubor XML, který popisuje sadu souborů CAB nebo MSHC. Aplikace Help Viewer může přečíst MSHA a získat tak seznam obsahu (.CAB nebo. Soubory MSHC) k dispozici pro místní instalaci.

Toto je pouze Úvod popisující základní schéma XML pro MSHA Help Viewer. Níže najdete příklad implementace pod tímto stručným přehledem a ukázkou Sample HelpContentSetup. msha.

Název MSHA pro účely tohoto úvodu je HelpContentSetup. msha (název souboru může být cokoli s příponou. MSHA). HelpContentSetup. msha (příklad níže) by měl obsahovat seznam souborů CAB a MSHCs, které jsou k dispozici. Typ souboru musí být konzistentní v rámci MSHA (nepodporuje kombinaci typů souborů MSHA a CAB). Pro každý soubor CAB nebo mshc by měl být <div class="package"> ... </div> (viz příklad níže).

Poznámka: v následujícím příkladu implementace jsme zahrnuli balíček brandingu. to je důležité, aby bylo možné zahrnout potřebné prvky pro vykreslování obsahu Visual Studio a chování obsahu.

Ukázkový soubor HelpContentSetup. msha: (nahraďte "název sady obsahu 1" a "název sady obsahu 2" atd. s názvy souborů.)

<html>
<head />
<body class="vendor-book">
<div class="details">
<span class="vendor">Your Company</span>
<span class="locale">en-us</span>
<span class="product">Your Company Help Content</span>
<span class="name">Your Company Help Content</span>
</div>
<div class="package-list">
<div class="package">
<span class="name">Your_Company _Content_Set_1</span>
<span class="deployed">True</span>
<a class="current-link" href="Your_Company _Content_Set_1.mshc">Your_Company _Content_Set_1.mshc </a>
</div>
<div class="package">
<span class="name">Your_Company _Content_Set_2</span>
<span class="deployed">True</span>
<a class="current-link"href=" Your_Company _Content_Set_2.mshc "> Your_Company _Content_Set_2.mshc </a>
</div>.
  1. Vytvořte místní složku, například "C:\SampleContent".

  2. V tomto příkladu použijeme soubory MSHC k tomu, aby obsahovaly témata. MSHC je zip s příponou souboru, která se změnila z .zip na. MSHC.

  3. Vytvořte následující HelpContentSetup. msha jako textový soubor (pomocí programu Poznámkový blok byl použit k vytvoření souboru) a uložte ho do výše uvedené složky (viz krok 1).

Třída "Brandinging" existuje a je jedinečná. Značka mshc je součástí tohoto úvodního nástroje, aby měl nainstalovaný obsah branding, a chování obsahu, které jsou obsaženy v MSHCs, bude obsahovat příslušné podpůrné prvky obsažené v balíčku branding. Bez tohoto výsledku dojde k chybám, když systém vyhledá položky podpory, které nejsou součástí zkopírovaného (instalovaného) obsahu.

pokud chcete získat balíček Visual Studio branding, zkopírujte soubor Branding_en-US. mshc ve složce C:\Program Files (x86) \microsoft Help Viewer\v2.3\ do vaší pracovní složky.

<html>
<head />
<body class="vendor-book">
<div class="details">
<span class="vendor">Your Company</span>
<span class="locale">en-us</span>
<span class="product">Your Company Help Content</span>
<span class="name">Your Company Help Content</span>
</div>
<div class="package-list">
<div class="package">
<span class="name">Your_Company _Content_Set_1</span>
<span class="deployed">True</span>
<a class="current-link" href="Your_Company _Content_Set_1.mshc">Your_Company _Content_Set_1.mshc </a>
</div>
<div class="package">
<span class="name">Your_Company _Content_Set_2</span>
<span class="deployed">True</span>
<a class="current-link"href=" Your_Company _Content_Set_2.mshc "> Your_Company _Content_Set_2.mshc </a>
</div>
<div class="package">
<span class="packageType">branding</span>
<span class="name">Branding_en-US</span>
<span class="deployed">True</span>
<a class="current-link" href="Branding_en-US.mshc">Branding_en-US.mshc</a>
</div>
</div>
</body>
</html>

Souhrn

když použijete a rozšíříte výše uvedené kroky, umožníte VSPs nasazovat sady obsahu pro Visual Studio Help Viewer.

přidání helpu do prostředí pro Visual Studio (integrovaný a izolovaný režim)

Úvod

tento návod ukazuje, jak začlenit obsah v nápovědě do aplikace Visual Studio Shell a jak ho nasadit.

Požadavky

  1. Visual Studio 2013

  2. Visual Studio 2013 Redist izolovaného prostředí

Přehled

Visual Studio 2013Prostředí je verze Visual Studio 2013 integrovaného vývojového prostředí (IDE), na které můžete aplikaci založit. Takové aplikace obsahují izolované prostředí spolu s rozšířeními, která vytvoříte. Pro sestavení rozšíření použijte šablony projektů izolovaného prostředí, které jsou součástí Visual Studio 2013 sady SDK.

Základní kroky pro vytvoření aplikace založené na izolovaném prostředí a její nápovědě:

  1. Získejte Visual Studio 2013 Distribuovatelný modul ISO Shell (stažení od Microsoftu).

  2. v Visual Studio vytvořte rozšíření pro nápovědu, které je založené na izolovaném prostředí, například rozšíření help společnosti Contoso popsané dále v tomto návodu.

  3. Zabalte rozšíření a distribuovatelné prostředí ISO do balíčku MSI nasazení (instalace aplikace). Tento návod nezahrnuje krok nastavení.

vytvořte Visual Studio úložiště obsahu. V případě integrovaného scénáře prostředí změňte Visual Studio12 na název katalogu produktů následujícím způsobem:

  • Vytvořit složku C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15.

  • Vytvořte soubor s názvem CatalogType.xml a přidejte ho do složky. Soubor by měl obsahovat následující řádky kódu:

    <?xml version="1.0" encoding="UTF-8"?>
    <catalogType>UserManaged</catalogType>
    

Definujte úložiště obsahu v registru. V případě integrovaného prostředí změňte VisualStudio15 na název katalogu produktů:

  • HKLM\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15

    Klíč: hodnota řetězce LocationPath: C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15\

  • HKLM\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15\en-US

    Key: hodnota řetězce v katalogu: Visual Studio 2013 dokumentace

Vytvoření projektu

Vytvoření rozšíření izolovaného prostředí:

  1. v Visual Studio v části soubor vyberte možnost nové Project v části jiné typy Project zvolte možnost rozšiřitelnost a pak zvolte Visual Studio Shell izolované. pojmenujte projekt ContosoHelpShell ), chcete-li vytvořit projekt rozšiřitelnosti na základě šablony Visual Studio izolované prostředí.

  2. V Průzkumník řešení v projektu ContosoHelpShellUI ve složce soubory prostředků otevřete ApplicationCommands. vsct. Ujistěte se, že je tento řádek zakomentováný (vyhledejte "No_Help"): <!-- <define name="No_HelpMenuCommands"/> -->

  3. Pro zkompilování a spuštění ladění použijte klávesu F5. V experimentální instanci rozhraní IDE izolovaného prostředí klikněte na nabídku help . Zajistěte, aby se zobrazily příkazy pro zobrazení, Přidání a odebrání obsahu a Nastavení v nápovědě.

  4. V Průzkumník řešení v projektu ContosHelpShell ve složce pro přizpůsobení prostředí otevřete ContosoHelpShell. pkgdef. Chcete-li definovat katalog nápovědě společnosti Contoso, přidejte následující řádky:

     [$RootKey$\Help]
    "Product"="Contoso"
    "Catalog"="Contoso"
    "Version"="100"
    "BrandingPackage"="ContosoBrandingPackage.mshc"
    
  5. V Průzkumník řešení v projektu ContosHelpShell otevřete ve složce pro přizpůsobení prostředí položku ContosoHelpShell. Application. pkgdef. Chcete-li povolit nápovědu pro klávesu F1, přidejte následující řádky:

    // F1 Help Provider
    
    [$RootKey$\HelpProviders\{C99BDC23-FF29-46bf-9658-ADD634CCAED8}]
    "Name"="13407"
    "Package"="{DA9FB551-C724-11d0-AE1F-00A0C90FFFC3}"
    @="Help3 Provider"
    [$RootKey$\HelpProviders]
    @="{C99BDC23-FF29-46bf-9658-ADD634CCAED8}"
    [$RootKey$\Services\{C99BDC23-FF29-46bf-9658-ADD634CCAED8}]
    "Name"="Help3 Provider"
    @="{4A791146-19E4-11D3-B86B-00C04F79F802}"
    
  6. V Průzkumník řešení v kontextové nabídce řešení ContosoHelpShell vyberte položku nabídky vlastnosti . V části Vlastnosti konfigurace vyberte Configuration Manager. Ve sloupci Konfigurace změňte všechny hodnoty "ladit" na "Release".

  7. Sestavte řešení. Tím se vytvoří sada souborů ve složce verze, která se použije v další části.

Chcete-li tento test otestovat, jako kdyby byl nasazen:

  1. Na počítači, do kterého nasazujete contoso, nainstalujte stažený (z výše uvedeného) prostředí ISO Shell.

  2. Vytvořte složku ve složce \ \Program Files (x86) \ a pojmenujte ji Contoso .

  3. Zkopírujte obsah ze složky verze ContosoHelpShell do \ složky \Program Files (x86) \Contoso.

  4. Spusťte Editor registru výběrem možnosti Spustit v nabídce Start a zadáním příkazu Regedit . V editoru registru zvolte možnost soubor a pak položku importovat. Přejděte do složky projektu ContosoHelpShell. V podsložce ContosoHelpShell vyberte ContosoHelpShell. reg.

  5. Vytvořit úložiště obsahu:

    Pro prostředí ISO Shell – vytvoření C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\ContosoDev12 úložiště obsahu společnosti Contoso

    V případě Visual Studio 2013 integrovaného prostředí vytvořte složku C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15.

  6. Vytvořte CatalogType.xml a přidejte je do úložiště obsahu (předchozí krok) obsahující:

    <?xml version="1.0" encoding="UTF-8"?>
    <catalogType>UserManaged</catalogType>
    
  7. Přidejte následující klíče registru:

    HKLM\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15Key: hodnota řetězce LocationPath:

    Pro prostředí ISO Shell:

    C:ProgramDataMicrosoftHelpLibrary2CatalogsVisualStudio15

    Visual Studio 2013 Integrované prostředí:

    C:ProgramDataMicrosoftHelpLibrary2CatalogsVisualStudio15en-US

    Key: hodnota řetězce v katalogu: Visual Studio 2013 dokumentace Pro prostředí ISO Shell se jedná o název vašeho katalogu.

  8. Zkopírujte obsah (kabiny nebo MSHC a MSHA) do místní složky.

  9. Příklad integrovaného příkazového řádku prostředí pro testování úložiště obsahu. Pro prostředí ISO změňte podle potřeby hodnoty Catalog a launchingApp, aby odpovídaly produktu.

    "C:\Program Files (x86) \Microsoft Help Viewer\v2.3\HlpViewer.exe"/catalogName VisualStudio15/helpQuery Method = "Page&ID = ContosoTopic0"/launchingApp Microsoft, VisualStudio, 12.0

  10. Spusťte aplikaci Contoso (z kořenového adresáře aplikace Contoso). V prostředí ISO Shell vyberte položku nabídky help a změňte Předvolby Ponápovědě pro použití místní aplikace.

  11. V prostředí zvolte položku nabídky help a pak Zobrazte Help. Měl by se spustit místní prohlížeč nápovědy. Klikněte na kartu Spravovat obsah . V části zdroj instalace klikněte na tlačítko možnosti disku . Klikněte na tlačítko ... a přejděte do místní složky obsahující obsah společnosti Contoso (zkopírované do místní složky ve výše uvedeném kroku). Vyberte HelpContentSetup. msha. Contoso by se teď měl zobrazit jako kniha v výběrech knihy. Zvolte Přidat a pak klikněte na tlačítko aktualizovat (pravý dolní roh).

  12. V integrovaném vývojovém prostředí společnosti Contoso vyberte klávesu F1 pro otestování funkcí F1.

Další zdroje informací

rozhraní api pro modul Runtime najdete v tématu Windows Help api.

Další informace o tom, jak využít rozhraní API pro nápovědu, najdete v tématu Příklady kódu pro Help Viewer.

Návrhy funkcí můžete odeslat Community vývojářům.