Author of Smart Contracts
Enter parameter description as
Markdown
Markdown for Smart Contracts
This document contains information about Markdown constructs that can be used to design formatted text in smart contracts. Sign this contract to acknowledge the information has been read and understood.
Smart Contracts are XML objects with cryptographical signatures. They contain both machine-readable information, as well as human-readable information. Human-readable information can be formatted, and localized. To simplify editing of human-readable text for smart contracts, a reduced Markdown dialect has been created. By using the
LegalLab
software, made available on
GitHub
by
Trust Anchor Group
, smart contracts can be designed, where the used writes human-readable information using such Markdown.
The following subsections lists available Markdown constructs that can be used when editing smart contracts.
The following constructs are available:
-
To create
bold text
, text is enclosed between double asterisks (*). **Example** becomes
Example
.
-
To create
italic text
, text is enclosed between single asterisks (*). *Example* becomes
Example
.
-
To create
underline text
, text is enclosed between underscore characters (_). _Example_ becomes
Example
.
-
To create
strikethrough text
, text is enclosed between tilde characters (~). ~Example~ becomes
Example
.
Superscript and Subscript
-
Subscript is created by enclosing it between aquare brackets [ and ]. A[1], A[2], … becomes A
1
, A
2
, …
-
Superscript is created by enclosing it between aquare brackets [ and ], with the first prefixed by a cirkumflex character (^). a^[2]+b^[2]=c^[2] becomes a
2
+b
2
=c
2
You can include values of parameters in the contract, by enclosing the parameter name between [% and ]. [%Example] becomes:
.
Contracts can include bullet lists, both numbered and unnumbered. Unnumbered bullet lists are created by placing each bullet item on a separate row, prefxing with with an asterisk (*) and a space or tab character.
Example:
* Item 1
* Item 2
* Item 3
becomes
-
Item 1
-
Item 2
-
Item 3
If you want to create numbered bullet lists, prefix the items using #. instead (a hash sign, followed by a period, and space).
Example:
#. Item 1
#. Item 2
#. Item 3
becomes
-
Item 1
-
Item 2
-
Item 3
If you want to use Markdown characters (such as *, [, ], ^, _, ~, #, \) in your text, prefix them using the backslash character (\).
Paragraphs are lines of text separated by at least one empty row. Multiple lines without empty rows between them are joined into a single paragraph.
Divide your text into sections by adding headings of different levels. A header is created by placing it on a separate row, prefixed by a number of hash signs (#), representing the level of the following section in the text. Level 1 (top) header is one #. Level 2, has two (##), level 3 has three (###), etc. Example:
### Example heading of level 3.
Level 1 headings can be generated without using #, and instead place a line of consequtive equal signs (=) below.
Level 2 headings can be generated without using #, and instead place a line of consequtive equal signs (-) below.
The row after the heading must be empty.