meta:style_guide

This is an old revision of the document!


Style Guide

(Right now this is less of a real style guide, but more of a “what to watch for so DokuWiki works right” document. For now the general style guideline is “just try to match the layout of the other pages in the namespace” I guess)

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.

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.

Extra Syntax

Base syntax of the wiki is documented on the DokuWiki site: syntax

This wiki has some plugins to allow for some more syntax. Some of them are available as buttons in the editor, others are not, so here's a few of those. This is not all - but if you see something not covered and you're curious about how it works, you can just edit the page where it's used, and look at the markdown or just copypaste it.

Attribute/Type/Group/Skill Icons

Attributes Types Groups Skills
Attribute: Smile {{attr:s}} Type: Vo {{type:vo}} Group: µ's {{group:m}} Skill: Appeal+ {{skill:appeal}}
Attribute: Pure {{attr:p}} Type: Sp {{type:sp}} Group: Aqours {{group:a}} Skill: Critical Chance Up {{skill:critchance}}
Attribute: Cool {{attr:c}} Type: Gd {{type:gd}} Group: Nijigaku {{group:n}} Skill: Crit Power Up {{skill:critpower}}
Attribute: Active {{attr:a}} Type: Sk {{type:sk}} Skill: Damage Reduction {{skill:dr}}
Attribute: Natural {{attr:n}} Skill: Heal {{skill:heal}}
Attribute: Elegant {{attr:e}} Skill: Shield {{skill:shield}}
Attribute: Neutral {{attr:x}} Skill: Skill Chance Up {{skill:skillchance}}
Skill: SP Gauge Fill {{skill:spfill}}
Skill: SP Gauge Gain Up {{skill:spgain}}
Skill: SP Power Up {{skill:sppower}}
Skill: Voltage Gain Up {{skill:vogain}}
Skill: Voltage+ {{skill:voplus}}

Card Thumbnails

You can add a card's image by using {{card:X}}, where X is the card's School Idol Number, as seen in-game when sorting by it or in the URL of databases such as Kirara. Use {{card:unidolized:X}} if you want to show the unidolized thumbnail.

{{card:480}} {{card:unidolized:480}}

TeX

TeX can be used to make nice and beautiful math. Open a math environment as you would in a TeX document. In there, you can do almost anything you can do with TeX, including math symbols or opening more environments using \begin.

TeX can be inlined: $x=5$ or put in a seperate paragraph: $$a^2 = 3 \cdot \frac{a}{2}$$
TeX can be inlined: $x=5$ or put in a seperate paragraph: $$a^2 = 3 \cdot \frac{a}{2}$$

Right Floating Wrap

Floating wraps are useful for putting infoboxes, images, videos or anything else on the side.

<WRAP right>text</WRAP>

One other useful wrap is the “clear” wrap, which will add empty space to the text until the floating wrap is over, like here. You should use it if you have a long floating wrap, but only a short text, so the next section doesn't get mushed next to the float as well. You can find it in the Wrap menu in the editor (⏏ symbol, “clear floats”).

YouTube Embed

{{youtube>VIDEOID}}

The video ID is taken from the YouTube URL (the part at the end - for example, for https://www.youtube.com/watch?v=yRZPhvonGB8 the video ID is yRZPhvonGB8).

Graphs

The ApexCharts plugin allows you to make fancy interactive graphs. Check the ApexCharts examples page to see what is possible.

To use an ApexChart here, copy the value of what would be in the options array (everything inside and including {…}) and put it between <achart> tags. Take a look at the source of Bonus Costumes for an example of it in action.

Tabs

<tabbox The First Tab Title> 
Hello, I am the first tab.
<tabbox The Other Tab Title> 
Look at me, I am more text.
<tabbox selected The Default Tab Title> 
Put "selected" behind "tabbox" to have a tab selected by default when opening a page.
</tabbox>

The First Tab Title

Hello, I am the first tab.

The Other Tab Title

Look at me, I am more text.

The Default Tab Title

Put “selected” behind “tabbox” to have a tab selected by default when opening a page.

The “selected” property is optional - if you don't add it to any tabs, the first tab will be selected by default.

Table Filtering and Sorting

If you have a long table that could profit from some search functionality (like Accessories for example), you simply have to add this in the line before the table:

{{tablelayout?tableSearch=1&tableSort=1&rowsHeaderSource=1}}

This will automatically add column filters and sorting options to the next table. The number behind rowsHeaderSource= is the number of header rows - if you have more than one header row, make sure to change it, or the headers will also be sorted/filtered.

Table Cell Colouring

If you want to highlight a single cell in a table, you can do so my changing the background colour:

^ ^ A ^ B ^
^ 1 | @red:A1 | @lightblue:B1 |
^ 2 | @mediumspringgreen:A2 | @#126126:B2 |
A B
1 A1 B1
2 A2 B2

Markers

Markers are simple way to mark spots in pages which are in need of further work. There are three markers you can put:

[(:fixme)]: This part needs to be reworked, to be easier to understand.

[(:todo)]: This note points out that there should be further information about this topic here.

[(:proof)]: This part should have some proof or citation about its claims.

Use these markers when starting out with a new page, to mark locations where other editors can help and contribute.

Footnote Names

The footnotes, as described on the DokuWiki page, work fine for marking the source of something or citing a reference for some information:

This is a fact ((and this is the source for that fact))
This is a fact 1)

But if you use a reference multiple times in a page, you can save a lot of writing by giving the references a name:

This is a fact ((my_ref_name>and this is a source I will use multiple times))
This is a fact 2)

The part before the > is the name for the reference, and later in the page you can simply use that name instead of typing out the whole reference:

This is another fact ((my_ref_name))
This is another fact 3)

1) and this is the source for that fact
2), 3) and this is a source I will use multiple times

Contributors to this page:
meta/style_guide.1637321904.txt.gz · Last modified: 2021/11/19 11:38 by Suyooo