Conventions

This sections describes the conventions used in this document.

The definition of properties of various enitities (like rules and rule sets) has the following format:

property name

property attributes property description

There are two groups of property attributes. The first one describes how the property is added to the documentation: automatic states that the property is added automatically during generation of this documentation, manual indicates that the value of property has to be added manually after generation of the documentation. The generator will only generate a stub for manual properties.

The second group describes when the property is present: always indicates that the property will always be added in case of an automatic property, and should always be added in case of a manual property. The absence of the always attribute indicates that the property may be left out. For example, the intersects with property of rule sets may be absent if there are no intersecting rule sets.

Rule set properties

name

automatic, always The name of the rule set. Names of implicit rule sets are enclosed in angular brackets.

definition

manual, always the criterion which defines which rules are in this rule set;
it might be a good idea to include this in the declaration of rule sets, so that this information can be added automatically

intersects with

automatic other rule sets that intersect the rule set, but are not supersets of it

superset of

automatic other rule sets that are subsets of the rule set, but not equal to it

subset of

automatic other rule sets that are supersets of the rule set, but not equal to it

equal to

automatic other rule sets that are equal to the rule set; indicates possibility to simplify things

rules

automatic, always the rules contained in the rule set

Rule properties

name

automatic, always the name of the rule

display name

automatic, always the display name of the rule; may be equal to the name

kind

automatic, always the kind of taclet the rule belongs to, i.e. NoFindTaclet, AntecTaclet, SuccTaclet, or RewriteTaclet

contained in

automatic, always list of rule sets the rule belongs to

definition

automatic, always the definition of the rule as given in the .key file;
this could be split up into the different clauses and declarations that can occur in a rule definition

options

automatic the choices the taclet is assigned to

introduced by

automatic for rules added by another rule, this gives the name of the introducing rule

source file

automatic name of the file in which the rule is defined