Skip to content

Latest commit

 

History

History
46 lines (35 loc) · 2.62 KB

BUILDING.md

File metadata and controls

46 lines (35 loc) · 2.62 KB

Building this repository

One of the implementation guides in this repository (eg Shared Health Summary) can be built on your local device using the FHIR Implementation Guide publishing tool.

The steps to do this are:

Clone the repository onto your local device

This option uses the capability of git version control system to obtain any updates on your local device. It does presume a basic understanding of git, which is outside the scope of this readme. For further information on cloning a repository, refer to this GitHub help page. Essentially,

Set up the FHIR IG Publisher tooling

The IG publisher can be downloaded from the FHIR website here, as java executable file entitled org.hl7.fhir.igpublisher.jar.

Additionally, the IG publisher requires the following supporting tools to be installed:

  • ruby with rubygems
  • ruby gem jekyll
  • python 2.x
  • python module pygments

Refer to the installation guidance here

Running the IG publisher

The publisher can be run as a GUI application, or run from the command line.

Running in GUI mode

  1. Simply double click the jar application file
  2. Click the button 'choose' and locate the repository on your device and open one of the ig controller json files in the root directory eg ig-sharedhealthsummary-1.json
  3. Then click on the 'execute' button to start the publisher
  4. Once complete, the IG can then be viewed

Running on the command line

  1. Open a bash terminal at the root directory of the repository
  2. Issue the command, noting that your jar file is likely found at a different location 
    java -jar "/c/work/git/fhir-ig-publisher/org.hl7.fhir.igpublisher.jar" -ig ig-sharedhealthsummary-1.json
  3. A large number of messages/logging is printed to the terminal, which can largely be ignored (unless it fails to run in which case the error messages become useful in troubleshooting).
  4. Once complete, the IG can then be viewed

Viewing the generated output

The IG publisher is configured to generate its content in the output folder. Open one of the sub-directories for the particular IG that was run. Open the file index.html in a browser.

Further information

The official documentation for the IG publisher: http://wiki.hl7.org/index.php?title=IG_Publisher_Documentation