Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

(this page was created automatically. In case of formatting issues, please visit the official Wiki Page)

Page Template

This page will give a systematic guide on the structure and required content of component-pages in this Wiki. Furthermore, it will outline rules on the formatting of text and images.

...

  • Tokens: a table of all usable tokens and a short description of their effect
  • Structure & Layout: measurements, spacing, adaptive layout variation
  • Styling: color, custom measurements
  • Actions & Variants: interaction, transitions, variants
  • Testing: automated testing
  • Data Source: requirements, implimentation

Not every component needs every section. Conversely, a new section can be created if necessary. Each section can include subsections (using Headings (h4) for clarity) if plausible.

...

The Documentation has 4 types of tags: draft, new, updated, caution.

Life cycle of tagsImage RemovedLife cycle of tagsImage Added

Syntax:

---
title: 
note: 
tags:
- (place the tag name written in lowercase letters here)
--- 

...

A note at the start of the page might give further information on the critical content.

...

Alerts

Alerts are colored boxes that can be placed at the beginning of a page, under der h1 heading. They give general information about the following article. There are two types of notes:

...

> [!WARNING]
> Text inside the alert.

Example:

[!WARNING] This component might not work as intended. Please use with caution.