拡張機能の Windows Azure Pack 管理ポータル ヘルプをカスタマイズする方法

  • [アーティクル]

 

適用対象: Azure Pack Windows

TOCMapping ファイルは、左側のナビゲーション ウィンドウ リンクをレンダリングします。 次の図は、Windows Azure Pack 管理ポータルに左側のナビゲーション ウィンドウが存在する場所を示しています。

Windows Azure Pack Left Navigation Pane

各リンクには、TOC マッピング ファイル内の <set> 要素に含まれるコンテキストがあります。 子要素 <関連のトピック> には、ヘルプ コンテンツと関連する属性情報への実際のリンクが含まれています。 次の XML 例は、MySQL 拡張機能の XML マッピング ファイルを示しています。

<?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>

関連トピック>の<属性は次のとおりです。

属性

説明

topicContextId

リンクのセット内のトピックを一意に識別するシーケンシャル番号。 セット内の 2 つのトピックは、同じ topicContextId を共有できません。

title

管理ポータルの左側のナビゲーション ウィンドウに表示されるリンク テキスト。

Id

これは、レンダリングされる .xhtml コンテンツ ファイルの名前です。 たとえば、コンテンツ ファイルが myhelp.xhtml の場合、ID は "myhelp" になります。

レンダリングされたヘルプ コンテンツは 、.xhtml ファイルに格納されます。 Azure Pack の既定のインストールWindowsで提供される拡張機能は、独自のヘルプ コンテンツを作成するためのガイドとして使用できるヘルプ コンテンツ .xhtml ファイルを提供します。

カスタム ヘルプ タスク

  1. 更新する拡張機能の左側のナビゲーション ウィンドウのTOCMapping.xml ファイルを見つけます。 詳細については、「Windows Azure Pack カスタム ヘルプの概要」を参照してください。

  2. メモ帳でTOCMapping.XMLを開き、更新が必要なリンクのコンテキスト (<セット>) を見つけます。

  3. リンク コンテキスト セット>の必要な<関連トピック>要素を更新します<。

拡張機能の既存のヘルプ コンテンツを変更する方法

  1. TOCMapping.xml ファイルを見つけます。 詳細については、「Windows Azure Pack カスタム ヘルプの概要」を参照してください。

  2. メモ帳でTOCMapping.xmlを開き、必要なヘルプ リンク<関連トピックを含むヘルプ コンテキスト <セット>を特定します>。

  3. 関連するトピック>要素の id> 属性を調べることで、<ヘルプ コンテンツ .xhtml ファイルを<特定します。

  4. .xhtml ファイルを編集して保存し、ヘルプ コンテンツを変更します。

拡張機能に新しいヘルプ コンテンツを追加する方法

  1. ヘルプ コンテンツを作成し、ヘルプ コンテンツの適切なフォルダーに .xhtml ファイルとして保存します。 通常、これは拡張子のTOCMapping.xmlファイルと同じフォルダーになりますが、これは保証されません。 拡張機能のヘルプ コンテンツの検索については、「Azure Pack カスタム ヘルプの概要Windows」を参照してください。

  2. メモ帳で拡張機能のTOCMapping.xmlを開き、新しいヘルプ コンテンツを追加するヘルプ コンテキスト <セット>を特定します。 拡張機能のTOCMapping.xmlの検索については、「Azure Pack カスタム ヘルプの概要Windows参照してください。

  3. ヘルプ コンテキスト <セット>に<関連するトピック>要素を追加します。 relatedTopic> の <Id 属性は、最初の手順で作成されたヘルプ コンテンツ ファイル名で、拡張子が .xhtml でなくてもかまいません。

ヘルプ イメージをレンダリングする方法

  1. イメージを .PNG または .GIF ファイルとして作成する

  2. 拡張機能のヘルプ コンテンツ .xhtml ファイルと同じフォルダーにイメージを配置します。 拡張機能のヘルプ コンテンツの検索については、「Azure Pack カスタム ヘルプの概要Windows」を参照してください。

  3. イメージをレンダリングするヘルプ コンテンツ .xhtml ファイルで、次の形式を使用して img> タグ内のイメージを<参照します。

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

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

参照

Azure Pack 拡張機能のカスタム ヘルプをWindowsする