diff --git a/manual/src/main/asciidoc/include/introduction.adoc b/manual/src/main/asciidoc/include/introduction.adoc index 1773637cc..f1ccf576f 100644 --- a/manual/src/main/asciidoc/include/introduction.adoc +++ b/manual/src/main/asciidoc/include/introduction.adoc @@ -29,6 +29,7 @@ conditions, e.g. file name extensions or a provided scope. The latter is an extr like "java:classpath" for a directory containing Java classes or "maven:repository" for a URL. === Rules + Rules are expressed as Cypher queries and are specified in XML files: [source,xml] @@ -36,7 +37,7 @@ Rules are expressed as Cypher queries and are specified in XML files: ---- + xsi:schemaLocation="http://schema.jqassistant.org/rule/v2.2 https://jqassistant.github.io/jqassistant/current/schema/jqassistant-rule-v2.2.xsd"> @@ -90,6 +91,8 @@ Rules are expressed as Cypher queries and are specified in XML files: ---- +NOTE: The rule XML schema is available https://jqassistant.github.io/jqassistant/snapshot/schema/jqassistant-rule-v2.2.xsd[online] and should be picked automatically for code completion by your IDE. + Each rule comes with an unique id (e.g. "my-rules:MyConstraint") which can be referenced by other rules. jQAssistant will take care about executing the rules in the correct order. Furthermore a human readable description shall help developers to understand the rationale behind them. @@ -164,7 +167,7 @@ In these cases it is possible to perform a dynamic extension (duck-typing) to th ---- + xsi:schemaLocation="http://schema.jqassistant.org/rule/v2.2 https://jqassistant.github.io/jqassistant/current/schema/jqassistant-rule-v2.2.xsd"> @@ -197,7 +200,7 @@ further severity is given, e.g. ---- + xsi:schemaLocation="http://schema.jqassistant.org/rule/v1.8 https://jqassistant.github.io/jqassistant/current/schema/jqassistant-rule-v2.2.xsd"> @@ -282,7 +285,7 @@ Both concepts and constraints may define required parameters: ---- + xsi:schemaLocation="http://schema.jqassistant.org/rule/v1.8 https://jqassistant.github.io/jqassistant/current/schema/jqassistant-rule-v2.2.xsd"> <1>