Skip to content

Markdown in an Orchestra file

Don Mendelson edited this page Mar 17, 2020 · 1 revision

The Orchestra XML schema has a provision for storing documentation in markdown (as well as other media types). Set the contentType attribute to "text/markdown" to inform processors that the documentation of an element should be interpreted as markdown.

Example with a word marked as italic:

<code value="8" id="10009" name="Cross">
  <annotation>
    <documentation contentType="text/markdown">Cross (orders where counterparty is an exchange, valid for all messages *except* IOIs)</documentation>
  </annotation>
</code>

When you document an element in a markdown file, md2orchestra passes it through to an Orchestra file as-is, retaining any style markings such as bold or italic.

Clone this wiki locally