Definieren eines Keys

In IXIASOFT CCMS Web können Sie Variablen in Maps definieren und als Key in Topics einfügen. Sie können Keys einsetzen, um Inhalte in Topics zu haben, die sich automatisch ändern, je nachdem in welcher Map sich das Topic befindet.

Beispielsweise können Sie Keys verwenden, um Namen für Produkte oder Produktfunktionen zu definieren. Wenn sich Namen im Laufe der Zeit ändern, müssen Sie nicht alle Topics bearbeiten. Sie müssen nur den Key in der Map bearbeiten, der den Namen definiert. Weiterhin gilt, wenn Sie zwei Maps haben, bei denen derselbe Key einen Namen unterschiedlich definiert, werden Topics mit diesem Key automatisch mit dem richtigen Namen für die Map aktualisiert, in der sie sich befinden.

Sie können Keys auf verschiedene Weise definieren und Ihren Inhalten hinzufügen. Am häufigsten werden Keys auf folgende Weise verwendet:

  • Sie definieren die Keys in der Map und fügen Sie den Topics in dieser Map hinzu.
  • Sie definieren Keys in einer Submap, die Sie dann anderen Maps hinzufügen können. Auf diese Weise definieren Sie die Keys nur einmal in einer Map und verwenden dann die Map immer dann, wenn Sie dieses Keys zu einem Topic hinzufügen möchten, als Submap wieder.
Anmerkung: Wenn Keys an mehreren Stellen definiert sind, haben die in der Haupt-Map (der Stamm-Map) definierten Keys Vorrang vor den Key-Definitionen in Submaps, es sei denn, es ist ein spezieller Bereich für die Keys definiert.

Außerdem müssen Sie die Map einchecken, bevor neue Keys verwendet werden können.

So definieren Sie einen Key:

  1. Wählen Sie im Map-Editor die Position im Topic aus, an der Sie den Key einfügen möchten.
  2. Klicken Sie in der Symbolleiste auf Symbol "Variable (als DITA-Key) definieren".
    Das Dialogfeld Variable definieren wird angezeigt.
  3. Geben Sie im Feld Name einen Namen für den Key ein.
    Sie können eine beliebige Zeichenfolge eingeben, die jedoch keine Leerzeichen enthalten darf. Dieser Name wird verwendet, um von einem Topic aus auf den Key zu verweisen.
  4. Geben Sie im Feld Wert den Wert ein, der angezeigt werden soll, wenn der Key verwendet wird.
  5. Wenn Sie Keys verwenden möchten, um Links zu definieren (z. B. externe Links zu Websites), müssen Sie den Key im XML-Texteditor bearbeiten:
    1. Klicken Sie auf der Symbolleiste Oxygen Web Author auf Schaltfläche "Einstellungen".
    2. Wählen Sie in der Dropdownliste Als XML bearbeiten aus.
      Der Inhalt des Hauptbearbeitungsbereichs wird im Texteditor als XML geladen.
    3. Bearbeiten Sie den XML-Code für den Key direkt:

      Nachfolgend ist ein Beispiel des XML-Codes für einen externen Link aufgeführt:

      <keydef format="html" href="https://www.ixiasoft.com/documentation-guide/" 
keys="IXIAsitedocs" processing-role="resource-only" scope="external"/>
  6. Klicken Sie auf das Symbol OK

Ein <keydef> wird mit den von Ihnen definierten Werten in die Map eingefügt.

Sobald Sie die Map freigeben, kann der Key in Topics eingefügt werden.