Fachportal für Technische Dokumentation

Author-it - Metadaten über Variablen verwalten

Sind die Inhalte, die Sie verwalten, sehr umfangreich? Laufen Sie Gefahr, den Überblick zu verlieren? Sind Sie auf der Suche nach einer intelligenten Methode, auf Daten strukturiert zugreifen zu können? Nutzen Sie Variablen, um Ihre Objekte mit Metadaten auszuzeichnen. Mit Hilfe der Suchfunktion lassen sich diese Objekte später schnell herausfiltern.

Was sind Metadaten?

Metadaten sind Daten über Daten, das bedeutet Schlüsselwörter oder Beschreibungen zum Inhalt, die beim Suchen nach Inhalten genutzt werden können. Einige Metadaten vergibt Author-it automatisch, wie z. B. den Namen des Autors oder Änderungsdaten. Auch Release-States sind Metadaten. Möglicherweise möchten Sie zusätzlich noch weitere Metadaten definieren.

Nehmen wir an, Sie suchen Topics mit bestimmten Merkmalen, wie z. B.:

  • Produkttyp
  • Textart (Marketing-Texte, Technische Dokumentation, Schulungsunterlagen)
  • Absatzmarkt
  • Kunde

In Author-it können Sie auf unterschiedliche Weise Metadaten vergeben, indem Sie

  • Ihre Ordner nach bestimmten Konventionen benennen
  • für Objekt-Beschreibungen bestimmte Konventionen festlegen
  • spezielle Templates für entsprechende Informationsklassen verwenden (z. B. das "Anleitungs-Template" für Handlungsanleitungen)
  • über Variablen den Author-it-Objekten bestimmte Werte zuweisen

In diesem Artikel geht es um die zuletzt genannte Möglichkeit, Metadaten zu vergeben: die Verwendung von Metadaten-Variablen. Mit Variablen können Sie jedes Objekt mit Metadaten auszeichnen, ohne dass diese in der Publikation sichtbar sind.

Vorgehensweise

Um Metadaten als Variablen anzulegen und zu verwalten gehen Sie folgendermaßen vor:

  1. Variablen im Author-it Administrator anlegen
  2. Variablen in Author-it verwenden
  3. In Author-it nach Variablen suchen

Variablen im Author-it Administrator anlegen

So legen Sie im Author-it Administrator neue Variablen an:

  1. Öffnen Sie Ihre Library im Author-it Administrator.
  2. Klicken Sie Variables --> Main Variables --> Add.
  3. Geben Sie im Fenster Variable <> default settings den Variablennamen ein, wählen Sie den Variablentyp aus und geben Sie eventuell die entsprechenden Werte ein.

Tipp: Wenn Sie feste Variablenwerte haben, wählen Sie als Variablentyp List of Values. Hier definieren Sie eine Liste, aus der Sie bei der Variablen-Vergabe den entsprechenden Wert auswählen können. Bei frei definierbaren Variablenwerten verwenden Sie den Variablentyp Text. Sobald Sie in Author-it diesen Variablentyp vergeben, können Sie den gewünschten Text eingeben.

Beispielszenario

Sie erstellen eine Dokumentation für verschiedene Produkte und verschiedene Kunden, auf zwei verschiedenen Plattformen.

Dafür definieren Sie im Author-it Administrator drei Variablen mit vorgegebenen Werten:

 Variablenname Variablenwert
 <Produkt> "PR123", "PR456", "PR789", "PR106"
 <Kunde> "Firma Mayer", "Firma Schmid", "Firma Bauer"

<Plattform>

 "Linux", "Unix"

Variablen in Author-it verwenden

So weisen Sie in Author-it einem Objekt Metadaten über Variablen zu:

  1. Öffnen Sie das entsprechende Objekt (z. B. Topic).
  2. Klicken Sie Tools-->Variables-->Assignments,
    oder
    öffnen Sie das Kontextmenü im Explorer und klicken Sie List Variable Assignments... .
  3. Wählen Sie aus dem linken Fensterbereich eine Metadaten-Variable aus.
  4. Klicken Sie  Pfeil , um die Variable dem geöffneten Objekt zuzuweisen.
    Das Fenster Variable Assignments öffnet sich.
  5. Wählen Sie den gewünschten Wert aus, bzw. geben Sie den gewünschten Wert ein und klicken Sie OK.

Das aktive Objekt wurde mit dem ausgewählten Variablen-Wert ausgezeichnet. Sie können einem Objekt verschiedene Variablen gleichzeitig zuordnen.

 

In Author-it nach Variablen suchen

DieTopics, die Sie mit Metadaten-Variablen ausgezeichnet haben, können Sie über die Author-it Suchfunktion schnell finden.

Nehmen wir an, Sie suchen Objekte mit bestimmten Merkmalen, wie:

  • alle Topics, die mit der Firma Mayer zu tun haben
  • alle Topics, die sich auf das Produkt PR123 beziehen und mit der Firma Mayer zu tun haben
  • alle Topics, die sich auf das Produkt PR123 beziehen und mit der Firma Mayer zu tun haben, und von Unix unterstützt werden.

Ins Suchfeld geben Sie nun Folgendes ein:

Im ersten Fall: <Kunde>=Firma Mayer.

Im zweiten Fall: <Kunde>=Firma Mayer + <Produkt>=PR123.

Im dritten Fall: <Kunde>=Firma Mayer + <Produkt>=PR123 + <Plattform>=Unix.

Bei dieser Art der Eingabe suchen Sie sowohl nach dem Variablennamen, wie auch nach dem entsprechenden Wert. Deshalb werden Ihnen nur die Objekte angezeigt, denen die gesuchten Variablenwerte zugewiesen wurden.
Würden Sie über die Volltextsuche nur den Wert eingeben, würde Author-it alle Objekte finden, in denen die entsprechende Zeichenfolge vorkommt, aber nicht die Variablenwerte. So könnte z. B. das Wort „Unix" auch in Topics vorkommen, die gar nicht mit der Variablen <Plattform> markiert sind!


21.05.07
Britta Heuermann - Technikredakteurin bei Comet Computer
Weitere Artikel von Britta Heuermann

Mit dem Artikel verknüpfte Schlagwörter:
Author-it Autorensysteme Content-Management-Systeme Redaktionssysteme Single-Source-Publishing Technische Dokumentation

HTML Druckversion

Suche



Themenbereich:

Werbung

Nicht verpassen
Gezielt informieren mit Author-it Aspect und Assist

Erfolgreiche Bildbearbeitung mit Gimp

Das bietet Open-Source-Software

DITA – Konzepte und Anwendungen: Tools für jeden Bedarf

DITA: ein neuer Standard mit Zukunft

Successful DITA Implementation with FrameMaker

Wissensaustausch mit Wikis: Einfach loslegen

Agil und eXtrem - die Zukunft der Technischen Dokumentation

Startseite | Impressum | Kontakt

[XML-RSS]

Doku.Info ist ein Service von Comet Computer GmbH - Die Profis für Technische Dokumentation