loading table of contents...

2.7.6.2. Editing the rule configuration

To edit the settings of one of the listed rules, select the rule from the list and click the "Edit" button:

Figure 2.7.33. Editing a rule configuration

This opens the rule configuration dialog:

Figure 2.7.34. Rule configuration dialog

This allows to edit following settings:
Rule ID
The rule identifier. The rule identifier has to be unique within the Docmenta installation. The first character of a rule identifier has to be a letter or underscore (_). All following characters have to be letters (A-Z, a-z), digits (0-9), underscore or dash (-).
Title
A title that summarizes the functionality of the rule. This should be no more than one sentence.
Enabled
This checkbox defines whether the rule is enabled or disabled. If a rule is disabled, then it will never be executed.
Default State
The default state defines whether the rule is executed by default. If the default state is "off", then the user is still able to execute the rule as part of a consistency-check by explicitly enabling the rule in the consistency-check dialog. If the default state is "on", then the rule is executed, except the user explicitly disables the rule in the consistency-check dialog.
Scope
The scope defines for which products the rule is to be executed. If "All Products" is selected, then the rule is available for all existing products and for all new products to be created. If "All Products" is unchecked, then the rule is only available for the products selected in the list below.
Java Class
The fully qualified name of the Java class that implements the rule. The specified class has to implement the org.docma.plugin.HTMLRule interface. Details on the rule class are given in the online help that is opened when clicking the "Help" button next to the input field.
Arguments
Arguments that are supported by the selected Java class can be entered here. The supported arguments are described in the online help that is opened when clicking the "Help" button next to the Java class input field.
Check settings
After having entered a valid class name in the "Java Class" input field, a list of one or more checks is displayed (below the "Arguments" field). This is the list of available checks of the entered rule class. For each check one of the severity levels "INFO", "WARNING" or "ERROR" can be defined. The checkboxes next to the severity level allow to define whether a check is executed when content is saved (content editor) or when user executes a consistency-check, or in both situations. Furthermore, it can be defined whether the check is executed with auto-correction enabled or disabled.