SDK do Microsoft Help ViewerMicrosoft Help Viewer SDK

Este artigo contém as seguintes tarefas para integradores do Visual Studio Help Viewer:This article contains the following tasks for Visual Studio Help Viewer integrators:

  • Criação de um tópico (suporte a F1)Creating a topic (F1 support)

  • Criando um pacote de conteúdo de identidade visual do Help ViewerCreating a Help Viewer content-branding package

  • Implantar um conjunto de artigosDeploying a set of articles

  • Adicionando Ajuda para o shell do Visual Studio (integrado ou isolado)Adding help to the Visual Studio shell (integrated or isolated)

  • Recursos adicionaisAdditional Resources

Criação de um tópico (suporte a F1)Creating a topic (F1 support)

Esta seção fornece uma visão geral dos componentes de um tópico apresentado, requisitos de tópico, uma breve descrição de como criar um tópico (incluindo os requisitos de suporte F1) e, finalmente, um tópico de exemplo com seu resultado renderizado.This section provides an overview of the components of a presented topic, topic requirements, a short description for how to create a topic (including F1 support requirements) and finally, an example topic with its rendered result.

Visão geral de tópico do Visualizador de ajudaHelp Viewer Topic Overview

Quando um tópico é chamado para renderização, o Visualizador da Ajuda obtém os elementos de pacote de identidade visual que estão associados com o tópico no momento da instalação ou a última atualização, juntamente com o tópico XHTML e combina os dois para resultar na exibição de conteúdo apresentada (dados de identidade Visual + dados de tópico).When a topic is called for rendering, the Help Viewer gets the branding package elements that are associated with the topic at the time of install or last update, along with the topic XHTML, and combines the two to result in the presented content view (branding data + topic data). O pacote de marcas contém logotipos, suporte a comportamentos de conteúdo e o texto de identidade visual (direitos autoral, etc.).The branding package contains logos, support for content behaviors, and branding text (copyright, etc.). Consulte "Criar pacote de identidade visual" abaixo para obter mais informações sobre os elementos de pacote de identidade visual.See "Creating Branding Package" below for more information about the branding package elements. Caso não há nenhum pacote de marcas associada ao tópico, o Visualizador da Ajuda usará o pacote de marcas fallback localizado na raiz do aplicativo Visualizador da Ajuda (Branding_en US.mshc).In the event there is no branding package associated with the topic, the Help Viewer will use the fallback branding package located in the Help Viewer application root (Branding_en-US.mshc).

Requisitos de tópico do Visualizador de ajudaHelp Viewer Topic Requirements

Para ser processado corretamente dentro do Visualizador da Ajuda, o conteúdo bruto do tópico deve ser W3C básico 1.1 XHTML.To be rendered correctly within the Help Viewer, raw topic content must be W3C Basic 1.1 XHTML.

Normalmente, um tópico contém duas seções:A topic typically contains two sections:

  • Metadados (consulte a referência de metadados de conteúdo): pai dos dados sobre o tópico, por exemplo, a ID exclusiva do tópico, o valor de palavra-chave, o tópico Sumário ID, ID do nó, etc.Metadata (see Content Metadata Reference): data about the topic, for example, the topic unique ID, keyword value, the topic TOC ID, parent node ID, etc.

  • Conteúdo do corpo: em conformidade com XHTML do W3C básico 1.1 que inclui suporte para comportamentos de conteúdo (área recolhível, trecho de código, etc. Uma lista completa é mostrada abaixo).Body content: compliant with W3C Basic 1.1 XHTML which includes supported content behaviors (collapsible area, code snippet, etc. A full list is shown below).

Pacote de identidade visual do Visual Studio com suporte a controles:Visual Studio Branding Package supported controls:

  • LinksLinks

  • Trecho de códigoCodeSnippet

  • CollapsibleAreaCollapsibleArea

  • Membro herdadoInherited Member

  • LanguageSpecificTextLanguageSpecificText

Suporte para cadeias de caracteres de idioma (não diferencia maiusculas de minúsculas):Supported language strings (not case sensitive):

  • JavaScriptjavascript

  • CSharp ou c#csharp or c#

  • cplusplus ou visualc + + ou c + +cplusplus or visualc++ or c++

  • JScriptjscript

  • Visual Basic ou do vbvisualbasic or vb

  • f # ou fsharp ou fsf# or fsharp or fs

  • si - uma cadeia de caracteres que representa um nome de idiomaother - a string that represents a language name

Criação de um tópico do Visualizador da AjudaCreating a Help Viewer topic

Criar um novo documento XHTML chamado ContosoTopic4.htm e incluir a marca de título (abaixo).Create a new XHTML document named ContosoTopic4.htm, and include the title tag (below).

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

<body>  

</body>  
</html>  

Em seguida, adicione dados para definir como o tópico é para ser apresentado (próprio da marca ou não), como fazer referência a este tópico para F1, em que este tópico existe dentro do Sumário, sua ID (para a referência de link por outros tópicos), etc. Consulte a tabela "Metadados de conteúdo" abaixo para obter uma lista completa de metadados com suporte.Next, add data to define how the topic is to be presented (self branded or not), how to reference this topic for F1, where this topic exists within the TOC, its ID (for link reference by other topics), etc. See the "Content Metadata" table below for a complete list of supported metadata.

  • Nesse caso, usaremos nosso próprio pacote de marcas, uma variante do pacote de identidade visual do Visual Studio Help Viewer.In this case, we will use our own branding package, a variant of the Visual Studio Help Viewer branding package.

  • Adicionar o valor e nome de meta F1 (conteúdo de "Microsoft.Help.F1" = "ContosoTopic4") que corresponderá o valor de F1 fornecido no conjunto de propriedades do IDE.Add the F1 meta name and value ("Microsoft.Help.F1" content=" ContosoTopic4") that will match the supplied F1 value in the IDE property bag. (Consulte a seção de suporte de F1 para obter mais informações). Esse é o valor que corresponde a F1 chamar de dentro do IDE para exibir este tópico quando F1 é escolhido no IDE.(See the F1 Support section for more information.) This is the value that is matched to the F1 call from within the IDE to display this topic when F1 is chosen in the IDE.

  • Adicione a ID do tópico.Add the topic ID. Isso é a cadeia de caracteres que é usada por outros tópicos para vincular a esse tópico.This is the string that is used by other topics to link to this topic. É a identificação de Visualizador de ajuda para este tópico.It is the Help Viewer ID for this topic.

  • Para o Sumário, adicione nó do pai deste tópico para definir no qual este nó de Sumário do tópico serão exibidos.For the TOC, add this topic's parent node to define where this topic TOC node will appear.

  • Para o Sumário, adicione a ordem de nó deste tópico.For the TOC, add this topic's node order. Quando o nó pai tem um número de nós filhos, defina na ordem de nós filho local deste tópico.When the parent node has n number of children nodes, define in the order of child nodes this topic's location. Por exemplo, este tópico é o número 4 de 4 tópicos de filho.)For example, this topic is number 4 of 4 child topics.)

Seção de metadados de exemplo:Example metadata section:

<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>  

O corpo do tópicoThe Topic Body

O corpo (sem incluir o cabeçalho e rodapé) do tópico conterá links da página, uma seção de observação, uma área recolhível, um trecho de código e uma seção de texto específicos do idioma.The body (not including the header and footer) of the topic will contain page links, a note section, a collapsible area, a code snippet, and a section of language specific text. Consulte a seção de identidade visual para obter informações sobre essas áreas do tópico apresentada.See the branding section for information about those areas of the presented topic.

  1. Adicione uma marca de título do tópico: <div class="title">Contoso Topic 4</div>Add a topic title tag: <div class="title">Contoso Topic 4</div>

  2. Adicione uma seção de Observação: <div class="alert"> add your table tag and text </div>Add a note section: <div class="alert"> add your table tag and text </div>

  3. Adicione uma área recolhível: <CollapsibleArea Expanded="1" Title="Collapsible Area Test Heading"> add text </CollapsibleArea>Add a collapsible area: <CollapsibleArea Expanded="1" Title="Collapsible Area Test Heading"> add text </CollapsibleArea>

  4. Adicione um trecho de código: <CodeSnippet EnableCopyCode="true" Language="CSharp" ContainsMarkup="false" DisplayLanguage="C#" > a block of code </CodeSnippet>Add a code snippet: <CodeSnippet EnableCopyCode="true" Language="CSharp" ContainsMarkup="false" DisplayLanguage="C#" > a block of code </CodeSnippet>

  5. Adicionar texto específico do idioma de código: <LanguageSpecificText devLangcs="CS" devLangvb="VB" devLangcpp="C++" devLangnu="F#" /> Observe que devLangnu = permite que você insira outras linguagens.Add code language specific text: <LanguageSpecificText devLangcs="CS" devLangvb="VB" devLangcpp="C++" devLangnu="F#" /> Note that devLangnu= allows you to enter other languages. Por exemplo, devLangnu = "Fortran" exibirá Fortran quando o trecho de código DisplayLanguage = FortranFor example, devLangnu="Fortran" will display Fortran when the code snippet DisplayLanguage = Fortran

  6. Adicione links de página: <a href="ms-xhelp://?Id=ContosoTopic1">Main Topic</a>Add page links: <a href="ms-xhelp://?Id=ContosoTopic1">Main Topic</a>

Note

Observação: para sem suporte novo "idioma de exibição" (exemplo, F #, Cobol, Fortran) colorização de código no trecho de código será monocromático.Note: for non-supported new "Display Language" (example, F#, Cobol, Fortran) code colorization in the code snippet will be monochrome.

Tópico Visualizador da Ajuda do exemplo o código ilustra como definir metadados, um trecho de código, uma área recolhível e texto específico do idioma.Example Help Viewer Topic The code illustrates how to define metadata, a code snippet, a collapsible area, and language specific text.

<?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>  

Suporte de F1F1 Support

No Visual Studio, selecionar F1 gera valores fornecidos do posicionamento do cursor dentro do IDE e preenche um "recipiente" com os valores fornecidos (com base no local do cursor.In Visual Studio, selecting F1 generates values supplied from the placement of the cursor within the IDE and populates a "property bag" with the supplied values (based on cursor location. Quando o cursor estiver sobre o recurso x, o recurso x está ativa/em foco e preenche o recipiente de propriedades com valores.When the cursor is over feature x, feature x is active/in focus and populates property bag with values. Quando F1 é selecionado o recipiente de propriedades é preenchido e código de F1 do Visual Studio verifica se a fonte de ajuda os clientes padrão é local ou online (on-line é o padrão), em seguida, cria a cadeia de caracteres apropriada com base nos usuários definindo (on-line é o padrão) - execução do shell (consulte o guia de administrador Ajuda do exe iniciar os parâmetros) com parâmetros para o Visualizador da Ajuda local + as palavras-chave do recipiente de se a Ajuda local é o padrão ou a URL do MSDN com a palavra-chave na lista de parâmetros.When F1 is selected the property bag is populated and Visual Studio F1 code looks to see if the customers default Help source is local or online (online is the default), then creates the appropriate string based on the users setting (online is the default) - shell execute (see the Help Administrator Guide for exe launch parameters) with parameters for the local help viewer + keyword(s) from the property bag if local help is the default, or the MSDN URL with the keyword in the parameter list.

Se três cadeias de caracteres são retornadas para F1, conhecida para como uma cadeia de caracteres com vários valores, levar o primeiro termo, procure para uma ocorrência e, se encontrado, podemos terminar; Se não, avance para a próxima cadeia de caracteres.If three strings are returned for F1, referred to as a multi-value string, take the first term, look for a hit, and if found, we are done; if not, move to the next string. Ordem é importante.Order matters. Apresentação as palavras-chave com vários valores deve ser uma cadeia de caracteres mais longa a cadeia de caracteres mais curta.Presentation of the multi-value keywords should be longest string to shortest string. Para verificar isso no caso de palavras-chave de vários valores, examine a cadeia de caracteres de URL F1 online, que inclui a palavra-chave escolhida.To verify this in the case for multi-value keywords, look at the online F1 URL string, which will include the chosen keyword.

No Visual Studio 2012, podemos intencionalmente uma divisão mais forte entre online e offline, para que se a configuração do usuário para Online, em seguida, podemos simplesmente passada a solicitação F1 diretamente ao nosso serviço de consulta on-line no MSDN em vez de roteamento por meio do agente de biblioteca de ajuda que tínhamos no Visual Studio 2010.In Visual Studio 2012, we intentionally made a stronger divide between online and offline, so that if the user's setting was for Online, then we simply passed the F1 request directly to our online query service on MSDN rather than routing through the Help Library Agent that we had in Visual Studio 2010. Em seguida, podemos contar com um estado de "conteúdo do fornecedor instalado = true" para determinar se deve fazer algo diferente nesse contexto.We then rely on a state of "vendor content installed = true" to determine whether to do something different in that context. Se for true, em seguida, executamos essa lógica de roteamento e análise, dependendo de como você deseja dar suporte a seus clientes.If true, we then perform this parsing and routing logic depending on what you wish to support for your customers. Se for false, podemos ir para MSDN.If false, then we just go to MSDN. Se a configuração do usuário for Local, basta ir todas as chamadas para o mecanismo de ajuda local.If the user's setting is to Local, then all calls simply go to the local help engine.

F1 diagrama de fluxo:F1 Flow Diagram:

Fluxo F1F1 flow

Quando a fonte de conteúdo de Ajuda do Visualizador da Ajuda padrão é definida como on-line (lançamento em navegador):When the Help Viewer default help content source is set to online (Launch in browser):

  • Recursos do Visual Studio Partner (VSP) emitem um valor para o recipiente F1 (prefix.keyword de recipiente da propriedade e a URL on-line para o prefixo encontrado no registro): F1 envia uma URL de VSP + parâmetros para o navegador.Visual Studio Partner (VSP) features emit a value to the F1 property bag (property bag prefix.keyword and online URL for the prefix found in the registry): F1 sends a VSP URL+ parameters to the browser.

  • Recursos do Visual Studio (editor de linguagem, itens de menu específico do Visual Studio, etc.): F1 envia uma URL do Visual Studio para o navegador.Visual Studio features (language editor, Visual Studio specific menu items, etc.): F1 sends a Visual Studio URL to the browser.

Quando a fonte de conteúdo de Ajuda do Visualizador da Ajuda padrão é definida como a Ajuda local (Iniciar no Help Viewer):When the Help Viewer default help content source is set to local Help (Launch in Help Viewer):

  • Recursos VSP onde a palavra-chave correspondem entre o recipiente de propriedades de F1 e o índice de repositório local (ou seja, o prefix.keyword de recipiente da propriedade = valor localizado no índice de repositório local): F1 renderiza o tópico no Visualizador da Ajuda.VSP features where keyword match between F1 property bag and local store index (that is, the property bag prefix.keyword = the value found in the local store index): F1 renders the topic in the Help Viewer.

  • Recursos do Visual Studio (nenhuma opção para VSP substituir o recipiente de emissores de recursos do Visual Studio): F1 renderiza um tópico do Visual Studio no Visualizador da Ajuda.Visual Studio features (no option for the VSP to override the property bag emitted from Visual Studio features): F1 renders a Visual Studio topic in the Help Viewer.

Defina os seguintes valores de registro para habilitar o F1 Fallback para conteúdo de Ajuda do fornecedor.Set the following registry values to enable F1 Fallback for vendor Help content. Fallback de F1 significa que o Visualizador da Ajuda é definido para procurar conteúdo de ajuda de F1 online, e o conteúdo do fornecedor está instalado localmente para o disco rígido dos usuários.F1 Fallback means that the Help Viewer is set to look for F1 Help content online, and the vendor content is installed locally to the users' hard drive. O Visualizador da Ajuda deve examinar a Ajuda local para o conteúdo mesmo que a configuração padrão é para obter ajuda online.The Help Viewer should look at local Help for the content even though the default setting is for online help.

  1. Defina as VendorContent valor sob a chave do registro ajuda 2.3:Set the VendorContent value under the Help 2.3 registry key:

    • Para sistemas operacionais de 32 bits:For 32-bit operating systems:

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

      "VendorContent" = DWORD: 00000001"VendorContent"=dword:00000001

    • Para sistemas operacionais de 64 bits:For 64-bit operating systems:

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

      "VendorContent" = DWORD: 00000001"VendorContent"=dword:00000001

  2. Registre o namespace de parceiro na chave do registro ajuda 2.3:Register the partner namespace under the Help 2.3 registry key:

    • Para sistemas operacionais de 32 bits:For 32-bit operating systems:

      HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Help\v2.3\Partner\< namespace>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Help\v2.3\Partner\<namespace>

      "local"="offline""location"="offline"

    • Para sistemas operacionais de 64 bits:For 64-bit operating systems:

      HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Partner\< namespace>HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Partner\<namespace>

      "local"="offline""location"="offline"

Namespace nativo de análise de baseBase Native Namespace Parsing

Para ativar a análise de um namespace base nativo, no registro de adicionar um novo DWORD pelo nome do: BaseNativeNamespaces e defina seu valor como 1 (sob a chave de catálogo que desejam dar suporte).To turn on base native namespace parsing, in the registry add a new DWORD by the name of: BaseNativeNamespaces and set its value to 1 (under the catalog key that they want to support). Por exemplo, se você quiser usar o catálogo do Visual Studio, pode adicionar a chave para o caminho:For example, if you want to use the Visual Studio catalog, you could add the key to the path:

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

Quando uma palavra-chave F1 no formato de QUE CABEÇALHO/método for encontrado, o caractere '/' será analisado, resultando em construção:When an F1 keyword in the format HEADER/METHOD is encountered, the '/' character will be parsed out, resulting in the following construct:

  • CABEÇALHO: será o namespace que pode ser usado para se registrar no registroHEADER: will be the namespace that can be used to register in the registry

  • MÉTODO: isso se tornará a palavra-chave que é passada.METHOD: this will become the keyword that gets passed through.

Por exemplo, dada uma biblioteca personalizada chamada CustomLibrary e um método chamado MyTestMethod, quando uma solicitação chega de F1 será formatada como CustomLibrary/MyTestMethod.For example, given a custom library called CustomLibrary and a method called MyTestMethod, when an F1 request comes in it will be formatted as CustomLibrary/MyTestMethod.

Um usuário possa registrar CustomLibrary como o namespace sob a seção de parceiros e fornecer qualquer chave local que desejar, e a palavra-chave passada para a consulta será MyTestMethod.A user can then register CustomLibrary as the namespace under the Partners hive, and provide whatever location key they desire, and the keyword passed to the query will be MyTestMethod.

Habilitar a ferramenta no IDE de depuração de ajudaEnable Help debugging tool in the IDE

Adicione a seguinte chave do registro e o valor:Add the following registry key and value:

Tecla de Ajuda do HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\15.0\Dynamic: saída de depuração de exibição do valor de varejo: SimHKEY_CURRENT_USER\Software\Microsoft\VisualStudio\15.0\Dynamic Help key: Display Debug Output in Retail value: YES

No IDE, sob o item de menu de Ajuda, selecione "Depurar contexto de Ajuda"In the IDE, under the Help menu item, select "Debug Help Context"

Metadados de conteúdoContent Metadata

A tabela a seguir, qualquer cadeia de caracteres que aparece entre colchetes é um espaço reservado que deve ser substituído por um valor reconhecido.In the following table, any string that appears between brackets is a placeholder that must be replaced by a recognized value. Por exemplo, em <name="Microsoft.Help.Locale meta" conteúdo = "[código do idioma]" / >, "[código de idioma]" deve ser substituído por um valor, como "en-us".For example, in <meta name="Microsoft.Help.Locale" content="[language code]" />, "[language code]" must be replaced by a value such as "en-us".

Propriedade (representação de HTML)Property (HTML Representation) DescriçãoDescription
< conteúdo de meta name="Microsoft.Help.Locale" = "[código do idioma]" / >< meta name="Microsoft.Help.Locale" content="[language-code]" /> Define uma localidade para este tópico.Sets a locale for this topic. Se essa marca é usada em um tópico, ele deve ser usado apenas uma vez e deve ser inserido acima quaisquer outras marcas do Microsoft Help.If this tag is used in a topic, it must be used just once and it must be inserted above any other Microsoft Help tags. Se essa marca não for usada, o texto do corpo do tópico é indexado usando o separador de palavras que está associado com a localidade do produto, se for especificado; Caso contrário, en-us é usado o separador de palavras.If this tag is not used, the body text of the topic is indexed by using word breaker that is associated with the product locale, if it is specified; otherwise, the en-us word breaker is used. Essa marca é compatível com ISOC RFC 4646.This tag conforms to ISOC RFC 4646. Para garantir que o Microsoft Help funciona corretamente, use essa propriedade em vez do atributo de idioma geral.To ensure that Microsoft Help works correctly, use this property instead of the general Language attribute.
< conteúdo de meta name="Microsoft.Help.TopicLocale" = "[código do idioma]" / >< meta name="Microsoft.Help.TopicLocale" content="[language-code]" /> Define uma localidade para este tópico quando outras localidades também são usadas.Sets a locale for this topic when other locales are also used. Se essa marca é usada em um tópico, ele deve ser usado apenas uma vez.If this tag is used in a topic, it must be used just once. Use essa marca quando o catálogo contém o conteúdo em mais de um idioma.Use this tag when the catalog contains content in more than one language. Vários tópicos em um catálogo podem ter a mesma ID, mas cada um deve especificar um TopicLocale exclusivo.Multiple topics in a catalog can have the same ID, but each must specify a unique TopicLocale. O tópico que especifica um TopicLocale que corresponde à localidade do catálogo é o tópico que é exibido no sumário.The topic that specifies a TopicLocale that matches the locale of the catalog is the topic that is displayed in the table of contents. No entanto, todas as versões de idioma do tópico são exibidas nos resultados da pesquisa.However, all language versions of the topic are displayed in Search results.
< título > [Title] < /title >< title>[Title]</title> Especifica o título deste tópico.Specifies the title of this topic. Essa marca é obrigatório e deve ser usada apenas uma vez em um tópico.This tag is required, and must be used just once in a topic. Se o corpo do tópico não contém um título <div > seção, esse título é exibida no tópico e no sumário.If the body of the topic does not contain a title <div> section, this Title is displayed in the topic and in the table of contents.
< nome da meta = "Microsoft.Help.Keywords" conteúdo = "[aKeywordPhrase]" / >< meta name=" Microsoft.Help.Keywords" content="[aKeywordPhrase]"/> Especifica o texto de um link que é exibido no painel de índice do Visualizador da Ajuda.Specifies the text of a link that is displayed in the index pane of the Help Viewer. Quando o link é clicado, o tópico é exibido. Você pode especificar várias palavras-chave de índice para um tópico, ou você pode omitir essa marca se não quiser links deste tópico para aparecer no índice.When the link is clicked, the topic is displayed.You can specify multiple index keywords for a topic, or you can omit this tag if you do not want links to this topic to appear in the index. "K" palavras-chave de versões anteriores da Ajuda podem ser convertidas para essa propriedade."K" keywords from earlier versions of Help can be converted to this property.
< conteúdo de meta name="Microsoft.Help.Id" = "[TopicID]" / >< meta name="Microsoft.Help.Id" content="[TopicID]"/> Define o identificador para este tópico.Sets the identifier for this topic. Essa marca é obrigatório e deve ser usada apenas uma vez em um tópico.This tag is required, and must be used just once in a topic. A ID deve ser exclusiva entre tópicos no catálogo que têm a mesma configuração de localidade.The ID must be unique among topics in the catalog that have the same locale setting. Em outro tópico, você pode criar um link para este tópico usando esta ID.In another topic, you can create a link to this topic by using this ID.
< meta name="Microsoft.Help.F1" content="[System.Windows.Controls.Primitives.IRecyclingItemContainerGenerator]"/ >< meta name="Microsoft.Help.F1" content="[System.Windows.Controls.Primitives.IRecyclingItemContainerGenerator]"/> Especifica a palavra-chave F1 deste tópico.Specifies the F1 keyword for this topic. Você pode especificar várias palavras-chave F1 para um tópico, ou você pode omitir essa marca se você não quiser que este tópico a ser exibido quando um usuário de aplicativo pressiona F1.You can specify multiple F1 keywords for a topic, or you can omit this tag if you do not want this topic to be displayed when an application user presses F1. Normalmente, apenas uma palavra-chave de F1 é especificada para um tópico.Typically, just one F1 keyword is specified for a topic. Palavras-chave de "F" de versões anteriores da Ajuda podem ser convertidas para essa propriedade."F" keywords from earlier versions of Help can be converted to this property.
< nome da meta = "Descrição" content = "[Descrição do tópico]" / >< meta name="Description" content="[topic description]" /> Fornece um breve resumo do conteúdo neste tópico.Provides a short summary of the content in this topic. Se essa marca é usada em um tópico, ele deve ser usado apenas uma vez.If this tag is used in a topic, it must be used just once. Esta propriedade é acessada diretamente pela biblioteca de consulta; ele não é armazenado no arquivo de índice.This property is accessed directly by the query library; it is not stored in the index file.
conteúdo de meta name="Microsoft.Help.TocParent" = "[parent_Id]" / >meta name="Microsoft.Help.TocParent" content="[parent_Id]"/> Especifica o tópico pai deste tópico no sumário.Specifies the parent topic of this topic in the table of contents. Essa marca é obrigatório e deve ser usada apenas uma vez em um tópico.This tag is required, and must be used just once in a topic. O valor é o Microsoft.Help.Id do pai.The value is the Microsoft.Help.Id of the parent. Um tópico pode ter apenas um local na tabela do conteúdo.A topic can have just one location in the table of contents. "-1" é considerado a ID do tópico para a raiz do Sumário."-1" is considered the topic ID for the TOC root. No Visual Studio 2013Visual Studio 2013, essa página é a home page do Visualizador da Ajuda.In Visual Studio 2013Visual Studio 2013, that page is Help Viewer home page. Isso é o mesmo motivo que podemos adicionar especificamente TocParent =-1 para alguns tópicos para garantir que elas aparecem na parte superior nível. Home page do Help Viewer é uma página do sistema e portanto não podem ser substituídas.This is the same reason we specifically add TocParent=-1 to some topics to ensure that they show up at the top level.The Help Viewer home page is a system page and so non-replaceable. Se um VSP tenta adicionar uma página com uma ID de -1, ele pode obter adicionado ao conjunto de conteúdo, mas o Help Viewer sempre usará a página do sistema - início do Help ViewerIf a VSP tries to add a page with an ID of -1, it may get added to the content set, but Help Viewer will always use the system page - Help Viewer Home
< conteúdo de meta name="Microsoft.Help.TocOrder" = "[número inteiro positivo]" / >< meta name="Microsoft.Help.TocOrder" content="[positive integer]"/> Especifica onde este tópico no sumário aparece em relação a seus tópicos de ponto a ponto.Specifies where in the table of contents this topic appears relative to its peer topics. Essa marca é obrigatório e deve ser usada apenas uma vez em um tópico.This tag is required, and must be used just once in a topic. O valor é um inteiro.The value is an integer. Um tópico que especifica um inteiro menor valor aparece acima de um tópico que especifica um valor mais alto de inteiro.A topic that specifies a lower-value integer appears above a topic that specifies a higher-value integer.
< conteúdo de meta name="Microsoft.Help.Product" = "[product code]" / >< meta name="Microsoft.Help.Product" content="[product code]"/> Especifica o produto descrita neste tópico.Specifies the product that this topic describes. Se essa marca é usada em um tópico, ele deve ser usado apenas uma vez.If this tag is used in a topic, it must be used just once. Essas informações também podem ser fornecidas como um parâmetro que é passado para o indexador de Ajuda.This information can also be supplied as a parameter that is passed to the Help Indexer.
< conteúdo de meta name="Microsoft.Help.ProductVersion" = "[número de versão]" / >< meta name="Microsoft.Help.ProductVersion" content="[version number]"/> Especifica a versão do produto descrita neste tópico.Specifies the version of the product that this topic describes. Se essa marca é usada em um tópico, ele deve ser usado apenas uma vez.If this tag is used in a topic, it must be used just once. Essas informações também podem ser fornecidas como um parâmetro que é passado para o indexador de Ajuda.This information can also be supplied as a parameter that is passed to the Help Indexer.
< conteúdo de meta name="Microsoft.Help.Category" = "[string]" / >< meta name="Microsoft.Help.Category" content="[string]"/> Usado por produtos para identificar subseções de conteúdo.Used by products to identify subsections of content. Você pode identificar várias subseções para um tópico, ou você pode omitir essa marca se você não quiser que os links para identificar quaisquer subseções.You can identify multiple subsections for a topic, or you can omit this tag if you do not want links to identify any subsections. Essa marca é usada para armazenar os atributos para TargetOS e TargetFrameworkMoniker quando um tópico é convertido de uma versão anterior da Ajuda.This tag is used to store the attributes for TargetOS and TargetFrameworkMoniker when a topic is converted from an earlier version of Help. O formato do conteúdo é AttributeName:AttributeValue.The format of the content is AttributeName:AttributeValue.
< conteúdo da meta name="Microsoft.Help.TopicVersion ="[número de versão de tópico]"/ >< meta name="Microsoft.Help.TopicVersion content="[topic version number]"/> Especifica a esta versão do tópico quando há várias versões em um catálogo.Specifies this version of the topic when multiple versions exist in a catalog. Porque Microsoft.Help.Id não é garantida para ser exclusivo, essa marca é necessária quando mais de uma versão de um tópico existe em um catálogo, por exemplo, quando um catálogo contém um tópico para o .NET Framework 3.5 e um tópico para o .NET Framework 4 e ambos têm o mesmo Micro reversível. Ajuda.Because Microsoft.Help.Id is not guaranteed to be unique, this tag is required when more than one version of a topic exists in a catalog, for example, when a catalog contains a topic for the .NET Framework 3.5 and a topic for the .NET Framework 4 and both have the same Microsoft.Help.Id.
< nome da meta = "SelfBranded" content = "[TRUE ou FALSE]" / >< meta name="SelfBranded" content="[TRUE or FALSE]"/> Especifica se este tópico usa o pacote de marcas de inicialização do Gerenciador de biblioteca de Ajuda ou um pacote de marcas é específico para o tópico.Specifies whether this topic uses the Help Library Manager start-up branding package or a branding package that is specific to the topic. Essa marca deve ser verdadeiro ou falso.This tag must be either TRUE or FALSE. Se for TRUE, em seguida, o pacote de marcas para o tópico associado substitui o pacote de marcas é definido quando inicia o Help Library Manager para que o tópico é renderizado conforme o esperado, mesmo se for diferente do processamento de outros tipos de conteúdo.If it is TRUE, then the branding package for the associated topic overrides the branding package that is set when Help Library Manager starts so that the topic is rendered as intended even if it differs from the rendering of other content. Se for FALSE, o tópico atual é renderizado de acordo com o pacote de marcas é definido quando o Help Library Manager é iniciado.If it is FALSE, the current topic is rendered according to the branding package that is set when Help Library Manager starts. Por padrão, o Help Library Manager presume Self identidade visual seja false, a menos que a variável SelfBranded é declarada como TRUE; Portanto, você não precisa declarar <nome meta = "SelfBranded" content = "Falso" / >.By default, Help Library Manager assumes self-branding to be false unless the SelfBranded variable is declared as TRUE; therefore, you do not have to declare <meta name="SelfBranded" content="FALSE"/>.

Criando um pacote de marcasCreating a branding package

A versão do Visual Studio abrange um número de diferentes produtos do Visual Studio, incluindo os shells integrados e isolado para parceiros do Visual Studio.The Visual Studio release encompasses a number of different Visual Studio products, including the Isolated and Integrated shells for Visual Studio Partners. Cada um desses produtos requer um certo grau de conteúdo da Ajuda baseado em tópico exclusivo para o produto, o suporte de identidade visual.Each of these products requires some degree of topic-based Help content branding support, unique to the product. Por exemplo, tópicos do Visual Studio precisam ter uma apresentação consistentes de marcas, enquanto SQL Studio, que encapsula o Shell do ISO, requer sua própria exclusivo ajuda conteúdo de identidade visual para cada tópico.For example, Visual Studio topics need to have a consistent brand presentation, whereas SQL Studio, which wraps ISO Shell, requires its own unique Help content branding for each topic. Um parceiro de Shell integrado pode querer seus tópicos da Ajuda para estar dentro do pai do conteúdo de Ajuda do produto Visual Studio enquanto mantém seu próprio tópico identidade visual.An Integrated Shell Partner may want their Help topics to be within the parent Visual Studio product Help content while maintaining their own topic branding.

Identidade visual de pacotes é instalados pelo produto que contém o Visualizador da Ajuda.Branding packages are installed by the product containing the Help Viewer. Produtos do Visual Studio:For Visual Studio products:

  • Um pacote de marcas de fallback (Branding_<localidade >. mshc) está instalado na raiz do aplicativo de Ajuda do visualizador 2.3 (exemplo: C:\Program Files (x86) \Microsoft Help Viewer\v2.3), o pacote de idiomas do Visualizador da Ajuda.A fallback branding package (Branding_<locale>.mshc) is installed in the Help Viewer 2.3 app root (example: C:\Program Files (x86)\Microsoft Help Viewer\v2.3) by the Help Viewer language pack. Isso é usado para casos em que o produto identidade visual do pacote não está instalado (nenhum conteúdo foi instalado) ou em que o pacote de marcas instalado está corrompido.This is used for cases where either the product branding package is not installed (no content has been installed) or where the installed branding package is corrupted. Observe que os elementos do Visual Studio (logotipo e comentários) são ignorados quando o fallback de raiz do aplicativo identidade visual do pacote é usado.Note that the Visual Studio elements (logo and Feedback) are ignored when the app root fallback branding package is used.

  • Quando o conteúdo do Visual Studio é instalado do serviço do pacote de conteúdo, um pacote de marcas também é instalado (para o primeiro cenário de instalação de conteúdo de tempo).When Visual Studio content is installed from the content package service, a branding package is also installed (for the first time content installation scenario). Se houver uma atualização para o pacote de marcas, a atualização é instalada quando a próxima atualização de conteúdo ou uma ação de instalação de pacote adicionais ocorre.If there is an update to the branding package, the update is installed when the next content update or additional package install action happens.

O Microsoft Help Viewer dá suporte à identidade visual de tópicos com base nos metadados do tópico.The Microsoft Help Viewer supports the branding of topics based on topic metadata.

  • Em que os metadados de tópico definem self da marca = true, renderizar o tópico como está, não faça nada (com relação às General a identidade visual).Where topic metadata defines self branded = true, render the topic as is, do nothing (as far as branding).

  • Em que os metadados de tópico definem self da marca = false, usar o pacote de marcas associado com valor de metadados TopicVendor.Where topic metadata defines self branded = false, use the branding package associated with TopicVendor metadata value.

  • Conteúdo em que os metadados de tópico definem name="Microsoft.Help.TopicVendor" =< nome de pacote de identidade visual no fornecedor MSHA >, use o pacote de marcas definido no valor do conteúdo.Where topic metadata defines name="Microsoft.Help.TopicVendor" content=< branding package name in vendor MSHA>, use the branding package defined in the content value.

  • Observe que, no catálogo do Visual Studio, há um aplicativo de prioridade de pacotes de identidade visual.Note that within the Visual Studio catalog, there is a priority application of Branding Packages. Primeiro o Visual Studio identidade visual padrão é aplicada e, em seguida, se definido nos metadados do tópico e tem suporte com a identidade visual associado do pacote (conforme definido na msha a instalação), o definida pelo fornecedor de identidade visual é aplicado como uma substituição.First Visual Studio default branding is applied, and then, if defined in the topic metadata and supported with the associated branding package (as defined in the installation msha), the vendor defined branding is applied as an override.

Elementos de identidade visual normalmente se enquadram em três categorias principais:Branding elements typically fall into three main categories:

  • Elementos de cabeçalho (os exemplos incluem um link de comentários, o texto de aviso de isenção condicional, o logotipo)Header elements (examples include feedback link, conditional disclaimer text, logo)

  • Conteúdo comportamentos (exemplos incluem elementos de texto do controle de expandir/recolher e elementos de trecho de código)Content behaviors (examples include expand/collapse control text elements and code snippet elements)

  • Elementos de rodapé (exemplo Copyright)Footer elements (example Copyright)

Itens considerados como incluem elementos com marca (detalhado nessa especificação):Items considered as branded elements include (detailed in this spec):

  • Logotipo do catálogo/produto (Visual Studio exemplo)Catalog/product logo (example, Visual Studio)

  • Elementos de link e o email de comentáriosFeedback link and e-mail elements

  • Texto de aviso de isençãoDisclaimer text

  • Texto de direitos autoraisCopyright text

Arquivos de suporte no pacote de identidade visual do Visual Studio Help Viewer incluem:Supporting files in the Visual Studio Help Viewer branding package include:

  • Elementos gráficos (logotipos, ícones, etc.)Graphics (logos, icons, etc.)

  • Arquivos de script de Branding.js - comportamentos de conteúdo de suporteBranding.js - script files supporting content behaviors

  • Branding.XML - cadeias de caracteres que é usado de forma consistente entre o conteúdo do catálogo.Branding.xml - strings that are consistently used across catalog content. Observação: para elementos de texto de localização do Visual Studio em branding.xml, incluem _locID = "<valor exclusivo >"Note: for Visual Studio localization text elements in the branding.xml, include _locID="<unique value>"

  • Branding.CSS - definições de estilo para consistência de apresentaçãoBranding.css - style definitions for presentation consistency

  • Printing.CSS - definições de estilo para apresentação impressa consistentePrinting.css - style definitions for consistent printed presentation

Conforme observado acima, pacotes de identidade visual são associados ao tópico:As noted above, Branding Packages are associated with the topic:

  • Quando SelfBranded = false é definido nos metadados, o tópico herda o catálogo de pacote de identidade VisualWhen SelfBranded = false is defined in the metadata, the topic inherits the catalog branding package

  • Ou quando SelfBranded = false e existe é um pacote de marca exclusivo definido no MSHA e disponível quando o conteúdo está instaladoOr when SelfBranded = false and there is a unique Branding Package defined in the MSHA and available when the content is installed

Para VSPs Implementando pacotes de identidade visual personalizados (conteúdo VSP, SelfBranded = True), uma maneira para prosseguir é começar com o pacote de marcas de fallback (instalado com o Visualizador da Ajuda) e altere o nome do arquivo conforme apropriado.For VSPs implementing custom branding packages (VSP content, SelfBranded=True), one way to proceed is to start with the fallback branding package (installed with the Help Viewer), and change the name of the file as appropriate. O Branding_<localidade >. mshc arquivo é um arquivo zip com a extensão de arquivo foi alterado para. mshc, portanto, simplesmente altere a extensão de. mshc para. zip e extraia o conteúdo.The Branding_<locale>.mshc file is a zip file with the file extension changed to .mshc, so simply change the extension from .mshc to .zip and extract the contents. Veja a seguir para a identidade visual de elementos do pacote e modificar conforme apropriado (por exemplo, altere o logotipo para o logotipo VSP e a referência para o logotipo no arquivo Branding.xml, atualizar Branding.xml por informações específicas VSP, etc.).See below for branding package elements and modify as appropriate (for example, change the logo to the VSP logo and the reference to the logo in the Branding.xml file, update Branding.xml per VSP specifics, etc.).

Quando todas as modificações são feitas, crie um arquivo zip que contém os elementos de identidade visual desejados e altere a extensão para. mshc.When all modifications are done, create a zip file containing the desired branding elements and change the extension to .mshc.

Para associar o pacote de marcas personalizado, crie o MSHA que contém a referência ao arquivo mshc identidade visual, juntamente com o conteúdo mshc (que contém os tópicos).To associate the custom branding package, create the MSHA which contains the reference to the branding mshc file along with the content mshc (containing the topics). Veja a seguir "MSHA" para saber como criar um MSHA básico.See below "MSHA" for how to create a basic MSHA.

O arquivo de Branding.xml contém elementos a lista usada para itens específicos em um tópico de renderização consistente quando o tópico contém <meta name="Microsoft.Help.SelfBranded" conteúdo = "false" / >.The Branding.xml file contains a list elements used for consistently rendering specific items in a topic when the topic contains <meta name="Microsoft.Help.SelfBranded" content="false"/>. A lista do Visual Studio de elementos no arquivo Branding.xml esteja listada abaixo.The Visual Studio list of elements in the Branding.xml file is listed below. Observe que essa lista se destina a ser usado como um modelo para usuários pioneiros do Shell do ISO, onde eles modificarem esses elementos (por exemplo, logotipo, comentários e direitos autorais) para atender às sua próprias necessidades da marca de produto.Note that this list is intended to be used as a template for ISO Shell adopters, where they modify these elements (for example logo, feedback, and Copyright) to meet their own product branding needs.

Observação: as variáveis observadas por "{n}" tem dependências de código - remover ou alterar esses valores causará erros e, possivelmente, a falha do aplicativo. Identificadores de localização (exemplo _locID="codesnippet.n") são incluídos no pacote do Visual Studio de identidade visual.Note: variables noted by "{n}" have code dependencies - removing or changing these values will cause errors and possibly application crash.Localization identifiers (example _locID="codesnippet.n") are included in the Visual Studio Branding Package.

Branding.XMLBranding.xml

Recurso:Feature: CollapsibleAreaCollapsibleArea
Uso:Use: Expandir recolhe o texto do controle de conteúdoExpand collapses content control text
ElementoElement ValueValue
ExpandTextExpandText ExpandirExpand
CollapseTextCollapseText RecolherCollapse
Recurso:Feature: Trecho de códigoCodeSnippet
Uso:Use: Texto de controle de trecho de código.Code snippet control text. Observação: Conteúdo do trecho de código com espaço "Não-separável" será alterado para o espaço.Note: Code snippet content with "Non-Breaking" space will be changed to space.
ElementoElement ValueValue
CopyToClipboardCopyToClipboard Copiar para a Área de TransferênciaCopy to Clipboard
ViewColorizedTextViewColorizedText Exibir coloridoView Colorized
CombinedVBTabDisplayLanguageCombinedVBTabDisplayLanguage Visual Basic (exemplo)Visual Basic (Sample)
VBDeclarationVBDeclaration DeclaraçãoDeclaration
VBUsageVBUsage UsoUsage
Recurso:Feature: Comentários, o rodapé e o logotipoFeedback, Footer, and Logo
Uso:Use: Fornece um controle de comentários do cliente fornecer comentários sobre o tópico atual por email.Provide a Feedback control for customer to supply feedback on the current topic via e-mail. Texto de direitos autorais para o conteúdo.Copyright text for the content. Definição de logotipo.Logo definition.
ElementoElement Valor (essas cadeias de caracteres podem ser modificadas para atender à necessidade de adoção de conteúdo.)Value (These strings can be modified to meet content adopter need.)
Direitos autoraisCopyRight © 2013 Microsoft Corporation.© 2013 Microsoft Corporation. Todos os direitos reservados.All rights reserved.
SendFeedbackSendFeedback <href = "{0}" {1}> enviar comentários</a > sobre este tópico à Microsoft.<a href="{0}" {1}>Send Feedback</a> on this topic to Microsoft.
FeedbackLinkFeedbackLink
LogoTitleLogoTitle Visual Studio 2013Visual Studio 2013
LogoFileNameLogoFileName vs_logo_bk.gifvs_logo_bk.gif
LogoFileNameHCLogoFileNameHC vs_logo_wh.gifvs_logo_wh.gif
Recurso:Feature: Isenção de responsabilidadeDisclaimer
Uso:Use: Um conjunto de casos isenção de responsabilidade específicos para a máquina conteúdo traduzido.A set of case specific disclaimers for machine translated content.
ElementoElement ValueValue
MT_EditableMT_Editable Este artigo foi traduzido por máquina.This article was machine translated. Se você tiver uma conexão de Internet, selecione "Veja este tópico online" para exibir esta página em modo editável junto com o conteúdo original em inglês ao mesmo tempo.If you have an Internet connection, select "View this topic online" to view this page in editable mode with the original English content at the same time.
MT_NonEditableMT_NonEditable Este artigo foi traduzido por máquina.This article was machine translated. Se você tiver uma conexão de Internet, selecione "Veja este tópico online" para exibir esta página em modo editável junto com o conteúdo original em inglês ao mesmo tempo.If you have an Internet connection, select "View this topic online" to view this page in editable mode with the original English content at the same time.
MT_QualityEditableMT_QualityEditable Este artigo foi traduzido manualmente.This article was manually translated. Se você tiver uma conexão de Internet, selecione "Veja este tópico online" para exibir esta página em modo editável junto com o conteúdo original em inglês ao mesmo tempo.If you have an Internet connection, select "View this topic online" to view this page in editable mode with the original English content at the same time.
MT_QualityNonEditableMT_QualityNonEditable Este artigo foi traduzido manualmente.This article was manually translated. Se você tiver uma conexão de Internet, selecione "Veja este tópico online" para exibir esta página em modo editável junto com o conteúdo original em inglês ao mesmo tempo.If you have an Internet connection, select "View this topic online" to view this page in editable mode with the original English content at the same time.
MT_BetaContentsMT_BetaContents Este artigo foi traduzido por máquina para uma versão preliminar.This article was machine translated for a preliminary release. Se você tiver uma conexão de Internet, selecione "Veja este tópico online" para exibir esta página em modo editável junto com o conteúdo original em inglês ao mesmo tempo.If you have an Internet connection, select "View this topic online" to view this page in editable mode with the original English content at the same time.
MT_BetaRecycledContentsMT_BetaRecycledContents Este artigo foi traduzido manualmente para uma versão preliminar.This article was manually translated for a preliminary release. Se você tiver uma conexão de Internet, selecione "Veja este tópico online" para exibir esta página em modo editável junto com o conteúdo original em inglês ao mesmo tempo.If you have an Internet connection, select "View this topic online" to view this page in editable mode with the original English content at the same time.
Recurso:Feature: LinkTableLinkTable
Uso:Use: Suporte para links do tópico onlineSupport for online topic links
ElementoElement ValueValue
LinkTableTitleLinkTableTitle Tabela de linkLink Table
TopicEnuLinkTextTopicEnuLinkText Exibir a versão em inglês</a > deste tópico que está disponível no seu computador.View the English version</a> of this topic that is available on your computer.
TopicOnlineLinkTextTopicOnlineLinkText Veja este tópico <href = "{0}" {1}> online</a >View this topic <a href="{0}" {1}>online</a>
OnlineTextOnlineText OnlineOnline
Recurso:Feature: Controle de áudio de vídeoVideo Audio control
Uso:Use: Exibir elementos e o texto para o conteúdo de vídeoDisplay elements and text for video content
ElementoElement ValueValue
MultiMediaNotSupportedMultiMediaNotSupported Internet Explorer 9 ou posterior deve estar instalado para dar suporte a {0} conteúdo.Internet Explorer 9 or greater must be installed to support {0} content.
VideoTextVideoText exibindo vídeodisplaying video
AudioTextAudioText fluxo de áudiostreaming audio
OnlineVideoLinkTextOnlineVideoLinkText <p > para exibir o vídeo associado a este tópico, clique em {0} <href = "{1}" >{2}aqui</a >.< / p ><p>To view the video associated with this topic, click {0}<a href="{1}">{2}here</a>.</p>
OnlineAudioLinkTextOnlineAudioLinkText <p > para ouvir o áudio associado a este tópico, clique em {0} <href = "{1}" >{2}aqui</a >.< / p ><p>To listen to the audio associated with this topic, click {0}<a href="{1}">{2}here</a>.</p>
Recurso:Feature: Controle de conteúdo não instaladoContent Not Installed control
Uso:Use: Elementos de texto (cadeias de caracteres) usados para a renderização de contentnotinstalled.htmText elements (strings) used for the rendering of contentnotinstalled.htm
ElementoElement ValueValue
ContentNotInstalledTitleContentNotInstalledTitle Nenhum conteúdo foi encontrado no seu computador.No content was found on your computer.
ContentNotInstalledDownloadContentTextContentNotInstalledDownloadContentText <p > para baixar o conteúdo em seu computador, <href = "{0}" {1}> clique na guia gerenciar</a >.< / p ><p>To download content to your computer, <a href="{0}" {1}>click the Manage tab</a>.</p>
ContentNotInstalledTextContentNotInstalledText <p > nenhum conteúdo é instalado em seu computador.<p>No content is installed on your computer. Consulte seu administrador para a instalação de conteúdo de ajuda local. < /p >Please see your Administrator for local Help content installation.</p>
Recurso:Feature: Controle de tópico não encontradoTopic Not Found control
Uso:Use: Elementos de texto (cadeias de caracteres) usados para a renderização de topicnotfound.htmText elements (strings) used for the rendering of topicnotfound.htm
ElementoElement ValueValue
TopicNotFoundTitleTopicNotFoundTitle Não é possível localizar o tópico solicitado no seu computador.Cannot find requested topic on your computer.
TopicNotFoundViewOnlineTextTopicNotFoundViewOnlineText <p > o tópico solicitado não foi encontrado no seu computador, mas você pode <href = "{0}" {1}> Exibir o tópico online</a >.< / p ><p>The topic you requested was not found on your computer, but you can <a href="{0}" {1}>view the topic online</a>.</p>
TopicNotFoundDownloadContentTextTopicNotFoundDownloadContentText <p > consulte o painel de navegação para links para tópicos semelhantes, ou <href = "{0}" {1}> clique na guia gerenciar</a > para baixar o conteúdo em seu computador.< / p ><p>See the navigation pane for links to similar topics, or <a href="{0}" {1}>click the Manage tab</a> to download content to your computer.</p>
TopicNotFoundTextTopicNotFoundText <p > o tópico solicitado não foi encontrado no seu computador. < /p ><p>The topic you requested was not found on your computer.</p>
Recurso:Feature: Tópico corrompido de controleTopic Corrupted Control
Uso:Use: Elementos de texto (cadeias de caracteres) usados para a renderização de topiccorrupted.htmText elements (strings) used for the rendering of topiccorrupted.htm
ElementoElement ValueValue
TopicCorruptedTitleTopicCorruptedTitle Não é possível exibir o tópico solicitado.Unable to display the requested topic.
TopicCorruptedViewOnlineTextTopicCorruptedViewOnlineText <p > o Visualizador da Ajuda é não é possível exibir o tópico solicitado.<p>Help Viewer is unable to display the requested topic. Pode haver um erro no conteúdo do tópico ou uma dependência do sistema subjacente. < /p >There may be an error in the topic's content or an underlying system dependency.</p>
Recurso:Feature: Controle de página inicialHome Page control
Uso:Use: Texto de oferecer suporte à exibição do conteúdo do nó de nível superior do Visualizador da Ajuda.Text supporting the display of the Help Viewer top level node content.
ElementoElement ValueValue
HomePageTitleHomePageTitle Início do Help ViewerHelp Viewer Home
HomePageIntroductionHomePageIntroduction <p > Bem-vindo ao Microsoft Help Viewer, uma fonte essencial de informações para todos que usam ferramentas, produtos, tecnologias e serviços da Microsoft.<p>Welcome to the Microsoft Help Viewer, an essential source of information for everyone who uses Microsoft tools, products, technologies, and services. O Visualizador da Ajuda fornece acesso a instruções e informações de referência, código de exemplo, artigos técnicos e muito mais.The Help Viewer gives you access to how-to and reference information, sample code, technical articles, and more. Para localizar o conteúdo que você precisa, procure o sumário, use a pesquisa de texto completo ou navegue pelo conteúdo usando o palavra-chave índice. < /p >To find the content you need, browse the table of contents, use full-text search, or navigate through content using the keyword index.</p>
HomePageContentInstallTextHomePageContentInstallText <p ><br / > Use o <href = "{0}" {1}> Gerenciar conteúdo</a > guia para fazer o seguinte:<ul ><li > Adicionar conteúdo ao seu computador.< / li ><li > Verificar se há atualizações para seu conteúdo local.< / li ><li > Remover o conteúdo do seu computador.< / li ></ul > < /p ><p><br />Use the <a href="{0}" {1}>Manage Content</a> tab to do the following:<ul><li>Add content to your computer.</li><li>Check for updates to your local content.</li><li>Remove content from your computer.</li></ul></p>
HomePageInstalledBooksHomePageInstalledBooks Livros instaladosInstalled Books
HomePageNoBooksInstalledHomePageNoBooksInstalled Nenhum conteúdo foi encontrado no seu computador.No content was found on your computer.
HomePageHelpSettingsHomePageHelpSettings Configurações de conteúdo de ajudaHelp Content Settings
HomePageHelpSettingsTextHomePageHelpSettingsText <p > sua configuração atual é a Ajuda local.<p>Your current setting is local help. O Visualizador da Ajuda exibe o conteúdo que você instalou em seu computador. <br / > para alterar a fonte de conteúdo da Ajuda, na barra de menus do Visual Studio, escolha <span style = "{0}" > Ajuda, definir preferência da Ajuda</span >.< br / > < /p >The Help Viewer displays content that you have installed on your computer.<br />To change your source of Help content, on the Visual Studio menu bar, choose <span style="{0}">Help, Set Help Preference</span>.<br /></p>
MegabytesMegaByte MBMB

branding.jsbranding.js

O arquivo branding.js contém JavaScript usado pelos elementos de identidade visual do Visual Studio Help Viewer.The branding.js file contains JavaScript used by the Visual Studio Help Viewer branding elements. Abaixo está uma lista de elementos de identidade visual e a função de JavaScript de suporte.Below is a list of the branding elements and the supporting JavaScript function. Todas as cadeias de caracteres a ser localizada para esse arquivo são definidas na seção "Cadeias de caracteres localizáveis" na parte superior desse arquivo.All strings to be localized for this file are defined in the "Localizable Strings" section at the top of this file. Observe que o arquivo ICL foi criado para cadeias de caracteres loc dentro do arquivo branding.js.Note that ICL file has been created for loc strings within the branding.js file.

Recurso de identidade VisualBranding Feature Função JavaScriptJavaScript Function DescriçãoDescription
Var...Var ... Definir variáveisDefine variables
Obter a linguagem de código do usuárioGet the user code language setUserPreferenceLangsetUserPreferenceLang mapeia um índice # para a linguagem de códigomaps an index # to code language
Definir e obter valores de cookieSet and Get cookie values getCookie, setCookiegetCookie, setCookie
Membro herdadoInherited Member changeMembersLabelchangeMembersLabel Expandir/recolher membro herdadoExpand/collapse inherited member
Quando SelfBranded = FalseWhen SelfBranded=False onLoadonLoad Ler a cadeia de caracteres de consulta para verificar se é uma solicitação de impressão.Read the query string to check if it's a print request. Defina todos os codesnippets para se concentrar na guia preferencial do usuário. Se for uma impressão de solicitação, em seguida, defina isPrinterFriendly como true.Set all the codesnippets to focus the user preferred tab. If it's a print request then set isPrinterFriendly to true. Verificação de modo de alto contraste.Check for high contrast mode.
Trecho de códigoCode Snippet addSpecificTextLanguageTagSetaddSpecificTextLanguageTagSet
getIndexFromDevLanggetIndexFromDevLang
ChangeTabChangeTab
setCodesnippetLangsetCodesnippetLang
setCurrentLangsetCurrentLang
CopyToClipboardCopyToClipboard
CollapsibleAreaCollapsibleArea addToCollapsibleControlSetaddToCollapsibleControlSet gravar todos os objetos que o controle recolhível em lista.write all the collapsible control object into list.
CA_ClickCA_Click com base no estado da área recolhível, define qual imagem e texto para apresentarbased on state of collapsible area, defines which image and text to present
Suporte de contraste do logotipoContrast support for Logo isBlackBackground()isBlackBackground() Chamado para determinar se o plano de fundo é preto.Called to determine if background is black. Só precisa quando no modo de alto contraste.Only accurate when in high contrast mode.
isHighContrast()isHighContrast() usar um span colorido para detectar o modo de alto contrasteuse a colored span to detect high contrast mode
onHighContrast(black)onHighContrast(black) Chamado quando o alto contraste é detectadoCalled when high contrast is detected
Funcionalidade LSTLST functionality
addToLanSpecTextIdSet(id)addToLanSpecTextIdSet(id)
updateLST(currentLang)updateLST(currentLang)
getDevLangFromCodeSnippet(lang)getDevLangFromCodeSnippet(lang)
Funcionalidade de multimídiaMultiMedia functionality legenda (Iniciar, final, texto, estilo)caption(begin, end, text, style)
findAllMediaControls(normalizedId)findAllMediaControls(normalizedId)
getActivePlayer(normalizedId)getActivePlayer(normalizedId)
captionsOnOff(id)captionsOnOff(id)
toSeconds(t)toSeconds(t)
getAllComments(node)getAllComments(node)
styleRectify (styleName, styleValue)styleRectify(styleName, styleValue)
showCC(id)showCC(id)
SubTitle(ID)subtitle(id)

ARQUIVOS HTMHTM FILES

O pacote de marcas contém um conjunto de arquivos HTM que dão suporte a cenários para a comunicação de informações de chave para que os usuários o conteúdo de Ajuda, por exemplo uma home page que contém uma seção que descreve quais conjuntos de conteúdo são instalados e as páginas informando ao usuário quando não é possível tópicos ser encontrada no conjunto de locais de tópicos.The branding package contains a set of HTM files that support scenarios for communicating key information to Help content users, for example a homepage that contains a section describing which content sets are installed and pages telling the user when topics cannot be found in the local set of topics. Observe que esses arquivos HTM podem ser modificados por produto.Note that these HTM files can be modified per product. Fornecedores de Shell ISO são capazes de pegar o pacote de marcas padrão e altere o comportamento e o conteúdo dessas páginas para suite sua necessidade.ISO Shell vendors are able to take the default branding package and change the behavior and content of these pages to suite their need. Esses arquivos se referir a seu respectivo pacote de marcas para que as marcas de identidade visual para obter o conteúdo correspondente do arquivo branding.xml.These files refer to their respective branding package in order for the branding tags to get the corresponding content from the branding.xml file.

ArquivoFile UseUse Fonte de conteúdo exibidoDisplayed Content Source
HomePagehomepage.htm Essa é uma página que exibe conteúdo atualmente instalado e qualquer outra mensagem apropriada para apresentar ao usuário sobre seu conteúdo.This is a page that displays currently installed content, and any other message appropriate to present to the user about their content. Este arquivo tem o conteúdo adicional da meta dados atributo "Microsoft.Help.Id" = "-1", que coloca esse conteúdo na parte superior do Sumário conteúdo local.This file has the additional meta data attribute "Microsoft.Help.Id" content="-1" which places this content at the top of the local content TOC.
< META_HOME_PAGE_TITLE_ADD / ><META_HOME_PAGE_TITLE_ADD /> Branding.XML, marca <HomePageTitle >Branding.xml, tag <HomePageTitle>
< HOME_PAGE_INTRODUCTION_SECTION_ADD / ><HOME_PAGE_INTRODUCTION_SECTION_ADD /> Branding.XML, marca <HomePageIntroduction >Branding.xml, tag <HomePageIntroduction>
< HOME_PAGE_CONTENT_INSTALL_SECTION_ADD / ><HOME_PAGE_CONTENT_INSTALL_SECTION_ADD /> Branding.XML, marca <HomePageContentInstallText >Branding.xml, tag <HomePageContentInstallText>
< HOME_PAGE_BOOKS_INSTALLED_SECTION_ADD / ><HOME_PAGE_BOOKS_INSTALLED_SECTION_ADD /> Título de seção marca Branding.xml<HomePageInstalledBooks >, os dados gerados por aplicativo, <HomePageNoBooksInstalled > quando não há livros estão instalados.Heading section Branding.xml tag<HomePageInstalledBooks>, the data generated from application, <HomePageNoBooksInstalled> when no books are installed.
< HOME_PAGE_SETTINGS_SECTION_ADD / ><HOME_PAGE_SETTINGS_SECTION_ADD /> Título de seção marca Branding.xml <HomePageHelpSettings >, seção texto <HomePageHelpSettingsText >.Heading section Branding.xml tag <HomePageHelpSettings>, section text <HomePageHelpSettingsText>.
topiccorrupted.htmtopiccorrupted.htm Quando há um tópico em conjunto local, mas por algum motivo não pode ser exibido (corrompido de conteúdo).When a topic exists in the local set, but for some reason cannot be displayed (corrupted content).
< META_TOPIC_CORRUPTED_TITLE_ADD / ><META_TOPIC_CORRUPTED_TITLE_ADD /> Branding.XML, marca <TopicCorruptedTitle >Branding.xml, tag <TopicCorruptedTitle>
< TOPIC_CORRUPTED_SECTION_ADD / ><TOPIC_CORRUPTED_SECTION_ADD /> Branding.XML, marca <TopicCorruptedViewOnlineText >Branding.xml, tag <TopicCorruptedViewOnlineText>
topicnotfound.htmtopicnotfound.htm Quando um tópico não é encontrado no conteúdo do local definido nem está disponível onlineWhen a topic is not found in the local content set, nor available online
< META_TOPIC_NOT_FOUND_TITLE_ADD / ><META_TOPIC_NOT_FOUND_TITLE_ADD /> Branding.XML, marca <TopicNotFoundTitle >Branding.xml, tag <TopicNotFoundTitle>
< META_TOPIC_NOT_FOUND_ID_ADD / ><META_TOPIC_NOT_FOUND_ID_ADD /> Branding.XML, marca <TopicNotFoundViewOnlineText > + <TopicNotFoundDownloadContentText >Branding.xml, tag <TopicNotFoundViewOnlineText> + <TopicNotFoundDownloadContentText>
< TOPIC_NOT_FOUND_SECTION_ADD / ><TOPIC_NOT_FOUND_SECTION_ADD /> Branding.XML, marca <TopicNotFoundText >Branding.xml, tag <TopicNotFoundText>
contentnotinstalled.htmcontentnotinstalled.htm Quando não há nenhum conteúdo local instalado para o produto.When there is no local content installed for the product.
< META_CONTENT_NOT_INSTALLED_TITLE_ADD / ><META_CONTENT_NOT_INSTALLED_TITLE_ADD /> Branding.XML, marca <ContentNotInstalledTitle >Branding.xml, tag <ContentNotInstalledTitle>
< META_CONTENT_NOT_INSTALLED_ID_ADD / ><META_CONTENT_NOT_INSTALLED_ID_ADD /> Branding.XML, marca <ContentNotInstalledDownloadContentText >Branding.xml, tag <ContentNotInstalledDownloadContentText>
< CONTENT_NOT_INSTALLED_SECTION_ADD / ><CONTENT_NOT_INSTALLED_SECTION_ADD /> Branding.XML, marca <ContentNotInstalledText >Branding.xml, tag <ContentNotInstalledText>

Arquivos CSSCSS Files

O pacote Visual Studio ajuda do Visualizador de identidade visual contém dois arquivos css para dar suporte à apresentação de conteúdo ajuda do Visual Studio consistente:The Visual Studio Help Viewer Branding Package contains two css files to support consistent Visual Studio Help content presentation:

  • Branding.css - contém os elementos de css para a renderização de where SelfBranded = falseBranding.css - contains css elements for rendering where SelfBranded=false

  • Printer.css - contém os elementos de css para a renderização de where SelfBranded = falsePrinter.css - contains css elements for rendering where SelfBranded=false

Arquivos branding.CSS inclui definições de apresentação de tópico do Visual Studio (limitação é que o branding.css contido no Branding_<localidade >. mshc do serviço do pacote pode ser alterado).Branding.css files includes definitions for Visual Studio topic presentation (caveat is that the branding.css contained in the Branding_<locale>.mshc from the package service may change).

Arquivos gráficosGraphic Files

Conteúdo do Visual Studio exibe um logotipo do Visual Studio, bem como outros elementos gráficos.Visual Studio content displays a Visual Studio logo as well as other graphics. A lista completa de arquivos gráficos no pacote de identidade visual do Visual Studio Help Viewer é mostrada abaixo.The complete list of graphic files in the Visual Studio Help Viewer branding package is shown below.

ArquivoFile UseUse ExemplosExamples
clear.gifclear.gif Usado para renderizar a área recolhívelUsed to render Collapsible Area
footer_slice.giffooter_slice.gif Apresentação do rodapéFooter presentation
info_icon.gifinfo_icon.gif Usado ao exibir informaçõesUsed when displaying information Aviso de isenção de responsabilidadeDisclaimer
online_icon.gifonline_icon.gif Esse ícone deve ser associada com links onlineThis icon is to be associated with online links
tabLeftBD.giftabLeftBD.gif Usado para renderizar o contêiner de trecho de códigoUsed to render the code snippet container
tabRightBD.giftabRightBD.gif Usado para renderizar o contêiner de trecho de códigoUsed to render the code snippet container
vs_logo_bk.gifvs_logo_bk.gif Usada para referências de logotipo de contraste normal, conforme definido na marca de Branding.xml <LogoFileName >.Used for normal contrast logo references as defined in Branding.xml tag <LogoFileName>. Para produtos do Visual Studio, o nome do logotipo é vs_logo_bk.gif.For Visual Studio products, logo name is vs_logo_bk.gif.
vs_logo_wh.gifvs_logo_wh.gif Usada para referências de logotipo alta normal, conforme definido na marca de Branding.xml <LogoFileNameHC >.Used for normal high logo references as defined in Branding.xml tag <LogoFileNameHC>. Para produtos do Visual Studio, o nome do logotipo é vs_logo_wh.gif.For Visual Studio products, logo name is vs_logo_wh.gif.
ccOff.pngccOff.png Legendas de gráficoCaptioning graphic
ccOn.pngccOn.png Legendas de gráficoCaptioning graphic
ImageSprite.pngImageSprite.png Usado para renderizar a área recolhívelUsed to render Collapsible Area expandido ou recolher gráficoexpanded or collapse graphic

Implantar um conjunto de tópicosDeploying a set of topics

Este é um tutorial muito simple e rápido para a criação de uma implantação de conteúdo do Visualizador da Ajuda conjunto composta por um arquivo MSHA e o conjunto de cabs ou MSHC que contém os tópicos.This is a very simple and quick tutorial for creating a Help Viewer content deployment set comprised of an MSHA file and the set of cabs or MSHC's containing the topics. O MSHA é um arquivo XML que descreve um conjunto de cabs ou arquivos MSHC.The MSHA is an XML file that describes a set of cabs or MSHC files. O Visualizador da Ajuda podem ler o MSHA para obter uma lista de conteúdo (o. CAB ou. Arquivos MSHC) disponíveis para instalação local.The Help Viewer can read the MSHA to obtain a list of content (the .CAB or .MSHC files) available for local installation.

Isso é apenas um livro de instruções que descrevem o esquema XML muito básico para o MSHA de Visualizador de Ajuda.This is only a primer describing the very basic XML schema for the Help Viewer MSHA. Observe que há um exemplo de implementação abaixo dessa breve visão geral e exemplo HelpContentSetup. msha.Note that there is an example implementation below this brief overview and sample HelpContentSetup.msha.

O nome do MSHA, para fins deste primer é HelpContentSetup. msha (o nome do arquivo pode ser qualquer coisa, com a extensão. MSHA).The name of the MSHA, for the purposes of this primer, is HelpContentSetup.msha (the name of the file can be anything, with the extension .MSHA). HelpContentSetup. msha (exemplo abaixo) deve conter uma lista de cabs ou MSHCs disponíveis.HelpContentSetup.msha (example below) should contain a list of the cabs or MSHCs available. Observe que o tipo de arquivo deve ser consistente dentro a MSHA (não oferece suporte a uma combinação de tipos de arquivo CAB e de MSHA).Note that the file type must be consistent within the MSHA (does not support a combination of MSHA and CAB file types). Para cada CAB ou MSHC, deve haver um <div classe = "pacote" >... </div > (consulte o exemplo a seguir).For each CAB or MSHC, there should be a <div class="package">...</div> (see example below).

Observação: no exemplo a implementação abaixo, incluímos o pacote de marcas.Note: in the implementation example below, we have included the branding package. Isso é essencial para incluir a fim de obter o necessários elementos de renderização de conteúdo do Visual Studio e comportamentos de conteúdo.This is critical to include in order to get the needed Visual Studio content rendering elements and content behaviors.

Arquivo HelpContentSetup msha exemplo: (substitua "nome 1 do conjunto de conteúdo" e "nome do conjunto 2" etc. com seus nomes de arquivo de conteúdo.)Sample HelpContentSetup.msha file: (Replace "content set name 1" and "content set name 2" etc. with your file names.)

<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. Crie uma pasta local, algo como "C:\SampleContent"Create local folder, something like "C:\SampleContent"

  2. Neste exemplo, usaremos arquivos MSHC para conter os tópicos.For this example, we will use MSHC files to contain the topics. Um MSHC é um zip com a extensão de arquivo alterado de. zip para. MSHC.An MSHC is a zip with the file extension changed from .zip to .MSHC.

  3. Criar a abaixo HelpContentSetup. msha como um arquivo de texto (bloco de notas foi usado para criar o arquivo) e salve-o para a pasta mencionada acima (consulte a etapa 1).Create the below HelpContentSetup.msha as a text file (notepad was used to create the file) and save it to the above noted folder (see step 1).

Observe que a classe "Marca" exista e seja exclusivo.Note that the class "Branding" exists and is unique. A identidade visual mshc está incluído neste primer para que o conteúdo instalado tiver a identidade visual e os comportamentos de conteúdo que estão contidos nos MSHCs terá suporte apropriado elementos contidos no pacote de identidade visual.The Branding mshc is included in this primer so that the installed content will have branding, and the content behaviors that are contained in the MSHCs will have the appropriate support elements contained in the branding package. Sem isso, haverá erros quando o sistema procura por itens de suporte que não fazem parte do copiados (instalado) conteúdo.Without this, errors will result when the system looks for support items that are not part of the ripped (installed) content.

Para obter o pacote de identidade visual do Visual Studio, copie o arquivo de Branding_en US.mshc em C:\Program Files (x86) \Microsoft Help Viewer\v2.3\ para sua pasta de trabalho.To obtain the Visual Studio branding package, copy Branding_en-US.mshc file at C:\Program Files (x86)\Microsoft Help Viewer\v2.3\ to your working folder.

<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>  

ResumoSummary

Usando e estendendo as etapas acima permitirá VSPs implantar seus conjuntos de conteúdo para o Visual Studio Help Viewer.Using and extending the above steps will enable VSPs to deploy their content sets for the Visual Studio Help Viewer.

Adicionar uma ajuda para o Visual Studio Shell (integrado e isolado)Adding help to the Visual Studio Shell (Integrated and Isolated)

IntroduçãoIntroduction

Este passo a passo demonstra como incorporar o conteúdo da Ajuda em um aplicativo de Shell do Visual Studio e, em seguida, implantá-lo.This walkthrough demonstrates how to incorporate Help content into a Visual Studio Shell application and then deploy it.

RequisitosRequirements

  1. Visual Studio 2013Visual Studio 2013

  2. Pacote redistribuível do Shell de isolado do Visual Studio 2013Visual Studio 2013 Isolated Shell Redist

Visão geralOverview

O Visual Studio 2013Visual Studio 2013 Shell é uma versão dos Visual Studio 2013Visual Studio 2013 IDE no qual você pode basear um aplicativo.The Visual Studio 2013Visual Studio 2013 Shell is a version of the Visual Studio 2013Visual Studio 2013 IDE on which you can base an application. Esses aplicativos contêm o Shell isolado junto com as extensões que você cria.Such applications contain the Isolated Shell together with extensions that you create. Usar modelos de projeto do Shell isolado, que são incluídos no Visual Studio 2013Visual Studio 2013 SDK, a criação de extensões.Use Isolated Shell project templates, which are included in the Visual Studio 2013Visual Studio 2013 SDK, to build extensions.

As etapas básicas para criar um aplicativo baseado no Shell isolado e da Ajuda:The basic steps for creating an Isolated Shell-based application and its Help:

  1. Obter o Visual Studio 2013Visual Studio 2013 ISO redistribuível do Shell (um download da Microsoft).Obtain the Visual Studio 2013Visual Studio 2013 ISO Shell redistributable (a Microsoft download).

  2. No Visual Studio, crie uma extensão de Ajuda que é baseada no Shell isolado do, por exemplo, a extensão de Ajuda da Contoso que é descrita posteriormente neste passo a passo.In Visual Studio, create a Help extension that is based on the Isolated Shell, for example, the Contoso Help extension that is described later in this walkthrough.

  3. Encapsule a extensão e o Shell de ISO redistribuível em uma implantação de MSI (uma configuração de aplicativo).Wrap the extension and the ISO Shell redistributable into a deployment MSI (an application setup). Este passo a passo não inclui uma etapa de instalação.This Walkthrough does not include a setup step.

Crie um repositório de conteúdo do Visual Studio.Create a Visual Studio content store. Para o cenário de Shell integrado, altere Studio12 Visual para o nome do catálogo de produto da seguinte maneira:For the Integrated Shell scenario, change Visual Studio12 to the product catalog name as follows:

  • Crie pasta C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15.Create folder C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15.

  • Crie um arquivo chamado Catalogtype e adicioná-lo para a pasta.Create a file named CatalogType.xml and add it to the folder. O arquivo deve conter as seguintes linhas de código:The file should contain the following lines of code:

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

Defina o repositório de conteúdo no registro.Define the content store in the registry. Para o Shell integrado, altere VisualStudio15 para o nome do catálogo de produto:For the Integrated Shell, change VisualStudio15 to the product catalog name:

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

    Chave: Valor de cadeia de caracteres LocationPath: C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15\Key: LocationPath String value: C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15\

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

    Chave: Valor de cadeia de caracteres CatalogName: Visual Studio 2013Visual Studio 2013 documentaçãoKey: CatalogName String value: Visual Studio 2013Visual Studio 2013 Documentation

Criar o projetoCreate the Project

Para criar uma extensão de Shell isolado:To create an Isolated Shell extension:

  1. No Visual Studio, sob arquivo, escolha novo projeto, em Other Project Types escolha extensibilidadee, em seguida, escolha Shell do Visual Studio isolado.In Visual Studio, under File, choose New Project, under Other Project Types choose Extensibility, and then choose Visual Studio Shell Isolated. Nomeie o projeto ContosoHelpShell) para criar um projeto de extensibilidade com base no modelo de Shell isolado do Visual Studio.Name the project ContosoHelpShell) to create an extensibility project based on the Visual Studio Isolated Shell template.

  2. No Gerenciador de soluções, no projeto ContosoHelpShellUI, na pasta arquivos de recurso, abra ApplicationCommands.vsct.In Solution Explorer, in the ContosoHelpShellUI project, in the Resource Files folder, open ApplicationCommands.vsct. Verifique se que essa linha é comentada (procure por "No_Help"): <!-- <define name="No_HelpMenuCommands"/> -->Make sure this line is commented out (search for "No_Help"): <!-- <define name="No_HelpMenuCommands"/> -->

  3. Escolha a tecla F5 para compilar e executar depurar.Choose the F5 key to compile and run Debug. Na instância experimental do IDE do Shell isolado, escolha o ajudar menu.In the experimental instance of the Isolated Shell IDE, choose the Help menu. Certifique-se de que o exibir ajuda, adicionar e remover conteúdo da Ajuda, e Definir preferência da Ajuda comandos são exibidos.Make sure that the View Help, Add and Remove Help Content, and Set Help Preference commands appear.

  4. No Gerenciador de soluções, no projeto ContosHelpShell, na pasta de personalização do Shell, abra ContosoHelpShell.pkgdef.In Solution Explorer, in the ContosHelpShell project, in the Shell Customization folder, open ContosoHelpShell.pkgdef. Para definir o catálogo de Ajuda da Contoso, adicione as seguintes linhas:To define the Contoso Help catalog, add the following lines:

     [$RootKey$\Help]  
    "Product"="Contoso"  
    "Catalog"="Contoso"  
    "Version"="100"  
    "BrandingPackage"="ContosoBrandingPackage.mshc"  
    
  5. No Gerenciador de soluções, no projeto ContosHelpShell, na pasta de personalização do Shell, abra ContosoHelpShell.Application.pkgdef.In Solution Explorer, in the ContosHelpShell project, in the Shell Customization folder, open ContosoHelpShell.Application.pkgdef. Para habilitar a Ajuda de F1, adicione as seguintes linhas:To enable F1 Help, add the following lines:

    // 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. No Solution Explorer, no menu de contexto da solução ContosoHelpShell, escolha o propriedades item de menu.In Solution Explorer, on the context menu of the ContosoHelpShell solution, choose the Properties menu item. Sob propriedades de configuração, selecione Configuration Manager.Under Configuration Properties, select Configuration Manager. No configuração coluna, altere todos os valores "Debug" como "Versão".In the Configuration column, change every "Debug" value to "Release".

  7. Compile a solução.Build the solution. Isso cria um conjunto de arquivos em uma pasta de versão, que será usada na próxima seção.This creates a set of files in a release folder, which will be used in the next section.

Para testar isso como se implantado:To test this as if deployed:

  1. No computador, você está implantando Contoso para instalar o Shell da ISO (acima) baixado.On the machine you are deploying Contoso to, install the downloaded (from above) ISO Shell.

  2. Crie uma pasta na \\Program Files (x86)\e nomeie-o Contoso.Create a folder in \\Program Files (x86)\, and name it Contoso.

  3. Copie o conteúdo da pasta da versão ContosoHelpShell para \pasta de \Contoso\ do \Program Files (x86).Copy the contents from the ContosoHelpShell release folder to \\Program Files (x86)\Contoso\ folder.

  4. Inicie o Editor do registro, escolhendo executados na iniciar menu e inserindo Regedit.Start Registry Editor by choosing Run in the Start menu and entering Regedit. No editor do registro, escolha arquivoe então importação.In the registry editor, choose File, and then Import. Navegue até a pasta do projeto ContosoHelpShell.Browse to the ContosoHelpShell project folder. Na pasta ContosoHelpShell subpropriedades, escolha ContosoHelpShell.reg.In the ContosoHelpShell sub-folder, choose ContosoHelpShell.reg.

  5. Crie um repositório de conteúdo:Create a content store:

    Para o Shell ISO - criar um repositório de conteúdo do Contoso C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\ContosoDev12For ISO Shell - create a Contoso content store C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\ContosoDev12

    Para Visual Studio 2013Visual Studio 2013 Integrated Shell, crie a pasta C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15For Visual Studio 2013Visual Studio 2013 Integrated Shell, create folder C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15

  6. Criar Catalogtype e adicionar ao repositório de conteúdo (etapa anterior) que contém:Create CatalogType.xml and add to the content store (previous step) containing:

    <?xml version="1.0" encoding="UTF-8"?>  
    <catalogType>UserManaged</catalogType>  
    
  7. Adicione as seguintes chaves do registro:Add the following registry keys:

    HKLM\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15Key: Valor de cadeia de caracteres LocationPath:HKLM\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15Key: LocationPath String value:

    Para o Shell do ISO:For ISO Shell:

    C:ProgramDataMicrosoftHelpLibrary2CatalogsVisualStudio15C:ProgramDataMicrosoftHelpLibrary2CatalogsVisualStudio15

    Visual Studio 2013Visual Studio 2013 Shell integrado: Integrated Shell:

    C:ProgramDataMicrosoftHelpLibrary2CatalogsVisualStudio15en-EUAC:ProgramDataMicrosoftHelpLibrary2CatalogsVisualStudio15en-US

    Chave: Valor de cadeia de caracteres CatalogName: Visual Studio 2013Visual Studio 2013 documentação.Key: CatalogName String value: Visual Studio 2013Visual Studio 2013 Documentation. Para o Shell do ISO, isso é o nome do seu catálogo.For ISO Shell, this is the name of your catalog.

  8. Copie o conteúdo (cabs ou MSHC e MSHA) em uma pasta local.Copy your content (cabs or MSHC and MSHA) to a local folder.

  9. Linha de comando de Shell integrado de exemplo para testar o repositório de conteúdo.Example Integrated Shell command line for testing content store. Para o Shell do ISO, altere os valores de catálogo e launchingApp conforme apropriado para coincidir com o produto.For ISO Shell, change the catalog and launchingApp values as appropriate to match the product.

    Método de /helpQuery /catalogName VisualStudio15 "C:\Program arquivos (x86) \Microsoft Help Viewer\v2.3\HlpViewer.exe" = "página & id = ContosoTopic0" /launchingApp Microsoft VisualStudio, 12.0"C:\Program Files (x86)\Microsoft Help Viewer\v2.3\HlpViewer.exe" /catalogName VisualStudio15 /helpQuery method="page&id=ContosoTopic0" /launchingApp Microsoft,VisualStudio,12.0

  10. Inicie o aplicativo da Contoso (da raiz do aplicativo Contoso).Launch the Contoso application (from the Contoso app root). No Shell de ISO, escolha o ajudar item de menu e altere o Definir preferência da Ajuda para usar a Ajuda Local.Within ISO Shell, choose the Help menu item, and change the Set Help Preference to Use Local Help.

  11. Dentro do shell, escolha o ajudar item de menu, em seguida, exibir ajuda.Within the shell, choose the Help menu item, then View Help. Deve iniciar o Visualizador da Ajuda local.The local Help viewer should launch. Escolha a guia Gerenciar Conteúdo. Sob fonte de instalação, escolha o disco botão de opção.Choose the Manage Content tab. Under Installation Source, choose the Disk option button. Escolha o ... botão e navegue até a pasta local que contém o conteúdo do Contoso (copiado para a pasta local na etapa anterior).Choose the ... button and browse to the local folder containing Contoso content (copied to the local folder in the above step). Escolha o HelpContentSetup. msha.Choose the HelpContentSetup.msha. A Contoso agora deve aparecer como um livro em seleções de livro.Contoso should now show up as a book in the book selections. Escolher Adde, em seguida, escolha o atualização botão (canto inferior direito).Choose Add, and then choose the Update button (bottom right corner).

  12. Dentro do IDE de Contoso, escolha a tecla F1 para testar a funcionalidade de F1.Within the Contoso IDE, choose the F1 key to test F1 functionality.

Recursos adicionaisAdditional Resources

Para a API de tempo de execução, consulte API de Ajuda do Windows.For the Runtime API, see Windows Help API.

Para obter informações adicionais sobre como usar a API de Ajuda, consulte exemplos de código do Visualizador de ajudaFor additional information on how to leverage the Help API, see Help Viewer Code Examples

Para fornecer comentários sobre esses componentes, use Microsoft Connect.To provide feedback about these components, use Microsoft Connect.

Envie sugestões de recursos ao Microsoft User VoicePlease submit feature suggestions to Microsoft User Voice

Para obter ajuda adicional, experimente o fóruns do sistema de Ajuda e documentação do desenvolvedor do MSDNTo get additional help, try the MSDN Developer Documentation and Help System forums

Atualizações em quebrar o problema, consulte o Leiame do Visualizador de ajudaUpdates on breaking issue, please see the Help Viewer Readme

Para contatar diretamente a equipe de PM do Visualizador de Ajuda, envie um email para hlpfdbk@microsoft.comTo contact the Help Viewer PM team directly, send e-mail to hlpfdbk@microsoft.com