Skip to content

Commit 47c03b1

Browse files
committed
Update profile README.md
1 parent c761f81 commit 47c03b1

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

src/main/profile/README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,4 +74,27 @@ Algorithm:
7474
and not `?profile ?qudt:excludes ?resource` in `<profile:currentState>`, the resource and its direct triples
7575
(including blank nodes and their triples) are added to the coresponding file in the profile
7676

77-
Profile-specific files are found under `target/dist/profile/[profilename]`.
77+
## Guide for Profile Developers
78+
79+
Profile-specific files are put in `target/dist/profile/[profilename]`. Each profile must be listed in the `pom.xml` file. Look for
80+
81+
```
82+
<foreach>
83+
<values>
84+
<in>
85+
construction
86+
```
87+
88+
... and add the profile folder name.
89+
90+
Add two files in that folder:
91+
1. write an `includes.ttl` file:
92+
1. containing a `?profile a qudt:Profile` triple
93+
2. optionally containing `?profile qudt:includes ?resource` triples
94+
3. optionally containing `?profile qudt:blocksIncludes ?resource` triples or a SHACL-AF rule that generates these triples - thus `?resource` can never be inferred as being included
95+
1. write an `excludes.ttl` file:
96+
2. containing a `?profile a qudt:Profile` triple
97+
2. optionally containing `?profile qudt:excludes ?resource` triples
98+
3. optionally containing `?profile qudt:blocksExcludes ?resource` triples or a SHACL-AF rule that generates these triples - thus `?resource` can never be inferred as being excluded
99+
100+
For `?profile` please use the IRI `profile:[profilename]`, e.g. `<http://qudt.org/schema/vocab/profile/construction> or `profile:construction` if the `profile` prefix is defined.

0 commit comments

Comments
 (0)