Asciidoctor JATS

Asciidoctor JATS is extension for Asciidoctor that converts AsciiDoc documents to the Journal Article Tag Suite (JATS) format. JATS is an XML format for scientific papers with a wide acceptance in life science journals and journal databases.

The converter outputs XML compatible with the Article Authoring Tag Set. Other tag sets, namely Archiving and Interchange and Journal Publishing, are out of the scope of this project.

Status

Asciidoctor JATS is currently in development. It does little more than nothing. To see what is implemented, regularly check the feature list.

Goal

The goal of this project is to support authors of (especially scientific) articles in writing by leveraging Asciidoctor’s easy to learn markup and the ability to output all kinds of formats that are relevant to their work.

Documents in JATS can support the publishing process by providing a file format that is an accepted standard by publishers. By Asciidoctor’s philosophy to separate content from form the article can be output to any format, allowing for a higher re-use due to publishing the work in multiple formats.

What works? What doesn’t?

Currently only a small subset of functionality is implemented. Due to limitations of the JATS format not all features of Asciidoc(tor) will or can be implemented. (To help with prioritizing the implementation of missing features please open an issue and/or up-vote existing ones.)

The list of available features include:

General document structure: Headings are converted to sections. JATS does not support "levels" sections. This is implemented by nesting sections, so skipping a level (e.g. using === without ==) might lead to a ill-formed document.
Inline markup: Bold, italic, and monospace text will be translated. Also will super- and sub-scripts.
Lists: Ordered and unordered lists will be translated, but will not keep the numberings as defined.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/manuelprinz/asciidoctor-jats.

Resources

Authors

Asciidoctor JATS was written by Manuel Prinz.

Copyright

Free use of this software is granted under the terms of the MIT License.

For the full text of the license, see the LICENSE file.

manuelprinz / asciidoctor-jats Goto Github PK