The Guide and VBMapp controllers allow for the specification of the format of the resulting content. At this time, two formats are supported: HTML and Plain Text.
The format is chosen by specifying the X-DocType header as either 'text' or 'html'. The default format is HTML.
HTML Format
When the HTML format is specified, or no X-DocType is specified, the resulting text embedded in the various JSON nodes will contain text formatted as HTML. This allows for complete styling of the resulting text.
HTML Styles
The table below lists the HTML classes that are used to style the documents. Clients may provide their own CSS to attach styles to these elements to style the documents as needed.
HTML Element | Class | Description |
---|---|---|
DIV | table_header | A header above a table of information |
DIV | table_desc | A description above a table of information and below table_header |
TABLE | table_definitions | A table of definitions |
TH | col1 | The 1st header column of a table |
TH | col2 | The 2nd header column of a table |
TD | col1 | The 1st data column of a table |
TD | col2 | The 2nd data column of a table |
Plain Text Format
When the Plain Text format is specified, the resulting JSON nodes will contain text that is only formatted with only line feeds (LF - 0x0A) and horizontal tab (TAB - 0x09) characters for formatting.