Repository navigation
Diagnostic tags
Language: English · Русский
A tag is a plain string attached to a diagnostic. Tags name a diagnostic and let you find it; they do not change how it runs. They appear in the Tags column of the Diagnostics pane and the Diagnostic reports pane, take part in the search on both panes, can be clicked to search for the tag, and are written to every exported report.
Two kinds of tags exist.
Written by the rule author in the tags list of a configuration file and kept as written. A rule without tags has none. Use them for your own conventions, such as a discipline or a system.
Set by the product. They are always English and look the same in every interface language. A user tag that reuses a system tag name is ignored, so a configuration file cannot fake one.
| Tag | Meaning |
|---|---|
BuiltIn |
The check ships with Revit Linter. |
Custom |
A user-defined check from diagnostics.config.yaml. |
Collision |
A collision check from diagnostics.config.yaml. |
ParameterProject |
A project parameter check from diagnostics.config.yaml. |
Example |
The check came from the installed example configurations. |
Tour |
The managed practical-tour training check. |
Debug |
The check came from a debug configuration. |
Project and Family are the document kinds a diagnostic applies to. The product sets them on a built-in check from its document filter; on a configured rule they are ordinary tags the author writes in tags, because only the rule knows where it applies. They are not reserved.
- A built-in diagnostic gets
BuiltInand the document kinds it applies to (Project,Familyor both). - A rule loaded from a configuration file gets the tag of its declared
type(Custom,CollisionorParameterProject) and, when the product installed the rule, the provenance tag (Example,TourorDebug). The author'stagsfrom the file follow. - The system tags come first in declaration order, then the user tags in the order they are written in the file.
Before the list is built, tags are trimmed, empty tags are dropped and duplicates are removed ignoring case, so MEP and mep are one tag.
-
Diagnostic parameters — the
tagsfield of a rule. - Diagnostics pane — finding diagnostics by tag.