No commit activity in last 3 years
No release in over 3 years
Ruby gem that install pandoc-jats custom Pandoc writer
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.10
~> 10.0
~> 3.0

Runtime

 Project Readme

pandoc-jats-ruby

This gem is obsolete, as of Pandoc 2.0 a JATS writer is part of the core Pandoc package.

A Ruby gem that packages the pandoc-jats Lua custom writer for Pandoc generating JATS XML - specifically Journal Publishing Tag Library NISO JATS Version 1.0.

Template

pandoc-jats uses the template default.jats - the template uses the same format as other Pandoc templates (e.g. if/end conditions, for/end loops, and a dot can be used to select a field of a variable that takes an object), but is more complex because of the extensive metadata in JATS. Templates are parsed by Pandoc, not the custom Lua writer.

Installation

Add this line to your application's Gemfile:

gem 'pandoc-jats-ruby'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pandoc-jats-ruby

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake rspec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mfenner/pandoc-jats-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.