Enabling Keyword Expansion

By enabling keyword expansion for a project, you can embed keywords within text files. These keywords are automatically expanded during file check-outs, to provide file and revision information within the file. You should use only one keyword per line.

Keyword expansion and EOL conversion work correctly for UTF-8 unicode files, which previously could be corrupted on check-in. However, EOL conversion is not supported for UTF-16 or UTF-32 unicode files. .

StarTeam supports Log and History Keywords from the StarTeam Server and from the MPX Cache Agent.

CAUTION:

Never use a keyword in a revision comment, as it will be expanded during the keyword expansion process.

Choose StarTeam > Project > Properties . In the Server, Navigator, or Package Explorers, right click on the project, and choose Properties from the context menu.
The Properties dialog box opens.
Expand StarTeam Provider and select Project.
Click the Options tab.
Check the Keyword Expansion check box to enable keyword expansion and use keywords in your text files.
This check box applies to files added or checked in from StarTeam or from StarTeam integrations with third-party applications.
In Expand Keywords for These File Extensions field, type the file extensions (for example, .bat, .cpp) for which you want to use keywords.
You can use a space, comma, or semicolon as keyword delimiters. The file extensions list can contain a maximum of 254 characters. If you leave this text box blank, no keywords will be expanded.

Note: When Keyword Expansion is enabled, the StarTeam Eclipse Plugin uses the encoding specified in the StarTeam Properties dialog box to expand the keywords in files as the files are checked-out. After check-out, any encoding changes are managed by Eclipse, not the StarTeam Eclipse Plugin.