SDK do Microsoft Help ViewerMicrosoft Help Viewer SDK

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

  • Criando um tópico (suporte F1)Creating a topic (F1 support)

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

  • Implantando um conjunto de artigosDeploying a set of articles

  • Adicionando ajuda ao shell do Visual Studio (integrado ou isolado)Adding help to the Visual Studio shell (integrated or isolated)

  • Recursos adicionaisAdditional Resources

Criar um tópico (suporte F1)Create 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, por fim, 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 do tópico do Help ViewerHelp Viewer Topic Overview

Quando um tópico é chamado para renderização, o Visualizador da ajuda obtém os elementos do pacote de identidade visual associados ao tópico no momento da instalação ou da última atualização, juntamente com o tópico XHTML, e combina os dois para resultar no modo de exibição de conteúdo apresentado (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 identidade visual contém logotipos, suporte para comportamentos de conteúdo e texto de identidade visual (direitos autorais etc.).The branding package contains logos, support for content behaviors, and branding text (copyright, etc.). Consulte "criando pacote de identidade visual" abaixo para obter mais informações sobre os elementos do pacote de identidade visual.See "Creating Branding Package" below for more information about the branding package elements. Caso não haja nenhum pacote de identidade visual associado ao tópico, o Visualizador da ajuda usará o pacote de identidade visual de fallback localizado na raiz do aplicativo Help Viewer (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 do tópico do Help ViewerHelp Viewer Topic Requirements

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

Um tópico normalmente contém duas seções:A topic typically contains two sections:

  • Metadados (consulte referência de metadados de conteúdo): dados sobre o tópico, por exemplo, a ID exclusiva do tópico, o valor da palavra-chave, a ID de Sumário do tópico, a ID do nó pai, 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: compatível com o XHTML básico 1,1 do W3C, que inclui comportamentos de conteúdo com suporte (á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).

Controles com suporte do pacote de marca do Visual Studio:Visual Studio Branding Package supported controls:

  • LinksLinks

  • CodeSnippetCodeSnippet

  • CollapsibleAreaCollapsibleArea

  • Membro herdadoInherited Member

  • LanguageSpecificTextLanguageSpecificText

Cadeias de idiomas com suporte (não diferencia maiúsculas de minúsculas):Supported language strings (not case sensitive):

  • javascriptjavascript

  • Csharp ou c #csharp or c#

  • CPlusPlus ou Visual c++ + + ou c++cplusplus or visualc++ or c++

  • jscriptjscript

  • VisualBasic ou VBvisualbasic or vb

  • f # ou FSharp ou FSf# or fsharp or fs

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

Criando um tópico do Help ViewerCreating a Help Viewer topic

Crie um novo documento XHTML chamado ContosoTopic4.htm e inclua 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 deve ser apresentado (automarcado 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 referência de link por outros tópicos), etc. Consulte a tabela "metadados de conteúdo" abaixo para obter uma lista completa dos 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 marca, uma variante do pacote de identidade visual do Help Viewer.In this case, we will use our own branding package, a variant of the Visual Studio Help Viewer branding package.

  • Adicione o meta e o valor F1 ("Microsoft. help. F1" content = "ContosoTopic4") que corresponderão ao valor F1 fornecido no recipiente 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 suporte F1 para obter mais informações.) Esse é o valor que é correspondido à chamada F1 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. Esta é a cadeia de caracteres usada por outros tópicos para vincular a este tópico.This is the string that is used by other topics to link to this topic. É a ID do Visualizador da ajuda deste tópico.It is the Help Viewer ID for this topic.

  • Para o Sumário, adicione o nó pai deste tópico para definir onde este nó de Sumário do tópico será exibido.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 n o número de nós filhos, defina na ordem dos nós filho o 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 filho.For example, this topic is number 4 of 4 child topics.

Exemplo de seção de metadados: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 o rodapé) do tópico conterá links de página, uma seção de observação, uma área recolhível, um trecho de código e uma seção de texto específico 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 identidade visual para obter informações sobre essas áreas do tópico apresentado.See the branding section for information about those areas of the presented topic.

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

  2. Adicionar 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 à linguagem de código: <LanguageSpecificText devLangcs="CS" devLangvb="VB" devLangcpp="C++" devLangnu="F#" /> Observe que devLangnu= permite que você insira outros idiomas.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" exibe o Fortran quando o trecho de código DisplayLanguage = FortranFor example, devLangnu="Fortran" displays Fortran when the code snippet DisplayLanguage = Fortran

  6. Adicionar 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>

Observação

Observação: para uma nova colorização de código "idioma de vídeo" (exemplo, F #, COBOL, Fortran) sem suporte 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 do Help Viewer de exemplo O código ilustra como definir metadados, um trecho de código, uma área recolhível e um texto específico a um 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 a F1F1 Support

No Visual Studio, a seleção de F1 gera valores fornecidos a partir do posicionamento do cursor dentro do IDE e popula um "recipiente de propriedades" 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 está sobre o recurso x, o recurso x está ativo/em foco e popula 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 o código F1 do Visual Studio procura ver se a fonte de ajuda padrão dos clientes é local ou online (online é o padrão), em seguida, cria a cadeia de caracteres apropriada com base na configuração de usuários (online é o padrão)-shell execute (consulte o guia do administrador da ajuda para parâmetros de inicialização exe) com parâmetros para a ajuda local do Help Viewer + palavra-chave do recipiente de propriedades se a ajuda local for 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 forem retornadas para F1, mencionadas como uma cadeia de valores múltiplos, pegar o primeiro termo, procurar um problema e, se for encontrado, terminaremos; caso contrário, mova 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. O pedido é importante.Order matters. A apresentação das palavras-chave de vários valores deve ser a cadeia de caracteres mais longa para 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 incluirá 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, fizemos intencionalmente uma divisão mais forte entre online e offline, de modo que, se a configuração do usuário estivesse para online, simplesmente passamos a solicitação F1 diretamente para nosso serviço de consulta online no MSDN em vez de rotear por meio do agente da 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, usamos um estado de "conteúdo do fornecedor instalado = verdadeiro" para determinar se é preciso 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, executamos essa lógica de análise e de roteamento dependendo do que você deseja dar suporte aos 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, basta ir para o MSDN.If false, then we just go to MSDN. Se a configuração do usuário for local, todas as chamadas vão para o mecanismo de ajuda local.If the user's setting is to Local, then all calls go to the local help engine.

Diagrama de fluxo de F1:F1 Flow Diagram:

Fluxo de F1F1 flow

Quando a fonte de conteúdo da ajuda padrão do Visualizador da ajuda está definida como online (iniciar no navegador):When the Help Viewer default help content source is set to online (Launch in browser):

  • Os recursos do Visual Studio Partner (VSP) emitem um valor para o recipiente de propriedades F1 (prefixo do recipiente de propriedades. a palavra-chave e a URL online para o prefixo encontrado no registro): F1 envia uma URL do 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íficos 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 da ajuda padrão do Visualizador da ajuda é definida como ajuda local (iniciar no Visualizador da ajuda):When the Help Viewer default help content source is set to local Help (Launch in Help Viewer):

  • Os recursos do VSP em que a palavra-chave corresponde entre o recipiente de propriedades F1 e o índice de repositório local (ou seja, o prefixo do recipiente de propriedades. keyword = o valor encontrado no índice de repositório local): F1 renderiza o tópico no Help Viewer.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 o VSP substituir o recipiente de propriedades emitido por 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 valores de registro a seguir para habilitar o fallback F1 para o conteúdo de ajuda do fornecedor.Set the following registry values to enable F1 Fallback for vendor Help content. O fallback de F1 significa que o Visualizador da ajuda está definido para procurar F1 conteúdo de ajuda online e o conteúdo do fornecedor é instalado localmente no 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 do conteúdo, mesmo que a configuração padrão seja para a ajuda online.The Help Viewer should look at local Help for the content even though the default setting is for online help.

  1. Defina o valor VendorContent na chave do registro Help 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 do parceiro na chave do registro Help 2,3:Register the partner namespace under the Help 2.3 registry key:

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

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

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

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

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

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

Análise de namespace nativo baseBase Native Namespace Parsing

Para ativar a análise de namespace nativo base, no registro, adicione um novo DWORD com o nome de: BaseNativeNamespaces e defina seu valor como 1 (na chave de catálogo para a qual deseja oferecer 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, poderá adicionar a chave ao 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 for encontrada uma palavra-chave F1 no formato de cabeçalho/método, o caractere '/' será analisado, resultando na seguinte construção:When an F1 keyword in the format HEADER/METHOD is encountered, the '/' character will be parsed out, resulting in the following construct:

  • HEADER: 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 F1 chega, ela 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 pode então registrar CustomLibrary como o namespace no hive Partners e fornecer qualquer chave de local que desejarem, 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 de depuração de ajuda no IDEEnable Help debugging tool in the IDE

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

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

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

Valor: exibir a saída de depuração em dados de varejo: SimValue: Display Debug Output in Retail Data: YES

No IDE, no item de menu ajuda, selecione depurar contexto de ajuda.In the IDE, under the Help menu item, select Debug Help Context.

Metadados de conteúdoContent Metadata

Na tabela a seguir, qualquer cadeia de caracteres que apareça 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 <meta name="Microsoft.Help.Locale" content="[language code]" /> , "[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 HTML)Property (HTML Representation) DescriçãoDescription
< meta name="Microsoft.Help.Locale" content="[language-code]" /> Define uma localidade para este tópico.Sets a locale for this topic. Se essa marca for usada em um tópico, ela deverá ser usada apenas uma vez e deverá ser inserida acima de qualquer outra marca de ajuda da Microsoft.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 será indexado usando o separador de palavras associado à localidade do produto, se for especificado; caso contrário, o separador de palavras en-US será usado.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 está de acordo com o ISOC RFC 4646.This tag conforms to ISOC RFC 4646. Para garantir que a ajuda da Microsoft funcione corretamente, use essa propriedade em vez do atributo idioma geral.To ensure that Microsoft Help works correctly, use this property instead of the general Language attribute.
< 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 for usada em um tópico, ela deverá ser usada apenas uma vez.If this tag is used in a topic, it must be used just once. Use essa marca quando o catálogo contiver 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 deles 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.
< title>Título</title>< title>[Title]</title> Especifica o título deste tópico.Specifies the title of this topic. Essa marca é necessária 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 contiver uma seção de título <div> , esse título será exibido 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.
< meta name=" Microsoft.Help.Keywords" content="[aKeywordPhrase]"/> Especifica o texto de um link que é exibido no painel índice do Help Viewer.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.When the link is clicked, the topic is displayed. Você pode especificar várias palavras-chave de índice para um tópico ou pode omitir essa marca se não quiser que os links para este tópico apareçam no índice.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. Palavras-chave "K" 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.
< meta name="Microsoft.Help.Id" content="[TopicID]"/> Define o identificador deste tópico.Sets the identifier for this topic. Essa marca é necessária 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 os 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 essa 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]"/> Especifica a palavra-chave F1 para este tópico.Specifies the F1 keyword for this topic. Você pode especificar várias palavras-chave F1 para um tópico ou pode omitir essa marca se não quiser que este tópico seja exibido quando um usuário do aplicativo pressionar 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 F1 é especificada para um tópico.Typically, just one F1 keyword is specified for a topic. Palavras-chave "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.
< meta name="Description" content="[topic description]" /> Fornece um breve resumo do conteúdo deste tópico.Provides a short summary of the content in this topic. Se essa marca for usada em um tópico, ela deverá ser usada apenas uma vez.If this tag is used in a topic, it must be used just once. Essa 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.
meta name = "Microsoft. help. TocParent" content = "[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 é necessária 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 no sumário.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 é o Help Viewer Home Page.In Visual Studio 2013Visual Studio 2013, that page is Help Viewer home page. Esse é o mesmo motivo pelo qual adicionamos especificamente TocParent =-1 a alguns tópicos para garantir que eles apareçam no nível superior.This is the same reason we specifically add TocParent=-1 to some topics to ensure that they show up at the top level. O Visualizador da ajuda home page é uma página do sistema e, portanto, não substituível.The Help Viewer home page is a system page and so non-replaceable. Se um VSP tentar adicionar uma página com uma ID de-1, ela poderá ser adicionada ao conjunto de conteúdo, mas o Help Viewer sempre usará a página do sistema-início da ajuda 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
< meta name="Microsoft.Help.TocOrder" content="[positive integer]"/> Especifica o local no sumário que este tópico aparece em relação aos seus tópicos de pares.Specifies where in the table of contents this topic appears relative to its peer topics. Essa marca é necessária 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 de valor inferior aparece acima de um tópico que especifica um inteiro de valor mais alto.A topic that specifies a lower-value integer appears above a topic that specifies a higher-value integer.
< meta name="Microsoft.Help.Product" content="[product code]"/> Especifica o produto que este tópico descreve.Specifies the product that this topic describes. Se essa marca for usada em um tópico, ela deverá ser usada 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 da ajuda.This information can also be supplied as a parameter that is passed to the Help Indexer.
< meta name="Microsoft.Help.ProductVersion" content="[version number]"/> Especifica a versão do produto que este tópico descreve.Specifies the version of the product that this topic describes. Se essa marca for usada em um tópico, ela deverá ser usada 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 da ajuda.This information can also be supplied as a parameter that is passed to the Help Indexer.
< 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 pode omitir essa marca se não quiser que os links identifiquem nenhuma subseção.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.
< meta name="Microsoft.Help.TopicVersion content="[topic version number]"/> Especifica 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. Como não há garantia de que Microsoft.Help.Id seja exclusivo, essa marca é necessária quando há mais de uma versão de um tópico 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 Microsoft.Help.Id.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.
< meta name="SelfBranded" content="[TRUE or FALSE]"/> Especifica se este tópico usa o pacote de identidade visual de inicialização do Gerenciador de biblioteca de ajuda ou um pacote de identidade visual que é 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 TRUE ou FALSE.This tag must be either TRUE or FALSE. Se for TRUE, o pacote de identidade visual do tópico associado substituirá o pacote de identidade visual definido quando o Gerenciador de biblioteca de ajuda for iniciado para que o tópico seja renderizado como pretendido mesmo que seja diferente do processamento de outro 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 será renderizado de acordo com o pacote de identidade visual que é definido quando o Gerenciador de biblioteca de ajuda é 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 Gerenciador de biblioteca de ajuda assume que a própria identidade visual seja falsa, a menos que a variável SelfBranded seja declarada como verdadeira; Portanto, você não precisa declarar <meta name="SelfBranded" content="FALSE"/> .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"/>.

Criar um pacote de identidade visualCreate a branding package

A versão do Visual Studio abrange vários produtos diferentes do Visual Studio, incluindo os shells isolados e integrados 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 algum grau de suporte de identidade visual de conteúdo de ajuda baseado em tópico, exclusivo para o produto.Each of these products requires some degree of topic-based Help content branding support, unique to the product. Por exemplo, os tópicos do Visual Studio precisam ter uma apresentação de marca consistente, enquanto o SQL Studio, que encapsula o Shell ISO, requer sua própria identidade visual exclusiva de conteúdo da ajuda 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 que seus tópicos de ajuda estejam dentro do conteúdo da ajuda do produto do Visual Studio pai, mantendo sua própria identidade visual de tópico.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.

Os pacotes de identidade visual são instalados pelo produto que contém o Visualizador da ajuda.Branding packages are installed by the product containing the Help Viewer. Para produtos do Visual Studio:For Visual Studio products:

  • Um pacote de identidade visual de fallback (Branding_ <locale> . mshc) é instalado na raiz do aplicativo Help viewer 2,3 (exemplo: c:\Arquivos de programas (x86) \Microsoft Help Viewer\v2.3) pelo pacote de idiomas do Help Viewer.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 pacote de identidade visual do produto não está instalado (nenhum conteúdo foi instalado) ou onde o pacote de identidade visual 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. Os elementos do Visual Studio (logotipo e comentários) são ignorados quando o pacote de identidade visual de fallback de raiz do aplicativo é usado.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 a partir do serviço de pacote de conteúdo, um pacote de marca também é instalado (para o cenário de instalação de conteúdo pela primeira vez).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 identidade visual, a atualização será instalada quando a próxima atualização de conteúdo ou ação de instalação de pacote adicional ocorrer.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.

  • Onde os metadados do tópico definem Self-Brand = true, renderizar o tópico como está, não faça nada (no que diz respeito à identidade visual).Where topic metadata defines self branded = true, render the topic as is, do nothing (as far as branding).

  • Quando os metadados do tópico definem a automarca = false, use o pacote de identidade visual associado ao valor de metadados TopicVendor.Where topic metadata defines self branded = false, use the branding package associated with TopicVendor metadata value.

  • Em que os metadados de tópico definem Name = "Microsoft. help. TopicVendor" Content = < branding package name in vendor MSHA> , use o pacote de identidade visual definido no valor de 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.

  • No catálogo do Visual Studio, há um aplicativo de prioridade de pacotes de marca.Within the Visual Studio catalog, there is a priority application of Branding Packages. A primeira marca padrão do Visual Studio é aplicada e, em seguida, se definido nos metadados do tópico e com suporte com o pacote de identidade visual associado (conforme definido no MSHA de instalação), a identidade visual definida pelo fornecedor será aplicada 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.

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

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

  • Comportamentos de conteúdo (exemplos incluem elementos de texto de controle 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 de direitos autorais)Footer elements (example Copyright)

Os itens considerados como elementos de marca incluem (detalhados nesta especificação):Items considered as branded elements include (detailed in this spec):

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

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

  • Texto de isençãoDisclaimer text

  • Texto de direitos autoraisCopyright text

Os arquivos de suporte no pacote de identidade Visual Studio Help Viewer incluem:Supporting files in the Visual Studio Help Viewer branding package include:

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

  • Arquivos de Branding.js-script com suporte a comportamentos de conteúdoBranding.js - script files supporting content behaviors

  • Branding.xml-cadeias de caracteres usadas consistentemente no 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 na branding.xml, inclua _locID = " <unique value> "Note: for Visual Studio localization text elements in the branding.xml, include _locID="<unique value>"

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

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

Conforme observado acima, os 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 pacote de identidade visual do catálogoWhen SelfBranded = false is defined in the metadata, the topic inherits the catalog branding package

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

Para VSPs implementar pacotes personalizados de identidade visual (VSP, SelfBranded = true), uma maneira de prosseguir é começar com o pacote de identidade visual de fallback (instalado com o Visualizador da ajuda) e alterar 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 <locale> arquivo Branding_. mshc é um arquivo zip com a extensão de arquivo alterada para. mshc, portanto, basta alterar a extensão de. mshc para. zip e extrair 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 abaixo os elementos de pacote de identidade visual e modifique conforme apropriado (por exemplo, altere o logotipo para o logotipo VSP e a referência ao logotipo no arquivo Branding.xml, atualize Branding.xml específico de 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 forem concluídas, crie um arquivo ZIP contendo 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 identidade visual personalizado, crie o MSHA, que contém a referência ao arquivo de identidade visual mshc junto 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). Consulte abaixo "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 uma lista de elementos usados para processar consistentemente itens específicos em um tópico quando o tópico contém <meta name="Microsoft.Help.SelfBranded" content="false"/> .The Branding.xml file contains a list of elements used for consistently rendering specific items in a topic when the topic contains <meta name="Microsoft.Help.SelfBranded" content="false"/>. A lista de elementos do Visual Studio no arquivo de Branding.xml está listada abaixo.The Visual Studio list of elements in the Branding.xml file is listed below. Essa lista destina-se a ser usada como um modelo para os usuários do Shell ISO, onde eles modificam esses elementos (por exemplo, logotipo, comentários e direitos autorais) para atender às suas necessidades de identidade visual do produto.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 indicadas por "{n}" têm dependências de código-a remoção ou alteração desses valores causará erros e possivelmente falha do aplicativo.Note: variables noted by "{n}" have code dependencies - removing or changing these values will cause errors and possibly application crash. Os identificadores de localização (por exemplo _locID = "CodeSnippet. n") estão incluídos no pacote de identidade Visual Studio.Localization identifiers (example _locID="codesnippet.n") are included in the Visual Studio Branding Package.

Branding.xmlBranding.xml

ElementoElement DescriçãoDescription
Recurso:Feature: CollapsibleAreaCollapsibleArea
Use:Use: Expande recolhe o texto de controle de conteúdoExpand collapses content control text
ElementElement ValorValue
ExpandTextExpandText ExpandaExpand
CollapseTextCollapseText RecolherCollapse
Recurso:Feature: CodeSnippetCodeSnippet
Use:Use: Texto de controle de trecho de código.Code snippet control text. Observação: o conteúdo do trecho de código com espaço "não separável" será alterado para espaço.Note: Code snippet content with "Non-Breaking" space will be changed to space.
ElementElement ValorValue
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, rodapé e logotipoFeedback, Footer, and Logo
Use:Use: Forneça um controle de comentários para que o cliente forneça 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 do conteúdo.Copyright text for the content. Definição do logotipo.Logo definition.
ElementElement Valor (essas cadeias de caracteres podem ser modificadas para atender à necessidade de conteúdo.)Value (These strings can be modified to meet content adopter need.)
InternacionaisCopyRight © 2013 Microsoft Corporation.© 2013 Microsoft Corporation. Todos os direitos reservados.All rights reserved.
SendFeedbackSendFeedback <a href="{0}" {1}>Envie comentários </a> sobre este tópico para a 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: EnçãoDisclaimer
Use:Use: Um conjunto de isenções específicas do caso para conteúdo traduzido por computador.A set of case-specific disclaimers for machine translated content.
ElementElement ValorValue
MT_EditableMT_Editable Este artigo foi traduzido por máquina.This article was machine translated. Se você tiver uma conexão com a Internet, selecione "exibir este tópico online" para exibir essa página no modo editável 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 com a Internet, selecione "exibir este tópico online" para exibir essa página no modo editável 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 com a Internet, selecione "exibir este tópico online" para exibir essa página no modo editável 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 com a Internet, selecione "exibir este tópico online" para exibir essa página no modo editável 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 com a Internet, selecione "exibir este tópico online" para exibir essa página no modo editável 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 com a Internet, selecione "exibir este tópico online" para exibir essa página no modo editável 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
Use:Use: Suporte para links de tópico onlineSupport for online topic links
ElementElement ValorValue
LinkTableTitleLinkTableTitle Vincular tabelaLink Table
TopicEnuLinkTextTopicEnuLinkText Exiba 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 Exibir este tópico <a 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
Use:Use: Exibir elementos e texto para conteúdo de vídeoDisplay elements and text for video content
ElementElement ValorValue
MultiMediaNotSupportedMultiMediaNotSupported O Internet Explorer 9 ou superior deve estar instalado para dar suporte ao {0} conteúdo.Internet Explorer 9 or greater must be installed to support {0} content.
VideoTextVideoText exibindo vídeodisplaying video
AudioTextAudioText áudio de streamingstreaming audio
OnlineVideoLinkTextOnlineVideoLinkText <p>Para exibir o vídeo associado a este tópico, clique {0} <a 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 {0} <a 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
Use:Use: Elementos de texto (cadeias de caracteres) usados para o processamento de contentnotinstalled.htmText elements (strings) used for the rendering of contentnotinstalled.htm
ElementElement ValorValue
ContentNotInstalledTitleContentNotInstalledTitle Nenhum conteúdo foi encontrado no seu computador.No content was found on your computer.
ContentNotInstalledDownloadContentTextContentNotInstalledDownloadContentText <p>Para baixar o conteúdo para o seu computador, <a 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 está instalado em seu computador.<p>No content is installed on your computer. Consulte o administrador para a instalação do conteúdo da ajuda local.</p>See your Administrator for local Help content installation.</p>
Recurso:Feature: Controle de tópico não encontradoTopic Not Found control
Use:Use: Elementos de texto (cadeias de caracteres) usados para o processamento de topicnotfound.htmText elements (strings) used for the rendering of topicnotfound.htm
ElementElement ValorValue
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 <a 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 obter links para tópicos semelhantes ou <a href="{0}" {1}> clique na guia Gerenciar </a> para baixar conteúdo para o 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 controle corrompidoTopic Corrupted Control
Use:Use: Elementos de texto (cadeias de caracteres) usados para o processamento de topiccorrupted.htmText elements (strings) used for the rendering of topiccorrupted.htm
ElementElement ValorValue
TopicCorruptedTitleTopicCorruptedTitle Não é possível exibir o tópico solicitado.Unable to display the requested topic.
TopicCorruptedViewOnlineTextTopicCorruptedViewOnlineText <p>O Visualizador da ajuda não pode 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 em uma dependência de 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
Use:Use: Texto que dá suporte à exibição do conteúdo do nó de nível superior do Help Viewer.Text supporting the display of the Help Viewer top-level node content.
ElementElement ValorValue
HomePageTitleHomePageTitle Página inicial 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 Help Viewer fornece acesso a informações de instruções e 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 de que você precisa, procure o Sumário, use a pesquisa de texto completo ou navegue pelo conteúdo usando o índice de palavra-chave.</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 a <a href="{0}" {1}> guia gerenciar conteúdo </a> para fazer o seguinte: <ul> <li> adicionar conteúdo ao seu computador. </li> <li> Verifique se há atualizações para seu conteúdo local. </li> <li> Remova 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 da ajudaHelp Content Settings
HomePageHelpSettingsTextHomePageHelpSettingsText <p>Sua configuração atual é 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 origem do conteúdo da ajuda, na barra de menus do Visual Studio, escolha <span style="{0}"> ajuda, definir preferência de 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>
MBMegaByte MBMB

branding.jsbranding.js

O arquivo de branding.js contém o JavaScript usado pelos elementos de identidade Visual Studio Help Viewer.The branding.js file contains JavaScript used by the Visual Studio Help Viewer branding elements. Abaixo está uma lista dos elementos de identidade visual e a função JavaScript de suporte.Below is a list of the branding elements and the supporting JavaScript function. Todas as cadeias de caracteres a serem localizadas para esse arquivo são definidas na seção "cadeias de caracteres localizáveis" na parte superior deste arquivo.All strings to be localized for this file are defined in the "Localizable Strings" section at the top of this file. O arquivo ICL foi criado para as cadeias de caracteres Loc dentro do arquivo de branding.js.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 o idioma do código do usuárioGet the user code language setUserPreferenceLangsetUserPreferenceLang mapeia um índice # para 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 CarregamentoonLoad Leia 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 trechos para focalizar a guia preferencial do usuário. Se for uma solicitação de impressão, 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. Verifique o modo de alto contraste.Check for high contrast mode.
Snippet de códigoCode Snippet addSpecificTextLanguageTagSetaddSpecificTextLanguageTagSet
getIndexFromDevLanggetIndexFromDevLang
ChangeTabChangeTab
setCodesnippetLangsetCodesnippetLang
setCurrentLangsetCurrentLang
CopyToClipboardCopyToClipboard
CollapsibleAreaCollapsibleArea addToCollapsibleControlSetaddToCollapsibleControlSet Escreva todo o objeto de controle recolhível na lista.write all the collapsible control object into list.
CA_ClickCA_Click com base no estado da área recolhível, define a imagem e o texto a serem apresentadosbased on state of collapsible area, defines which image and text to present
Suporte de contraste para logotipoContrast support for Logo isBlackBackground()isBlackBackground() Chamado para determinar se o plano de fundo é preto.Called to determine if background is black. Somente preciso no modo de alto contraste.Only accurate when in high contrast mode.
isHighContrast()isHighContrast() usar um intervalo colorido para detectar o modo de alto contrasteuse a colored span to detect high contrast mode
onHighContrast (preto)onHighContrast(black) Chamado quando é detectado alto contrasteCalled 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 (início, fim, texto, estilo)caption(begin, end, text, style)
findAllMediaControls(normalizedId)findAllMediaControls(normalizedId)
getActivePlayer(normalizedId)getActivePlayer(normalizedId)
captionsOnOff (ID)captionsOnOff(id)
totais (t)toSeconds(t)
getAllComments (nó)getAllComments(node)
styleRectify (estilo, stylevalue)styleRectify(styleName, styleValue)
showCC (ID)showCC(id)
subtítulo (ID)subtitle(id)

ARQUIVOS HTMHTM FILES

O pacote de identidade visual contém um conjunto de arquivos HTM que dão suporte a cenários para a comunicação de informações de chave para ajudar os usuários de conteúdo, 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 que dizem ao usuário quando os tópicos não podem ser encontrados no conjunto de tópicos local.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. Esses arquivos HTM podem ser modificados por produto.These HTM files can be modified per product. Os fornecedores de shell ISO são capazes de usar o pacote de identidade visual padrão e alterar o comportamento e o conteúdo dessas páginas para atender às suas necessidades.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 fazem referência ao respectivo pacote de identidade visual para que as marcas de identidade visual obtenham o conteúdo correspondente do arquivo de 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 UsoUse Fonte de conteúdo exibidaDisplayed Content Source
homepage.htmhomepage.htm Esta é uma página que exibe o 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. Esse arquivo tem o atributo de metadados adicional "Microsoft.Help.Id" content = "-1", que coloca esse conteúdo na parte superior do Sumário de 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 /> A seção de título Branding.xml marca <HomePageInstalledBooks> , os dados gerados do aplicativo, <HomePageNoBooksInstalled> quando nenhum livro é instalado.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 /> Seção de título Branding.xml marca <HomePageHelpSettings> , texto da seção <HomePageHelpSettingsText> .Heading section Branding.xml tag <HomePageHelpSettings>, section text <HomePageHelpSettingsText>.
topiccorrupted.htmtopiccorrupted.htm Quando um tópico existe no conjunto local, mas por algum motivo não pode ser exibido (conteúdo corrompido).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 conjunto de conteúdo local, 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 de identidade visual do Visualizador da ajuda do Visual Studio contém dois arquivos CSS para dar suporte à apresentação de conteúdo da 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 elementos CSS para renderização em que SelfBranded = falseBranding.css - contains css elements for rendering where SelfBranded=false

  • Printer. css-contém elementos CSS para renderização em que SelfBranded = falsePrinter.css - contains css elements for rendering where SelfBranded=false

Os arquivos. CSS de identidade visual incluem definições para a apresentação de tópico (a limitação é que a identidade visual. css contida no Branding_ <locale> . mshc do serviço de pacote pode ser alterada).Branding.css files include 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

O conteúdo do Visual Studio exibe um logotipo do Visual Studio, bem como outros 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 Visualizador da ajuda é mostrada abaixo.The complete list of graphic files in the Visual Studio Help Viewer branding package is shown below.

ArquivoFile UsoUse ExemplosExamples
clear.gifclear.gif Usado para renderizar a área recolhívelUsed to render Collapsible Area
footer_slice.giffooter_slice.gif Apresentação de rodapéFooter presentation
info_icon.gifinfo_icon.gif Usado ao exibir informaçõesUsed when displaying information Isenção de responsabilidadeDisclaimer
online_icon.gifonline_icon.gif Este ícone deve ser associado a 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 Usado para referências de logotipo de contraste normal, conforme definido na marca 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 Usado para referências de logotipo alto normal, conforme definido na marca 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 Gráfico de legendasCaptioning graphic
ccOn.pngccOn.png Gráfico de legendasCaptioning graphic
ImageSprite.pngImageSprite.png Usado para renderizar a área recolhívelUsed to render Collapsible Area gráfico expandido ou recolherexpanded or collapse graphic

Implantar um conjunto de tópicosDeploy a set of topics

Este é um tutorial simples e rápido para a criação de um conjunto de implantação de conteúdo do Help Viewer composto por um arquivo MSHA e o conjunto de cabs ou MSHCs que contém os tópicos.This is a simple and quick tutorial for creating a Help Viewer content deployment set comprised of an MSHA file and the set of cabs or MSHCs containing the topics. O MSHA é um arquivo XML que descreve um conjunto de arquivos cabs ou MSHC.The MSHA is an XML file that describes a set of cabs or MSHC files. O Help Viewer pode 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 primo que descreve o esquema XML muito básico para o Help Viewer MSHA.This is only a primer describing the very basic XML schema for the Help Viewer MSHA. Há um exemplo de implementação abaixo desta breve visão geral e exemplo de arquivo HelpContentSetup. msha.There is an example implementation below this brief overview and sample HelpContentSetup.msha.

O nome do MSHA, para os fins deste primor, é arquivo 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). Arquivo 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. O tipo de arquivo deve ser consistente dentro do MSHA (não dá suporte a uma combinação de tipos de arquivo MSHA e CAB).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 class="package"> ... </div> (Veja o exemplo abaixo).For each CAB or MSHC, there should be a <div class="package">...</div> (see example below).

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

Arquivo arquivo HelpContentSetup. msha de exemplo: (substitua "nome do conjunto de conteúdo 1" e "nome do conjunto de conteúdo 2", etc. com os nomes de arquivo.)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. Criar pasta local, algo como "C:\SampleContent"Create local folder, something like "C:\SampleContent"

  2. Para este exemplo, usaremos os 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 alterada de. zip para. MSHC.An MSHC is a zip with the file extension changed from .zip to .MSHC.

  3. Crie o arquivo HelpContentSetup. msha abaixo como um arquivo de texto (o bloco de notas foi usado para criar o arquivo) e salve-o na pasta indicada 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).

A classe "branding" existe e é exclusiva.The class "Branding" exists and is unique. A mshc de identidade visual está incluída neste primor para que o conteúdo instalado tenha identidade visual, e os comportamentos de conteúdo contidos no MSHCs terão os elementos de suporte apropriados 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, os erros ocorrerão quando o sistema procurar por itens de suporte que não fazem parte do conteúdo copiado (instalado).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 marcas do Visual Studio, copie o arquivo Branding_en-US. mshc em C:\Arquivos de programas (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

Usar e estender as etapas acima permitirá que o VSPs implante seus conjuntos de conteúdo para o Visualizador da ajuda do Visual Studio.Using and extending the above steps will enable VSPs to deploy their content sets for the Visual Studio Help Viewer.

Adicionar ajuda ao shell do Visual Studio (integrado e isolado)Add help to the Visual Studio Shell (Integrated and Isolated)

IntroduçãoIntroduction

Este tutorial 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.

RequirementsRequirements

  1. Visual Studio 2013Visual Studio 2013

  2. Redistribuição de shell isolado Visual Studio 2013Visual Studio 2013 Isolated Shell Redist

Visão geralOverview

O Visual Studio 2013Visual Studio 2013 shell é uma versão do Visual Studio 2013Visual Studio 2013 IDE na 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. Use modelos de projeto de shell isolados, que são incluídos no Visual Studio 2013Visual Studio 2013 SDK, para criar 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 em shell isolado e sua ajuda:The basic steps for creating an Isolated Shell-based application and its Help:

  1. Obtenha os pacotes Visual Studio 2013Visual Studio 2013 redistribuíveis do Shell ISO (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 com base no Shell isolado, por exemplo, a extensão de ajuda da Contoso que é descrita mais adiante neste guia.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. Empacote a extensão e o Shell ISO redistribuível em um MSI de implantação (uma instalação de aplicativo).Wrap the extension and the ISO Shell redistributable into a deployment MSI (an application setup). Este passo a passos não inclui uma etapa de configuraçã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 o Visual Studio12 para o nome do catálogo de produtos da seguinte maneira:For the Integrated Shell scenario, change Visual Studio12 to the product catalog name as follows:

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

  • Crie um arquivo chamado CatalogType.xml e adicione-o à 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 produtos: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: LocationPath valor da cadeia de caracteres: C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15Key: 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: CatalogName valor da cadeia de caracteres: 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 isolada:To create an Isolated Shell extension:

  1. No Visual Studio, em arquivo, escolha novo projeto, em outros tipos de projeto , escolha extensibilidade e, 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 recursos, abra ApplicationCommands. vsct.In Solution Explorer, in the ContosoHelpShellUI project, in the Resource Files folder, open ApplicationCommands.vsct. Verifique se essa linha foi comentada (pesquise 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 a depuração.Choose the F5 key to compile and run Debug. Na instância experimental do IDE do Shell isolado, escolha o menu ajuda .In the experimental instance of the Isolated Shell IDE, choose the Help menu. Verifique se a exibição ajuda, adicione e remova o conteúdo da ajuda e defina os comandos de preferência da ajuda.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 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 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 Gerenciador de Soluções, no menu de contexto da solução ContosoHelpShell, escolha o item de menu Propriedades .In Solution Explorer, on the context menu of the ContosoHelpShell solution, choose the Properties menu item. Em Propriedades de configuração, selecione Configuration Manager.Under Configuration Properties, select Configuration Manager. Na coluna configuração , altere cada valor de "debug" para "Release".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 liberaçã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 fosse implantado:To test this as if deployed:

  1. No computador em que você está implantando o contoso, instale o Shell ISO baixado (do acima).On the machine you are deploying Contoso to, install the downloaded (from above) ISO Shell.

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

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

  4. Inicie o editor do registro escolhendo executar no menu Iniciar e inserindo Regedit .Start Registry Editor by choosing Run in the Start menu and entering Regedit. No editor do registro, escolha arquivo e importar.In the registry editor, choose File, and then Import. Navegue até a pasta do projeto ContosoHelpShell.Browse to the ContosoHelpShell project folder. Na subpasta ContosoHelpShell, escolha ContosoHelpShell. reg.In the ContosoHelpShell subfolder, choose ContosoHelpShell.reg.

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

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

    Para o Visual Studio 2013Visual Studio 2013 shell integrado, 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. Crie CatalogType.xml e adicione 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 da cadeia de LocationPath:HKLM\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15Key: LocationPath String value:

    Para o Shell ISO:For ISO Shell:

    C:ProgramDataMicrosoftHelpLibrary2CatalogsVisualStudio15C:ProgramDataMicrosoftHelpLibrary2CatalogsVisualStudio15

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

    C:ProgramDataMicrosoftHelpLibrary2CatalogsVisualStudio15en-USC:ProgramDataMicrosoftHelpLibrary2CatalogsVisualStudio15en-US

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

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

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

    "C:\Arquivos de programas (x86) \Microsoft Help Viewer\v2.3\HlpViewer.exe"/catalogName VisualStudio15/helpQuery Method = "Page&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 contoso (da raiz do aplicativo contoso).Launch the Contoso application (from the Contoso app root). No Shell ISO, escolha o item de menu ajuda e altere a preferência de ajuda definir para usar a ajuda local.Within ISO Shell, choose the Help menu item, and change the Set Help Preference to Use Local Help.

  11. No Shell, escolha o item de menu ajuda e, em seguida, exiba a ajuda.Within the shell, choose the Help menu item, then View Help. O Visualizador da ajuda local deve ser iniciado.The local Help viewer should launch. Escolha a guia gerenciar conteúdo . Em origem da instalação, escolha o botão de opção disco .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 da Contoso (copiado para a pasta local na etapa acima).Choose the ... button and browse to the local folder containing Contoso content (copied to the local folder in the above step). Escolha o arquivo HelpContentSetup. msha.Choose the HelpContentSetup.msha. Agora, a Contoso deve aparecer como um livro nas seleções do livro.Contoso should now show up as a book in the book selections. Escolha Adicionar e, em seguida, escolha o botão Atualizar (canto inferior direito).Choose Add, and then choose the Update button (bottom right corner).

  12. No IDE contoso, escolha a tecla F1 para testar a funcionalidade 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 mais informações sobre como aproveitar a API de ajuda, consulte exemplos de código do Help Viewer.For more information on how to leverage the Help API, see Help Viewer code examples.

Você pode enviar sugestões de recursos na comunidade de desenvolvedores.You can submit feature suggestions on Developer Community.