Compartir a través de

Personalización de la ayuda del Portal de administración de módulos de Azure Windows para una extensión

  • Artículo

 

Se aplica a: Windows Azure Pack

El archivo TOCMapping es responsable de representar los vínculos del panel de navegación izquierdo. En el diagrama siguiente se muestra dónde existe el panel de navegación izquierdo en el portal de administración de Windows Azure Pack.

Windows Azure Pack Left Navigation Pane

Cada vínculo tiene un contexto que se encuentra en un <elemento set> dentro del archivo de asignación de TOC. El tema> relacionado con el elemento <secundario contiene el vínculo real al contenido de ayuda y a la información de atributo asociada. En el ejemplo XML siguiente se muestra el archivo de asignación XML para la extensión 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>

Los atributos del <tema> relacionado son los siguientes:

Atributo

Descripción

topicContextId

Número secuencial que identifica de forma única el tema dentro del conjunto de vínculos. Dos temas dentro del conjunto no pueden compartir el mismo topicContextId.

title

Texto del vínculo que se muestra en el panel de navegación izquierdo del Portal de administración.

Identificador

Este es el nombre del archivo de contenido .xhtml que se va a representar. Por ejemplo, si el archivo de contenido es myhelp.xhtml, el identificador es "myhelp".

El contenido de la ayuda representada se almacena en archivos .xhtml. Las extensiones proporcionadas en el Windows instalación predeterminada de Azure Pack proporcionan archivos .xhtml de contenido de ayuda que se pueden usar como guía para crear su propio contenido de ayuda.

Tareas de ayuda personalizadas

  1. Busque el TOCMapping.xml Archivo para el panel de navegación izquierdo de la extensión que desea actualizar. Para más información, consulte Windows Introducción a la Ayuda personalizada de Azure Pack.

  2. Abra TOCMapping.XML en Bloc de notas y busque el contexto (<establecido>) para el vínculo que necesita actualizar.

  3. Actualice el elemento de tema> relacionado necesario <del conjunto> de contextos <de vínculo.

Modificación del contenido de ayuda existente para una extensión

  1. Busque el archivo TOCMapping.xml. Para más información, consulte Windows Introducción a la Ayuda personalizada de Azure Pack.

  2. Abra TOCMapping.xml en Bloc de notas e identifique el conjunto> de contextos <de ayuda que contiene el tema relacionado con el vínculo<> de ayuda necesario.

  3. Identifique el archivo .xhtml de contenido de ayuda inspeccionando el <atributo id> del <elemento de tema> relacionado.

  4. Edite y guarde el archivo .xhtml para modificar el contenido de la ayuda.

Cómo agregar contenido de ayuda nuevo a una extensión

  1. Cree el contenido de ayuda y guárdelo como un archivo .xhtml en la carpeta adecuada para el contenido de ayuda. Normalmente, esta será la misma carpeta que el archivo TOCMapping.xml para la extensión, pero esto no está garantizado. Para obtener información sobre cómo localizar el contenido de ayuda de una extensión, consulte Windows Introducción a la Ayuda personalizada de Azure Pack.

  2. Abra TOCMapping.xml para la extensión en Bloc de notas e identifique el conjunto> de contexto <de ayuda al que se agregará el nuevo contenido de ayuda. Para obtener información sobre cómo buscar el TOCMapping.xml para una extensión, consulte introducción a Windows Ayuda personalizada de Azure Pack.

  3. Agregue un <elemento de tema> relacionado al conjunto> de contextos <de ayuda. El atributo Id del tema relacionado> debe ser el nombre del <archivo de contenido de ayuda creado en el primer paso sin la extensión .xhtml.

Cómo representar imágenes de ayuda

  1. Cree la imagen como un archivo .PNG o .GIF

  2. Coloque la imagen en la misma carpeta que los archivos .xhtml de ayuda de la extensión. Para obtener información sobre cómo localizar el contenido de ayuda de una extensión, consulte Windows Introducción a la Ayuda personalizada de Azure Pack.

  3. En el archivo .xhtml de contenido de ayuda que representa la imagen, use el siguiente formato para hacer referencia a la imagen en una <etiqueta img> :

    <src="/HelpContent/GetImage/<extensionName>/<FileName>.<extension>" class="mtpsimage" alt="note"  />

    Por ejemplo <, img src="/HelpContent/GetImage/websystemadminextension/jj205510.note(en-us,MSDN.10).gif" class="mtpsimage" alt="note" />

Consulte también

Windows ayuda personalizada de extensión de Azure Pack