Created Manual of Style (markdown)
commited
commit
c49261b24b1159f32aea355c8fe442fb439ef3ad
... | ... | @@ -0,0 +1,51 @@ |
1 | This is a (rough) guide for formatting Fancade wiki pages. |
|
2 | ||
3 | [[_TOC_]] |
|
4 | ||
5 | ## Formatting |
|
6 | ||
7 | Wiki pages should not use one hash symbol to create sections and subsections, as the size would match the title page. |
|
8 | ||
9 | - NO: <span style="color:red"># Section</span> |
|
10 | - OK: <span style="color:green">## Section</span> |
|
11 | ||
12 | ## Layout |
|
13 | ||
14 | ### Games |
|
15 | ||
16 | The article's title must match the casing of the game. |
|
17 | ||
18 | A snapshot of the game may optionally come first before the article content. Please use one image only. |
|
19 | ||
20 | Afterwards, the game name is written, and should link to its corresponding **play.fancade.com** game, with a description of the game thereafter, which may include: |
|
21 | ||
22 | - who made it, |
|
23 | - when it is introduced to [[Quest]] |
|
24 | - [[Fanjam]] winner for... |
|
25 | ||
26 | The **How to Play** section should come next. Inside this section should show comprehensive details on the controls, and the resulting actions, as well as how objects interact, etc. |
|
27 | ||
28 | The following is optional but recommended to be added: |
|
29 | ||
30 | - **Solutions**, showing the various solutions for each level. The notation should be described, unless controls are simple enough (e.g. swiping). Used for puzzle games. |
|
31 | - The arrow macros can be used in cases like swiping. Enclose the cardinal direction in two angled brackets: <code><< + W + >></code> = <<W>>. W, NW, N, NE, E, SE, S, SW are available. |
|
32 | - **Walkthrough**, linking to YouTube videos to solutions, in a series of levels. Generally used for non-puzzle games. |
|
33 | - A playlist should be preferred if it is provided (or created), unless it is moderately out of order. |
|
34 | - **Credits** by the author |
|
35 | - **Related**, links to related articles. |
|
36 | ||
37 | Other optional sections may be created if there are technical details to the game (e.g. [[Extreme Painist]]) |
|
38 | ||
39 | ### Blocks |
|
40 | ||
41 | The title must match the casing of the block. |
|
42 | ||
43 | The article should firstly contain what the block does. |
|
44 | ||
45 | The inputs are listed next, from top to bottom. This should be indicated with **Inputs:** on the top (not a section, just plaintext). Outputs are listed similarly. |
|
46 | ||
47 | The image of the block is put hereafter. |
|
48 | ||
49 | Then, **Notes** comes next. This should contain all the necessary information about the block, along with its quirks. |
|
50 | ||
51 | The **Example** section comes next. In each example, the description of what the script does comes first before the image. |
|
... | ... | \ No newline at end of file |