MedTechLabel WP2 T1.1 Information Model Guide
0.4.3 - ci-build

MedTechLabel WP2 T1.1 Information Model Guide, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.4.3 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/medtechlabel-wp2-im/ and changes regularly. See the Directory of published versions

Installation

This "website" is created by running a script (_buidl.bat) that converts the different input files into this website. Therefor, a tool called IG-publisher is used. In the following it is described what is necessary as a precondition to run the scripts.

Necessary Software

The following software (components) are needed. Installation should be done in the order listed:

  • Java SDK (to run the JAR files)
  • node.js (basic scripting)
  • npm (packaging manager)
  • jekyll (to generate and render the website content)
  • PlantUML (to help with drawing the UML diagrams)
  • SUSHI (to convert the FSH files)
  • IG-publisher (to run the publiher izself)

Software Installation

To run the generation script the necessary software must be installed:

install Java SDK from official website install node.js from official website: https://nodejs.org/en

node -v
npm -v

install Ruby from website: https://rubyinstaller.org/

npm install -g fsh-sushi

SUSHI can be used to create a new empty implementation guide:

sushi init .

Running the build script with option 1 downloads the latest files for the publisher.

Generating the site

After downloading (or updating) the publisher the website is generated by running the script (for Windows):

_build.bat

or for LINUX:

_build.sh

To generate the site, option 2 must be selected. Afterwards, the website is available in the output directory.

Results of generation

The result is placed in a subdirectory output. All previous content will be replaced.

A file called ''full_IG.zip'' contains the complete website. It can be extracted into a new (empty) directory. The file ''index.html'' should be opened to read the content.

  • https://hl7.github.io/docs/ig_publisher/getting-started
  • https://confluence.hl7.org -> IG-publisher
  • https://nodejs.org/en
  • https://rubyinstaller.org/
    • https://rubyinstaller.org/downloads/