Warning

This gem is still under development. Moreover, unlike other Metanorma gems, there is no formal MPFA specification, and this work is still currently exploratory.

Functionality

This gem processes Metanorma documents following a template for generating documents for the Mandatory Provident Fund Schemes Authority of Hong Kong.

The gem currently inherits from the https://github.com/metanorma/metanorma-standoc gem, and aligns closely to it. Refer to https://metanorma.com for guidance.

Usage

The preferred way to invoke this gem is via the metanorma script:

$ metanorma --type mpfa a.adoc                   # output HTML and DOC
$ metanorma --type mpfa --extensions html a.adoc # output just HTML
$ metanorma --type mpfa --extensions doc a.adoc  # output just DOC
$ metanorma --type mpfa --extensions xml a.adoc  # output MPFA XML

The gem translates the document into Metanorma XML format, and then validates its output against the MPFA Metanorma XML document model; errors are reported to console against the XML, and are intended for users to check that they have provided all necessary components of the document.

The gem then converts the XML into output formats such as HTML and DOC.

Sample documents are available at https://github.com/metanorma/mn-samples-mpfa

Installation

If you are using a Mac, the https://github.com/metanorma/metanorma-macos-setup repository has instructions on setting up your machine to run Metanorma scripts such as this one. You need only run the following in a Terminal console:

$ bash <(curl -s https://raw.githubusercontent.com/metanorma/metanorma-macos-setup/master/metanorma-setup)
$ gem install metanorma-mpfa
$ gem install metanorma-cli

The metanorma-cli gem is the command-line interface for the Metanorma tool suite (incorporating the metanorma executable seen above).

Documentation

See The MPFA flavor of Metanorma

Data Models

The MPFA Document format is an instance of the StandardDocument model. Details of this general model can be found on its page.

Examples

• Example documents are avalable at the MPFA Samples repository.