Language Keybindings About

MWiki Reference Card

Overview ¶

MWiki markup language, also known as MWiki wikicode, is a based on Github-flavored Markdown (GFM). The markup language also is inspired by MyST markdown from Jupyter Book project, Obsidian markdown format and Mediawiki's markup language.

Frontmatter (Page Metadata) ¶

The frontmatter is a YAML section at the beginning of MWiki *.md page file within two triple dashes (---), which contains machine-readable metadata of the current wiki page, including, authors, tags, date, description, abbreviations an dother page settings.

Example: consider the wiki page file

whose content is 

---
author:  John Doe
date:    2022-06-10
description: Survey of NAS - Network Attached Storage devices for reliable backup, data replication and file sharing.

---

Describe what is a NAS 

+ S.M.A.R.T monitoring of disks.
+ SMB file sharing - SAMBA implementation 

...

![[picture-of-synology-nas.png]]

Alternative Document Title ¶

By default, the title of a wiki page is the same as the related mardown file name without the .md file extension. However, it is possible to change a wiki page title by adding the directive 

title:  Name of New title here

to the document frontmatter.

Section (Heading) Enumeration ¶

Section enumeration is disabled by default. It can be enabled by adding the following directive to the document frotmatter. 

section_enumeration: on

It can also be explicit disabled by adding 

section_enumeration: off

or 

section_enumeration: off

Equation Enumeration ¶

The frontmatter directive 'equation_enumeration' allows changing the equation enumeration style. 

equation_enumeration: <style>

The following enumeration styles supported:

More details are provided about this feature in the LaTeX section of this document.

Abbreviations ¶

The frontmatter can be used for defining abbreviations of common words. Consider a wiki page whose the frontmatter is 

---
author:      John Doe
date:        2022-06-10
description: Survey of NAS - Network Attached Storage devices for reliable backup, data replication and file sharing.
abbreviations:
   NAS:  Network Attached Storage Device
   RAID: Redudant Array of Inexpensive Disks
   NFS:  Network File System 
   SMB:  Server Message Block (Windows shares, also known as network shares)
---

Any word defined in the 'abbreviations' section of a YAML frontmatter of a particular wiki page file, it is replaced by the <abbr> html5 element.

For instance if a text of this wiki page is 

Most NAS devides provide Web UI for quickly 
creating SMB network shares, windows shared folders.

Then, it will be rendered to html as 

Most <abbr title="Network Attached Storage Device">NAS</abbr>  
devides provide Web UI for quickly creating 
<abbr title="Server Message Block">SMB</abbr> network shares, 
windows shared folders.

When the mouse is over any abbr text, which has black dashes below it, a pop up window is appears displaying the meaning of the abbreviation. This feature also works on mobile devices, including phones and tablets.

The wordlinks feature allows quickly creating hyperlinks for words defined in the wordlinks section of a frontmatter of a wiki page. This feature is useful for creating hyperlinks to dictionry definitions or Wikipedia articles related to a particular word. For instance consider the following frontmatter of a Wiki page *.md file. 

---
description: Wiki page (note) description here.

abbreviations:
    GUI: Graphics User Interface

wordlinks:
   ZFS:      https://hyperlink-to-wikipedia-of-ZFS
   TrueNAS:  https://link-to-wikipedia-of-TrueNAS

---

Whenever the word ZFS appears in any MWiki, paragraph, quote or bullet list, it is replaced by a hyperlink whose label is the word 'ZFS' and the URL is the corresponding URL to this word defined wordlist YAML dictionary.

For instance, the wiki text 

The file system ZFS is awesome!

is rendered to HTML as 

The file system
<a href=" https://hyperlink-to-wikipedia-of-ZFS" ...>ZFS</a>
is awesome.

The advantage of this feature allows users to turn words of a MWiki page into hyperlinks without modifying the text or defining the hyperlink multiple times as

Comments ¶

Single Line Comment ¶

Any line starting with '%' percent sign is regarded as single line comment and not rendered. NOTE: It is the same comment syntax of MyST markdown used by Jupyter Book project.

Example: 

% single line comment 
  % Other single line comment

Write something here. This line will be rendered.

% Single line comments are not rendered.

Redering:

Info: Rendering Result

Write something here. This line will be rendered.

Multi Line Comment ¶

Mutli line comments are code blocks with {comment} tag. 

Line here.

```{comment}
The multi line comments syntax reuses 
  the syntax of code blocks.
and are not rendered by the markdown processor.
```

Some text after.
Info: Rendering Result

Line here.

Some text after.

Multi line comments can also be written using the command on for rendering the markdown code enclosed in the comment block without needing to delete the {comment} tag and the backticks surrounding the code. 

Line here.

```{comment} on 
The multi line comments syntax reuses 
  the syntax of code blocks.
and are not rendered by the markdown processor.
```

Some text after.

The tag {command} can also be written as {command} off for enabling the rendering/display of the enclosed code.

Text Formating ¶

Italic Text ¶

+ *text in italic*

Rendering:

Bold Text ¶

Syntax: 

**Bold text here**

Example: 

+ Example of syntax of a **bold text**.

Strikethrough Text (Deleted Text) ¶

Example: 

+ Example of ~~Deleted text~~ syntax.

Rendering:

Highlighted Text ¶

A highlighted text must be enclosed by ==. Example: 

this ==text will be higlighted== and remaining of the text.

Rendering:

this text will be higlighted and remaining of the text.

Typographic Notation ¶

MWiki can convert ascii notation, such as (C) to the copyright unicode symbol, (TM) to trademark unicode symbol and other notations to the equivalent unicode symbol.

Example: 

+ Copyright Symbol (C)
+ Copyright Symbol {C}
+ Registered Symbol (R)
+ Registered Symbol (C)
+ Trademark(TM) symbol
+ Trademark{TM} symbol
+ The angle is 60{deg} degrees 
+ The angle is 60{degrees} degrees 
+ The price is 30 {euros}
+ The price is 50 {pounds}
+ The price is 50 {gbp}  (British Pounds)
+ The price is 20 {yens}
+ Pilcrow Symbol {pilcrow} or {pagraph}
+ Section Symbol  {section}

Rendering:

Links to Wiki Pages (also called notes) 

+ [[Link to internal page]]

Rendering:

Raw External Link (1) 

+ <https://www.site.com/some/page>

Rendering:

Raw External Link (2) 

+ <https://www.site.com/some/page>

Rendering:

External Link with Label 

+ [Link label](https://www.site.com/some/page)

Rendering:

Example: 

+ This page presents a study of [control][ceng] engineering and [state-space][ssmodel] models.

[ceng]: https://en.wikipedia.org/wiki/Control_engineering 

[ssmodel]: <https://en.wikipedia.org/wiki/State-space_representation>
      "In control engineering and system identification, a state-space representation is a mathematical model of a physical system specified as a set of input, output, and variables related by first-order differential equations or difference equations. Such variables, called state variables, evolve over time in a way that depends on the values they have at any given instant and on the externally imposed values of input variables. Output variables’ values depend on the state variable values and may also depend on the input variable values."

Rendering:

Hyperlink to Mastodon Handles (User Accounts)

Syntax: 

@<USERNAME>@<SERVER>

Creates a hyperlink to a Mastodon user account. For instance, the Mastodon handle (user account) 

+ @kde@floss.social

is rendered to HTML as 

+  <a href="https://floss.social/@kde" class="link-esternal" ...  >@kde@floss.social</a>

In other words, @kde@floss.social is rendered as hyperlink (link for short) to the Mastodon user account of the KDE project project.

Hyperlink to DOI - Digital Object Identifier (1)

Syntax: 

<doi:$DOI-BIBLIOGRAPHIC-REFERENCE>

Example: 

+ Reference: Time Aware Least Recent Used (TLRU) cache management policy in ICN  <doi:10.1109/ICACT.2014.6779016>

Rendering:

When this DOI hyperlink is rendered, it is expanded to: 

https://doi.org/10.1109/ICACT.2014.6779016

Hyperlink to DOI - Digital Object Identifier (2)

This syntax when rendered yields the raw hyperlink, whose label is the DOI URL.

Syntax: 

<r-doi:$DOI-BIBLIOGRAPHIC-REFERENCE>

Example: 

+ Paper: *Time Aware Least Recent Used (TLRU) cache management policy in ICN*
  + <r-doi:10.1109/ICACT.2014.6779016>

Rendering:

Hyperlink to ArXiv paper

Syntax: 

<arxiv:$ArXivID>
OR:
  <arXiv:$ArXivID>

Example: 

+ See this paper:  <arxiv:1609.06088> - *Time Derivative of Rotation Matrices: a Tutorial*, shiyu zhao, (2016)

Rendering:

The hyperlink <arxiv:1609.06088> when rendered is expanded to following hyperlink. 

https://arxiv.org/abs/1609.06088

Hyperlink to ArXiv paper (Full Hyperlink)

Example: 

+ *Time Derivative of Rotation Matrices: a Tutorial*, Shiyu Zhao, (2016)  
  + <r-arxiv:1609.06088>

Rendering:

Hyperlink to Semantic Scholar

This syntax generates a hyperlink to a research paper listed in Semantic Scholar by its Semantic-Scholar Identifier (ID). 

<S2CID:$SEMANTIC-SCHOLAR-ID> 

  OR:
 
<r-S2CID:$SEMANTIC-SCHOLAR-ID>  
   => Display hyperlink as Link label

Example: 

+ See this article: *Secure Distribution of Protected Content in Information-Centric Networking* - <S2CID:198967720>

Rendering:

Hyperlink to PubMed Paper by PubMed Id (Pmid)

This type of special short hyperlink allows to create a link to research papers in PubMed Central database by using the PMID - PubMed of the research paper.

Syntax: 

<pmid:$PUB-MED-ID-HERE>

Example: 

+ Reference: *Teaching population health: a competency map approach to education* <pmid:23524919>

Rendering:

The special hyperlink <pmid:23524919> is expanded to: 

https://pubmed.ncbi.nlm.nih.gov/23524919

Hyperlink to PubMed Paper by PubMed Id (Pmid) - (Full Link)

Example: 

+ *Teaching population health: a competency map approach to education* 
  + <r-pmid:23524919>

Rendering:

Hyperlink to Patent

Syntax: 

<patent:$PATENT-NUMBER>
OR
  <r-patent:$PATENT-NUMBER>

Example: 

+ Short Link 1: <patent:US9906369>
+ Full Link 1:  <r-patent:US9906369>
+ Short Link 2: <patent:7,139,686>
+ Full Link 2:  <r-patent:7,139,686>

Rendering:

Hyperlink to RFC Standard

Special link to RFC (Request for Comment) technical standards proposed by the IETF (Internet Engineering Task Force).

Syntax: 

<rfc:$RFC-NUMBER> => Short Link
  <r-rfc:$RFC-NUMBER> => Link as label

Example: 

+ See <rfc:7231> - Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content

+ See <r-rfc:7231> - Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content

Rendering:

Hyperlink to PEP (Pyhton Enhancement Proposal)

Syntax: 

<pep:$PEP-NUMBER>
OR:
  <r-pep:$PEP-NUMBER>

Example: 

+ See: Python WSGI - Webserver Gateway Interface  <pep:333> 
+ See: Python WSGI - Webserver Gateway Interface  <r-pep:333>

Rendering:

Hyperlink to Python Package

Syntax: 

<pypi:$PACKAGE-NAME>
OR:
  <r-pypi:$PACKAGE-NAME>

Example: 

+ Pyhton <pypi:sqlitedict> package 
+ Python sqltedict package, available at <r-pypi:sqlitedict>

Rendering:

Hyperlink to CVE - Common Vulnerability Exposures

This special link syntax allows creating hyperlinks to the CVE (Common Vulnerability Exposure) database given the CVE unique identifier.

Syntax: 

<cve:$CVE_NUMBER>
or
 <CVE:$CVE_NUMBER>

Example: the link shortcut 

+  <cve:CVE-2024-53104>

is equivalent to the hyperlink 

+ [CVE-2024-53104](https://www.cve.org/CVERecord?id=CVE-2024-53104)

and is rendered to html as

Hyperlink to Subreddit

Syntax: 

<rd:/r/$NAME-OF-SUBREDDIT>

or

<reddit:/r/$NAME-OF-SUBREDDIT>

Example: 

+ C++ Subreddit <rd:/r/cpp> 
+ <reddit:/r/smalltalk>

Rendering:

The hyperlink <rd:/r/cpp> is a hyperlink to

Image ¶

Internal Image ¶

The syntax for internal Wiki images is based on Obsidian's markdown syntax for embedding files on pages. It is not necessary to specify the full path or relative path of an image file as it will be displayed regardless of the sub directory it is located within the wiki pages repository.

Syntax: 

![[image_file.png]]

Or 

![[relative/path/to/images/image_file_name.png]]

External Image ¶

Hyperlink to external image. The image URL can be a relative URL as shown in the example below or a URL of type https://www.site.com/files/image.png .

Syntax: 

![$IMAGE-ALT-TEXT-DESCRIPTION]($IMAGE-URL)

Example: 

![Java's Duke Mascot](/static/example_java_duke_mascot.svg)

Rendering:

Java's Duke Mascot

Figures ¶

Figures are images with metadata, including automatic enumeration with optional attributes such as caption (also known as label), unique identifier and alt text (alternative text) for better accessibility.

Figure of external image ¶

A figure of an external image uses URL (Universal Resource Locator) for external images possibly loaded from other websites. In the following example the image example_java_duke_mascot.svg is loaded from a external URL of a ficticious web site https://some-web-site.com.

Example: 

```{figure} https://some-web-site.com/pictures/example_java_duke_mascot.svg
:width: 200px
:alt: Java duke mascot, one of the symbols of the Java programming language.

Java's Duke mascot
```

Rendering:

Java duke mascot, one of the symbols of the Java programming language.

1: Java's Duke mascot

Figure of Internal Image ¶

Example: 

```{figure} ![[logo-java-coffee-cup.png]]
:name: unique-identifier-of-the-image-optional
:height: 200px
:alt: An iconic symbol of the Java programming language. Note the alt text should provide a detailed description of the image for better accessibility.

Java coffee cup symbol. 
```

Note that internal images can be uploaded by copying and pasting images to the MWiki code editor or by manual upload using the editor button with label 'Link to Uploaded File'.

Uploading images by copying and pasting images:

Now when an user pastes an image from the clipboard in the wiki editor with Ctrl+V or by clicking with mouse right button for opening the context menu and clicking at paste, the image is uploaded to the server and the editor inserts the following template code for a figure containing a reference to the pasted image pasted-image-1754432753336.jpg. 

```{figure} ![[pasted-image-1754432753336.jpg]]
:name: 
:alt: Optional Alt text (alternative) text for accessibility

Optional Figure caption here.
```

Then, then user can change the label/caption, optional alt text, optiona name (unique) identifier for cross referencing and also add the attributes :width: 150px or height: 100px.

Videos ¶

Embed Youtube Video ¶

Embed Youtube video given its ID (Unique Identifier) or URL.

Syntax: 

{youtube}`<VIDEO-URL-OR-ID>`

Example

Embed video 3 Hours of Most Common Logical Fallacies to Fall Asleep To, whose URL is

Code example: 

{youtube}`https://www.youtube.com/watch?v=bNE4uBMsnP0`

or

{youtube}`bNE4uBMsnP0`

Embed Uploaded Video Files ¶

MP4 or WEBM video files can be embedded in the current page by using the syntax. 

![[video-file-to-be-embedded.mp4]]

or 

![[video-file-to-be-embedded.webm]]

Embedded video files are rendered as html5 embedded element with controls for playing the video, including button for start playing the video, button for stopping the video and so on.

NOTE: It is possible to upload video files directly in the wiki editor by clicking at the button with label 'Link to Uploaded File' in the editor toolbar section 'insert'.

Video Blocks ¶

Video blocks {video} are similar to {figure} blocks, they allow embeding videos with metadata.

Syntax for internal videos uploaded to the Wiki. This code is auomtically inserted in the editor after successful upload of a webm or mp4 video. 

```{video}  ![[name-of-internal-video.webm]]
:name: Unique ID - Identifier.
:alt: Alt text, video description optional metadata.
    
Video caption (also known as label)
```

Syntax for external videos. 

```{video}  https://somedomain.com/files/video.mp4
:name: Unique ID - Identifier.
:alt: Alt text, video description optional metadata.

Video caption (also known as label)
```

Code Blocks ¶

Inline code ¶

Inline code must be surrounded by backtick character (`).

Example: 

+ The wiki syntax `<rfc:7231>` is rendered to a hyperlink to 
http 1.1 standard from IETF <rfc:7231>

Rendering:

Code Block ¶

Example python source code block: 

```python
# Code for listing root directory 
import os 
for x in os.listdir("/"):
    print(x)
```

Rendering: 

# Code for listing root directory 
import os 
for x in os.listdir("/"):
    print(x)

Quotes ¶

Quotion Syntax

Example: 

> Let us change our traditional attitude to the construction of programs: Instead of imagining that our main task is to instruct a computer what to do, let us concentrate rather on explaining to humans what we want the computer to do.
> - -- Donald E. Knuth, Literate Programming, 1984

Rendering:

Let us change our traditional attitude to the construction of programs: Instead of imagining that our main task is to instruct a computer what to do, let us concentrate rather on explaining to humans what we want the computer to do.

  • -- Donald E. Knuth, Literate Programming, 1984

Quotation Syntax Using Code Block

Example: 

```{quote}
Let us change our traditional attitude to the 
construction of programs: Instead of imagining that 
our main task is to instruct a computer what to do, 
let us concentrate rather on explaining to humans 
what we want the computer to do.
  -- Donald E. Knuth, Literate Programming, 1984
```

Rendering:

Let us change our traditional attitude to the construction of programs: Instead of imagining that our main task is to instruct a computer what to do, let us concentrate rather on explaining to humans what we want the computer to do. -- Donald E. Knuth, Literate Programming, 1984

LaTeX Math Equations ¶

Inline ¶

Let $x \in \mathbb{R}$ be a real number and $f(x) = \sqrt{x^2 - 10}$.

Rendering:

Let \(x \in \mathbb{R}\) be a real number and \(f(x) = \sqrt{x^2 - 10}\).

Display Mode ¶

$$
    A = \begin{bmatrix} 
              \alpha &  \beta 
          \\  \gamma &  \zeta 
        \end{bmatrix}
$$

Rendering:

$$ A = \begin{bmatrix} \alpha & \beta \\ \gamma & \zeta \end{bmatrix} $$

Display Mode Without Enumeration ¶

$$
  \notag 
    A = \begin{bmatrix} 
              \alpha &  \beta 
          \\  \gamma &  \zeta 
        \end{bmatrix}
$$

Rendering:

$$ \notag A = \begin{bmatrix} \alpha & \beta \\ \gamma & \zeta \end{bmatrix} $$

Display Mode using Code Block Syntax ¶

Example: 

```{math}
  \notag 
    A = \begin{bmatrix} 
              \alpha &  \beta 
          \\  \gamma &  \zeta 
        \end{bmatrix}
```

Rendering:

$$ \notag A = \begin{bmatrix} \alpha & \beta \\ \gamma & \zeta \end{bmatrix} $$

Equation Enumeration Style ¶

MWiki supports the following LaTeX equation enumeration styles

that can be changed by adding the next line to the document front-matter as shown in the following code example. Note that the front-matter is a human-readable human configuration in the markdown code between the lines containing '---' (three dashes) at the beginning of the page.

Front-matter example: 

```
---
description: Description of the document
equation_enumeration: subsection
  ... ... ... ... ... 
  ... ... ... ... ... 
---
```

Example consider the remaining of the page source code below after the front-matter.

Remaining of the wiki page source after the front-matter. 

## Section 1 

Introduction ....

$$
   % equation (A)
   f(x) = x^2 - 2x + 10
$$

Root of the equation

$$
   % equation (B)
   x = ....
$$


### Subsection 1.1

Quadratic formula.

$$
   % equation (C)
   x = \frac{-b \pm \sqrt{b^2 - 4ac}}
$$

Cubic function 

$$
  % equation (D)
  f(x) = x^3
$$

## Section 2

### Section 2.1

Equation 1 of section 2.1

$$
  % Equation (F)
  y = 2 x + 10
$$

Equation 2 of section 2.2

$$
  % Equation (G)
   b = y - 10
$$

Cross Reference To LaTeX Equations ¶

Example: 

Pendulum position vector $\mathbf{r}(t)$.

$$
  \label{eq_pendulum_position_vector}
  \mathbf{r}(t) = \ell \sin \theta(t) \mathbf{e}_x + \ell \cos \theta(t) \mathbf{e}_y
$$


The velocity of a point mass, a body with negligible dimensions, is given by

$$
   \label{eq_def_velocity}
   \mathbf{v}(t) = \frac{d \mathbf{r}}{dt} = \dot{\mathbf{r}}(t)
$$


Compute the velocity of the pendulum point-mass by replacing $\eqref{eq_pendulum_position_vector}$  in $\eqref{eq_def_velocity}$.

$$
   \mathbf{v}(t) = \frac{d}{dt} [ \ell \sin \theta(t) \mathbf{e}_x + \ell \cos \theta(t) \mathbf{e}_y ]
$$

Redering:

Note: Rendering Output

Pendulum position vector \(\mathbf{r}(t)\).

$$ \label{eq_pendulum_position_vector} \mathbf{r}(t) = \ell \sin \theta(t) \mathbf{e}_x + \ell \cos \theta(t) \mathbf{e}_y $$

The velocity of a point mass, a body with negligible dimensions, is given by

$$ \label{eq_def_velocity} \mathbf{v}(t) = \frac{d \mathbf{r}}{dt} = \dot{\mathbf{r}}(t) $$

Compute the velocity of the pendulum point-mass by replacing \(\eqref{eq_pendulum_position_vector}\) in \(\eqref{eq_def_velocity}\).

$$ \mathbf{v}(t) = \frac{d}{dt} [ \ell \sin \theta(t) \mathbf{e}_x + \ell \cos \theta(t) \mathbf{e}_y ] $$

Latex Macros ¶

It is possible to define LaTeX macros for writing math expressions in a more concise wayby using a code block similar to the example below on the top of the page. This specialcode block is not rendered, it is processed by MathJax or other LaTeX rendering engines. 

```{latex_macro}
% Logical AND 
\DeclareMathOperator{\\and}{ \\wedge }
% Logical OR
\DeclareMathOperator{\\or}{ \\vee }

 % ---- OR add your OWN LaTeX Macros here ------%%

```

After adding the previous macro to the top of the page, one can write logical expressions \(\neg (p \wedge q)\), which means not (p and q) or NAND(p, q), in the following form: 

$$
\neg (p \and q) \equiv \neg p \or q
$$

Pseudocode of Algorithm ¶

This wiki also supports LaTeX pseudocode of algorithms compatible with LaTeX algorithmic package. The implementation of this feature relies on pseudocode-js and MathJax JavaScript libraries.

Example: 

```{pseudo}
\begin{algorithm}
\caption{Buble Sort Algorithm}
\begin{algorithmic}
\PROCEDURE{BubbleSort}{$A, n$}
   \STATE $B = $ \CALL{CopyArray}{$A, n$}
   \STATE $\:$ \textit{// i = 0, 1, ..., n - 1}
   \FOR{$i = 0$ \TO  $i < n$}
       \STATE $\:$ \textit{// j = 0, 1, ..., n - 2 }
       \FOR{$j = 0$ \TO $j < n - 1$}
           \IF{$B[j] > B[j+1]$}
               \STATE swap $B[j]$ with $B[j+1]$
           \ENDIF
       \ENDFOR
   \ENDFOR
   \RETURN{$B$}
\ENDPROCEDURE
\end{algorithmic}
\end{algorithm}
```

Rendering: 

\begin{algorithm}
\caption{Buble Sort Algorithm}
\begin{algorithmic}
\PROCEDURE{BubbleSort}{$A, n$}
   \STATE $B = $ \CALL{CopyArray}{$A, n$}
   \STATE $\:$ \textit{// i = 0, 1, ..., n - 1}
   \FOR{$i = 0$ \TO  $i < n$}
       \STATE $\:$ \textit{// j = 0, 1, ..., n - 2 }
       \FOR{$j = 0$ \TO $j < n - 1$}
           \IF{$B[j] > B[j+1]$}
               \STATE swap $B[j]$ with $B[j+1]$
           \ENDIF
       \ENDFOR
   \ENDFOR
   \RETURN{$B$}
\ENDPROCEDURE
\end{algorithmic}
\end{algorithm}

Table ¶

Example: 

|  German          |   English         |
|------------------|-------------------|
| Deutsch          | German            |
| ja               | yes               |
| jetzt            | now               |
| nein             | no or not         | 
| hallo Welt       | hello World       |
| hallo Leute      | hello people      |
| willkomen        | welcome           |
| Hilfe            | Help              |
| die Zeit         | time              | 
| die Einstellugen | settings (plural) |
| die Kunst        | art               |
| die Freiheit     | freedom, liberty  |
| die Menschen     | people            |
| die Wirtschaft   | the economy       |
| das Ding         | thing, stuff      |
| das Miteglied    | member            |

Rendering:

German English
Deutsch German
ja yes
jetzt now
nein no or not
hallo Welt hello World
hallo Leute hello people
willkomen welcome
Hilfe Help
die Zeit time
die Einstellugen settings (plural)
die Kunst art
die Freiheit freedom, liberty
die Menschen people
die Wirtschaft the economy
das Ding thing, stuff
das Miteglied member

Lists ¶

Bullet Lists ¶

Example: 

+ Element 1 
+ Element 2 
  + Element 2.1
  + Element 2.2
+ Element 3
  + Element 3.1
  + Element 3.2
     + Element 3.2.1
     + Element 3.3.1

Rendering:

Ordered List ¶

Example: 

1. Element 1
2. Element 2
   1. Element 2.1
   2. Element 2.2 
3. Element 3
   1. Element 3.1
   2. Element 3.2
   3. Element 3.3
      + Element 3.3.1
      + Element 3.3.2
   4. Element 3.4
4. Element 4

Rendering:

  1. Element 1
  2. Element 2
    1. Element 2.1
    2. Element 2.2
  3. Element 3
    1. Element 3.1
    2. Element 3.2
    3. Element 3.3
      • Element 3.3.1
      • Element 3.3.2
    4. Element 3.4
  4. Element 4

List of Checkboxes / List of Tasks ¶

Example: 

+ [x] Implement full text search.
+ [ ] Implement a revision control system.

Rendering:

Definition Lists ¶

Example: 

HTML 
   : Hypertext Markup Language 

DOM 
   : Domain Object Model 
   : Object that represents a parsed HTML tag in the memory.

WWW
   : World Wide Web

Rendering:

HTML
Hypertext Markup Language
DOM
Domain Object Model
Object that represents a parsed HTML tag in the memory.
WWW
World Wide Web

Footnotes ¶

Footnote Reference ¶

Syntax 1: Compatible with MyST markdown and Obsidian markdown. 

+ The motor speed is 300 rmp^[revolutions per minute].

Rendering:

Syntax 2: Only used by MWiki, but it does not conflict with any markdown syntax such as [label](http://some-site.com). 

+ Ship speed is about 30 knots^{Nautical miles per hour}.

Rendering:

Footnotes listing ¶

The following code lists all footnotes of current wiki page. 

```{footnotes}
```

Rendering:

[1] revolutions per minute

[2] Nautical miles per hour

Admonitions (Callout Boxes) ¶

Info Admonition ¶

:::{info}
Give some information to the user.
:::

Rendering:

Info

Give some information to the user.

Tip Admonition ¶

:::{tip}
Try changing `tip` to `warning`!
:::

Rendering:

Tip

Try changing tip to warning!

Note Admonition ¶

:::{note}
Make sure to check the relative error before stopping 
the iterations.
:::

Rendering:

Note

Make sure to check the relative error before stoppingthe iterations.

Warning Admonition ¶

:::{warning}

Make sure that device is fully charged before installing the firmware. Otherwise, it the device **may not be able to reboot**.
:::

Rendering:

Warning

Make sure that device is fully charged before installing the firmware. Otherwise, the device may not be able to reboot.

Foldable Admonition ¶

:::{note}
:class: dropdown

This is initially hidden, and can be clicked to be opened when you are viewing the content.
:::

Rendering:

Note

This is initially hidden, and can be clicked to be opened when you are viewing the content.

Mathematical Definition Admonition ¶

Example: 

:::{def} Inverse Matrix 
:label: inverse-matrix

The inverse matrix $A^{-1}$ of a matrix $A: n \times n$ is defined as a matrix that when multiplied by the square matrix A yields the identity matrix. Note that not always an inverse matrix of a square matrix Q exists. 

$$
  \notag
   A^{-1} A \triangleq A^{-1} \triangleq \mathbf{I}
$$

:::

Rendering:

: (Inverse Matrix)

The inverse matrix \(A^{-1}\) of a matrix \(A: n \times n\) is defined as a matrix that when multiplied by the square matrix A yields the identity matrix. Note that not always an inverse matrix of a square matrix Q exists.

$$ \notag A^{-1} A \triangleq A^{-1} \triangleq \mathbf{I} $$

Mathematical Theorem Admonition ¶

Example: 

:::{theorem} Determinant of Orthogonal Matrix  

The determinant of a **orthogonal matrix** $Q \in \mathbb{R}^{n \times n}$ of n rows and n columns is always 1.

$$
 \notag 
  \det(Q) = 1
$$


```{proof}

$$
\notag 
\begin{split}
      \det (Q Q^T)      &= \det(Q) \det(Q^{T}) 
   \\ \det (Q Q^T)      &= \det(Q) \det(Q) 
   \\ \det (Q Q^{-1})   &= \det(Q) \det(Q) 
   \\ \det (\mathbf{I}) &= \det(Q)^2
   \\  1                &= \det{Q}^2
   \\  \det(Q)          &= 1
\end{split}
$$
```
% --- end determinant proof ---

:::

Rendering:

1: (Determinant of Orthogonal Matrix)

The determinant of a orthogonal matrix \(Q \in \mathbb{R}^{n \times n}\) of n rows and n columns is always 1.

$$ \notag \det(Q) = 1 $$
$$ \notag \begin{split} \det (Q Q^T) &= \det(Q) \det(Q^{T}) \\ \det (Q Q^T) &= \det(Q) \det(Q) \\ \det (Q Q^{-1}) &= \det(Q) \det(Q) \\ \det (\mathbf{I}) &= \det(Q)^2 \\ 1 &= \det{Q}^2 \\ \det(Q) &= 1 \end{split} $$

Example of solved exercise ¶

:::{example} Chain Rule for Derivative Multi-Variate Functions

Let the function f be $f(x, y) = x^2/A^2 + y^2/B^2 - C$.  Find the derivative of f with respect to t. And x and y are functions of t, $x = x(t) = A \cos t$ and $y = y(t) = B \sin t$. 


```{solution}   
$$
 \notag 
\begin{split}
  \frac{df}{dt} 
    &= \frac{\partial f}{\partial x} \frac{dx}{dt}  
    + \frac{\partial f}{\partial y} \frac{dy}{dt}  \\

    &=  \frac{\partial}{\partial x} (x^2/A^2 + y^2/B^2 - C) 
           \frac{d}{dt} ( A \cos t)
       \\ & +  \frac{\partial}{\partial y} (x^2/A^2 + y^2/B^2 - C) 
           \frac{d}{dt} ( A \sin t)  \\

    &=  (2x/A^2) (-A \sin t) + (2y/B^2) (A \cos t) \\ 
    &=  -2x \sin(t) / A + 2y \cos(t) / B \\
    &=  -2(A  \cos(t)) \sin(t) / A + 2(B  \sin(t)) \cos(t) / B \\
    &=  -2 \cos t  \sin t  + 2 \sin t  \cos t \\ 
    &=  0 
\end{split}
$$
```
:::

Rendering:

MyST Roles ¶

The MyST Roles are similar to MyST directives, but they are single line. Exmaple:

Syntax: 

{rolename}`text content here`

Raw Text ¶

This MyST role renders a text to itself without the text being interpreted to anything and without any escape character.

Syntax: 

{r}`enclosed text` or {raw}`enclosed text`

Example: 

+ {r}`<a href="https://site.com">label</a>`

Rendering:

Note that the markdown rendered to the enclosed text within backticks "`" and not interpreted as a hyperlink.

Underline text ¶

Makes a any text underline.

Example: 

{u}`underline text`

Rendering:

Abbreviation ¶

This syntax defines abbreviation of acronyms, that is rendered to an <abbr> html5 tag. The description of the acronym is shown in a popup window that appears when the user hoovers the mouse on the the abbreviation element.

Syntax: 

{abbr}`$ACRONYM  ($DESCRIPTION)`

Example: 

+ This wiki engine provides a syntax closer to {abbr}`MyST (Markedly Structured Text)`.
+ {abbr}`HTML (Hypertext Markup Language)` is a declarative language.

Rendering:

Text Notes ¶

This MyST role (not available by default in MyST) allows adding notes to text that are displayed in a popup window in a similar way to the abbr MyST role for abbreviations.

Syntax: 

{note}`[TERM or SENTENCE] ([NOTE])`

For instance, consider the following markdown code 

+ A python {note}`dictionary (This data structure is a hash table)` has type Dict[key, value].

which is rendered as

The term "dictionary" is displayed with underline dots. When the user clicks at this text, a popup window containing the note "This data structure is a hash table" is shown to the user.

Math Role for Inline LaTeX ¶

+ The math expression  {math}`x^2 - 10x + 20` the previous function.

Rendering:

Subscript Role ¶

+ Water: H{sub}`2`O

Rendering:

Superscript Role ¶

Superscript Roles: 

+ The 7{sup}`th` element.

Rendering:

Further Reading ¶