Markdown Formatted Content
A schema that is used to validate a part of Laboperator workflow templates.
Markdown
Rich media content that can be formatted using Markdown.
For a general introduction to Markdown go to Markdown Guide or search for Markdown to find extensive resources online.
Laboperator Flavoured Markdown
Laboperator workflows extend Markdown with custom syntax to render additional content.
Field References
Reference fields defined in your workflow to dynamically display their current value.
Syntax
{{(field|)<identifier>|<variant>}}
Note that the field
type indicator can be omitted for brevity.
Parameters
| identifier | The identifier of the field that is referenced |
| variant | The reference variant. Should be one of value
, title
, plain
. Defaults to value
. |
Example 1
By default rendered values are highlighted against the background:
Some text with an inline reference to {{myField}}.
Example 2
You can render the title of a field instead of the value using the title
variant:
The field _myField_ has the title {{myField|title}}.
Example 3
Using the plain
variant you can render the plain value of a field without
any highlights. This is for example useful for cleaner tables:
| {{myField|title}} | {{anotherField|title}} |
| ----------------- | ---------------------- |
| {{myField|plain}} | {{anotherField|plain}} |
Field Inputs
Render inputs for fields defined in your workflow.
Syntax
{{field-input|<identifier>}}
# or
!{{<identifier>}}
Note that the field-input
type indicator can be omitted for brevity, if the placeholder is prefixed with an exclamation mark (!
).
Parameters | identifier | The identifier of the field that is referenced |
Example 1
Please enter the observed color of the substance:
!{{observedColor}}
Grids
You can use the %col
tag to organize content in a grid.
Syntax
%col <container?> <card?> <breakpoint={1-12}?>
# content is indented by two spaces or one tab
content
Parameters
| container | An optional flag that should be set if additional %col
tags are nested inside. See Example 2. |
| card | An optional flag that can be set if the block should get a background. |
| breakpoint | Breakpoints can be used to specifically set how many columns of a 12 column grid the block should span. See Material UI Fluid Grids for details. Possible breakpoints are xs
, sm
, md
, lg
, and xl
. The value can be between 1
and 12
. |
Example 1: Simple columns ``` %col This text is in one column. %col And this text in a second column next to it.
%col This text is in a second row. %col card This text is in a second row in the second column and has a background %col This row can have a different number of columns. This is the third. ```
Example 2: Nested columns
%col container card
%col
This is a the first column inside an outer block with background.
%col container
%col
We can nest this even further
%col
Allowing us to build complex layouts
Example 2: Breakpoints ``` %col xs={12} md={6} On a small screen this column fills up the whole width.
On a tablet in landscape it will only fill up half the screen and the two blocks will show next to each other. %col This block will adjust to the first one automatically. ```