User:.vivien/Style guide: Difference between revisions

From Zoo Wiki
Created page with "==Sections== Item, relic and cosmetic pages should have the following sections: <syntaxhighlight lang="wikitext"> ==Obtaining== ==Effects== ==History== </syntaxhighlight> Only items with "special" obtaining conditions should have an Obtaining section. This includes: * Items obtained from goal rewards (e.g. reward #20 always gives 6 Cake Slices) * Hidden upgraded items (e.g. Rice Cracker) * Secret items (e.g. Omelette) * Unobtainable items (e.g. Ethereum)"
 
→‎Terminology: Colon, the developer
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
==Sections==
This is a list of '''guidelines''' for writing and formatting pages on this wiki.
Item, relic and cosmetic pages should have the following sections:
 
Like all style guides, this list is not an end-all-be-all. If a rule makes your article hard to read or confusing, feel free to disregard it.
 
==Layout==
Item, relic and cosmetic pages should look like this:
<syntaxhighlight lang="wikitext">
<syntaxhighlight lang="wikitext">
<!-- Start a page with {{Item infobox}}, {{Relic infobox}} or {{Cosmetic infobox}} -->
==Obtaining==
==Obtaining==
<!-- This section can be omitted, see below -->
==Effects==
==Effects==
<!-- Start this section with {{Ingame description}} -->
==History==
==History==
</syntaxhighlight>
</syntaxhighlight>
Line 11: Line 18:
* Secret items (e.g. [[Omelette]])
* Secret items (e.g. [[Omelette]])
* Unobtainable items (e.g. [[Ethereum]])
* Unobtainable items (e.g. [[Ethereum]])
Only secret relics (e.g. [[API Key]]) should have an Obtaining section. If a relic is obtained from quests, the Obtaining section isn't needed.
==Terminology==
Try to match how terms are used in-game. For example, cosmetics are "obtained" because that's the term used in <code>/cosmetics</code>' About menu.
In particular:
* [[Relics]] and [[cosmetics]] are "obtained", "equipped" and "unequipped"
* [[Leaders]] are "set" (or "chosen"<ref name="stats">{{cite Discord|name=Zoo|channel=zoo-bot|url=//discord.com/channels/461575285364752384/1075501763374895276/1240257796918870027|date=2024-05-15|type=<code>/stats</code> menu}}</ref>) and "removed"<ref>{{cite Discord|name=Zoo|channel=zoo-bot|url=//discord.com/channels/461575285364752384/1075501763374895276/1240256814705152061|date=2024-05-15|type=buttons in <code>/leaders</code>}}</ref>
* [[Profile themes]] are "unlocked"<ref name="profile-theme">Settings menu in the online view: <blockquote>🎨 Change profile theme<br>You've unlocked ___ themes. Keep playing to unlock more!</blockquote></ref>
If a term is lowercase in-game (e.g. "profile themes"<ref name="profile-theme"/>), it should be lowercase on the wiki.
Use the "default" alias of terminal commands (that is, the one that appears in the heading when typing {{cmd|help [command]}}).
<blockquote>OK: {{cmd|repaircmd}}, {{cmd|inventory}}
<br>Don't use: {{cmd|repaircommand}}, {{cmd|inv}}</blockquote>
Use the word "player" when talking about the person playing, and "game" or "Zoo" when talking about Zoo itself.
<blockquote>[[Crown]] only works when the <mark>player</mark> has at least 100% zoo completion.<br>
In the [[Zoo Cards]] minigame, the <mark>player</mark> collects trading cards of the <mark>game</mark>'s animals.</blockquote>
The reader might not know who Colon is, so refer to him as "the developer", "Colon, the game's developer", or similar.
==Formatting==
Use <code><nowiki><code></code></nowiki></code> for slash commands, terminal folders and terminal files. Use <code><nowiki>{{cmd}}</nowiki></code> for terminal commands.
<blockquote><syntaxhighlight lang="wikitext">Auto-rescues can be disabled with <code>/settings</code>.
The <code>/etc/calendar</code> folder contains the {{cmd|defer}} command.
Usage: {{cmd|give [name or id]/[card]/[amount?]}}</syntaxhighlight></blockquote>
'''Bolden''' the subject of an article.
<blockquote>'''Paintbrush''' is an item.</blockquote>
Format citations using [[:Template:cite Discord]], [[:Template:cite changelog]] and [[:Template:cite devlog]]. See also [[:Category:Citation templates]].
==References==

Latest revision as of 15:47, 22 May 2024

This is a list of guidelines for writing and formatting pages on this wiki.

Like all style guides, this list is not an end-all-be-all. If a rule makes your article hard to read or confusing, feel free to disregard it.

Layout[edit | edit source]

Item, relic and cosmetic pages should look like this:

<!-- Start a page with {{Item infobox}}, {{Relic infobox}} or {{Cosmetic infobox}} -->
==Obtaining==
<!-- This section can be omitted, see below -->
==Effects==
<!-- Start this section with {{Ingame description}} -->
==History==

Only items with "special" obtaining conditions should have an Obtaining section. This includes:

  • Items obtained from goal rewards (e.g. reward #20 always gives 6 Cake Slices)
  • Hidden upgraded items (e.g. Rice Cracker)
  • Secret items (e.g. Omelette)
  • Unobtainable items (e.g. Ethereum)

Only secret relics (e.g. API Key) should have an Obtaining section. If a relic is obtained from quests, the Obtaining section isn't needed.

Terminology[edit | edit source]

Try to match how terms are used in-game. For example, cosmetics are "obtained" because that's the term used in /cosmetics' About menu.

In particular:

If a term is lowercase in-game (e.g. "profile themes"[3]), it should be lowercase on the wiki.

Use the "default" alias of terminal commands (that is, the one that appears in the heading when typing $ help [command]).

OK: $ repaircmd, $ inventory
Don't use: $ repaircommand, $ inv

Use the word "player" when talking about the person playing, and "game" or "Zoo" when talking about Zoo itself.

Crown only works when the player has at least 100% zoo completion.
In the Zoo Cards minigame, the player collects trading cards of the game's animals.

The reader might not know who Colon is, so refer to him as "the developer", "Colon, the game's developer", or similar.

Formatting[edit | edit source]

Use <code></code> for slash commands, terminal folders and terminal files. Use {{cmd}} for terminal commands.

Auto-rescues can be disabled with <code>/settings</code>.

The <code>/etc/calendar</code> folder contains the {{cmd|defer}} command.

Usage: {{cmd|give [name or id]/[card]/[amount?]}}

Bolden the subject of an article.

Paintbrush is an item.

Format citations using Template:cite Discord, Template:cite changelog and Template:cite devlog. See also Category:Citation templates.

References[edit | edit source]

  1. 15 May 2024. /stats menu by Zoo in the #zoo-bot channel in the 9th Tail Bot Hub server.
  2. 15 May 2024. Buttons in /leaders by Zoo in the #zoo-bot channel in the 9th Tail Bot Hub server.
  3. 3.0 3.1 Settings menu in the online view:

    🎨 Change profile theme
    You've unlocked ___ themes. Keep playing to unlock more!