Markdown guide

Markdown is a simple markup language that can be converted to plain HTML. Here are some of the basic elements you can use.

Headings

Available in: Club pages Tournament pages

You can create headings by placing # in front of your text. The number of # determines the level of the heading.

# Heading 1
## Heading 2
### Heading 3

Text formatting

You can make text bold by placing it between two **. To make text italic, place it between two two _. With ==text== you highlight it.

**This text is bold**
_This text is italic_

Lists

You can create unordered lists by placing - in front of your list items.

- Element 1
- Element 2
- Element 3

Ordered lists can be created by placing the number and a dot in front of the list elements.

1st element 1
2. element 2
3. element 3

In the forum a line such as 1. element does not become a numbered list on its own, so game notation like 1. e4 e5 is not broken. Numbered lists are therefore not available there.

Available in: Club pages Tournament pages

You can create links by putting the link text in square brackets [] and the URL in round brackets ().

[Linktext](https://www.example.com)

However, most links are also automatically recognized and converted into clickable links. That works everywhere, in the forum too.

Quotes

You can create quotes by prefixing the text with a >.

> This is a quote

Horizontal lines

Available in: Club pages Tournament pages

You can create horizontal lines by writing three or more - in a line.

This allows you to separate sections.

---

Create new page (like wiki links)

Available in: Club pages Tournament pages

You can create a new page by placing the link text or page name in double square brackets [[ ]].

The page is created automatically when it is called up and can then be edited.

[[target page]]

or

[[Target page|Displayed text]]

Folders for pages

Available in: Club pages Tournament pages

Club and tournament pages can be organized into folders. To do this, enter a path as the page name when creating or renaming a page, with a slash between the folder and the page.

Handbook/Rules

The part before the last slash is the folder, the rest is the page name. In the page overview the pages then appear under their folder. Folders emerge from the names alone, you do not have to create them separately. Nesting is possible, for example Handbook/Tournaments/Rules. To move a page into another folder, simply rename it with a new path.

Within a folder, pages can be referenced briefly and relatively with wiki links. There are three cases.

  • [[Name]] without a slash refers relatively to a page in the same folder. On the page Handbook/Rules, [[Registration]] therefore leads to Handbook/Registration.
  • [[Folder/Name]] with a slash refers absolutely from the top level, regardless of the current folder. [[Tournaments/Results]] always leads to Tournaments/Results.
  • [[/Name]] with a leading slash deliberately refers absolutely to a page at the top. This is how you link a top-level page from within a folder, for example [[/Imprint]].

The relative and absolute resolution works the same way on tournament pages.

Usernames

The user name is automatically linked and displays information about the user on mouseover.

<user name="shaack"/>

or in short form

<user id="shaack"/>

Parameters

  • name: name of the user (required)

id is an equivalent alias for name; it is what the <user id="name"/> short form expands to.

Diagrams

You can create chess diagrams with the following syntax.

The FEN goes inside the tag, everything else is a parameter on the opening tag.

<diagram>rnbqkbnr/ppp1pppp/8/3p4/3P4/8/PPP1PPPP/RNBQKBNR w KQkq - 0 1</diagram>
<diagram interactive="false" size="xs">rnbqkbnr/ppp1pppp/8/3p4/3P4/8/PPP1PPPP/RNBQKBNR w KQkq - 0 1</diagram>
<diagram markers="d4-success d5-danger" arrows="e2e4-warning">rnbqkbnr/ppp1pppp/8/3p4/3P4/8/PPP1PPPP/RNBQKBNR w KQkq - 0 1</diagram>

This spelling works the same on club pages, on the pages of manual tournaments and in the forum.

The self-closing form with the FEN as a parameter is still read as well, as is the old <fen>…</fen> from the forum. Both produce the same diagram.

<diagram fen="rnbqkbnr/ppp1pppp/8/3p4/3P4/8/PPP1PPPP/RNBQKBNR w KQkq - 0 1"/>

Parameters

  • fen: FEN notation of the diagram, when it is not inside the tag (value is an alias)
  • interactive: Allows pieces to be moved (true or false, optional, default: true)
  • size: Maximum size of the diagram (xs, sm, md, lg, optional, standard: md)
  • orientation: The color shown at bottom (white, black or auto, optional, default: auto)
  • markers: Coloured field markers, space-separated as square-colour, e.g. markers="e4-danger d5-warning f3-success" (optional)
  • arrows: Coloured arrows, space-separated as fromto-colour, e.g. arrows="e2e4-success d7d5-danger" (optional)

The colours for markers and arrows are warning (orange), danger (red), success (green) and info (blue).

Commented games

Available in: Forum

You can put a whole game into a posting as PGN. It is shown as a replayable game with a board.

<pgn>
[White "shaack"]
[Black "Maiholz"]

1. e4 e5 2. Nf3 Nc6 3. Bb5 {Ruy Lopez} a6
</pgn>

Nothing inside <pgn> is read as markdown, the text reaches the board exactly as you wrote it. Line breaks are kept. For a single position without a sequence of moves use a diagram.

Alert boxes

Available in: Club pages Tournament pages

Coloured alert boxes with <alert type="…">content</alert>. Types: primary, secondary, success, danger, warning, info, light, dark. Without type it defaults to info.

<alert type="warning">Registration closes on May 1st!</alert>
<alert>Just a note.</alert>

In the forum the tag stays plain text.

Games

Games can be linked so that the current status of the game is automatically displayed.

Shows player names and the current half moves or the result:

<game id=“hg4JpONwsqFe”/>

Shows the score from the perspective of the player “shaack”:

<game id=“hg4JpONwsqFe” view=“shaack”/>

Shows the score from the white player's point of view:

<game id=“hg4JpONwsqFe” view=“white” note=“Note for the tournament committee”/>

In the first case, something like “shaack - Maiholz (1-0)” is displayed.

In the second case, the score is displayed from the point of view of the player “shaack”, i.e. simply “1”. This display can be used for tournament tables.

If the game is still in progress, the half-move is displayed, i.e. “shaack - Maiholz [23]” or simply “[23]”.

Parameters

  • id: ID of the game (required)
  • view: Name of the player whose perspective is to be displayed (optional)

Pairings in manual tournaments

Available in: Tournament pages

In manual tournaments a game is not linked by its id but noted as a planned pairing:

<game pairing="white-black"/>

white and black are the usernames of the two players, separated by a hyphen. Both must be tournament participants. As long as there is no id on the tag, it is a planned pairing and not yet a game. The director starts the pairing on the tournament page; the game is created and its id is appended (<game pairing="white-black" id="..."/>). See Manual tournaments for details.

Additional parameter:

  • pairing: white-black, usernames of white and black (manual tournaments only, instead of id)

Polls

Available in: Forum

Moderators of a forum can put a poll into their posting. The question is a parameter on the opening tag, the answers are <option> elements inside it.

<voting question="When shall we play the tournament?">
<option>In spring</option>
<option>In autumn</option>
</voting>

On publishing, the poll is stored and the tag in the posting is replaced by its short form, <voting id="…" question="…"/>. From then on the stored answers are the ones that count. They can no longer be changed through the text, because the votes cast are tied to them. The question can still be edited in the text.

A poll needs at least two and at most twenty answers. Every logged-in member who can read the posting may vote. Everyone has one vote, and a vote is final.

Parameters

  • question: The question shown above the answers (optional)
  • id: Key of the stored poll, set automatically on publishing