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

Wiki formatting

From Board Game Arena
Revision as of 22:36, 5 January 2024 by Sammy McSam (talk | contribs) (→‎Wiki templates: new / edited templates)
Jump to navigation Jump to search

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 🙂

Help:Formatting

Note: Wiki page changes are updated once per day on BoardGameArena.com.

Languages

Wiki page content displays:

  1. User's language, else
  2. English, else
  3. 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

Help:Lists

Issues

Markers (bullets *, numbering #), margins and padding are removed on BoardGameArena.com.

Bug reports

Workarounds

  1. Use static markers (•,-,1.).
  2. Replace with HTML + CSS.

¹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

  1. In-game h2 and h3 headings are visually indistinguishable.
  2. In-game h3 headings overlap text from the previous section.
  3. h5 headings and below are visually indistinguishable from body text.
  4. 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 vs BoardGameArena.com heading formatting
Wiki text Wiki BGA game panel BGA in-game
h2 
* List item

== Example h2 heading ==

* List item
  • List item
Example h2 heading
  • List item
  • List item
    • Example h2 heading
  • List item
    		•
  • List item
    • Example h2 heading
  • List item
    • h3 
    * List item

=== Example h3 heading ===

* List item
    • List item
    Example h3 heading
    • List item
  • List item
    • Example h3 heading
  • List item
    		•
  • List item
    • Example h3 heading
  • List item
    • h4 
    * List item

==== Example h4 heading ====

* List item
    • List item
    Example h4 heading
    • List item
  • List item
    • Example h4 heading
  • List item
    		•
  • List item
    • Example h4 heading
  • List item
    • h5 
    * List item

===== Example h5 heading =====

* List item
    • List item
    Example h5 heading
    • List item
  • List item
    • Example h5 heading
  • List item
    		•
  • List item
    • Example h5 heading
  • List item
    • Game panel heading example
    Game panel content appears in a single box:
    Ruleset heading example about.png
    In-game heading example
    In-game content appears in multiple boxes:
    Ruleset heading example.png

    Links

    Help:Links

    Issues

    1. Links to section headings # do not work outside of the wiki (doc.BoardGameArena.com).
    2. URL is resolved to /doc instead of the current page.
    3. 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

    1. Remove links that do not function as expected.

    Images

    Help:Images

    Issues

    1. 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.

    Workarounds

    1. Upload YourImage with the size it will appear.
    2. Create a {{gameIcon}} with a scale factor.
      e.g. {{YourIcon|scale=0.5}} to reduce the image dimensions by ½.

    Tips

    1. Optionally include rollover text [[File:Marrakech_example.jpg|Example move]]
    2. Optionally include a link [[File:Versions.png|link=https://lumberjacks-studio.com/en/project/trek-12_en/]]

    Tables

    Help:Tables

    Issues

    1. width: 98%; stretches tables across the screen on BoardGameArena.com.
    2. Borders do not display on BoardGameArena.com.

    Workarounds

    1. style="width:auto;" fits column width to the contents.
    2. border="2" creates table cell borders.
    3. Replace with HTML + CSS grid.
    Wiki vs BoardGameArena.com table formatting
    Wiki text Wiki BGA
    Raw wikitable 
    {|class="wikitable"
|+Caption
!0-90
|⭐
|-
!91-110
|⭐⭐
|-
!111-125
|⭐⭐⭐
|}
    Caption
    0-90 ⭐
    91-110 ⭐⭐
    111-125 ⭐⭐⭐
    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
|⭐⭐⭐
|}
    Caption
    0-90 ⭐
    91-110 ⭐⭐
    111-125 ⭐⭐⭐
    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:

    Training mode only
    Default
    Other
    # of players
    2
    3
    4
    Free-for-all
    Team
    All options win
    Align exactly 5 stones in a row
    Align exactly 4 stones in a row
    Overline win
    May align more than 5 stones in a row
    May align more than 4 stones in a row
    Capture win
    Make 5 captures
    Make 4 captures
    Capture three
    May capture two or three stones (Keryo Pente)
    Self-capture
    No effect: a stone may be placed in a capture position
    Self-capture: results in self-capture! (Poof Pente)
    Forbidden: a stone may not be placed in a capture position
    Overtime capture
    Break the line: may capture to break a winning line (Boat Pente)
    Capture the line: may capture an entire winning line
    Mixed capture
    Enabled: May capture stones of mixed colour
    Disabled: Captures of one colour only

    Blockquote

    Issues

    1. Margins and padding are removed on BoardGameArena.com.
    2. No left border.

    Workarounds

    1. Replace with HTML + CSS.

    Wiki templates

    Help:Templates

    Keyword icons

    One game developer wrote a function to substitute keywords for icons, however this method only worked in-game and not on game panel or wiki pages.

    Wiki template method

    Templates display in all locations (i.e. the wiki, game panel and in-game).

    Step 1
    Upload YourImage.png
    Step 2
    Create https://en.doc.boardgamearena.com/Template:YourIcon

    Fill in the parameters: 

    {{gameIcon
|tooltip=
|imageFileName=
|scale=1
|width=
|height=
|x=0
|y=0
|={{{|&ZeroWidthSpace;}}}
|textColor=black
|outlineColor=white
}}<noinclude>
[[Category:YourIcons]]
<noinclude>
    Step 3
    Insert {{YourIcon}}

    Template:GameIcon#Examples

    Template:InfoBox

    Customisable container(s) responsive to screen size.

    Example
    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.

    Category:PlayerBoardTemplates

    Template:Skill
    Wiki text Result
    {{Beginner}} {{Beginner|0}} rank Beginner rank 0
    {{Apprentice}} {{Apprentice|1}} rank Apprentice rank 1
    {{Average}} {{Average|100}} rank Average rank 100
    {{Good}} {{Good|200}} rank Good rank 200
    {{Strong}} {{Strong|300}} rank Strong rank 300
    {{Expert}} {{Expert|500}} rank Expert rank 500
    {{Master}} {{Master|700}} rank Master rank 700
    Other icons
    Wiki text Result
    {{player|2}} 2players
    {{hand|4}} 4cards in hand

    Category:GamePieceTemplates

    Cylinder tokens
    Wiki text Result
    {{redCylinder}} red token​
    {{orangeCylinder}} orange token​
    {{yellowCylinder}} yellow token​
    {{greenCylinder}} green token​
    {{blueCylinder}} blue token​
    {{purpleCylinder}} purple token​
    {{whiteCylinder}} white token​
    {{greyCylinder}} grey token​
    {{blackCylinder}} black token​
    {{creamCylinder}} cream token​
    Meeples
    Wiki text Result
    {{meeple|red}} red meeple​
    {{meeple|orange}} orange meeple​
    {{meeple|yellow}} yellow meeple​
    {{meeple|green}} green meeple​
    {{meeple|blue}} blue meeple​
    {{meeple|purple}} purple meeple​
    {{meeple|white}} white meeple​
    {{meeple|grey}} grey meeple​
    {{meeple|black}} black meeple​
    Dice
    Wiki text Result
    {{whiteDie|=1}} white die​
    {{yellowDie|=2}} yellow die​
    {{orangeDie|=3}} orange die​
    {{blackDie|=4}} black die​
    Miscellaneous tokens
    Wiki text Result
    {{blackStone}}
    {{whiteStone}}
    {{blackReversiToken}}
    {{whiteReversiToken}}
    {{blackDoubleCylinder}}
    black token​
    black token​
    {{whiteDoubleCylinder}}
    white token​
    white token​
    {{Hclue|8}} 8clue tokens

    Category:Card_templates

    Template:Card
    Wiki text Result
    {{card|=A}}    
    {{club|=K}} ​♣
    {{spade|=Q}} ​♠
    {{heart|=J}} ​♥
    {{diamond|=10}} ​♦
    {{cardBack}} 🟔
    {{club|colour=green}} ​♣
    Template:HCard
    Wiki text Result
    {{Hr|1|n=|c=}}

    {{Hy|2|n=|c=}}

    {{Hg|3|n=|c=}}

    {{Hb|4|n=|c=}}

    {{Hw|5|n=|c=}}

    {{Hm|5|n=|c=}}

    {{Hk|5|n=}}

    {{HBack|5|n=}}

    red1
    ,with a
    red1clue,
    yellow2
    ,with a
    yellow2clue,
    green3
    ,with a
    green3clue,
    blue4
    ,with a
    blue4clue,
    white5
    ,with a
    white5clue,
    multicolour5
    ,with a
    multicolour5clue,
    black powder5
    ,with a
    black powder5clue,
    card back​
    ,with a
    5clue,
    Template:Cardholder
    Wiki text Result
    {{cardholder|Alice|cards={{diamond|=A}}{{club|=A}}{{heart|=A}}{{spade|=A}} }} Alice​

    Category:GameIconTemplates

    Category:JumpDriveIcons
    Wiki text Result
    {{JumpDriveExplore|=1}} explore​
    {{JumpDriveDevelopment|=2}} development​
    {{JumpDriveWorld|=3}} non-military world​
    {{JumpDriveMilitaryWorld|=3}} military world​
    {{JumpDriveChromosome}} chromosome​
    {{JumpDriveMilitary}} military​
    {{JumpDriveNovelty|=1}} novelty​
    {{JumpDriveRare|=2}} rare elements​
    {{JumpDriveGenes|=3}} genes​
    {{JumpDriveAlien|=4}} alien​
    Category:SpaceStationPhoenixIcons
    Wiki text Result
    {{SSPGem|=1}} GEM1
    {{SSPFood|=2}} Food2
    {{SSPMetal|=3}} Metal3
    {{SSPWater|=4}} Water4
    {{SSPHumanoid}} Human​

    Category:GameBoardTemplates

    Template:Chessboard

    {{Chessboard}}

    A
    B
    C
    D
    E
    F
    G
    H
    8
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    8
    7
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    7
    6
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    6
    5
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    5
    4
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    4
    3
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    3
    2
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    2
    1
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    Empty Square
    1
    A
    B
    C
    D
    E
    F
    G
    H

    Template:Goboard9

    {{Goboard9}}

    A
    B
    C
    D
    E
    F
    G
    H
    J
    9
    9
    8
    8
    7
    7
    6
    6
    5
    5
    4
    4
    3
    3
    2
    2
    1
    1
    A
    B
    C
    D
    E
    F
    G
    H
    J

    Template:Quoridorboard

    {{Quoridorboard}}

    A
    B
    C
    D
    E
    F
    G
    H
    I
    9
    9
    8
    8
    7
    7
    6
    6
    5
    5
    4
    4
    3
    3
    2
    2
    1
    1
    A
    B
    C
    D
    E
    F
    G
    H
    I
    Retrieved from "http:///index.php?title=Wiki_formatting&oldid=19492"