SDK do Microsoft Help Viewer

Este artigo contém as seguintes tarefas para integradores Visual Studio Help Viewer:

  • Criando um tópico (suporte a F1)

  • Criando um pacote de identidade visual do Help Viewer

  • Implantando um conjunto de artigos

  • Adicionando ajuda ao shell Visual Studio (integrado ou isolado)

  • Recursos adicionais

Criar um tópico (suporte a F1)

Esta seção fornece uma visão geral dos componentes de um tópico apresentado, requisitos de tópico, uma breve descrição sobre como criar um tópico (incluindo requisitos de suporte F1) e, por fim, um tópico de exemplo com seu resultado renderizado.

Visão geral do tópico do Help Viewer

Quando um tópico é chamado para renderização, o Help Viewer 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 na exibição de conteúdo apresentada (dados de identidade visual + dados de tópico). O pacote de identidade visual contém logotipos, suporte para comportamentos de conteúdo e texto de identidade visual (direitos autorais, etc.). Consulte "Criando pacote de identidade visual" abaixo para obter mais informações sobre os elementos do pacote de identidade visual. Caso não haja nenhum pacote de identidade visual associado ao tópico, o Help Viewer usará o pacote de identidade visual de fallback localizado na raiz do aplicativo Help Viewer (Branding_en-US.mshc).

Requisitos do tópico do Help Viewer

Para ser renderizado corretamente no Help Viewer, o conteúdo bruto do tópico deve ser W3C Basic 1.1 XHTML.

Um tópico normalmente contém duas seções:

  • 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 do toc do tópico, a ID do nó pai etc.

  • Conteúdo do corpo: compatível com o W3C Basic 1.1 XHTML, que inclui comportamentos de conteúdo com suporte (área reututível, snippet de código etc. Uma lista completa é mostrada abaixo).

Visual Studio Controles com suporte do Pacote de Identidade Visual:

  • Links

  • Codesnippet

  • CollapsibleArea

  • Membro herdado

  • LanguageSpecificText

Cadeias de caracteres de idioma com suporte (não que não são sensíveis a minúsculas):

  • javascript

  • csharp ou c #

  • cplusplus ou visualc++ ou c++

  • jscript

  • visualbasic ou vb

  • f# ou fsharp ou fs

  • outros - uma cadeia de caracteres que representa um nome de idioma

Criando um tópico do Help Viewer

Crie um novo documento XHTML chamado ContosoTopic4.htm e inclua a marca de título (abaixo).

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

<body>

</body>
</html>

Em seguida, adicione dados para definir como o tópico deve ser apresentado (com identidade visual própria ou não), como referenciar este tópico para F1, em que esse tópico existe no TOC, sua ID (para referência de link por outros tópicos), etc. Consulte a tabela "Metadados de Conteúdo" abaixo para ver uma lista completa dos metadados com suporte.

  • Nesse caso, vamos usar nosso próprio pacote de identidade visual, uma variante do pacote de identidade visual Visual Studio Help Viewer.

  • Adicione o metadado F1 e o valor ("Microsoft.Help.F1" content=" ContosoTopic4") que corresponderão ao valor F1 fornecido no pacote de propriedades do IDE. (Consulte a seção Suporte A F1 para obter mais informações.) Esse é o valor que é corresponder à chamada F1 de dentro do IDE para exibir este tópico quando F1 é escolhido no IDE.

  • Adicione a ID do tópico. Essa é a cadeia de caracteres usada por outros tópicos para vincular a este tópico. É a ID do Help Viewer para este tópico.

  • Para o TOC, adicione o nó pai deste tópico para definir onde esse nó TOC do tópico será exibido.

  • Para o TOC, adicione a ordem de nó deste tópico. Quando o nó pai tiver n o número de nós filhos, defina na ordem dos nós filho o local deste tópico. Por exemplo, este tópico é o número 4 de quatro tópicos filho.

Seção de metadados de exemplo:

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

O corpo (não incluindo o header e o rodapé) do tópico conterá links de página, uma seção de observação, uma área reututível, um snippet de código e uma seção de texto específico do idioma. Consulte a seção de identidade visual para obter informações sobre essas áreas do tópico apresentado.

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

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

  3. Adicione uma área reutável: <CollapsibleArea Expanded="1" Title="Collapsible Area Test Heading"> add text </CollapsibleArea>

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

  5. Adicionar texto específico do idioma do código: <LanguageSpecificText devLangcs="CS" devLangvb="VB" devLangcpp="C++" devLangnu="F#" /> observe que permite que você insira outros devLangnu= idiomas. Por exemplo, devLangnu="Fortran" exibe Fortran quando o snippet de código DisplayLanguage = Fortran

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

Observação

Observação: para a nova "Linguagem de Exibição" sem suporte (por exemplo, F#, Cobol, Fortran) a colorização de código no snippet de código será monocromática.

Tópico do Visualizador da Ajuda de Exemplo O código ilustra como definir metadados, um snippet de código, uma área reututível e um texto específico do idioma.

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

No Visual Studio, selecionar F1 gera valores fornecidos do posicionamento do cursor no IDE e preenche um "pacote de propriedades" com os valores fornecidos (com base no local do cursor. Quando o cursor está sobre o recurso x, o recurso x está ativo/em foco e popula o pacote de propriedades com valores. Quando F1 é selecionado, o pacote de propriedades é populado 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), então 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 lançamento exe) com parâmetros para o visualizador de ajuda local + palavras-chave do pacote de propriedades se a ajuda local for o padrão, ou a URL do MSDN com a palavra-chave na lista de parâmetros.

Se três cadeias de caracteres são retornadas para F1, conhecidas como uma cadeia de caracteres de vários valores, pegue o primeiro termo, procure um hit e, se for encontrado, terminaremos; caso não, vá para a próxima cadeia de caracteres. A ordem é importante. 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. Para verificar isso no caso de palavras-chave de vários valores, veja a cadeia de caracteres de URL F1 online, que incluirá a palavra-chave escolhida.

No Visual Studio 2012, intencionalmente fizemos uma divisão mais forte entre online e offline, de modo que, se a configuração do usuário fosse 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 de Biblioteca de Ajuda que tínhamos no Visual Studio 2010. Em seguida, dependemos de um estado de "conteúdo do fornecedor instalado = true" para determinar se é preciso fazer algo diferente nesse contexto. Se for true, executaremos essa lógica de análise e roteamento, dependendo do que você deseja dar suporte para seus clientes. Se for false, basta ir para MSDN. Se a configuração do usuário for Local, todas as chamadas vão para o mecanismo de ajuda local.

Diagrama de Flow F1:

Fluxo F1

Quando a fonte de conteúdo de ajuda padrão do Help Viewer é definida como online (Iniciar no navegador):

  • Visual Studio Os recursos do parceiro (VSP) emitem um valor para o pacote de propriedades F1 (prefixo do pacote de propriedades.palavra-chave e URL online para o prefixo encontrado no Registro): F1 envia uma URL do VSP+ parâmetros para o navegador.

  • Visual Studio recursos (editor de idiomas, Visual Studio itens de menu específicos etc.): F1 envia uma URL Visual Studio para o navegador.

Quando a fonte de conteúdo de ajuda padrão do Help Viewer é definida como Ajuda local (Iniciar no Help Viewer):

  • Recursos do VSP em que a palavra-chave faz a combinação entre o pacote de propriedades F1 e o índice do armazenamento local (ou seja, o prefix.keyword do pacote de propriedades = o valor encontrado no índice do armazenamento local): F1 renderiza o tópico no Help Viewer.

  • Visual Studio recursos (nenhuma opção para o VSP substituir o pacote de propriedades emitido de Visual Studio recursos): F1 renderiza um tópico Visual Studio no Help Viewer.

De definir os seguintes valores do Registro para habilitar o Fallback F1 para o conteúdo da Ajuda do fornecedor. Fallback F1 significa que o Help Viewer está definido para procurar conteúdo da Ajuda F1 online e o conteúdo do fornecedor é instalado localmente no disco rígido dos usuários. O Help Viewer deve procurar ajuda local para o conteúdo, embora a configuração padrão seja para ajuda online.

  1. De definir o valor VendorContent na chave do Registro da Ajuda 2.3:

    • Para sistemas operacionais de 32 bits:

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

      "VendorContent"=dword:00000001

    • Para sistemas operacionais de 64 bits:

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

      "VendorContent"=dword:00000001

  2. Registre o namespace do parceiro na chave do Registro da Ajuda 2.3:

    • Para sistemas operacionais de 32 bits:

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

      "location"="offline"

    • Para sistemas operacionais de 64 bits:

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

      "location"="offline"

Análise de namespace nativo base

Para ativar a análise de namespace nativo de base, no Registro, adicione um novo DWORD pelo nome de: BaseNativeNamespaces e de definido seu valor como 1 (na chave do catálogo que deseja dar suporte). Por exemplo, se você quiser usar o catálogo Visual Studio, poderá adicionar a chave ao caminho:

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

Quando uma palavra-chave F1 no formato HEADER/METHOD for encontrada, o caractere '/' será analisado, resultando na seguinte construção:

  • HEADER: será o namespace que pode ser usado para se registrar no Registro

  • METHOD: isso se tornará a palavra-chave que é passada.

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 .

Em seguida, um usuário pode registrar CustomLibrary como o namespace no hive Parceiros e fornecer qualquer chave de local desejada, e a palavra-chave passada para a consulta será MyTestMethod.

Habilitar a ferramenta de depuração de Ajuda no IDE

Adicione a seguinte chave e valor do Registro:

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

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

Valor: Exibir saída de depuração em dados de varejo: SIM

No IDE, no item de menu Ajuda, selecione Depurar Contexto da Ajuda.

Metadados de conteúdo

Na tabela a seguir, qualquer cadeia de caracteres que aparece entre colchetes é um espaço reservado que deve ser substituído por um valor reconhecido. Por exemplo, em <meta name="Microsoft.Help.Locale" content="[language code]" /> , "[código de linguagem]" deve ser substituído por um valor como "en-us".

Propriedade (Representação HTML) Descrição
< meta name="Microsoft.Help.Locale" content="[language-code]" /> Define uma localidade para este tópico. Se essa marca for usada em um tópico, ela deverá ser usada apenas uma vez e deve ser inserida acima de qualquer outra marca de Ajuda da Microsoft. Se essa marca não for usada, o texto do corpo do tópico será indexado usando o disjuntor de palavras associado à localidade do produto, se for especificado; caso contrário, o disjuntor de palavras en-us será usado. Essa marca está em conformidade com o ISOC RFC 4646. Para garantir que a Ajuda da Microsoft funcione corretamente, use essa propriedade em vez do atributo language geral.
< meta name="Microsoft.Help.TopicLocale" content="[language-code]" /> Define uma localidade para este tópico quando outras localidades também são usadas. Se essa marca for usada em um tópico, ela deverá ser usada apenas uma vez. Use essa marca quando o catálogo contiver conteúdo em mais de um idioma. Vários tópicos em um catálogo podem ter a mesma ID, mas cada um deve especificar um TopicLocale exclusivo. O tópico que especifica um TopicLocale que corresponde à localidade do catálogo é o tópico exibido no índice. No entanto, todas as versões de idioma do tópico são exibidas nos resultados da pesquisa.
< title>[Título]</title> Especifica o título deste tópico. Essa marca é necessária e deve ser usada apenas uma vez em um tópico. Se o corpo do tópico não contém uma seção de título, este Título é exibido no tópico e no <div> tabela de conteúdo.
< meta name=" Microsoft.Help.Keywords" content="[aKeywordPhrase]"/> Especifica o texto de um link exibido no painel de índice do Help Viewer. Quando o link é clicado, o tópico é exibido. Você pode especificar várias palavras-chave de índice para um tópico ou omitir essa marca se não quiser que os links para este tópico apareçam no índice. Palavras-chave "K" de versões anteriores da Ajuda podem ser convertidas nessa propriedade.
< meta name="Microsoft.Help.Id" content="[TopicID]"/> Define o identificador deste tópico. Essa marca é necessária e deve ser usada apenas uma vez em um tópico. A ID deve ser exclusiva entre os tópicos no catálogo que têm a mesma configuração de localidade. Em outro tópico, você pode criar um link para este tópico usando essa ID.
< meta name="Microsoft.Help.F1" content="[System.Windows.Controls.Primitives.IRecyclingItemContainerGenerator]"/> Especifica a palavra-chave F1 para este tópico. 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. Normalmente, apenas uma palavra-chave F1 é especificada para um tópico. Palavras-chave "F" de versões anteriores da Ajuda podem ser convertidas nessa propriedade.
< meta name="Description" content="[topic description]" /> Fornece um breve resumo do conteúdo neste tópico. Se essa marca for usada em um tópico, ela deverá ser usada apenas uma vez. Essa propriedade é acessada diretamente pela biblioteca de consultas; ele não é armazenado no arquivo de índice.
meta name="Microsoft.Help.TocParent" content="[parent_Id]"/> Especifica o tópico pai deste tópico no tabela de conteúdo. Essa marca é necessária e deve ser usada apenas uma vez em um tópico. O valor é o Microsoft.Help.Id do pai. Um tópico pode ter apenas um local no tabela de conteúdo. "-1" é considerado a ID do tópico para a raiz do TOC. No Visual Studio 2013 , essa página é Help Viewer home page. Esse é o mesmo motivo pelo qual adicionamos especificamente TocParent=-1 a alguns tópicos para garantir que eles aparecem no nível superior. O Help Viewer home page é uma página do sistema e, portanto, não substituível. 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 – Página Inicial do Help Viewer
< meta name="Microsoft.Help.TocOrder" content="[positive integer]"/> Especifica onde no tabela de conteúdo este tópico aparece em relação a seus tópicos pares. Essa marca é necessária e deve ser usada apenas uma vez em um tópico. O valor é um inteiro. Um tópico que especifica um inteiro de valor inferior é exibido acima de um tópico que especifica um inteiro de valor mais alto.
< meta name="Microsoft.Help.Product" content="[product code]"/> Especifica o produto que este tópico descreve. Se essa marca for usada em um tópico, ela deverá ser usada apenas uma vez. Essas informações também podem ser fornecidas como um parâmetro que é passado para o Help Indexer.
< meta name="Microsoft.Help.ProductVersion" content="[version number]"/> Especifica a versão do produto que este tópico descreve. Se essa marca for usada em um tópico, ela deverá ser usada apenas uma vez. Essas informações também podem ser fornecidas como um parâmetro que é passado para o Help Indexer.
< meta name="Microsoft.Help.Category" content="[string]"/> Usado por produtos para identificar subseções de conteúdo. Você pode identificar várias subseções para um tópico ou omitir essa marca se não quiser links para identificar subseções. Essa marca é usada para armazenar os atributos para TargetOS e TargetFrameworkMoniker quando um tópico é convertido de uma versão anterior da Ajuda. O formato do conteúdo é AttributeName:AttributeValue.
< meta name="Microsoft.Help.TopicVersion content="[topic version number]"/> Especifica essa versão do tópico quando existem várias versões em um catálogo. Como Microsoft.Help.Id não é garantido que seja exclusivo, essa marca é necessária quando mais de uma versão de um tópico existe em um catálogo, por exemplo, quando um catálogo contém um tópico para o .NET Framework 3.5 e um tópico para o .NET Framework 4 e ambos têm o mesmo Microsoft.Help.Id.
< meta name="SelfBranded" content="[TRUE or FALSE]"/> Especifica se este tópico usa o pacote de identidade visual de start-up do Gerenciador de Biblioteca de Ajuda ou um pacote de identidade visual específico para o tópico. Essa marca deve ser TRUE ou FALSE. Se for TRUE, o pacote de identidade visual do tópico associado substituirá o pacote de identidade visual que é definido quando o Gerenciador de Biblioteca de Ajuda é iniciado para que o tópico seja renderizado conforme o esperado, mesmo que ele seja diferente da renderização de outro conteúdo. Se for FALSE, o tópico atual será renderizado de acordo com o pacote de identidade visual definido quando o Gerenciador de Biblioteca de Ajuda for iniciado. Por padrão, o Gerenciador de Biblioteca de Ajuda assume que a identidade visual é falsa, a menos que a variável SelfBranded seja declarada como TRUE; portanto, você não precisa declarar <meta name="SelfBranded" content="FALSE"/> .

Criar um pacote de identidade visual

A Visual Studio versão abrange vários produtos Visual Studio, incluindo os shells isolados e integrados para Visual Studio Parceiros. Cada um desses produtos requer algum grau de suporte de identidade visual de conteúdo da Ajuda baseado em tópico, exclusivo para o produto. Por exemplo, Visual Studio tópicos precisam ter uma apresentação de marca consistente, enquanto o SQL Studio, que envolve o SHELL ISO, requer sua própria identidade visual de conteúdo da Ajuda exclusiva para cada tópico. Um Parceiro do Shell Integrado pode querer que seus tópicos de Ajuda sejam dentro do conteúdo da Ajuda do Visual Studio do produto pai, mantendo sua própria identidade visual do tópico.

Os pacotes de identidade visual são instalados pelo produto que contém o Help Viewer. Para Visual Studio produtos:

  • Um pacote de identidade visual de fallback (Branding_ .mshc) é instalado na raiz do aplicativo <locale> Help Viewer 2.3 (exemplo: C:\Program Files (x86)\Microsoft Help Viewer\v2.3) pelo pacote de idiomas do Help Viewer. Isso é usado para casos em que o pacote de identidade visual do produto não está instalado (nenhum conteúdo foi instalado) ou em que o pacote de identidade visual instalado está corrompido. Os Visual Studio (logotipo e Comentários) são ignorados quando o pacote de identidade visual de fallback raiz do aplicativo é usado.

  • Quando Visual Studio conteúdo é instalado do serviço de pacote de conteúdo, um pacote de identidade visual também é instalado (pela primeira vez no cenário de instalação de conteúdo). Se houver uma atualização para o pacote de identidade visual, a atualização será instalada quando ocorrer a próxima atualização de conteúdo ou ação adicional de instalação do pacote.

O Microsoft Help Viewer dá suporte à identidade visual de tópicos com base nos metadados do tópico.

  • Em que os metadados do tópico definem a identidade visual = true, renderizar o tópico como está, não faça nada (tanto quanto a identidade visual).

  • Em que os metadados do tópico definem a identidade visual = false, use o pacote de identidade visual associado ao valor de metadados TopicVendor.

  • Em que os metadados do tópico definem name="Microsoft.Help.TopicVendor" content= , use o pacote de identidade visual < branding package name in vendor MSHA> definido no valor do conteúdo.

  • No catálogo Visual Studio, há um aplicativo de prioridade de Pacotes de Identidade Visual. Primeiro Visual Studio a identidade visual padrão é aplicada e, se definida nos metadados do tópico e tem suporte com o pacote de identidade visual associado (conforme definido no msha de instalação), a identidade visual definida pelo fornecedor é aplicada como uma substituição.

Elementos de identidade visual normalmente se enquadram em três categorias principais:

  • Elementos de título (exemplos incluem link de comentários, texto de isenção de responsabilidade condicional, logotipo)

  • Comportamentos de conteúdo (exemplos incluem elementos de texto de controle de expansão/repsução e elementos de snippet de código)

  • Elementos de rodapé (exemplo de Direitos Autorais)

Os itens considerados como elementos de marca incluem (detalhados nesta especificação):

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

  • Link de comentários e elementos de email

  • Texto de aviso de isenção de responsabilidade

  • Texto de direitos autorais

Os arquivos de suporte no Visual Studio de identidade visual do Help Viewer incluem:

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

  • Branding.js - arquivos de script que suportam comportamentos de conteúdo

  • Branding.xml - cadeias de caracteres que são usadas consistentemente no conteúdo do catálogo. Observação: para Visual Studio de texto de localização no branding.xml, inclua _locID=" <unique value> "

  • Branding.css – definições de estilo para consistência de apresentação

  • Printing.css – definições de estilo para apresentação impressa consistente

Conforme mencionado acima, pacotes de identidade visual estão associados ao tópico:

  • Quando SelfBranded = false é definido nos metadados, o tópico herda o pacote de identidade visual do catálogo

  • Ou quando SelfBranded = false e há um pacote de identidade visual exclusivo definido no MSHA e disponível quando o conteúdo é instalado

Para VSPs que implementam pacotes de identidade visual personalizados (conteúdo do VSP, SelfBranded=True), uma maneira de continuar é começar com o pacote de identidade visual de fallback (instalado com o Help Viewer) e alterar o nome do arquivo conforme apropriado. O Branding_ arquivo .mshc é um arquivo zip com a extensão de arquivo alterada para .mshc, portanto, basta alterar a extensão de .mshc para .zip extrair o <locale> conteúdo. Veja abaixo os elementos do pacote de identidade visual e modifique conforme apropriado (por exemplo, altere o logotipo para o logotipo do VSP e a referência ao logotipo no arquivo Branding.xml, atualize Branding.xml por especificações do VSP etc.).

Quando todas as modificações são feitas, crie um arquivo zip contendo os elementos de identidade visual desejados e altere a extensão para .mshc.

Para associar o pacote de identidade visual personalizado, crie o MSHA, que contém a referência ao arquivo mshc de identidade visual junto com o conteúdo mshc (que contém os tópicos). Veja abaixo "MSHA" para saber como criar um MSHA básico.

O Branding.xml arquivo contém uma lista de elementos usados para renderizar consistentemente itens específicos em um tópico quando o tópico contém <meta name="Microsoft.Help.SelfBranded" content="false"/> . A Visual Studio lista de elementos no arquivo Branding.xml está listada abaixo. Essa lista destina-se a ser usada como um modelo para os usuários do SHELL ISO, em que eles modificam esses elementos (por exemplo, logotipo, comentários e Direitos Autorais) para atender às suas próprias necessidades de identidade visual do produto.

Observação: as variáveis anotadas por "{n}" têm dependências de código – remover ou alterar esses valores causará erros e, possivelmente, falha do aplicativo. Identificadores de localização (exemplo _locID="codesnippet.n") estão incluídos no pacote Visual Studio identidade visual.

Branding.xml

Elemento Descrição
Recurso: CollapsibleArea
Use: Expandir resimos o texto do controle de conteúdo
Element Valor
ExpandText Expanda
CollapseText Recolher
Recurso: Codesnippet
Use: Texto de controle de snippet de código. Observação: o conteúdo do snippet de código com espaço "sem quebra" será alterado para espaço.
Element Valor
Copytoclipboard Copiar para a Área de Transferência
ViewColorizedText Exibir colorizado
CombinedVBTabDisplayLanguage Visual Basic (exemplo)
VBDeclaration Declaração
VBUsage Uso
Recurso: Comentários, rodapé e logotipo
Use: Forneça um controle comentários para que o cliente forneça comentários sobre o tópico atual por email. Texto de direitos autorais para o conteúdo. Definição de logotipo.
Element Valor (Essas cadeias de caracteres podem ser modificadas para atender à necessidade do adotador de conteúdo.)
Copyright © 2013 Microsoft Corporation. All rights reserved.
SendFeedback <a href="{0}" {1}>Envie comentários </a> sobre este tópico para a Microsoft.
FeedbackLink
LogoTitle Visual Studio 2013
LogotipoFileName vs_logo_bk.gif
LogotipoFileNameHC vs_logo_wh.gif
Recurso: Aviso de isenção de responsabilidade
Use: Um conjunto de isenções de responsabilidade específicas de caso para conteúdo traduzido por computador.
Element Valor
MT_Editable Este artigo foi traduzido por computador. 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.
MT_NonEditable Este artigo foi traduzido por computador. 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.
MT_QualityEditable Este artigo foi traduzido manualmente. 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.
MT_QualityNonEditable Este artigo foi traduzido manualmente. 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.
MT_BetaContents Este artigo foi traduzido por computador para uma versão preliminar. 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.
MT_BetaRecycledContents Este artigo foi traduzido manualmente para uma versão preliminar. 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.
Recurso: LinkTable
Use: Suporte para links de tópico online
Element Valor
LinkTableTitle Tabela de link
TopicEnuLinkText Veja a versão </a> em inglês deste tópico que está disponível em seu computador.
TopicOnlineLinkText Exibir este tópico <a href="{0}" {1}> online</a>
OnlineText Online
Recurso: Controle de áudio de vídeo
Use: Exibir elementos e texto para conteúdo de vídeo
Element Valor
MultiMediaNotSupported Internet Explorer 9 ou superior deve ser instalado para dar suporte ao {0} conteúdo.
Videotext exibindo vídeo
AudioText streaming de áudio
OnlineVideoLinkText <p>Para exibir o vídeo associado a este tópico, clique {0} <a href="{1}"> {2} aqui </a> .</p>
OnlineAudioLinkText <p>Para escutar o áudio associado a este tópico, clique {0} <a href="{1}"> {2} aqui </a> .</p>
Recurso: Controle Conteúdo Não Instalado
Use: Elementos de texto (cadeias de caracteres) usados para a renderização de contentnotinstalled.htm
Element Valor
ContentNotInstalledTitle Nenhum conteúdo foi encontrado em seu computador.
ContentNotInstalledDownloadContentText <p>Para baixar o conteúdo no computador, <a href="{0}" {1}> clique na guia Gerenciar </a> .</p>
ContentNotInstalledText <p>Nenhum conteúdo está instalado em seu computador. Consulte seu Administrador para instalação de conteúdo da Ajuda local.</p>
Recurso: Controle Tópico Não Encontrado
Use: Elementos de texto (cadeias de caracteres) usados para a renderização de topicnotfound.htm
Element Valor
TopicNotFoundTitle Não é possível encontrar o tópico solicitado em seu computador.
TopicNotFoundViewOnlineText <p>O tópico solicitado não foi encontrado no computador, mas você pode <a href="{0}" {1}> exibir o tópico online </a> .</p>
TopicNotFoundDownloadContentText <p>Consulte o painel de navegação para ver links para tópicos semelhantes ou clique na <a href="{0}" {1}> guia Gerenciar para baixar o conteúdo no </a> computador.</p>
TopicNotFoundText <p>O tópico solicitado não foi encontrado em seu computador.</p>
Recurso: Controle corrompido do tópico
Use: Elementos de texto (cadeias de caracteres) usados para a renderização de topiccorrupted.htm
Element Valor
TopicCorruptedTitle Não é possível exibir o tópico solicitado.
TopicCorruptedViewOnlineText <p>O Help Viewer não pode exibir o tópico solicitado. Pode haver um erro no conteúdo do tópico ou em uma dependência do sistema subjacente.</p>
Recurso: Controle home page
Use: Texto que suporta a exibição do conteúdo do nó de nível superior do Help Viewer.
Element Valor
HomePageTitle Página 1 do Help Viewer
HomePageIntroduction <p>Bem-vindo à Microsoft Help Viewer, uma fonte essencial de informações para todos que usam ferramentas, produtos, tecnologias e serviços da Microsoft. O Help Viewer fornece acesso a informações de ida e de referência, código de exemplo, artigos técnicos e muito mais. Para encontrar o conteúdo necessário, procure o tabela de conteúdo, use a pesquisa de texto completo ou navegue pelo conteúdo usando o índice de palavra-chave.</p>
HomePageContentInstallText <p><br />Use a <a href="{0}" {1}> guia Gerenciar Conteúdo para fazer o </a> seguinte: Adicionar conteúdo ao <ul> <li> computador. </li> <li> Verifique se há atualizações no conteúdo local. </li> <li> Remova o conteúdo do computador.</li></ul></p>
HomePageInstalledBooks Livros instalados
HomePageNoBooksInstalled Nenhum conteúdo foi encontrado em seu computador.
HomePageHelpSettings Ajuda de conteúdo Configurações
HomePageHelpSettingsText <p>Sua configuração atual é a ajuda local. O Help Viewer exibe o conteúdo que você instalou em seu computador. <br /> Para alterar a origem do conteúdo da Ajuda, na barra de menus Visual Studio, escolha <span style="{0}"> Ajuda, Definir Preferência da Ajuda </span> .<br /></p>
Megabyte MB

branding.js

O branding.js arquivo contém JavaScript usado pelos elementos de identidade visual Visual Studio Help Viewer. Abaixo está uma lista dos elementos de identidade visual e a função JavaScript de suporte. 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 desse arquivo. O arquivo ICL foi criado para cadeias de caracteres loc dentro do branding.js arquivo.

Recurso de identidade visual Função JavaScript Descrição
Var... Definir variáveis
Obter a linguagem de código do usuário setUserPreferenceLang mapeia um índice # para a linguagem de código
Definir e obter valores de cookie getCookie, setCookie
Membro herdado changeMembersLabel Expandir/ressuar membro herdado
Quando SelfBranded=False Onload Leia a cadeia de caracteres de consulta para verificar se é uma solicitação de impressão. De definir todos os códigosnippets para concentrar a guia preferencial do usuário. Se for uma solicitação de impressão, de definir isPrinterFriendly como true. Verifique o modo de alto contraste.
Snippet de código addSpecificTextLanguageTagSet
getIndexFromDevLang
ChangeTab
setCodesnippetLang
setCurrentLang
Copytoclipboard
CollapsibleArea addToCollapsibleControlSet escreva todo o objeto de controle reutível na lista.
CA_Click com base no estado da área que pode ser rebaixada, define qual imagem e texto apresentar
Suporte de contraste para Logotipo isBlackBackground() Chamado para determinar se o plano de fundo é preto. Preciso somente quando no modo de alto contraste.
isHighContrast() usar um intervalo colorido para detectar o modo de alto contraste
onHighContrast(black) Chamado quando alto contraste é detectado
Funcionalidade LST
addToLanSpecTextIdSet(id)
updateLST(currentLang)
getDevLangFromCodeSnippet(lang)
Funcionalidade multimedia caption(begin, end, text, style)
findAllMediaControls(normalizedId)
getActivePlayer(normalizedId)
captionsOnOff(id)
toSeconds(t)
getAllComments(node)
styleRectify(styleName, styleValue)
showCC(id)
subtitle(id)

ARQUIVOS HTM

O pacote de identidade visual contém um conjunto de arquivos HTM que dá suporte a cenários para comunicação de informações importantes para usuários de conteúdo da Ajuda, por exemplo, uma home page que contém uma seção que descreve quais conjuntos de conteúdo são instalados e páginas informando ao usuário quando os tópicos não podem ser encontrados no conjunto local de tópicos. Esses arquivos HTM podem ser modificados por produto. Os fornecedores do Shell ISO são capazes de pegar o pacote de identidade visual padrão e alterar o comportamento e o conteúdo dessas páginas para que eles sejam necessários. Esses arquivos se referem ao respectivo pacote de identidade visual para que as marcas de identidade visual recebam o conteúdo correspondente do arquivo branding.xml dados.

Arquivo Uso Fonte de conteúdo exibida
homepage.htm Esta é uma página que exibe o conteúdo instalado no momento e qualquer outra mensagem apropriada para apresentar ao usuário sobre seu conteúdo. Esse arquivo tem o atributo de metadados adicional "Microsoft.Help.Id" content="-1", que coloca esse conteúdo na parte superior do TOC de conteúdo local.
<META_HOME_PAGE_TITLE_ADD /> Branding.xml, marca <HomePageTitle>
<HOME_PAGE_INTRODUCTION_SECTION_ADD /> Branding.xml, marca <HomePageIntroduction>
<HOME_PAGE_CONTENT_INSTALL_SECTION_ADD /> Branding.xml, marca <HomePageContentInstallText>
<HOME_PAGE_BOOKS_INSTALLED_SECTION_ADD /> A seção título Branding.xml <HomePageInstalledBooks> marca , os dados gerados do aplicativo, quando nenhum livro é <HomePageNoBooksInstalled> instalado.
<HOME_PAGE_SETTINGS_SECTION_ADD /> Seção de título Branding.xml marca <HomePageHelpSettings> , texto da seção <HomePageHelpSettingsText> .
topiccorrupted.htm Quando existe um tópico no conjunto local, mas por algum motivo não pode ser exibido (conteúdo corrompido).
<META_TOPIC_CORRUPTED_TITLE_ADD /> Branding.xml, marca <TopicCorruptedTitle>
<TOPIC_CORRUPTED_SECTION_ADD /> Branding.xml, marca <TopicCorruptedViewOnlineText>
topicnotfound.htm Quando um tópico não é encontrado no conjunto de conteúdo local, nem disponível online
<META_TOPIC_NOT_FOUND_TITLE_ADD /> Branding.xml, marca <TopicNotFoundTitle>
<META_TOPIC_NOT_FOUND_ID_ADD /> Branding.xml, marca <TopicNotFoundViewOnlineText> + <TopicNotFoundDownloadContentText>
<TOPIC_NOT_FOUND_SECTION_ADD /> Branding.xml, marca <TopicNotFoundText>
contentnotinstalled.htm Quando não há nenhum conteúdo local instalado para o produto.
<META_CONTENT_NOT_INSTALLED_TITLE_ADD /> Branding.xml, marca <ContentNotInstalledTitle>
<META_CONTENT_NOT_INSTALLED_ID_ADD /> Branding.xml, marca <ContentNotInstalledDownloadContentText>
<CONTENT_NOT_INSTALLED_SECTION_ADD /> Branding.xml, marca <ContentNotInstalledText>

Arquivos CSS

O Visual Studio de Identidade Visual do Help Viewer contém dois arquivos css para dar suporte à apresentação consistente Visual Studio conteúdo da Ajuda:

  • Branding.css – contém elementos css para renderização em que SelfBranded=false

  • Printer.css – contém elementos css para renderização em que SelfBranded=false

Os arquivos Branding.css incluem definições para Visual Studio apresentação do tópico (a advertência é que o branding.css contido no Branding_ .mshc do serviço de pacote <locale> pode mudar).

Arquivos gráficos

Visual Studio conteúdo exibe um logotipo de Visual Studio, bem como outros gráficos. a lista completa de arquivos gráficos na Visual Studio pacote de identidade visual do visualizador da ajuda é mostrada abaixo.

Arquivo Uso Exemplos
clear.gif Usado para renderizar a área recolhível
footer_slice.gif Apresentação de rodapé
info_icon.gif Usado ao exibir informações Isenção de responsabilidade
online_icon.gif Este ícone deve ser associado a links online
tabLeftBD.gif Usado para renderizar o contêiner de trecho de código
tabRightBD.gif Usado para renderizar o contêiner de trecho de código
vs_logo_bk.gif Usado para referências de logotipo de contraste normal, conforme definido na marca Branding.xml <LogoFileName> . para produtos Visual Studio, o nome do logotipo é vs_logo_bk.gif.
vs_logo_wh.gif Usado para referências de logotipo de alto contraste, conforme definido na marca Branding.xml <LogoFileNameHC> . para produtos Visual Studio, o nome do logotipo é vs_logo_wh.gif.
ccOff.png Gráfico de legendas
ccOn.png Gráfico de legendas
ImageSprite.png Usado para renderizar a área recolhível gráfico expandido ou recolher

Implantar um conjunto de tópicos

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. O MSHA é um arquivo XML que descreve um conjunto de arquivos cabs ou MSHC. O Visualizador da ajuda pode ler o MSHA para obter uma lista de conteúdo (o .CAB ou. Arquivos MSHC) disponíveis para instalação local.

Isso é apenas um primo que descreve o esquema XML muito básico para o Help Viewer MSHA. Há um exemplo de implementação abaixo desta breve visão geral e exemplo de arquivo 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). Arquivo HelpContentSetup. msha (exemplo abaixo) deve conter uma lista de cabs ou MSHCs disponíveis. 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). Para cada cab ou MSHC, deve haver um <div class="package"> ... </div> (Veja o exemplo abaixo).

Observação: no exemplo de implementação abaixo, incluímos o pacote de identidade visual. isso é essencial para incluir a fim de obter os elementos de renderização de conteúdo de Visual Studio e os comportamentos de conteúdo necessários.

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

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

  2. Para este exemplo, usaremos os arquivos MSHC para conter os tópicos. Um MSHC é um zip com a extensão de arquivo alterada de .zip para. 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).

A classe "branding" existe e é exclusiva. 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. Sem isso, os erros ocorrerão quando o sistema procurar por itens de suporte que não fazem parte do conteúdo copiado (instalado).

para obter o pacote de identidade visual 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.

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

Resumo

usar e estender as etapas acima permitirá que o VSPs implante seus conjuntos de conteúdo para o Visual Studio Help Viewer.

adicionar ajuda ao Shell de Visual Studio (integrado e isolado)

Introdução

este tutorial demonstra como incorporar o conteúdo da ajuda em um aplicativo Visual Studio Shell e, em seguida, implantá-lo.

Requirements

  1. Visual Studio 2013

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

Visão geral

O Visual Studio 2013 shell é uma versão do Visual Studio 2013 IDE na qual você pode basear um aplicativo. Esses aplicativos contêm o Shell isolado junto com as extensões que você cria. Use modelos de projeto de shell isolados, que são incluídos no Visual Studio 2013 SDK, para criar extensões.

As etapas básicas para criar um aplicativo baseado em shell isolado e sua ajuda:

  1. Obtenha os pacotes Visual Studio 2013 redistribuíveis do Shell ISO (um download da Microsoft).

  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 posteriormente neste guia.

  3. Empacote a extensão e o Shell ISO redistribuível em um MSI de implantação (uma instalação de aplicativo). Este passo a passos não inclui uma etapa de configuração.

crie um repositório de conteúdo Visual Studio. Para o cenário de shell integrado, altere o Visual Studio12 para o nome do catálogo de produtos da seguinte maneira:

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

  • Crie um arquivo chamado CatalogType.xml e adicione-o à pasta. O arquivo deve conter as seguintes linhas de código:

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

Defina o repositório de conteúdo no registro. Para o Shell integrado, altere VisualStudio15 para o nome do catálogo de produtos:

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

    Chave: LocationPath valor da cadeia de caracteres: C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15\

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

    Chave: CatalogName valor da cadeia de caracteres: Visual Studio 2013 documentação

Criar o Project

Para criar uma extensão de shell isolada:

  1. em Visual Studio, em arquivo, escolha novo Project, em outros tipos de Project escolha extensibilidade e, em seguida, escolha Visual Studio Shell isolado. nomeie o projeto ContosoHelpShell para criar um projeto de extensibilidade com base no modelo de Shell isolado Visual Studio.

  2. No Gerenciador de Soluções, no projeto ContosoHelpShellUI, na pasta arquivos de recursos, abra ApplicationCommands. vsct. Verifique se essa linha foi comentada (pesquise por "No_Help"): <!-- <define name="No_HelpMenuCommands"/> -->

  3. Escolha a tecla F5 para compilar e executar a depuração. Na instância experimental do IDE do Shell isolado, escolha o menu ajuda . Verifique se a exibição ajuda, adicione e remova o conteúdo da ajuda e defina os comandos de preferência da ajuda.

  4. No Gerenciador de Soluções, no projeto ContosHelpShell, na pasta personalização do Shell, abra ContosoHelpShell. pkgdef. Para definir o catálogo de ajuda da Contoso, adicione as seguintes linhas:

     [$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. Para habilitar a ajuda F1, adicione as seguintes linhas:

    // 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 . Em Propriedades de configuração, selecione Configuration Manager. Na coluna configuração , altere cada valor de "debug" para "Release".

  7. Compile a solução. Isso cria um conjunto de arquivos em uma pasta de liberação, que será usada na próxima seção.

Para testar isso como se fosse implantado:

  1. No computador em que você está implantando o contoso, instale o Shell ISO baixado (do acima).

  2. Crie uma pasta em \ \Program Files (x86) \ e nomeie-a Contoso .

  3. Copie o conteúdo da pasta ContosoHelpShell Release para \ \Program Files (x86) \Contoso\ Folder.

  4. Inicie o editor do registro escolhendo executar no menu Iniciar e inserindo Regedit . No editor do registro, escolha arquivo e importar. Navegue até a pasta do projeto ContosoHelpShell. Na subpasta ContosoHelpShell, escolha ContosoHelpShell. reg.

  5. Criar um repositório de conteúdo:

    Para o Shell ISO-criar um C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\ContosoDev12 de armazenamento de conteúdo contoso

    Para o Visual Studio 2013 shell integrado, crie a pasta C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15

  6. Crie CatalogType.xml e adicione ao repositório de conteúdo (etapa anterior) que contém:

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

    HKLM\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15Key: valor da cadeia de LocationPath:

    Para o Shell ISO:

    C:ProgramDataMicrosoftHelpLibrary2CatalogsVisualStudio15

    Visual Studio 2013 Shell integrado:

    C:ProgramDataMicrosoftHelpLibrary2CatalogsVisualStudio15en-US

    Chave: CatalogName valor da cadeia de caracteres: Visual Studio 2013 documentação. Para o Shell ISO, esse é o nome do seu catálogo.

  8. Copie seu conteúdo (CABS ou MSHC e MSHA) para uma pasta local.

  9. Exemplo de linha de comando de shell integrada para testar o repositório de conteúdo. Para o Shell ISO, altere os valores de catálogo e launchingApp, conforme apropriado, para corresponder ao produto.

    "C:\Arquivos de programas (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). No Shell ISO, escolha o item de menu ajuda e altere a preferência de ajuda definir para usar a ajuda local.

  11. No Shell, escolha o item de menu ajuda e, em seguida, exiba a ajuda. O Visualizador da ajuda local deve ser iniciado. Escolha a guia gerenciar conteúdo . Em origem da instalação, escolha o botão de opção disco . 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). Escolha o arquivo HelpContentSetup. msha. Agora, a Contoso deve aparecer como um livro nas seleções do livro. Escolha Adicionar e, em seguida, escolha o botão Atualizar (canto inferior direito).

  12. No IDE contoso, escolha a tecla F1 para testar a funcionalidade F1.

Recursos adicionais

para a api de tempo de execução, consulte Windows api de ajuda.

Para obter mais informações sobre como aproveitar a API de ajuda, consulte exemplos de código do Help Viewer.

Você pode enviar sugestões de recursos no Community do desenvolvedor.