Create rules using regular expressions to apply Locks Keywords to your projects, preventing full segments, words or phrases within a segment and tags from being translated. Furthermore, the rules can be customized to only apply to specific file types.

Users may have as many Keyword Settings files as they wish. The default Settings File is C:\Users\Public\Alchemy Software\Catalyst 2021\keywords.xml  (see preview below). To edit or create a new Settings File, go to EXPERTS > Locks & Keywords > Options...

In the Locks and Keywords settings dialog, click the Add button to add a new rule to your new or existing Settings File.

The first choice to make is to select the appropriate type of rule for which to enter a regular expression, double click to open the dropdown:

• KEYWORD: Use to keyword any text or syntax within a segment using a regular expression to select it.
• LOCK: Lock a full segment using its ID or upon matching a specific condition.
• TAG: Define words or phrases to be protected when found between specific inline tags.

Each of the 3 options above will have different fields greyed out as they are not necessary.

The order in which the keywords are listed in a settings file can have an influence. Rules cannot include or append to text which is already locked as a keyword so it is usually advisable to apply the rules locking longer text or phrases before shorter ones. In this settings dialog, you can move a rule up or down the list using the Up arrow and Down arrow buttons.

Only the rules which are ticked as Enabled will be applied when Applying Locks and Keywords.

Rules from previous Catalyst version in .txt format can be imported with the Import... button. If a rule already exists it will not be duplicated.

Defining Keywords

KEYWORD uses regular expressions entered in the Expression field to select text to lock within a segment, known as keywords.

The Match Whole Word option, available to the KEYWORD type only, is set to True by default. While True, the expression will lock the keyword only if it matches whole words, i.e. surrounded by words delimiters such as spaces.
Example: See the results of using either Match Whole Word options when the expression "Copy" is applied to the segment "Copyright".

In the example above a single keyword in defined on each line using a regular expression.

Defining Locks

Using LOCK applies a lock to the segment matching the defined criteria, preventing its translation.

Lock segments in two ways:

• Matching text or syntax.
  
  Use the Expression field to enter a regular expression.
  When defining segments to lock by content, the expression must match the entire segment.  

• Matching the segment ID.
  
  Use the ID field to enter the segment ID.
  When defining segments to lock by ID, the ID is case sensitive and must match the whole id.

In the example above a locking entry is defined on each line

Defining keywords within Tags

Select TAG in the type dropdown to define words or phrases to be protected when found between specific inline tags.

Enter the tag element name which encapsulates the text to keyword in the Expression field.

Enter an attribute name found in the tags encapsulating the text to keyword in the Attribute Name field.

Enter an attribute value found in the tags encapsulating the text to keyword in the Attribute Value field.

The strings added in Expression, Attribute Name and Attribute Value fields are treated as standard text. Meaning they do not use regular expression and are not case sensitive.

Using this segment as an example:

<p>If you use a localisation tool like Catalyst<MadCap:conditionalText MadCap:conditions="Status.UnderConstruction" style="background-color: #ffd700;"> or CATALYST Developer/Pro</MadCap:conditionalText>, you can apply locks and keywords  under the EXPERTS ribbon.</p>