Udostępnij za pośrednictwem

How to Customize the Windows Azure Pack Management Portal Help for an Extension (Jak dostosować pomoc portalu administracyjnego pakietu Azure Pack dla rozszerzenia)

  • Artykuł

 

Dotyczy: Windows Azure Pack

Plik TOCMapping jest odpowiedzialny za renderowanie linków okienka nawigacji po lewej stronie. Na poniższym diagramie pokazano, gdzie w portalu zarządzania Windows Azure Pack istnieje okienko nawigacji po lewej stronie.

Windows Azure Pack Left Navigation Pane

Każde łącze ma kontekst zawarty w elemecie <set> w pliku mapowania toc. Temat> powiązany z elementem <podrzędnym zawiera rzeczywisty link do zawartości pomocy i skojarzonych informacji o atrybutach. Poniższy przykład XML przedstawia plik mapowania XML dla rozszerzenia 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>

Atrybuty powiązanego <tematu> są następujące

Atrybut

Opis

topicContextId

Sekwencyjny numer, który jednoznacznie identyfikuje temat w zestawie łączy. Dwa tematy w zestawie nie mogą współdzielić tego samego tematuContextId.

tytuł

Tekst linku wyświetlany w okienku nawigacji po lewej stronie portalu zarządzania.

Id

Jest to nazwa pliku zawartości xhtml, który ma być renderowany. Jeśli na przykład plik zawartości to myhelp.xhtml, identyfikator to "myhelp".

Zawartość renderowanej pomocy jest przechowywana w plikach xhtml. Rozszerzenia podane w domyślnej instalacji pakietu Windows Azure Pack zapewniają zawartość plików xhtml pomocy, których można użyć jako przewodnika do tworzenia własnej zawartości pomocy.

Niestandardowe zadania pomocy

  1. Znajdź plik TOCMapping.xml dla okienka nawigacji po lewej stronie rozszerzenia, które chcesz zaktualizować. Aby uzyskać więcej informacji, zobacz Windows Omówienie pomocy niestandardowej pakietu Azure Pack.

  2. Otwórz TOCMapping.XML w Notatnik i znajdź kontekst (<zestaw>) dla linku, który wymaga aktualizacji.

  3. Zaktualizuj wymagany <element powiązanego tematu> zestawu> kontekstowego <linku.

Jak zmodyfikować istniejącą zawartość pomocy dla rozszerzenia

  1. Znajdź plik TOCMapping.xml. Aby uzyskać więcej informacji, zobacz Windows Omówienie pomocy niestandardowej pakietu Azure Pack.

  2. Otwórz TOCMapping.xml w Notatnik i zidentyfikuj zestaw> kontekst <pomocy zawierający wymagany temat> związany z linkiem<pomocy.

  3. Zidentyfikuj plik xhtml zawartości pomocy, sprawdzając <atrybut id> powiązanego elementu tematu<>.

  4. Edytuj i zapisz plik xhtml, aby zmodyfikować zawartość pomocy.

Jak dodać nową zawartość Pomocy do rozszerzenia

  1. Utwórz zawartość Pomocy i zapisz ją jako plik xhtml w odpowiednim folderze dla zawartości pomocy. Zazwyczaj będzie to ten sam folder co plik TOCMapping.xml rozszerzenia, ale nie jest to gwarantowane. Aby uzyskać informacje na temat lokalizowania zawartości pomocy dla rozszerzenia, zobacz Windows Omówienie pomocy niestandardowej pakietu Azure Pack.

  2. Otwórz TOCMapping.xml rozszerzenia w Notatnik i zidentyfikuj zestaw> kontekst <pomocy, do którego ma zostać dodana nowa zawartość pomocy. Aby uzyskać informacje na temat lokalizowania TOCMapping.xml dla rozszerzenia, zobacz Windows Omówienie pomocy niestandardowej pakietu Azure Pack.

  3. Dodaj element powiązanego <tematu> do zestawu> kontekstów <pomocy. Atrybut <Id relatedTopic> powinien być nazwą pliku zawartości pomocy utworzoną w pierwszym kroku bez rozszerzenia xhtml.

Jak renderować obrazy Pomocy

  1. Tworzenie obrazu jako pliku .PNG lub .GIF

  2. Umieść obraz w tym samym folderze co pliki xhtml pomocy rozszerzenia. Aby uzyskać informacje na temat lokalizowania zawartości pomocy dla rozszerzenia, zobacz Windows Omówienie pomocy niestandardowej pakietu Azure Pack.

  3. W pliku xhtml zawartości pomocy, który renderuje obraz, użyj następującego formatu, aby odwołać się do obrazu w tagu <img> :

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

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

Zobacz też

Windows niestandardowej pomocy dotyczącej rozszerzenia pakietu Azure Pack