Como personalizar o Windows Ajuda do Portal de Gerenciamento do Azure Pack para uma extensão
Aplica-se a: Windows Azure Pack
O arquivo TOCMapping é responsável por renderizar os links do painel de navegação esquerdo. O diagrama a seguir ilustra onde o painel de navegação esquerdo existe no portal de gerenciamento do Windows Azure Pack.
.jpeg "Windows Azure Pack Left Navigation Pane")
Cada link tem um contexto contido em um <elemento de conjunto> dentro do arquivo de mapeamento TOC. O tópico> relacionado ao elemento <filho contém o link real para o conteúdo da ajuda e as informações de atributo associadas. O exemplo XML a seguir mostra o arquivo de mapeamento XML para a extensão MySQL.
<?xml version="1.0" encoding="utf-8"?>
<site xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" locale="en-us">
<set setContextId="mysqlextension.databases" title="mysqlextension.databases">
<relatedTopic topicContextId="0" title="Change the Password for a MySQL Database" id="jj822102(en-us,azure.100)" />
<relatedTopic topicContextId="1" title="View MySQL Database Information" id="jj822123(en-us,azure.100)" />
<relatedTopic topicContextId="2" title="Delete a MySQL Database" id="jj822141(en-us,azure.100)" />
<relatedTopic topicContextId="3" title="Create a MySQL Database" id="jj822150(en-us,azure.100)" />
<relatedTopic topicContextId="4" title="Navigate MySQL Databases" id="jj822106(en-us,azure.100)" />
</set>
</site>
Os atributos para <o tópico> relacionado são os seguintes
Atributo |
Descrição |
|---|---|
topicContextId |
Um número sequencial que identifica exclusivamente o tópico dentro do conjunto de links. Dois tópicos dentro do conjunto não podem compartilhar o mesmo topicContextId. |
título |
O texto do link exibido no painel de navegação esquerdo do Portal de Gerenciamento. |
ID |
Esse é o nome do arquivo de conteúdo .xhtml a ser renderizado. Por exemplo, se o arquivo de conteúdo for myhelp.xhtml, a ID será "myhelp". |
O conteúdo da ajuda renderizada é armazenado em arquivos .xhtml. As extensões fornecidas no padrão Windows instalação do Azure Pack fornecem arquivos .xhtml de conteúdo de ajuda que podem ser usados como um guia para criar seu próprio conteúdo de ajuda.
Tarefas de Ajuda Personalizadas
Como modificar os links de ajuda do painel de navegação esquerdo para uma extensão
Localize o arquivo TOCMapping.xml para o painel de navegação à esquerda da extensão que você deseja atualizar. Para obter mais informações, consulte Windows Visão geral da Ajuda Personalizada do Azure Pack.
Abra TOCMapping.XML em Bloco de notas e localize o contexto (<definido>) para o link que precisa ser atualizado.
Atualize o elemento de tópico> relacionado necessário <do conjunto> de contexto <de link.
Como modificar o conteúdo da ajuda existente para uma extensão
Localize o arquivo TOCMapping.xml. Para obter mais informações, consulte Windows Visão geral da Ajuda Personalizada do Azure Pack.
Abra TOCMapping.xml no Bloco de notas e identifique o conjunto de contexto <de ajuda que contém o tópico> relacionado ao link<de ajuda> necessário.
Identifique o arquivo .xhtml de conteúdo da ajuda inspecionando o <atributo ID> do <elemento de tópico> relacionado.
Edite e salve o arquivo .xhtml para modificar o conteúdo da ajuda.
Como adicionar novo conteúdo de ajuda a uma extensão
Crie o Conteúdo da Ajuda e salve-o como um arquivo .xhtml na pasta apropriada para o conteúdo da ajuda. Normalmente, essa será a mesma pasta que o arquivo TOCMapping.xml para a extensão, mas isso não é garantido. Para obter informações sobre como localizar o conteúdo da ajuda para uma extensão, consulte Windows Visão geral da Ajuda Personalizada do Azure Pack.
Abra TOCMapping.xml para a Extensão no Bloco de notas e identifique o conjunto> de contexto <de ajuda ao qual o novo conteúdo de ajuda deve ser adicionado. Para obter informações sobre como localizar o TOCMapping.xml de uma extensão, consulte Windows Visão geral da Ajuda Personalizada do Azure Pack.
Adicione um <elemento de tópico> relacionado ao conjunto> de contexto <de ajuda. O atributo ID do <relatedTopic> deve ser o nome do arquivo de conteúdo de ajuda criado na primeira etapa sem a extensão .xhtml.
Como renderizar imagens de ajuda
Criar a imagem como um arquivo .PNG ou .GIF
Coloque a imagem na mesma pasta que os arquivos .xhtml de conteúdo da extensão. Para obter informações sobre como localizar o conteúdo da ajuda para uma extensão, consulte Windows Visão geral da Ajuda Personalizada do Azure Pack.
No arquivo .xhtml de conteúdo da ajuda que renderiza a imagem, use o seguinte formato para fazer referência à imagem em uma <marca img> :
<src="/HelpContent/GetImage/<extensionName>/<FileName>.<extension>" class="mtpsimage" alt="note" />Por exemplo <, img src="/HelpContent/GetImage/websystemadminextension/jj205510.note(en-us,MSDN.10).gif" class="mtpsimage" alt="note" />