Styles markdown and markdownInline

The SelfHelp app provides two styles to create markdown content:

• markdown renders a complete markdown block, including headings, paragraphs, images, lists, tables, etc.
• markdownInline renders one line of markdown text and can be used to put emphasis to text elements or add inline links.

Both styles use the markdown parser Parsedown.

This Markdown Guide provides an overview of the commonly available markdown syntax. The specifix syntax that is supported by the SelfHelp app can be found on the Parsedown Webpage.

The style field data_config expects a JSON list. In the JSON, we can define how we would like to extract some data from DB and load into the traces. JSON Structure:

 [
    {
        "type": "static|dynamic",
        "table": "table_name | #url_param1",
        "retrieve": "first | last | all",
        "fields": [
            {
                "field_name": "name | #url_param2",
                "field_holder": "@field_1",
                "not_found_text": "my field was not found"              
            }
        ]
    }
]

Example:

 [
    {
        "type": "static",
        "table": "my_table",
        "retrieve": "first",
        "fields": [
            {
                "field_name": "my_field",
                "field_holder": "@field_holder",
                "not_found_text": "my field was not found"              
            }
        ]
    }
]

It means that the code will search the first row in table my_table and it will get the value of field my_field. Then the value will be assigned and if keyword @field_holder is used in text_md, it will be replaced with the found value. If no value was found it will return the predefined string not_found_text.

Images

A custom extension of the functionality of Parsedown allows to specify the size and style of images with a custom syntax:

![__alt__](__path__|__width__x__height__|__css__ "__title__")

where

• __alt__ is the text that is displayed if the image cannot be loaded.
• __path__ is the url of the image (when using an asset simply prepend the name of the asset with %).
• __width__ is the with of the image.
• __height__ is the height of the image.
• __css__ is a comma-seperated list of css classes (no spaces).
• __title__ is the text that is displayed when hovering over the image.

Note that images need to be loaded from the asset folder on the server and can, in general, not be linked by a url. This is blocked due to security reasons (an exception is the url https://via.placeholder.com which is very handy to quickly use placeholder images).

Links

Links are written in the form [Label](link). A link can either be internal or external. An external link can point to any url and must start with a protocol (i.e. http:// or https://). An internal link can point to any page, navigation section, wrapper section, or asset within the SelfHelp domain. Use the same syntax as with the linking styles (refer to the link style documentation).

In addition to this, a link can be prepended with ! which will cause the link to be opened in a new browser tab.