Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rubenpieters committed May 21, 2023
1 parent 07fa975 commit 6e52c57
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,31 +46,28 @@ rules:
...
```

### Rule
### Subsection

Defines a rule (numbered with 1.1.1.).
Defines a subsection (numbered with 1.1.1.).

```
rule: rule_id
text: Formatted Rule Text
toc: (optional indicator whether this rule should be added to the table of contents)
steps: (optional indicator whether this rule and any subelements should be referred to as 'step')
subsection: subsection_id
text: Formatted Subsection Text
toc: (optional indicator whether this subsection should be added to the table of contents)
steps: (optional indicator whether this subsection and any subelements should be referred to as 'step')
rules:
- sub_rule:
- rule:
...
- sub_rule:
- rule:
...
examples:
- text: Formatted Example Text
- text: Formatted Example Text
```

### SubRule
### Rule

Defines a subrule, which is nested below a rule (numbered with a.).
Defines a rule. A rule can be under a section (numbered with 1.1.1.) or nested below a rule (numbered with a.).

```
sub_rule: sub_rule_id
rule: rule_id
text: Formatted Rule Text
examples:
- text: Formatted Example Text
Expand Down Expand Up @@ -102,6 +99,12 @@ Reference any identifier of a chapter, section, rule, or subrule.
{ref:ref_id}
```

A reference can contain a capital letter at the start, to indicate the reference text should be capitalized.

```
{ref:Ref_id}
```

Referencing multiple identifiers at once is possible with a `,`.

```
Expand Down

0 comments on commit 6e52c57

Please sign in to comment.