Extend TemplateMark to support admonitions

[OliverTod]

As discussed on the weekly tech WG calls on 2020-11-18 and 2020-11-25 - I have proposed an annotation feature that allows lawyers, parties and counterparties to easily include notes to themselves/each other in the template text.

This already exists in many common markdown extensions as 'admonitions' (also called call-outs) - which is generally rendered as a coloured block (sometimes with coloured headings). See here for examples.

To be decided:

• what syntax we would adopt for this (eg three colons vs three exclamation points); and
• whether inline admonitions are also required.

[OliverTod]

@jeromesimeon with all of the work done recently on extensions to TemplateMark, I thought I would re-agitate this issue. Can you put it on your list of possible extensions to see if there is any demand for it? The documentation for Docusaurus on this issue is good: https://docusaurus.io/docs/markdown-features/admonitions

[jeromesimeon]

Hi @OliverTod,

thanks for the ping. I remember looking at possible extensions and I think this one should be relatively easy. What I’m not so clear about is the usecase for contracts / agreements.

would you have a few examples of usage that would help motivate this extension?

thanks!

[OliverTod]

Here is an example, taken from an agreement I am currently converting: You can see that there are admonitions that will make their way into the final agreement (the 'Explanations for this section') and also 'notes' which are used for negotiation/development purposes.

[OliverTod]

Another example from the same agreement:

An example from a random Cloud SaaS provider:

Another random example, this time from Uber, of American drafting that uses ALL CAPS for emphasis (but which could be better done in an admonition):