Project

metanorma-mpfa

0.0
No release in over a year
metanorma-mpfametanorma/metanorma-mpfaHomepageDocumentationSource CodeBug TrackerWiki
metanorma-mpfa lets you write MPFA documents in AsciiDoc syntax. This gem is in active development. Formerly known as metanorma-mpfd
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
73,754
Stars
1
Forks
2
Watchers
13
 Releases
Current version
0.9.2
Total releases
53
First release
2020-06-26
Latest release
2022-06-06
 Issues
Open Issues
2
Closed Issues
15
Total Issues
17
Issue Closure Rate
88%
 Pull Requests
Open Pull Requests
2
Closed Pull Requests
6
Merged Pull Requests
66
Pull Request Acceptance Rate
89%
 Development
Primary Language
XSLT
Licenses
BSD-2-Clause
Average date of last 50 commits
2022-06-04
Reverse Dependencies
0

 Dependencies

Development

equivalent-xml
~> 0.6
guard
~> 2.14
guard-rspec
~> 4.7
rake
~> 13.0
rspec
~> 3.6
rubocop
~> 1.5.2
sassc
= 2.4.0
simplecov
~> 0.15
timecop
~> 0.9
debug
>= 0

Runtime

htmlentities
~> 4.3.4
twitter_cldr
>= 0
metanorma-standoc
~> 2.1.0
 Project Readme

Metanorma-MPFA: Metanorma processor for MPFA documents

Gem Version Build Status Code Climate Pull Requests Commits since latest

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

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.