H1 Heading (#)

This document conveys formatting conventions for MariaDB Documentation. This is a training aid for staff and is used in CSS testing.

Each document has a single H1 which defines the HTML title and the H1 heading for the page.

Copyright © 2019 MariaDB Corporation. All rights reserved.

H2 Heading (*)

This paragraph appears under the H2 heading.

H2 headings appear in Reader Aid. To override automatic H2 RA entry, use H2A heading.

H3 Heading (=)

This paragraph appears under the H3 heading.

H3 headings are the lowest permitted heading level.

Specific Tests

Enhanced TOC

The purpose of an enhanced TOC is to present a side-by-side list of links and the information contained at that link.

Borderless Tables

Borderless tables allow information to be presented horizontally with minimal screen real estate.

FAQ

Frequently Asked Questions provide a question, a complete answer, and assocated metadata.

Figures

Figures visually convey complex patterns and flows to aid understanding.

Borderless Tables

A borderless table allows information to be presented horizontally with minimal screen real estate. Borderless tables are used for the enhanced TOC, but also when displaying lists of values.

1

6

11

16

2

7

12

17

3

8

13

18

4

9

14

19

5

10

15

20

What is a FAQ?

Frequently Asked Questions (FAQ) integrate a question, an answer, and associated metadata.

This answer was last updated 2021-01-04.
This text would typically direct the user to top of page, provide a feedback link, and contact link.

Line Blocks

The following are 2 blocks of lines that have hard line breaks:

line block 1 line 1.
line block 1 line 2.
line block 1 line 3.
line block 1 line 4.
line block 2 line 1.

Figures

A figure (image) appears below this line:

Xpand Isolation Levels

A figure appears above this line.

Italics

These words are italicized. This word is italicized.

Simple UL List

A list appears below this line:

  • Item 1

  • Item 2

  • Item 3

  • Item 4

  • Item 5

A list appears above this line.

Multi-level Unordered List

A multi-level unordered list appears below this line:

  • Item 1

    • Item 1a

      • Item 1a i

      • Item 1a ii

      • Item 1a iii

  • Item 2

    • Item 2a

      • Item 2a i

  • Item 3

    • Item 3a

      • Item 3a i

  • Item 4

    • Item 4a

      • Item 4a i

  • Item 5

    • Item 5a (no nested entries)

    • Item 5b

      • Item 5b i

A multi-level unordered list appears above this line.

Simple OL List

A list appears below this line:

  1. Item 1

  2. Item 2

  3. Item 3

  4. Item 4

  5. Item 5

A list appears above this line.

Multi-level Ordered List

A multi-level ordered list appears below this line:

  1. Item 1

    1. Item 1a

      1. Item 1a i

      2. Item 1a ii

      3. Item 1a iii

  2. Item 2

    1. Item 2a

      1. Item 2a

  3. Item 3

    1. Item 3a

      1. Item 3a i

  4. Item 4

    1. Item 4a

      1. Item 4a i

  5. Item 5

    1. Item 5a (no nested entries)

    2. Item 5b

      1. Item 5b i

A multi-level ordered list appears above this line.

Unordered List with Blocks

An unordered list appears below, containing block level elements:

  • Item 1:

    Second paragraph in Item 1.

  • Item 2:

    A code block appears below this line, in Item 2:

    $ sudo mariadb
    

    A code block appears above this line, in Item 2.

  • Item 3.

    A note appears below this line, in Item 3:

    Note

    First paragraph in Item 3 note.

    Second paragraph in Item 3 note.

    A note appears above this line in Item 3.

Ordered List with Blocks

An unordered list appears below, containing block level elements:

  1. Item 1:

    Second paragraph in Item 1.

  2. Item 2:

    A code block appears below this line, in Item 2:

    $ sudo mariadb
    

    A code block appears above this line, in Item 2.

  3. Item 3.

    A note appears below this line, in Item 3:

    Note

    First paragraph in Item 3 note.

    Second paragraph in Item 3 note.

    A note appears above this line in Item 3.

Comment

A single-line comment is located below this line:

A single-line comment is located above this line.

Multi-line Comment

A multi-line comment appears below this line:

A multi-line comment appears above this line.

FIXME Comments

A FIXME comment appears below this line:

A FIXME comment appears above this line.

TODO

A TODO is located below this line.

Todo

A todo entry

The 2nd paragraph in the todo.

A TODO is located above this line.

Verbatim

This ELEMENT **right here** is verbatim.

Bold

This ELEMENT is bold.

Table

A list table appears below this line:

Header Col 1

Header Col 2

Col 1 Row 1

Col 2 Row 1

Col 1 Row 2

Col 2 Row 2 Line 1
Col 2 Row 2 Line 2

Col 1 Row 3

  • Col 2 Row 3 Bullet 1

  • Col 2 Row 3 Bullet 2

Col 1 Row 4

Col 2 Row 4

A list table appears above this line.

Code Block for SQL

A SQL code block appears below this line followed by a none code block:

SELECT JSON_VALUE(Priv, "$.plugin") AS "Default Authentication",
       JSON_EXTRACT(Priv, "$.auth_or") AS "Alternate Authentications"
FROM mysql.global_priv
WHERE User = 'root' AND Host = 'localhost';
+------------------------+---------------------------------+
| Default Authentication | Alternate Authentications       |
+------------------------+---------------------------------+
| mysql_native_password  | [{}, {"plugin": "unix_socket"}] |
+------------------------+---------------------------------+

A none code block appears above this line.

Code Block for Console

A console code block appears below this line:

$ ls -al | grep -e wumpus | wc -l
$ sudo pwd

A console code block appears above this line.

The $ indicates a non-root user. sudo is used where relevant to indicate when the command should be run as a privileged user.

Code Block for Text

A text code block appears below this line:

SELECT JSON_VALUE(Priv, "$.plugin") AS "Default Authentication",
       JSON_EXTRACT(Priv, "$.auth_or") AS "Alternate Authentications"
FROM mysql.global_priv
WHERE User = 'root' AND Host = 'localhost';

+------------------------+---------------------------------+
| Default Authentication | Alternate Authentications       |
+------------------------+---------------------------------+
| mysql_native_password  | [{}, {"plugin": "unix_socket"}] |
+------------------------+---------------------------------+

A text code block appears above this line.

No syntax highlighting is redenred on a text code block.

Two blocks of indented text appear below:

This text is the start. Each line should be joined and wrapped. It will render in html as a blockquote. That is all!

This is another block of text. Isn't it nice?

The text blocks are above this line.

Code Block for C

A C code block appears below this line:

#include<stdio.h>
#include<stdlib.h>
#include<mysql.h>

MYSQL *conn;

/* Initialize Struct */
if (!(conn = mysql_init(0))){
   fprintf(stderr, "Unable to initialize connection struct\n");
   exit(1);
}

A C code block appears above this line.

Code Block for C++

A C++ code block appears below this line:

try {

      // Instantiate Driver
      sql::Driver *driver = sql::mariadb::get_driver_instance();

      // Configure Connection
      sql::SQLString user("username");
      sql::SQLString passwd("user_passwd");

      // Establish Connection
      sql::Connection* conn(
         driver->connect("jdbc:mariadb://localhost:3306/accounts", user, passwd));

   } catch(sql::SQLException& e){
      std::cerr << "Error Connecting to MariaDB Enterprise: " << e.what() << std::endl;
      return 1;
   }

A C++ code block appears above this line.

Code Block for Java

A Java code block appears below this line:

// Main Process
public static void main(String[] args) {
   Connection conn = null;

   try {

      Properties connProperties = new Properties();

      connProperties.put("user", "db_user");
      connProperties.put("password", "db_user_passwd");

      // Establish the Connection
      conn = DriverManager.getConnection(
            "jdbc:mariadb://localhost",
            connProperties);

   } catch (Exception e) {

         // Report Exception
         e.printStackTrace();
   }
}

A Java code block appears above this line.

Code Block for JavaScript or js

A JavaScript code block appears below this line:

// Add Contacts
async function add_contact(conn, data) {
   // Insert Data
   return await conn.query(
      "INSERT INTO users.contacts (first_name, last_name, email) VALUES (?, ?, ?)",
      [data.first_name, data.last_name, data.email]);
}

A JavaScript code block appears above this line.

Code Block for Python

A Python code block appears below this line:

try:
   conn = mariadb.connect(
      user="connpy_test",
      password="passwd",
      host="localhost",
      port=3306)
except mariadb.Error as e:
   print(f"Error connecting to MariaDB Enterprise: {e}")
   sys.exit(1)

A Python code block appears above this line.

Code Block for XML

An XML code block appears below this line:

<dependency>
   <groupId>org.mariadb.jdbc</groupId>
   <artifactId>mariadb-java-client</artifactId>
   <version>2.6.0</version>
</dependency>

An XML code block appears above this line.

Note Block

A note block appears below this line:

Note

The contents of this block appear in the note.

This is the second paragraph in the note block.

A code block appears below this line, in the note:

$ sudo mariadb

A code block appears above this line, in the note.

Itemized List:

  • Item 1

  • Item 2

Ordered List:

  1. Item 1

  2. Item 2

A note block appears above this line.

Rubric

A rubric appears below this line:

Rubric Title

A rubric appears above this line.

Use rubrics for headings that are not part of the document hierarchy and should not appear in the Reader Aid or the table of contents.

This line appears above H2A.

H2A

This paragraph rewsides under the H2A heading, another h2 example. When this heading is shown in the Reader Aid it is shown as "H2A RA Override" due to the presence of a raw HTML data value following the heading to override its default text.

This paragraph appears above the H3A heading.

H3A

This paragraph rewsides under the H3A heading, another h3 example.

Diffs

Reference uses raw-html diffs such as this one:

  • index_merge=on,index_merge_union=on,index_merge_sort_union=on,index_merge_intersection=on,index_merge_sort_intersection=off,engine_condition_pushdown=off,index_condition_pushdown=on,derived_merge=on,derived_with_keys=on,firstmatch=on,loosescan=on,materialization=on,in_to_exists=on,semijoin=on,partial_match_rowid_merge=on,partial_match_table_scan=on,subquery_cache=on,mrr=off,mrr_cost_based=off,mrr_sort_keys=off,outer_join_with_cache=on,semijoin_with_cache=on,join_cache_incremental=on,join_cache_hashed=on,join_cache_bka=on,optimize_join_buffer_size=offon,table_elimination=on,extended_keys=on,exists_to_in=on,orderby_uses_equalities=on,condition_pushdown_for_derived=on,split_materialized=on,condition_pushdown_for_subquery=on,rowid_filter=on,condition_pushdown_from_having=on

Paragraphs

This is a paragraph.

This is a paragraph. This has an extra line.

This is a paragraph.

This is a paragraph. This has an extra line and even a third line.

This is a paragraph.

"elements-bottom" anchor below