This is a documentation for Board Game Arena: play board games online !

Wiki formatting

From Board Game Arena
Revision as of 17:15, 6 April 2022 by Kevan (talk | contribs) (add Contents bug)
Jump to navigation Jump to search

These are some tips on how to make wiki rules pages display properly on the BGA site beneath a game. Feel free to add additional advice.

This page has been created following this forum thread. Because the BGA interface aggressively strips a lot of wiki markup when displaying page rules (all bullet points, images if they aren't formatted in a certain way, etc), users who are trying to write clear rules are either giving up (eg. after wrongly assuming images to be impossible) or making some rules pages worse (by taking paragraphs and converting them into clearer bullet points, without realising that those bullet points don't show up on BGA).

Bullet points

The BGA rules display strips all bullet points, if the regular wiki bullet markup of asterisks is used.

A common solution seems to be to add bullet-point unicode symbols. This also requires lines to be separated by paragraph breaks or <br/> tags, otherwise they all appear on the same line.

• Draw

• Play

• Discard
• Draw<br/>
• Play<br/>
• Discard

Contents

A 2020 update to BGA's ruleset display introduced a bug that (for rules pages with many sections) imports the index from the top of the wiki page, but none of the section links. Meaning that if the reader clicks on a link, it reloads their browser page without focusing on the section they wanted to read.

The index can be removed from a wiki page by adding ("no table of contents") anywhere on it.

Headings

A level two heading ("==") will appear with a box around it on the BGA view. A level three heading ("===") will not.

Images

Attempting to specify an image size in image markup (eg. [[File:Marrakech example.jpg|300px]]) will work in the wiki view, but will mean the image is stripped out on the BGA view.

Images must be included at the default size (so must also be uploaded at the size you want them to appear), eg:

[[File:Marrakech example.jpg]]

It's also possible to add rollover text if desired:

[[File:Marrakech example.jpg|Example move]]

External links will also work within BGA:

[[File:Versions.png|link=https://lumberjacks-studio.com/en/project/trek-12_en/]]

Numbered lists

Like bullet points, a numbered list in wiki markup (with a "#" before each line) doesn't display correctly. Workarounds are to write out the numbers by hand, with either paragraph breaks or <br/> tags between them:

1. Draw

2. Play

3. Discard
1. Draw<br/>
2. Play<br/>
3. Discard

Tables

Table borders are stripped by the BGA display. They can be added back by adding a fixed width border to the image markup, eg:

{| class="wikitable" border="2"
|-
!0-90
|⭐
|-
!91-110
|⭐⭐
|-
!111-125
|⭐⭐⭐
|}

will display as:

0-90
91-110 ⭐⭐
111-125 ⭐⭐⭐