Module:SchemaDiagram/doc

From Bonkipedia
< Module:SchemaDiagram
Revision as of 23:24, 30 June 2021 by [[mw:]]>Izno (uses tstyles)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This is the documentation page for Module:SchemaDiagram

Usage

Lua error: Internal error: The interpreter has terminated with signal "24".
{{#invoke:SchemaDiagram|render|
|layout= [
  { "title": "User",
    "color": "#C5E8B4",
    "tables": [
      [ "user" ],
      [ "user_properties", "user_newtalk" ]
    ]
  }
]
|sql_page=SchemaDiagram/sql/mediawiki-1.34.0.txt
}}

Lua error: Internal error: The interpreter has terminated with signal "24".

Parameters

caption
(Optional) Some wikitext to render above the diagram in a yellow caption.
layout
(Required) JSON structure that describes the database table groups (see below).
sql_page or sql
(Required) SQL "CREATE TABLE" syntax. Can either be the title of a page that contains it (e.g. Template:SchemaDiagram/sql/…), or a literal string.

Layout

The layout JSON structure is an array of objects, where each object describes a group of one or more database tables.

Each group object requires the following properties:

title
Name of the group to display.
color
CSS color value, to use as background color (using light pastel colors is the convention).
tables
An array of arrays of table names. The first level are columns.

See also