Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #19

Closed
wants to merge 10 commits into from
Closed

Update docs #19

wants to merge 10 commits into from

Conversation

pieterbos
Copy link
Collaborator

Updated the README and some documentation of classes, and added a BuiltinReferenceModels class to easily obtain model metadata. Added an archie-all dependency that depends on the entire library.

Also removed some unused files.

Fixes #11 and #9

Copy link
Collaborator

@steijgeler steijgeler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice, much easier to get started now! 🤓

Maybe just add a TOC, since there are a lot of sections in the README now

README.md Outdated

### Flattener and Operational Template creation
You can create operational templates of your archetypes. Think of operational templates as something you generate from an archetype or template, to more easily work with. While a source archetype or even a flattened archetype can still contain 'use_node' for example, these have all been replaced. And all use_archetype c_archetype_roots have been replaced with the structure of the arhetype. See the OpenEHR OPT2 specification for what it does.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part could use some rephrasing

README.md Outdated
- all datetime parsers are now located in com.nedap.archie.datetime.DateTimeParsers
- CObject is now an abstract class, as it should be according to specs
- ModelInfoLookup now also returns computed attributes, with isComputed() returning true. This can break lots of RM processing tools!
## Dependency
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add an TOC to the README? It's quite long

README.md Outdated
}
```

This instantiates a MetaModels class that has both the archie reference model implementation, the BMM models and AOM profiles. The BMM models and AOM profileswill be used for the flattener and archetype validator, the other models for tools that work on reference models.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

profileswill

@pieterbos
Copy link
Collaborator Author

rebasing no longer possible due to git magic on other branches i did. opening a new PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants