De Help van de Windows Azure Pack Management Portal voor een extensie aanpassen
Van toepassing op: Windows Azure Pack
Het TOCMapping-bestand is verantwoordelijk voor het weergeven van de koppelingen in het linkernavigatievenster. In het volgende diagram ziet u waar het linkernavigatiedeelvenster bestaat in de Windows Azure Pack-beheerportal.
Elke koppeling heeft een context die is opgenomen in een <ingestelde> element in het toc-toewijzingsbestand. Het onderwerp met betrekking tot> onderliggende elementen <bevat de werkelijke koppeling naar de Help-inhoud en de bijbehorende kenmerkinformatie. In het volgende XML-voorbeeld ziet u het XML-toewijzingsbestand voor de MySQL-extensie.
<?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>
De kenmerken voor <gerelateerd onderwerp> zijn als volgt
Kenmerk |
Beschrijving |
---|---|
topicContextId |
Een sequentieel getal dat het onderwerp uniek identificeert binnen de set koppelingen. Twee onderwerpen in de set kunnen niet dezelfde topicContextId delen. |
titel |
De koppelingstekst die wordt weergegeven in het linkernavigatiedeelvenster van de beheerportal. |
Id |
Dit is de naam van het .xhtml-inhoudsbestand dat moet worden weergegeven. Als het inhoudsbestand bijvoorbeeld myhelp.xhtml is, is de id 'myhelp'. |
De weergegeven Help-inhoud wordt opgeslagen in .xhtml-bestanden. De extensies in de standaardinstallatie van Windows Azure Pack bieden Help-inhoud .xhtml-bestanden die kunnen worden gebruikt als handleiding voor het maken van uw eigen Help-inhoud.
Aangepaste Help-taken
Help-koppelingen voor een extensie wijzigen in het linkernavigatiedeelvenster
Zoek het TOCMapping.xml Bestand voor het linkernavigatiedeelvenster van de extensie dat u wilt bijwerken. Zie Windows Overzicht van aangepaste Help voor Azure Pack voor meer informatie.
Open TOCMapping.XML in Kladblok en zoek de context (<set>) voor de koppeling die moet worden bijgewerkt.
Werk het vereiste gerelateerde <onderwerpelement> van de koppelingscontextset <>bij.
Bestaande Help-inhoud voor een extensie wijzigen
Zoek het bestand TOCMapping.xml. Zie Windows Overzicht van aangepaste Help voor Azure Pack voor meer informatie.
Open TOCMapping.xml in Kladblok en identificeer de Help-contextset <> die het vereiste help-koppelingsonderwerp<> bevat.
Identificeer het .xhtml-bestand van de Help-inhoud door het <id-kenmerk> van het <gerelateerde onderwerpelement> te inspecteren.
Bewerk en sla het XHTML-bestand op om de Help-inhoud te wijzigen.
Nieuwe Help-inhoud toevoegen aan een extensie
Maak de Help-inhoud en sla deze op als een XHTML-bestand in de juiste map voor de Help-inhoud. Normaal gesproken is dit dezelfde map als het TOCMapping.xml-bestand voor de extensie, maar dit is niet gegarandeerd. Zie Windows Overzicht van aangepaste Help voor Azure Pack voor informatie over het vinden van de Help-inhoud voor een extensie.
Open TOCMapping.xml voor de extensie in Kladblok en identificeer de Help-contextset <> waaraan de nieuwe Help-inhoud moet worden toegevoegd. Zie Windows Aangepaste Help-overzicht van Azure Pack voor informatie over het vinden van de TOCMapping.xml voor een extensie.
Voeg een <gerelateerd onderwerpelement> toe aan de Help-contextset<>. Het id-kenmerk van de <relatedTopic> moet de naam van het Help-inhoudsbestand zijn die in de eerste stap is gemaakt zonder de extensie .xhtml.
Help-afbeeldingen weergeven
De installatiekopieën maken als een .PNG- of .GIF-bestand
Plaats de afbeelding in dezelfde map als de Help-inhoud .xhtml-bestanden van de extensie. Zie Windows Overzicht van aangepaste Help voor Azure Pack voor informatie over het vinden van de Help-inhoud voor een extensie.
Gebruik in het help-inhoudsbestand .xhtml dat de afbeelding weergeeft de volgende indeling om te verwijzen naar de afbeelding in een <img-tag> :
<src="/HelpContent/GetImage/<extensionName>/<FileName>.<extension>" class="mtpsimage" alt="note" />
Bijvoorbeeld <img src="/HelpContent/GetImage/websystemadminextension/jj205510.note(en-us,MSDN.10).gif" class="mtpsimage" alt="note" />