Skip to content

Commit cf3d280

Browse files
committed
feat: add README.md for annotation usage and examples
1 parent aa56cdd commit cf3d280

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## Annotation Usage
2+
3+
### How to Use Annotations in Markdown Files
4+
5+
To annotate the content with domain terminology, wrap the text in annotation blocks using the following format:
6+
7+
```
8+
<!-- BEGIN-ANNOTATION: ontology_id -->
9+
The text goes here.
10+
<!-- END-ANNOTATION: ontology_id -->
11+
```
12+
13+
This annotation functionality automatically identifies and enriches domain-specific terminology with semantic hyperlinks.
14+
15+
### Available Ontologies
16+
17+
The following ontology IDs are supported:
18+
19+
- `oeo`
20+
- `brick`
21+
- `sms`
22+
- `fmi`
23+
- `dogont`
24+
- `s4grid`
25+
- `sargon`
26+
- `s4ener`
27+
- `bont`
28+
- `openadr`
29+
- `dices`
30+
31+
### Example
32+
33+
```
34+
<!-- BEGIN-ANNOTATION: oeo -->
35+
electrical energy is a form of energy derived from the potential or kinetic energy of charged particles.
36+
<!-- END-ANNOTATION: oeo -->
37+
38+
<!-- BEGIN-ANNOTATION: brick -->
39+
Building automation systems monitor temperature sensors.
40+
<!-- END-ANNOTATION: brick -->
41+
```

0 commit comments

Comments
 (0)