Skip to main content

[en] XML elements in Markdown

[en] Some DocBook XML elements are treated in a particular way when publishing to Markdown. This can be because of specific Markdown requirements, or because there is no Markdown equivalent for said elements.

[en] Admonitions

[en] Admonitions (such as Tips or Cautions) with titles, as well as all Notice and Danger admonitions are rendered as regular Markdown blockquotes. Notes, warnins and other admonitions that have an equivalent in Markdown, will be rendered as such.

260203_MD_Note_Regular.png

[en] A regular Note

260203_MD_Note_Title.png

[en] A Note with a title, output as a regular Markdown blockquote

[en] Info elements

[en] The following info elements are supported in Markdown output:

Anmerkung

[en] This applies to info elements at publication level.

  • [en] abstract

  • [en] copyright

  • [en] subtitle

  • [en] title

[en] These info elements are output as a Markdown header table.

260203_MD_Info_Elements.png

[en] Ordered lists

[en] Setting the numeration style (such as loweralpha, or lowerroman) does not affect the Markdown output, since they are not supported in Github Flavored Markdown. Instead, the default style defined by the browser is used.

[en] Inline elements and styles

[en] Many inline styles and XML elements do not have logical counterparts in Markdown. They will therefore be rendered as plain text. The list below is not exhaustive, but lists some of the most often used styles and elements for which there is no Markdown equivalent.

  • [en] Overline (style)

  • [en] guilabel

  • [en] tag

  • [en] bibliography and sybelements

[en] Tables

[en] There are a few limitations in Markdown concerning tables:

  • [en] Table footer rows are converted to regular table rows.

  • [en] Table titles and captions will be placed below the table, unless the table contains cell-spans (merged cells), in which case they will be placed above the table.

  • [en] Width and alignment information for tables will be discarded.

  • [en] A table without. header row will automatically get an empty header row in the Markdown output, since Markdown syntax requires a header row.

[en] Video

[en] Embedded video content will be converted to a link to the video URL