Module:SchemaDiagram/doc
This is a documentation subpage for Module:SchemaDiagram. It contains usage information, categories and other content that is not part of the original Module page. |
Usage
editUser
|
|
{{#invoke:SchemaDiagram|render| |layout= [ { "title": "User", "color": "#C5E8B4", "tables": [ [ "user" ], [ "user_properties", "user_newtalk" ] ] } ] |sql_page=SchemaDiagram/sql/mediawiki-1.34.0.txt }}
This module uses TemplateStyles: |
Parameters
editcaption
- (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
orsql
- (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
editThe 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.