Schlüsselwörter in Arbeitsdateien verwenden

Ein Schlüsselwort ist ein Platzhalter, der in textbasierte Arbeitsdateien eingefügt werden kann. Dieser Platzhalter ist eine spezielle Variable (z.B. $Date$, $Author$, $State$), die verwendet wird, um Textinformationen in einer Arbeitsdatei darzustellen. Schlüsselwörter können erweitert, (d.h. durch ihre Literalwerte ersetzt) werden, wenn eine Revision ausgecheckt wird.

Um ein Schlüsselwort zu verwenden, schließen Sie es einfach in eine in Dollarzeichen gesetzte Arbeitsdatei (z.B. $Date$) ein, und checken Sie die Datei zurück in ihr Archiv ein.

Angenommen, Peter möchte Informationen über das Mitglied anzeigen, das er als Kommentar in der Datei bearbeitet. Dazu kann er Schlüsselwörter verwenden. Er entscheidet sich für das Schlüsselwort $Log$. Peter legt in seinen Einstellungen fest, dass die Schlüsselworterweiterung beim Auschecken eines Mitglieds aktiviert ist. Anschließend platziert er das Schlüsselwort in ein Mitglied.

Ihr Administrator kann für Sie benutzerdefinierte Schlüsselwörter festlegen. Weitere Informationen zu benutzerdefinierten Schlüsselwörtern erhalten Sie von Ihrem Administrator.

Wenn Sie beim nächsten Mal die Revision auschecken, sucht Windchill RV&S in ihr nach Schlüsselwörtern und ersetzt diese, sofern die Schlüsselworterweiterung aktiviert ist, durch die entsprechenden Informationen.

Beim Prozess der Schlüsselworterweiterung werden Informationen automatisch zu einer Schlüsselwort-Referenz hinzugefügt oder aktualisiert, wenn eine Revision ausgecheckt oder angezeigt wird.

Wird z.B. das Schlüsselwort $Date$ gefunden, werden Datum und Uhrzeit der Revision (die beim Einchecken zugewiesen wurden) als Teil des Schlüsselworts zur Arbeitsdatei hinzugefügt. Erweitert könnte der Eintrag etwa folgendermaßen aussehen:

Das Hinzufügen oder Aktualisieren der Informationen in ein Schlüsselwort wird als Schlüsselworterweiterung bezeichnet.

Wenn z.B. in das Mitglied main.c die Schlüsselwörter $Author$und $State$ eingebettet sind, wird main.c ausgecheckt und folgender Befehl ausgegeben:

Die Schlüsselworterweiterung wird mithilfe des Dialogfensters Einstellungen in der GUI konfiguriert. Die Dialogfenster in der GUI können die Standardeinstellungen überschreiben.

• Ihr Administrator kann eine Richtlinie festlegen für Windchill RV&S, damit Schlüsselwörter ignoriert werden. Diese Richtlinie überschreibt Ihre Schlüsselworteinstellungen. Windchill RV&S benachrichtigt Sie nicht, wenn diese Richtlinie für Ihr Projekt festgelegt wird. Wenn Schlüsselwörter sich nicht erweitern lassen oder eine Erweiterung nicht rückgängig gemacht werden kann, Sie diese Möglichkeiten aber benötigen, wenden Sie sich an Ihren Administrator.

• Die Schlüsselworterweiterung gilt nur für Textdateien. Sie ist für Binärdateien deaktiviert.

Texte vor und nach dem Schlüsselwort bleiben erhalten, sodass es wie oben innerhalb von Ausdrücken und von Kommentaren verwendet werden kann.

Wenn die Schlüsselworterweiterung aktiviert ist und Sie eine Textdatei auschecken, die folgende Zeichenfolge enthält:

Wenn diese Zeichenfolge aufgefunden wird, fügt Windchill RV&S automatisch den Wert des Schlüsselworts $Revision$ in folgendem Format hinzu:

in einer C-Quelldatei eine Zeichenfolge mit dem Namen revnum erstellt, die die Revisionsnummer der Datei enthält. Das Programm kann anschließend so konfiguriert werden, dass diese Zeichenfolge beim Start angezeigt und die aktuelle Revision der Quelldatei des Programms automatisch dargestellt wird.

Zu den häufigsten Anwendungsmöglichkeiten für Schlüsselwörter zählt die Verwendung des Schlüsselworts $Revision$, um die Revisionsnummer einer Datei zu erhalten. Weitere häufige Anwendungen sind:

• Das Schlüsselwort $Header$ stellt eine einzeilige Zusammenfassung mit der Revision zugeordneten nützlichen Informationen bereit. Werden diese Informationen in einen Kommentar eingeschlossen, werden die Informationen für jeden bereitgestellt, der das Mitglied anzeigt.

• Das Schlüsselwort $Log$ bietet dieselbe Art von Informationen wie $Header$ zuzüglich der Revisionsbeschreibung. Das Schlüsselwort $Log$ stellt eine vollständige Liste von Änderungen bereit, die im Laufe der Zeit am Mitglied vorgenommen werden.

Das Schlüsselwortformat $<keyword>$ bewirkt, dass Windchill RV&S die Ersetzung zwischen dem ersten $ und dem nächsten $ vornimmt. Wenn Sie ein Schlüsselwort im Format $<keyword> verwenden, fährt Windchill RV&S mit dem Ersetzen fort, bis es auf ein anderes $ stößt. Es ist möglich, dass Windchill RV&S kein anderes $ findet, bis die Datei erneut ausgecheckt wird. Diese Art der Schlüsselwortverwendung gibt Ergebnisse zurück, die der Protokollierung ähnlich sind.

Wenn Sie möchten, dass Schlüsselwörter genau so bleiben, wie sie in einer Revision sind, deaktivieren Sie die Schlüsselworterweiterung in Ihren Einstellungen.

Sie können den Befehl ident in der Befehlszeilenschnittstelle verwenden, um Schlüsselwörter (erweitert oder unerweitert) in einem oder mehreren Mitgliedern zu finden und anzuzeigen. Weitere Informationen zum Befehl ident finden Sie in den CLI-Man-Pages.

Dieser Befehl zeigt den Namen aller Mitglieder, die Schlüsselwörter enthalten, sowie die Schlüsselwörter selbst an. Das ermöglicht Ihnen, auf einfache Weise ID-Informationen aus Quelldateien und kompilierten Objektdateien zu extrahieren.