Additionally, there are the following support projects:
ipf-docs, which is the source of this documentation. It is located at https://github.com/oehf/ipf-docs.
ipf-gazelle, which provides conformance profiles for HL7v2 based IHE transactions. It may be released independently and is located at https://github.com/oehf/ipf-gazelle.
ipf-oht-atna, which provides infrastructure for IHE audit trails and node authentication via TLS. It may be released independently and is located at https://github.com/oehf/ipf-oht-atna.
ipf-oht-atna libraries have been deprecated, and IPF has removed all dependencies targeting at
IPF 4.x builds with Java 11 for both compile time and runtime. IPF 3.x requires Java 8 for both compile time and runtime.
IPF builds using Maven 3.6. IPF and its dependencies are available at Maven Central, except for the MDHT dependencies that are provided at https://projects.suisse-open-exchange.healthcare/artifactory/releases.
Before building, adjust the
MAVEN_OPTS environment variable to assign Maven more heap space.
set MAVEN_OPTS=-Xmx1024m mvn clean install
In order to generate the site documentation, Java stubs from Groovy and Lombok
sources must be generated for proper Javadoc creation during the
set MAVEN_OPTS=-Xmx1024m mvn -Pgenerate-stubs generate-sources mvn site (-DskipTests) -rf :ipf
Documentation is maintained in Markdown in the
ipf-docs repository. Pushing changes to github will
automatically render the documentation at
https://oehf.github.io/ipf-docs. The generated Javadoc
must be copied from
target/site/apidocs into the
Javadocs artifacts are uploaded to Maven Central, which makes them also available online under
https://www.javadoc.io. The javadocs are located under
How to build and test the documentation locally
- Install Ruby and Jekyll as described here
- Clone the ipf-docs repository
gem install bundler
- In the project root directory, run
bundle installto download and install all dependencies
bundle exec jekyll serve
You can now browse the documentation at http://127.0.0.1:4000/ipf-docs/. If you update one of the Markdown files of the project, the server regenerates its content on the fly.
How to upload the documentation to github
- Simply commit the changes. Github Pages will regenerate the docs automatically