This is a documentation for Board Game Arena: play board games online !
Wiki formatting: Difference between revisions
Sammy McSam (talk | contribs) (→Images: image links do not work) |
Sammy McSam (talk | contribs) (→Wiki templates: updated templates, - examples, - keyword icons) |
||
Line 964: | Line 964: | ||
'''[https://www.mediawiki.org/wiki/Help:Templates Help:Templates]''' | '''[https://www.mediawiki.org/wiki/Help:Templates Help:Templates]''' | ||
=== | ===[[:Template:InfoBox]]=== | ||
Customisable container(s) responsive to screen size. | |||
=== | {{InfoBox|title=Example | ||
|body=Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. | |||
}} | |||
---- | |||
===Create your own icons=== | |||
{{infoBox |maxWidth= |color=#37c |titleAlign=left | {{infoBox |maxWidth= |color=#37c |titleAlign=left | ||
|title=Step 1 | |title=Step 1 | ||
Line 1,002: | Line 1,005: | ||
|body=Insert <code><nowiki>{{</nowiki>'''''YourIcon'''''<nowiki>}}</nowiki></code> | |body=Insert <code><nowiki>{{</nowiki>'''''YourIcon'''''<nowiki>}}</nowiki></code> | ||
}} | }} | ||
See '''[[:Template:GameIcon#Examples|Examples]]''' | |||
===[[:Category:GameIconTemplates]]=== | |||
===[[:Category: | |||
<div style="display:flex;flex-wrap:wrap;align-items:start;gap:0.5rem"> | <div style="display:flex;flex-wrap:wrap;align-items:start;gap:0.5rem"> | ||
Line 1,098: | Line 1,051: | ||
!Result | !Result | ||
|- | |- | ||
|<code><nowiki>{{meeple|red}}</nowiki></code> | |<code><nowiki>{{meeple|red|1}}</nowiki></code> | ||
|{{meeple|red}} | |{{meeple|red|1}} | ||
|- | |- | ||
|<code><nowiki>{{meeple|orange}}</nowiki></code> | |<code><nowiki>{{meeple|orange|2}}</nowiki></code> | ||
|{{meeple|orange}} | |{{meeple|orange|2}} | ||
|- | |- | ||
|<code><nowiki>{{meeple|yellow}}</nowiki></code> | |<code><nowiki>{{meeple|yellow|3}}</nowiki></code> | ||
|{{meeple|yellow}} | |{{meeple|yellow|3}} | ||
|- | |- | ||
|<code><nowiki>{{meeple|green}}</nowiki></code> | |<code><nowiki>{{meeple|green|4}}</nowiki></code> | ||
|{{meeple|green}} | |{{meeple|green|4}} | ||
|- | |- | ||
|<code><nowiki>{{meeple|blue}}</nowiki></code> | |<code><nowiki>{{meeple|blue|5}}</nowiki></code> | ||
|{{meeple|blue}} | |{{meeple|blue|5}} | ||
|- | |- | ||
|<code><nowiki>{{meeple|purple}}</nowiki></code> | |<code><nowiki>{{meeple|purple|6}}</nowiki></code> | ||
|{{meeple|purple}} | |{{meeple|purple|6}} | ||
|- | |- | ||
|<code><nowiki>{{meeple|white}}</nowiki></code> | |<code><nowiki>{{meeple|white|7}}</nowiki></code> | ||
|{{meeple|white}} | |{{meeple|white|7}} | ||
|- | |- | ||
|<code><nowiki>{{meeple|grey}}</nowiki></code> | |<code><nowiki>{{meeple|grey|8}}</nowiki></code> | ||
|{{meeple|grey}} | |{{meeple|grey|8}} | ||
|- | |- | ||
|<code><nowiki>{{meeple|black}}</nowiki></code> | |<code><nowiki>{{meeple|black|9}}</nowiki></code> | ||
|{{meeple|black}} | |{{meeple|black|9}} | ||
|} | |} | ||
Line 1,131: | Line 1,084: | ||
!Result | !Result | ||
|- | |- | ||
|<code><nowiki>{{whiteDie| | |<code><nowiki>{{whiteDie|1}}</nowiki></code> | ||
|{{whiteDie| | |{{whiteDie|1}} | ||
|- | |- | ||
|<code><nowiki>{{yellowDie| | |<code><nowiki>{{yellowDie|2}}</nowiki></code> | ||
|{{yellowDie| | |{{yellowDie|2}} | ||
|- | |- | ||
|<code><nowiki>{{orangeDie| | |<code><nowiki>{{orangeDie|3}}</nowiki></code> | ||
|{{orangeDie| | |{{orangeDie|3}} | ||
|- | |- | ||
|<code><nowiki>{{blackDie| | |<code><nowiki>{{blackDie|4}}</nowiki></code> | ||
|{{blackDie| | |{{blackDie|4}} | ||
|} | |} | ||
</div> | </div> | ||
---- | |||
===[[:Category:Card_templates]]=== | ===[[:Category:Card_templates]]=== | ||
Line 1,203: | Line 1,126: | ||
|<code><nowiki>{{club|colour=green}}</nowiki></code> | |<code><nowiki>{{club|colour=green}}</nowiki></code> | ||
|{{club|colour=green}} | |{{club|colour=green}} | ||
|} | |} | ||
Line 1,247: | Line 1,138: | ||
</div> | </div> | ||
---- | |||
<div style="display:flex;flex-wrap:wrap;align-items:start;gap:0.5rem"> | <div style="display:flex;flex-wrap:wrap;align-items:start;gap:0.5rem"> | ||
{|class="wikitable" style="text-align:center;" | {|class="wikitable" style="text-align:center;" | ||
!Wiki text | !Wiki text | ||
!Result | !Result | ||
|- | |- | ||
|<code><nowiki>{{ | |<code><nowiki>{{Beginner}} {{Beginner|0}}</nowiki></code> | ||
|{{ | |{{Beginner}} {{Beginner|0}} | ||
|- | |- | ||
|<code><nowiki>{{ | |<code><nowiki>{{Apprentice}} {{Apprentice|1}}</nowiki></code> | ||
|{{ | |{{Apprentice}} {{Apprentice|1}} | ||
|- | |- | ||
|<code><nowiki>{{ | |<code><nowiki>{{Average}} {{Average|100}}</nowiki></code> | ||
|{{ | |{{Average}} {{Average|100}} | ||
|- | |- | ||
|<code><nowiki>{{ | |<code><nowiki>{{Good}} {{Good|200}}</nowiki></code> | ||
|{{ | |{{Good}} {{Good|200}} | ||
|- | |- | ||
|<code><nowiki>{{ | |<code><nowiki>{{Strong}} {{Strong|300}}</nowiki></code> | ||
|{{ | |{{Strong}} {{Strong|300}} | ||
|- | |- | ||
|<code><nowiki>{{ | |<code><nowiki>{{Expert}} {{Expert|500}}</nowiki></code> | ||
|{{ | |{{Expert}} {{Expert|500}} | ||
|- | |- | ||
|<code><nowiki>{{ | |<code><nowiki>{{Master}} {{Master|700}}</nowiki></code> | ||
|{{Master}} {{Master|700}} | |||
|{{ | |||
|} | |} | ||
{|class="wikitable" style="text-align:center;" | {|class="wikitable" style="text-align:center;" | ||
!Wiki text | !Wiki text | ||
!Result | !Result | ||
|- | |- | ||
|<code><nowiki>{{ | |<code><nowiki>{{player|2}}</nowiki></code> | ||
|{{ | |{{player|2}} | ||
|- | |- | ||
|<code><nowiki>{{ | |<code><nowiki>{{hand|4}}</nowiki></code> | ||
|{{hand|4}} | |||
|{{ | |||
|} | |} | ||
</div> | </div> | ||
---- | |||
===[[:Category:GameBoardTemplates]]=== | ===[[:Category:GameBoardTemplates]]=== | ||
Revision as of 00:17, 13 February 2024
Purpose
This page was created as a result of the Wiki style guide forum thread.
Most wiki (doc.BoardGameArena.com) formatting is not preserved on BoardGameArena.com, but there are some workarounds. This page is a collection of unofficial tips on how to make wiki pages display well in-game and on game panels.
Feel free to add additional issues, advice and templates 🙂
Note: Wiki page changes are updated once per day on BoardGameArena.com.
Languages
Wiki page content displays:
- User's language, else
- English, else
- Create this page link/button.
e.g. A Chinese user reads the Jump Drive rules summary on its game panel page, displayed in English (en.doc.boardgamearena.com/Gamehelpjumpdrive) because the Chinese (zh.doc.boardgamearena.com/Gamehelpjumpdrive) page does not exist. The user sees a typo in the English rules and selects the edit page link to correct it, but the Chinese wiki's create page is displayed instead.
Bug reports
Lists
Issues
common.css
rulesMarkers (bullets *
, numbering #
), margins and padding are removed on BoardGameArena.com.
Bug reports
Workarounds
common.css
rules¹Dynamic markers generate HTML list structure.
²Without dynamic markers, <p>
paragraphs</p>
are generated which require line breaks before and after the "list" to prevent merging into surrounding paragraphs.
Headings
Level 1 (h1) headings are the title of the page e.g. = Wiki formatting =
, = Gamehelp[name] =
, = Tips_[name] =
.
Issues
- In-game h2 and h3 headings are visually indistinguishable.
- In-game h3 headings overlap text from the previous section.
- h5 headings and below are visually indistinguishable from body text.
- Inconsistency between in-game and game panel headings.
Bug reports
Workarounds
Since in-game h3 headings became indistinguishable from h2 headings:
- Change h3 to h4 headings.
- Use additional line breaks before h3 headings.
Wiki text | Wiki | BGA game panel | BGA in-game | |
---|---|---|---|---|
h2 | * List item == Example h2 heading == * List item |
Example h2 heading
|
Example h2 heading
|
Example h2 heading
|
h3 | * List item === Example h3 heading === * List item |
Example h3 heading
|
Example h3 heading
|
Example h3 heading
|
h4 | * List item ==== Example h4 heading ==== * List item |
Example h4 heading
|
Example h4 heading
|
Example h4 heading
|
h5 | * List item ===== Example h5 heading ===== * List item |
Example h5 heading
|
Example h5 heading
|
Example h5 heading
|
common.css
rulesgameserver.css
rulesLinks
- The Main_Page (root) of this wiki redirects to Help.
- BoardGameArena.com/doc displays the Help index of games.
- Note: each heading has a unique id appended with a number as necessary.
Issues
- Links to section headings
#
do not work outside of the wiki (doc.BoardGameArena.com). - URL is resolved to
/doc
instead of the current page. - In-game links navigate the user away from the game.
e.g. [[#Section_heading_link]]
⇨ https://BoardGameArena.com/doc#Section_heading_link ¹.
Bug reports
Workarounds
- Remove links that do not function as expected.
Images
Issues
- Resized images do not display on BoardGameArena.com.
- e.g.
[[File:Marrakech_example.jpg|300px]]
) because the resized image does not exist in the referenced directory.
- e.g.
- Image links do not work on BoardGameArena.com.
- e.g.
[[File:Versions.png|link=https://en.doc.boardgamearena.com/images/b/b5/Factum_Rules_Summary_EN_v1.jpg]]
because the link resolves tohttps://boardgamearena.com/dochttps://en.doc.boardgamearena.com/images/b/b5/Factum_Rules_Summary_EN_v1.jpg
- e.g.
Workarounds
- Upload YourImage with the size it will appear.
- Create a
{{gameIcon}}
with ascale
factor.- e.g.
{{YourIcon|scale=0.5}}
to reduce the image dimensions by ½.
- e.g.
- Replace image links with regular links.
- e.g.
[[File:Versions.png]]
[https://en.doc.boardgamearena.com/images/b/b5/Factum_Rules_Summary_EN_v1.jpg LinkText]
- e.g.
Tips
- Optionally include rollover text
[[File:Marrakech_example.jpg|Example move]]
Tables
Issues
common.css
ruleswidth: 98%;
stretches tables across the screen on BoardGameArena.com.- Borders do not display on BoardGameArena.com.
Workarounds
style="width:auto;"
fits column width to the contents.border="2"
creates table cell borders.- Replace with HTML + CSS grid.
Wiki text | Wiki | BGA | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Raw wikitable | {|class="wikitable" |+Caption !0-90 |⭐ |- !91-110 |⭐⭐ |- !111-125 |⭐⭐⭐ |} |
|
| ||||||||||||
width:auto; border="2"
|
{|class="wikitable" style="width:auto;" border="2" |+Caption !0-90 |⭐ |- !91-110 |⭐⭐ |- !111-125 |⭐⭐⭐ |} |
|
|
Option grids
Option grids can help visualise multiple interdependent options. Where inflexible wiki text tables fall short, HTML + CSS grid is responsive to screen size e.g. GameHelpPente:
Blockquote
Issues
common.css
rules- Margins and padding are removed on BoardGameArena.com.
- No left border.
Workarounds
<blockquote>
formattingWiki templates
Template:InfoBox
Customisable container(s) responsive to screen size.
Create your own icons
https://en.doc.boardgamearena.com/Template:YourIcon
Fill in the parameters:
{{gameIcon |tooltip= |imageFileName= |scale=1 |width= |height= |x=0 |y=0 |={{{|​}}} |textColor=black |outlineColor=white }}<noinclude> [[Category:YourIcons]] <noinclude>
{{YourIcon}}
See Examples
Category:GameIconTemplates
Wiki text | Result |
---|---|
{{redCylinder|1}}
|
|
{{orangeCylinder|2}}
|
|
{{yellowCylinder|3}}
|
|
{{greenCylinder|4}}
|
|
{{blueCylinder|5}}
|
|
{{purpleCylinder|6}}
|
|
{{whiteCylinder|7}}
|
|
{{greyCylinder|8}}
|
|
{{blackCylinder|9}}
|
|
{{creamCylinder|10}}
|
Wiki text | Result |
---|---|
{{meeple|red|1}}
|
|
{{meeple|orange|2}}
|
|
{{meeple|yellow|3}}
|
|
{{meeple|green|4}}
|
|
{{meeple|blue|5}}
|
|
{{meeple|purple|6}}
|
|
{{meeple|white|7}}
|
|
{{meeple|grey|8}}
|
|
{{meeple|black|9}}
|
Wiki text | Result |
---|---|
{{whiteDie|1}}
|
|
{{yellowDie|2}}
|
|
{{orangeDie|3}}
|
|
{{blackDie|4}}
|
Category:Card_templates
Wiki text | Result |
---|---|
{{card|=A}}
|
|
{{club|=K}}
|
♣ |
{{spade|=Q}}
|
♠ |
{{heart|=J}}
|
♥ |
{{diamond|=10}}
|
♦ |
{{cardBack}}
|
🟔 |
{{club|colour=green}}
|
♣ |
Wiki text | Result |
---|---|
{{cardholder|Alice|cards={{diamond|=A}}{{club|=A}}{{heart|=A}}{{spade|=A}} }}
|
Alice |
Wiki text | Result |
---|---|
{{Beginner}} {{Beginner|0}}
|
![]() ![]() |
{{Apprentice}} {{Apprentice|1}}
|
![]() ![]() |
{{Average}} {{Average|100}}
|
![]() ![]() |
{{Good}} {{Good|200}}
|
![]() ![]() |
{{Strong}} {{Strong|300}}
|
![]() ![]() |
{{Expert}} {{Expert|500}}
|
![]() ![]() |
{{Master}} {{Master|700}}
|
![]() ![]() |
Wiki text | Result |
---|---|
{{player|2}}
|
2players |
{{hand|4}}
|
4cards in hand |
Category:GameBoardTemplates
{{Goboard9}}
{{Quoridorboard}}