meta:style_guide

Style Guide

Card References

This wiki uses Attribute + Type to refer to cards. Both are abbreviated as three characters, using the first letter of the attribute and the type abbreviation as used in the game. So, for example, SGd stands for a Smile Guard-type card. This also ensures it will work with the automatic Card linking, which will add thumbnail images in case of ambiguous Attribute/Type/Member combinations.

Game Terms

Several things in the game are often referred to with several different terms across different communities. The Glossary page aims to keep track of such, but also defines on a primary term that was decided on. Wherever possible, these terms should be the ones used. If the given term or abbreviations are used on pages, the respective Glossary description will also be accessible by clicking on it.

Event and Gacha Titles

Wherever possible, use the Event and Gacha titles from the Global version. If in doubt, check the schedule page - it will serve a similar purpose as the Glossary page does for game terms, the titles used there should be used across the wiki.

Creating Pages

There's a little “Create new page” button in the sidebar if you're logged in. This will create a new page in the current namespace - so if you want to make a new page in Calculations, visit a page there, then hit the button on it.

The new page form will automatically convert the page title you enter into the proper URL format and open the editor. You can also create new sub-namespaces from there if neccessary.

Namespace Style

Some namespaces, such as the Cards and Songs listings, will have a relatively straightfoward page structure. A skeleton of it is also usually automatically added for new pages. If creating new pages, please try to follow the structure of similar pages in the same namespace to have a cohesive feel. You can also check the Namespaces page to see whether any namespace-specific style notes have been left there.

Headlines and Sections

There should be exactly one H1 headline on each page:

====== H1 Headline ======

DokuWiki will use the text in this heading as the page title and display it in all navigation related places (links, browser tabs, breadcrumbs, sitemap, namespace listings…).

To format the rest of the page into sections, you should only use H2 headlines and lower (by either using the “Lower Headline” or “Select Headline” buttons in the editor):

===== H2 Headline =====
==== H3 Headline ====
=== H4 Headline ===
== H5 Headline ==

Manually adding horizontal lines (----) is not neccessary.

Because DokuWiki uses the H1 Heading as the page title, you don't need to specify a link label for intrawiki links. [[gameplay:accessories|]] results in the same link as [[gameplay:accessories|Accessories]], since DokuWiki will automatically load the page title for the former. In fact, the first one is better, because it will automatically update if the page title is changed.

No Hotlinking

Hotlinking is when you take an image from another site and embed it as-is. Whenever someone visits the page where you embedded it, it will cause a request to the other site, and cause extra traffic and load for the other website's owner.

Instead, download the image, upload it onto the wiki, and embed that image. We don't want to cause trouble for other sites.


Contributors to this page:
meta/style_guide.txt · Last modified: 2022/01/10 21:05 by Suyooo