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 2023\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 new line will be added below the currently selected INDEX line. In the example below, Row 4 was selected before pressing the Add button.

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. More details below...
• LOCK: Lock a full segment using its ID or upon matching a specific condition. More details below...
• TAG: Define words or phrases to be protected when found between specific inline tags. More details below...

Each of the 3 options above will cause different fields to become greyed out as they are unnecessary.

The order in which the keywords are listed in a Settings file can have an influence. Because rules cannot include or append to text which is already locked as a keyword. It is thus advisable to apply the rules locking longer text or phrases before shorter ones.

Only the rules which are ticked as Enabled will be applied when Applying Locks and Keywords.
Rules can also be restricted to apply to only certain file types in your project in the FILE TYPES column. By default, it is always set to All file types.

Importing rules

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.

You may also Import rules from another Settings file (.xml). This can be useful in consolidating rules from different Settings files.

Managing your Locks & Keywords settings

Your list of rules is indexed in a specific order in which they will be applied. This is important because applying Keywords will not overwrite or extend an existing keyword, it only applies if the regular expression in the settings file is fully met. Should a portion of the expected keyword be already a keyword, the new keyword will not apply.

The rules total and selected count is automatically updated and displayed above the list to quickly assess when it is longer than the window.

Reordering the rules is made easy either using the and buttons, or dragging and dropping. When using the arrows buttons, it is possible to select multiple rows and move them together.

To delete rules, select one or more row (use CTRL or Shift + mouse click) and press the button. You will be prompted to confirm you want to delete the rules, after which point you cannot reinstate the deleted rules.

Searching

The Search Keywords...  tool located at the top right of the Settings dialog offers the ability to search within the various columns of the Locks & Keywords. The entered text instantly highlights the matching text and filters out any non-matching rows, for example:

Press the button to clear the search.

Sorting

The list of Locks & Keywords can be sorted by any columns. The default is the INDEX column.

Below, the sorting has been set on the EXPRESSION/TAG NAME column. As a result, the INDEX numbers are now in a different order and highlighted in Red.

At this point, pressing the Reorder Keywords File by Current Sorting Order button will rewrite the Settings file in the current sorted order and reassign the INDEX values in a sequential order (1, 2, 3, ...).

This update to the .xml file will only occur if you press the Save button, Save as or click OK on the dialog. Pressing Cancel will discard the current changes..

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>