Comment personnaliser l’aide du portail d’administration Azure Pack Windows pour une extension
S’applique à : Windows Azure Pack
Le fichier TOCMapping est responsable du rendu des liens du volet de navigation gauche. Le diagramme suivant illustre l’emplacement où le volet de navigation gauche existe dans le portail d’administration Azure Pack Windows.
.jpeg "Windows Azure Pack Left Navigation Pane")
Chaque lien a un contexte contenu dans un <élément set> dans le fichier de mappage TOC. La rubrique> associée à l’élément <enfant contient le lien réel vers le contenu d’aide et les informations d’attribut associées. L’exemple XML suivant montre le fichier de mappage XML de l’extension 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>
Les attributs de <la rubrique> associée sont les suivants :
Attribut |
Description |
|---|---|
topicContextId |
Nombre séquentiel qui identifie de manière unique la rubrique dans l’ensemble de liens. Deux rubriques dans le jeu ne peuvent pas partager le même topicContextId. |
title |
Texte du lien affiché dans le volet de navigation gauche du portail de gestion. |
Id |
Il s’agit du nom du fichier de contenu .xhtml à afficher. Par exemple, si le fichier de contenu est myhelp.xhtml, l’ID est « myhelp ». |
Le contenu d’aide rendu est stocké dans des fichiers .xhtml. Les extensions fournies dans la Windows l’installation d’Azure Pack par défaut fournissent du contenu .xhtml qui peut être utilisé comme guide pour créer votre propre contenu d’aide.
Tâches d’aide personnalisées
Comment modifier les liens d’aide du volet de navigation gauche pour une extension
Recherchez le fichier TOCMapping.xml pour le volet de navigation gauche de l’extension que vous souhaitez mettre à jour. Pour plus d’informations, consultez Windows Vue d’ensemble de l’aide personnalisée Azure Pack.
Ouvrez TOCMapping.XML dans Bloc-notes et recherchez le contexte (<défini>) pour le lien qui a besoin de la mise à jour.
Mettez à jour l’élément de rubrique associé requis <du jeu> de contextes <de> lien.
Modification du contenu d’aide existant pour une extension
Recherchez le fichier TOCMapping.xml. Pour plus d’informations, consultez Windows Vue d’ensemble de l’aide personnalisée Azure Pack.
Ouvrez TOCMapping.xml dans Bloc-notes et identifiez le jeu de contextes <d’aide qui contient la rubrique> associée au lien<d’aide requis.>
Identifiez le fichier .xhtml de contenu d’aide en inspectant l’attribut <id> de l’élément <de rubrique> associé.
Modifiez et enregistrez le fichier .xhtml pour modifier le contenu de l’aide.
Comment ajouter du contenu d’aide à une extension
Créez le contenu de l’aide et enregistrez-le en tant que fichier .xhtml dans le dossier approprié pour le contenu de l’aide. En règle générale, il s’agit du même dossier que le fichier TOCMapping.xml de l’extension, mais cela n’est pas garanti. Pour plus d’informations sur la localisation du contenu d’aide pour une extension, consultez Windows Vue d’ensemble de l’aide personnalisée Azure Pack.
Ouvrez TOCMapping.xml pour l’extension dans Bloc-notes et identifiez le jeu> de contextes <d’aide auquel le nouveau contenu d’aide doit être ajouté. Pour plus d’informations sur la localisation des TOCMapping.xml pour une extension, consultez Windows Vue d’ensemble de l’aide personnalisée Azure Pack.
Ajoutez un <élément de rubrique> associé au jeu> de contextes <d’aide. L’attribut ID de l’élément <relatedTopic> doit être le nom du fichier de contenu d’aide créé à la première étape sans l’extension .xhtml.
Guide pratique pour afficher des images d’aide
Créez l’image en tant que fichier .PNG ou .GIF
Placez l’image dans le même dossier que les fichiers .xhtml d’aide de l’extension. Pour plus d’informations sur la localisation du contenu d’aide pour une extension, consultez Windows Vue d’ensemble de l’aide personnalisée Azure Pack.
Dans le fichier .xhtml d’aide qui affiche l’image, utilisez le format suivant pour référencer l’image dans une <balise img> :
<src="/HelpContent/GetImage/<extensionName>/<FileName>.<extension>" class="mtpsimage" alt="note" />Par exemple <img src="/HelpContent/GetImage/websystemadminextension/jj205510.note(en-us,MSDN.10).gif » class="mtpsimage » alt="note » />