RML Document Structure - RmlUi Documentation

<rml>

All RmlUi documents begin with the <rml> element. The element should contain two children, <head> and <body>, as shown in the following basic structure of a document.

<rml>
	<head>
		<title>...</title>
		<link type="text/rcss" href="style.rcss"/>
		...
	</head>
	<body>
		...
	</body>
</rml>

<head>

The <head> element contains information about the current document, such as its title, style and template information is references. No information in the header is rendered.

<title>

The <title> element contains the title of the document. This is often used for the specifying the contents of the title bar of a game window.

<link>

The <link> element is used to specify additional resources the document requires.

Attributes

type = cdata (CI)

Type of link, which should be one of:

text/rcss - RmlUi Style Sheet Specification
text/template - RmlUi Template

href = cdata (CS)

Specifies the source URI, relative to the document being parsed.

<script>

The <script> element can be used to integrate scripting capabilities. A plugin is required to handle the script, such as the Lua plugin.

Attributes

src = cdata (CS): Specifies the source URI, relative to the document being parsed.

If the src attribute is not present, the element is an inline script whose content represents the script to run.

<body>

The <body> element contains the document’s content. All elements within the <body> tag become part of the document tree and are processed during layout, as determined by the active style sheets.