Erstellen einer Key-Definition

Sie können eine Variable in einer Map als Key definieren und diesen Key dann in eine beliebige Anzahl von Topics innerhalb der Map einfügen.

Warum und wann dieser Vorgang ausgeführt wird

Keys sind nützlich für die Handhabung der Konsistenz von Inhalten und für die Effizienz. Verwenden Sie Keys, um Elemente wie Namen für Produkte oder Funktionen zu definieren, und bearbeiten Sie dann den Key in der Map, der diesen Produkt- oder Funktionsnamen definiert.

Die beiden typischsten Methoden zum Definieren und Hinzufügen von Keys zu Ihren Inhalten sind:

  • Definieren Sie Keys in einer Map und fügen Sie diese dann zu den Topics der Map hinzu
  • Definieren Sie Keys in einer Unter-Map und verwenden Sie diese dann erneut, indem Sie sie zu anderen Zuordnungen mit Topics hinzufügen, die die von Ihnen definierten Keys benötigen

Sie können auch mehrere Definitionen für einen Key haben. Wenn Sie zwei Maps haben, bei denen derselbe Key einen Namen unterschiedlich definiert, werden Topics mit diesem Key automatisch mit dem richtigen Produkt- oder Funktionsnamen für die zugehörige Map aktualisiert.

Wenn mehrere Definitionen eines Keys in einer Map vorhanden sind, hat die erste Definition Vorrang vor allen nachfolgenden Definitionen, es sei denn, Sie legen einen bestimmten Bereich für die Keys fest, der diese Vorgabe ändert.

Sie müssen eine Map einchecken, bevor die neuen Key-Definitionen wirksam werden.

So erstellen Sie eine Key-Definition:

Prozedur

  1. Klicken Sie in der Strukturansicht für Map-Editor auf Bearbeiten.
  2. Wählen Sie die Position in der Map aus, zu der Sie den Key hinzufügen möchten, und klicken Sie dann auf .

    In einer Map können Sie fast überall Key-Definitionen hinzufügen. Aus visueller Sicht ist es sinnvoll, sie am Ende der Map einzufügen, damit sie bei der Topic-Navigation nicht im Weg sind.

    In einer Bookmap ist es üblich, Key-Definitionen im Vor- oder Nachsatz einzufügen. Sie können auch in Anhang, Kapitel, Entwurfseinleitung, Glossar, Hinweisen, Teil und Vorwort eingefügt werden.

  3. Wählen Sie im daraufhin eingeblendeten Pop-up-Menü die Option Neues Element und dann Gleiche Ebene oder Untergeordnete Ebene, je nachdem, ob Sie den Key als neben- oder untergeordnetes Element des ausgewählten Elements erstellen möchten.
  4. Klicken Sie im daraufhin angezeigten Dialogfeld Neues Element auf das Dropdown-Menü Element und wählen Sie <keydef>.
  5. Geben Sie in das Feld Key-Name den Namen für den Key ein.
  6. Wählen Sie für den Wert eine der folgenden Optionen aus:
    • Schlüsselwort bietet Ihnen einen Zusatz zur Keymap und verlangt von Ihnen die Eingabe eines Werts, den Sie als Referenz für diesen Key verwenden werden.
    • Objekt-Referenz unterstützt das Einfügen einer Referenz auf eine Grafik-, Topic- oder Map-Ressource, erfordert aber die Angabe des von DITA definierten Geltungsbereichs: lokal, gleichrangig oder extern.
    • Neues Topic-Referenz unterstützt die Erstellung gezielter Keys, die auf den von Ihnen festgelegten Topic-Bedingungen basieren.
    • Web-Link bietet Unterstützung für die Referenzierung von Live-Website-Links.
  7. Klicken Sie auf Einfügen.

Ergebnisse

Die Map enthält jetzt das Element <keydef> mit den von Ihnen definierten Werten.

Nächste Maßnahme

Nach dem Einchecken der Map können Sie den von Ihnen definierten Key in ein Topic einfügen.