キーを定義する

IXIASOFT CCMS Web では、マップで変数を定義し、変数をキーとしてトピックに挿入できます。キーを使用して、トピックがどのマップにあるかに応じて自動的に変更されるコンテンツをトピックに含めることができます。

たとえば、キーを使用して製品または製品機能の名前を定義できます。名前が時間の経過とともに変化する場合は、すべてのトピックを編集する必要はありません。名前を定義するマップのキーを編集するだけで済みます。さらに、同じキーで名前の定義が異なる 2 つのマップがある場合、そのキーを持つトピックは、そのトピックが含まれているマップの正しい名前に自動的に更新されます。

さまざまな方法でキーを定義し、コンテンツに追加できます。一般的なキーの使い方は、以下のとおりです。

マップでキーを定義し、定義したキーをマップ内のトピックに追加します。
サブマップでキーを定義し、定義したキーを他のマップに追加できます。このように、1 つのマップでキーを一度だけ定義し、トピックにこれらのキーを追加する必要がある場合はいつでも、マップをサブマップとして再利用します。

注: キーが複数の場所で定義されている場合、キーの特定のスコープが定義されていない限り、メインマップ（ルートマップ）で定義されたキーがサブマップのキー定義よりも優先されます。

そして、新しいキーを使用する前に、マップをチェックインする必要があります。

キーを定義するには、次の手順を実行します。

マップエディターのコンテンツビューで、キーを追加するトピックの場所を選択します。
ツールバーで、をクリックします。
変数の定義ダイアログが表示されます。
名前フィールドに、キーの名前を入力します。
英数字、ダッシュ '-'、およびアンダースコア '_' の任意の文字列を入力できます。スペースは許可されていません。この名前は、トピックからキーを参照するために使用されます。
値フィールドに、キーを使用したときに表示する値を入力します。
キーを使用してリンク (Web サイトへの外部リンクなど) を定義する場合は、XML テキストエディターでキーを編集する必要があります。
1. Oxygen Web Authorツールバーで、をクリックします。
2. ドロップダウンリストからXML として編集するを選択します。
  メインの編集エリアのコンテンツは、XML としてテキストエディターにロードされます。
3. キーの XML を直接編集します：
  以下は外部リンクの XML の一例です：
```
<keydef format="html" href="https://www.ixiasoft.com/documentation-guide/" 
keys="IXIAsitedocs" processing-role="resource-only" scope="external"/>
```
OKをクリックします。

定義した値で<keydef>要素がマップに挿入されます。

マップをリリースしたら、キーをトピックに挿入できます。