This applies to the “Cockpit” (v2) version of the NLG Cloud platform.
There are various output formats that you can get from the platform, including HTML. This can be used for formatting (h1, bold etc.) and embedding media like links, images and videos.
The formatting is configured in the ruleset, using the markdown notation. Markdown is a way to format text by adding defined symbols to it. See the markdown specification for details.
In the text export, you get the raw output generated in Markdown, but also an HTML formatted output (field "content_html").
Some options for formatting parts of a text are built into our platform for you to be easily configured.
In the style section of a sentence you can select the text formatting in which the sentence will be displayed. The Heading Levels correspond to HTML: Heading is the H1-headline, Heading Level 2 is the H2- headline and so on.
Paragraphs and line breaks
Adding paragraphs or line breaks outside of headlines can be solved by adding "NEWLINE" commands. A double NEWLINE leads to a separate paragraph (<p>), a single one to a line break (<br/>).
You just add the special word "NEWLINE" anywhere in your text and our machine will recognize it.
Group containers can output their lists not only as continuous text, but also as formatted lists, i.e. as ordered lists or bulleted lists.
First you create a group container in your text. Then you can select a format for your list in the "Edit Container" dialog by clicking on FORMATTED LIST OUTPUT:
This will produce a bullet list as output as default, but give you the choice to select "Ordered" which will get you an ordered list output.
The list output is also formatted as markdown in the raw version of texts.
Note: If a sentence that contains an automatically created list is used directly after a headline, a leading space character may interfere with the correct creation of the html output. To mitigate that, start the sentence with a list with the signal word "NEWLINE", so that it starts directly after the line break.
With the following parameters in the Link section in a container configuration dialog you can generate a link from your container output.
text - clickable text in a link
title - title of the link
Rendered output: Example
Rendered output: https://www.example.com
If you want the link text and its URL both to be variable, you can also write the markdown link notation by hand anywhere in the text and make text and url containers.
To generate an image, you can use the parameters in the Image section.
text - alternative text of the image
title - title of the image
Output as markdown (raw):
![Logo](https://www.ax-semantics.com/_Resources/Static/Packages/Noerdisch.AxSemanticsCom/Images/AXS_Logo_web.svg "AX Logo")
Manual Markdown Notation
For all those markdown options we did not cover, you can always directly put the markdown command charakters in your text and our platform will interpret them.
Emphases like italics or bold text are noted with one or two asterisks (*) for example. For a complete list of the markdown notation, please see its documentation.
The format returned from the API is JSON, which encapsulates the HTML, where escaped characters like the JSON newline "\n" is being added. Using a JSON parser to view the output removes those escaped sequences.
You can try this by switching to the "JSON Explorer" view in the API Docs and compare the Raw and JSON Explorer-parsed output.