Skip to content

Commit

Permalink
[New] Documentation about conceptual model
Browse files Browse the repository at this point in the history
  • Loading branch information
blcham committed Aug 7, 2021
1 parent 2811803 commit 44d27ee
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# SForms

Semantic form generator and processor for ontology-based smart forms.
**S**emantic **form** generator and processor for ontology-based smart forms.

### Supported features
## Supported features

- Input/Textarea
- Typeahead
Expand All @@ -11,10 +11,17 @@ Semantic form generator and processor for ontology-based smart forms.
- Checkbox
- Numeric input

# Development
## Representation in JSON-LD

Semantic form is structure that holds a form (set of questions) as well as its data (set of answers).
A conceptual model of Semantic forms is [questions/answers model](https://kbss.felk.cvut.cz/gitblit/summary/s-forms-model.git).
The conceptual model is described in RDF language. This library processes and generates Semantic forms using JSON-LD
format which is JSON compatible serialization of the RDF language.

## Development

Building SForms library can be done using `npm run build:lib`.

## Debugging content of a form
### Debugging content of a form

Rendering of a form can be easily tested through sample react application provided in `./test` folder. The application can be started by executing npm script through `npm run dev` and then accessing `loaclhost:8888` from a browser. It renders the form provided by the file `./test/rendering/form.json`. See `./test/rendering/TestApp.jsx` for more details.

0 comments on commit 44d27ee

Please sign in to comment.