Guidance for FHIR IG Creation
0.1.0 - CI Build International flag

Guidance for FHIR IG Creation, published by HL7 International - FHIR Management Group. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/FHIR/ig-guidance/ and changes regularly. See the Directory of published versions

Translation Formats

The IG publication tooling supports three formats for providing translations:

  • PO: GNU gettext PO files. File extension .po.
  • XLIFF: OASIS XLIFF 2.0. File extension .xliff.
  • JSON: an internal format functionally equivalent to XLIFF, for users who integrate with some other translation tool. File extension .json.

Which to use

  • For translating resources in an IG or a language pack, any of the three works. PO is still preferred: it has the best tool support, and the best handling of plural forms.
  • For the publisher's own Java translations, PO is required, because those are the only translations that use plural forms.
  • For template translations, PO is required.

Whichever you pick, keep one translation file per resource. The publisher generates all three formats on every build so you can switch, but only one should be in input/translations for a given resource.