Skip to content

README.adoc

Latest commit

 

History

History
59 lines (38 loc) · 2.13 KB

README.adoc

File metadata and controls

59 lines (38 loc) · 2.13 KB

mn2pdf Ruby gem

Gem Version Build Status Pull Requests Commits since latest

Purpose

The mn2pdf Ruby gem is a wrapper around the Java mn2pdf which converts Metanorma XML files into native PDFs.

This gem is used to provide mn2pdf.jar with mirrored version numbers, to allow Ruby code to easily refer to the desired mn2pdf version as dependencies.

Installation

gem install mn2pdf

Or include it in your gemspec.

Usage

require 'mn2pdf'
Mn2pdf.convert(sample_xml_path, output_pdf_path, sample_xsl_path, options = "")

The options are any options trailing in the mn2pdf Java executable, e.g. --split-by-language.

Updating the gem

Update lib/mn2pdf/version.rb to the desired version of mn2pdf.

Run rake to download the bin/mn2pdf.jar file:

rm -f bin/mn2pdf.jar
rake bin/mn2pdf.jar

Then release the gem with rake release.

Versioning

The gem version (VERSION) can be more granular than the mn2pdf JAR version (MN2PDF_JAR_VERSION) because the Ruby wrapper may need API changes that don’t require a new JAR.

  • When VERSION == MN2PDF_JAR_VERSION: a synchronized release, both update together

  • When VERSION is a patch release (e.g., 2.50.1) but MN2PDF_JAR_VERSION is 2.50: the Ruby API changed but no new JAR is needed

The release-tag.yml workflow handles this automatically when triggered by the mn2pdf Java repository.