io.fixprotocol.tablature:md-grammar

Easy authoring for rules of engagement using markdown

License	The Apache License, Version 2.0
GroupId	io.fixprotocol.tablature
ArtifactId	md-grammar
Last Version	0.4.2
Release Date	Dec 23, 2020
Type	jar
Description	Easy authoring for rules of engagement using markdown
Project URL	https://github.com/FIXTradingCommunity/tablature/wiki/md-grammar
Project Organization	FIX Trading Community

Download md-grammar

Filename	Size
md-grammar-0.4.2.pom
md-grammar-0.4.2.jar	69 KB
md-grammar-0.4.2-sources.jar	42 KB
md-grammar-0.4.2-javadoc.jar	637 KB
md-grammar-0.4.2-jar-with-dependencies.jar	15 MB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.fixprotocol.tablature/md-grammar/ -->
<dependency>
    <groupId>io.fixprotocol.tablature</groupId>
    <artifactId>md-grammar</artifactId>
    <version>0.4.2</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.fixprotocol.tablature/md-grammar/
implementation 'io.fixprotocol.tablature:md-grammar:0.4.2'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.fixprotocol.tablature/md-grammar/
implementation ("io.fixprotocol.tablature:md-grammar:0.4.2")

Apache Buildr

'io.fixprotocol.tablature:md-grammar:jar:0.4.2'

Apache Ivy

<dependency org="io.fixprotocol.tablature" name="md-grammar" rev="0.4.2">
  <artifact name="md-grammar" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.fixprotocol.tablature', module='md-grammar', version='0.4.2')
)

Scala SBT

libraryDependencies += "io.fixprotocol.tablature" % "md-grammar" % "0.4.2"

Leiningen

[io.fixprotocol.tablature/md-grammar "0.4.2"]

Dependencies

compile (3)

Group / Artifact	Type	Version
org.antlr : antlr4	jar	4.8-1
org.apache.logging.log4j : log4j-api	jar	2.14.0
org.apache.logging.log4j : log4j-core	jar	2.14.0

test (2)

Group / Artifact	Type	Version
org.junit.jupiter : junit-jupiter-engine	jar	5.7.0
org.junit.jupiter : junit-jupiter-params	jar	5.7.0

Project Modules

There are no modules declared in this project.

tablature

Converts a markdown document to a specification and documents a specification as markdown. Markdown can automatically be rendered as a web page in GitHub or other sites. This is an easy way to publish rules of engagement. Roundtrip is supported, allowing a user to update a specification iteratively with an ordinary text editor.

FIX Orchestra

The intial target of tablature is FIX Orchestra, "machine readable rules of engagement".

See these projects for the Orchestra standard and related resources:

• fix-orchestra-spec - the standard. The inital implementation of this project is based on FIX Orchestra version 1.0 Draft Standard.
• fix-orchestra - XML schemas, utilities, and demonstration code

Modules

md2orchestra

Translates a markdown document to an Orchestra repository file.

See the Tablature User Guide for Messages

orchestra2md

Translates an Orchestra repository file to a markdown document.

md2interfaces

Translates a markdown document to an Orchestra interfaces file.

See the Tablature User Guide for Interfaces

interfaces2md

Translates an Orchestra interfaces file to a markdown document.

md-grammar

A library to parse and write markdown files. Generic data structures act as an intermediary between the markdown parser and writer logic and applications that use them. In other words, the part of an application that reads or writes a specification like Orchestra needs no special knowledge of markdown.

For a brief introduction to markdown, see Markdown Notation.

Prerequisites

This project requires Java 11 or later. It should run on any platform for which a JVM is supported. Several open-source implementations are available, including OpenJDK.

Build

The project is built with Maven version 3.0 or later. See Building this Project

License

© Copyright 2020 FIX Protocol Limited

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

FIX Trading Community

The nonprofit standards organization for the electronic trading industry

Versions

Version
0.4.2 Dec 23, 2020
0.4.1 Oct 1, 2020
0.4.0 Aug 28, 2020