haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
kicad/pcbnew/dialogs/panel_setup_rules_help.md

130 lines
2.5 KiB
Markdown
Raw Normal View History

Minor adjustments to DRC syntax help.
2020-10-06 18:09:24 +00:00
### Top-level Clauses
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
(version <number>)
(rule <rule_name> <rule_clause> ...)
Minor adjustments to DRC syntax help.
2020-10-06 18:09:24 +00:00
### Rule Clauses
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
(constraint <constraint_type> ...)
(condition "<expression>")
(layer "<layer_name>")
Minor adjustments to DRC syntax help.
2020-10-06 18:09:24 +00:00
### Constraint Types
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
* annular_width
* clearance
Collapse silk constraints down to one. Also updates the rule syntax help and code-completion with a bunch of diff-pair and other stuff that hadn't been updated yet.
2020-10-11 10:51:23 +00:00
* courtyard_clearance
* diff_pair_gap
* diff_pair_uncoupled
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
* disallow
Collapse silk constraints down to one. Also updates the rule syntax help and code-completion with a bunch of diff-pair and other stuff that hadn't been updated yet.
2020-10-11 10:51:23 +00:00
* edge_clearance
* length
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
* hole
Collapse silk constraints down to one. Also updates the rule syntax help and code-completion with a bunch of diff-pair and other stuff that hadn't been updated yet.
2020-10-11 10:51:23 +00:00
* hole_clearance
* silk_clearance
* skew
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
* track_width
Collapse silk constraints down to one. Also updates the rule syntax help and code-completion with a bunch of diff-pair and other stuff that hadn't been updated yet.
2020-10-11 10:51:23 +00:00
* via_count
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
Minor adjustments to DRC syntax help.
2020-10-06 18:09:24 +00:00
### Item Types
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
* buried_via
* graphic
* hole
* micro_via
* pad
* text
* track
* via
* zone
Minor adjustments to DRC syntax help.
2020-10-06 18:09:24 +00:00
### Examples
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
Minor adjustments to DRC syntax help.
2020-10-06 18:09:24 +00:00
# Comment
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
(rule "copper keepout"
(constraint disallow track via zone)
(condition "A.insideArea('zone3')"))
(rule "BGA neckdown"
(constraint track_width (min 0.2mm) (opt 0.25mm))
(constraint clearance (min 0.05) (opt 0.08mm))
(condition "A.insideCourtyard('U3')"))
(rule HV
(constraint clearance (min 1.5mm))
(condition "A.NetClass == 'HV'"))
(rule HV
(layer outer)
(constraint clearance (min 1.5mm))
(condition "A.NetClass == 'HV'"))
(rule HV_HV
# wider clearance between HV tracks
(constraint clearance (min "1.5mm + 2.0mm"))
(condition "A.NetClass == 'HV' && B.NetClass == 'HV'"))
(rule HV_unshielded
(constraint clearance (min 2mm))
(condition "A.NetClass == 'HV' && !A.insideArea('Shield*')))
Minor adjustments to DRC syntax help.
2020-10-06 18:09:24 +00:00
### Notes
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
Version clause must be the first clause.
Rules should be ordered by specificity. Later rules take
precedence over earlier rules; once a matching rule is found
no further rules will be checked.
Use Ctrl+/ to comment or uncomment line(s).
Minor adjustments to DRC syntax help.
2020-10-06 18:09:24 +00:00
### Expression functions
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
Minor adjustments to DRC syntax help.
2020-10-06 18:09:24 +00:00
All function parameters support simple wildcards (`*` and `?`).
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
Minor adjustments to DRC syntax help.
2020-10-06 18:09:24 +00:00
True if any part of `A` lies within the given footprint's courtyard.
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
A.insideCourtyard('<footprint_refdes>')
Minor adjustments to DRC syntax help.
2020-10-06 18:09:24 +00:00
True if any part of `A` lies within the given zone's outline.
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
A.insideArea('<zone_name>')
Minor adjustments to DRC syntax help.
2020-10-06 18:09:24 +00:00
True if `A` has a hole which is plated.
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
A.isPlated()
Minor adjustments to DRC syntax help.
2020-10-06 18:09:24 +00:00
True if `A` is a member of the given group. Includes nested membership.
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
A.memberOf('<group_name>')
Minor adjustments to DRC syntax help.
2020-10-06 18:09:24 +00:00
True if `A` exists on the given layer. The layer name can be
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
either the name assigned in Board Setup > Board Editor Layers or
Minor adjustments to DRC syntax help.
2020-10-06 18:09:24 +00:00
the canonical name (ie: `F.Cu`).
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
Fix name-change in DRC rules syntax help.
2020-10-09 10:31:00 +00:00
A.existsOnLayer('<layer_name>')
Convert DRC rules syntax help to markdown Note, the original markdown spec specifies using 4 spaces to indent a code block (https://daringfireball.net/projects/markdown/syntax) Wrapping with three backticks doesn't work with this lib. Wrapping with a single backtick for span elements works ok.
2020-10-04 11:25:59 +00:00
NB: this returns true if `A` is on the given layer, independently
of whether or not the rule is being evaluated for that layer.
For the latter use a `(layer "layer_name")` clause in the rule.