RML Document Structure
<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
- text/script - RmlUi script
href
= cdata (CS)- Specifies the source URI, relative to the document being parsed.
<body>
The body of a document contains the document’s content. All elements within the <body>
tag is laid out and rendered by RmlUi based on the active style sheets.