In several places in the Berkeley Studio you can use Markdown to give structure to your text. Markdown is an intuitive markup language for plain text, that can be translated into more complex target languages such as HTML.
You can use MarkDown in the following places:
- texts on screen;
- text fragments;
- ‘free text’ informationsources; and
- the audit trail.
If your presentation layer so provides, you may also be able to use it in other places where text occurs, such as Model Information.
Markdown has several features that are briefly explained below.
Text in italics can be achieved by placing
_underscores_ around words.
Bold text is created by placing double
**asterisks** or double
__underscores__ around words.
Combined italics and bold text can be accomplished with
**_asterisks and underscores_**.
If you want to link to a website from within your text you can use
[link name](website URL). The first part,
[link name], will be displayed to the user, while the second part,
(website URL), is the link they will be sent to.
NOTE This part of MarkDown also works inside text fragments
NOTE You can also use linked texts or information sources to add extra information to a node.
You can create lists, either ordered or unordered. Ordered lists are created with numbers:
1. Item number one 2. Item number two
You can create unordered lists with a
* Item number one * Item number two
You can create headers in texts with Markdown. However, unless you want multiple headers in a single text, we recommend using titles or styles to do so. If you want to use headers, you can use them this way:
# Heading 1 ## Heading 2 ### Heading 3
… and so on until
###### Heading 6 (not advised).
When deciding on a heading level, we advise to use
# Heading 1 for the top-level heading in a node, regardless of the place in the website the application will eventually run in. The presentation layer will simply ‘demote’ the heading level to the appropriate level calculated from a base level, shoe-horning deep levels at 6. This is also why we advise against heading levels 4, 5 and 6. NOTE this is not specific to MarkDown.
These are the basic of MarkDown. If you want to know more, checkout this helpful site.
NOTE that while a part of the MarkDown standard is to render
HTMLcode within MarkDown, we do not support this feature, both for security and maintainability reasons.