Styling guide

This page is a general guide for editors and contributors of this wiki. These guidelines should be accepted and followed by all editors. None of the pages are protected so everyone can edit. Any edits done in good faith are welcomed, regardless of the format. All edits can be reverted.

Language

This wiki is in English. Please write in English to your best extent. Grammar can be corrected later by others and should not be a barrier to entry. Google Translate or other translators can also be used. When writing a comment or post in a different language, please provide a translation below.

Third person

Pages should be written in the third person, either in active or passive voice. Instead of "you" use "the player" instead. This makes the information seem less biased. Every contributor should aim to write in the active voice at least 95% of the time.

Exceptions: pages that are more subjective and "speak" to the reader should be written in second person ("you"). Example pages include:

• Styling guide (this page)
• Tips for Adventurers Guild
• FAQ
• To-do list

Page formatting

Every page should have at least one or two sentences at the top, which sum up the whole page and at least one picture under that. If a page has an established format, please follow it.

Pages for buildings usually follow this logic:

1. A short explanation of the functionality of the building, when it unlocks, and how many levels it has.
2. In-game description as seen in the building.
3. Sounds that can be heard from the building.
4. Gallery of each level of the building (with lvl. 0 included).
5. Building levels, which are generated via modules.
6. Crafting/Cooking/Production/Passive income/Building missions, which are generated via modules.
7. Technologies, which are generated via modules.
8. Trivia
9. See also section (links to related pages).

Pages for items are managed via the Module:Item info and therefore have a consistent layout:

1. A short description of the item, where it is mostly acquired and used.
2. In-game description and explanation (in case the in-game description is not precise enough).
3. Infobox of item's name, image, where it is mostly acquired, where it is mostly used, starting storage capacity, storage capacity boosts and total storage capacity.
4. Acquisitions (via module; the bullets are sorted according to the Navigation page).
5. Uses (via module; the bullets are sorted according to the Navigation page).
6. Trivia (has to be written by hand).

Desktop/Mobile

This wiki is mainly (~75%) used by mobile users, therefore it makes sense to optimize for mobile users. After a major edit was made it is recommended to see how it looks on a mobile device (phone). The main problem are wide tables on mobile i.e. tables with a lot of columns. The problem with wide tables is that images in those tables get shrunk to the smallest width of that column. Therefore it is recommended to reduce the number of columns or to avoid tables in general (at least those with pictures).

The other problem is JavaScript on mobile. Most mobile browsers support JavaScript, but Fandom does not. While features like image maps and levelling calculators are great on desktop it is recommended to add an alternative to those features. Inline CSS also doesn't work on Fandom, but CSS on this page will load (but only to mobile users). Where styling might be an issue for desktop or mobile you can use a trick in Source editor to hide the unwanted parts on desktop or mobile and replacing them with others. Use the following:

<div style="display:none"> <!-- For mobile users. -->
//text here will be displayed only to mobile users
</div>
<div class="hidden"> <!-- For desktop users. -->
//text here will be displayed only to desktop users
</div>

Sometimes images can also be problematic, because they don't always display the same on mobile as on desktop. If you have more than 2 images, use galleries.

Linking

Not every word that has a page should have a link. Do not link words to the same page name they're on (example: do not link "Food Stall" on page "Food Stall"), unless you link it to a section. It's recommended to only link the first appearence of a word with a page. Too much linking hurts user experience so be responsible with linking and think if a word really needs a link.

Links are made by highlighting a word then pressing ctrl+K or clicking on the "Link" icon in Visual Editor and selecting the appropriate page. Linking to a section (heading or subheading) on a page can be done in Source Editor by writing [[page_title#page_section|displayed_text]]. Linking the word "character - skills" to page Character, heading Skills: [[Character#Skills|character - skills]]. Linking to a subheading in Source Editor: [[Quests#Chapter_II_:_Smuggler.27s_map|Shogun's Katana Chapter II]].

Level vs. lvl. vs L

When "level" is followed by a number use "lvl." instead.

Also use "character level" instead of "guild level" so it doesn't get confused with Guild (building).

Capitalization

Every word should be written with matching uppercase and lowercase letter as it is written in-game.

A special case for this guideline would be the FAQ page. Sometimes players don't know what an item/artifact/object is called. That only applies to questions. It makes the answer easier to find.

• Tabs:
  • Capitalize when referring to the tab or page.
  • Special case: "Hall of Fame".

• Buildings:
  • Capitalize all words in the name.
  • Write in lowercase when referring to objects ("ship" when referring the the boat or "cauldron" when referring to the black pot).
  • Related: ship missions, caravan missions, etc. are all written in lowercase.

• Items:
  • Capitalize the first word.
  • Write in lowercase when referring to a group of items (e.g. treasure maps).
  • Note: items can be written without parentheses (e.g. "Bomb (Horoku)" => "Bomb").

• Mission types/destinations:
  • Capitalize all words (e.g. Trading, Treasure Island, Mexico City, etc.).

• Character classes and skills:
  • Capitalize all words.

• Haruka - skills (sometimes also called expedition skills):
  • Capitalize all words.
  • Note that "Some more coffee!" has an exclamation mark.

• Artifacts:
  • Capitalize the first word.

• Craftifacts:
  • Capitalize the first word.
  • Note that "Haruka" in "Necklace for Haruka" is capitalized, because that's her name.

• Quests:
  • Capitalize all/most words (note that "of", "the", "a" and "teeth" are in lowercase).
  • Write in lowercase when referring to a group of quests (e.g. daily quests (Puzzle of the Day and Wanted), festival quests, forest quests, etc. - these group names should generally be avoided, because they can be ambiguous), expect for the actual group names/questlines (e.g. "Once Upon a Forest").
  • Note: "WANTED" can be written as "Wanted".

• Achievements:
  • Use "achievements" when referring to more than one achievement; use "Achievements" when referring to the page or tab.
  • Most words are capitalized (exceptions are words like "the", "of", etc.). Full list: Achievements.

• Other:
  • Mosaic (Fragment)
  • mosaic (when NOT referring to the tab, page or quest)
  • Cooking
  • Charity
  • character level
  • experience points
  • expedition (when NOT referring to the tab or page)
  • bugle ()
  • "sack" ()
  • Nonograms Katana
  • firework(s) (when referring to the fireworks seen in Territory when completing the Festival quest or through Alchemist's Hut)

The whole list doesn't have to be remembered. If any of these words written wrong, please correct them. This list is meant to uniform capitalization of words on the wiki.

Time

Times should be written in UTC (Coordinated Universal Time).
When writing time in hours, minutes and seconds use this format: 12h 34m 56s.

Uploading images

It's better too many images than too little. Note that when uploading images to a already establish collection (e.g. new building level), please follow the already established format:

• Same ratio - if all images in that gallery/collection are in 2:3 (width:height) format, follow that format. Note that buildings also follow the same rule, although they have more precise ratios. This is important especially for galleries, because otherwise images look a bit longer or shorter compared to other images in the gallery.
• Same file extension (usually ".png") - this is really only important for images that are generated from a module/database (like items, Dungeon: enemies, etc.), but for other images it doesn't matter.

For items

When uploading images for items please follow this:

• Images must be in ".png" format.
• Size doesn't matter, as long as it's a square (50x50px, 75x75px, 120x120px, etc.) - higher quality is better.
• Dark brown background (screenshot when in Warehouse section (not the building) - item has to be owned; screenshots of items acquired from levelling up or solving nonograms are even better).

If for any reason the screenshot doesn't want to be edited, please upload the whole screenshot instead.

Image of an item can also be replaced with a better quality version.

In case the item is not owned and the image has not yet been uploaded on the wiki, upload what ever version possible. The image should still be a square and have a ".png" extension.

Uploading images: "Explore" > "Images" > "Add new image" (top right corner). Then drag and drop the desired file and press "Upload file".

For solved nonograms

Follow the examples on Black-and-White Nonograms#Miniatures Part 1 (10-22, Author: belko61).

Images should be added to the wiki by screenshotting solved nonograms (after you solve a nonogram, exit and then tap it again). Images should be cropped so that the black border line of the number bars are also visible. The name of the cropped image should contain "category", "subcategory" and "name_of_the_nonogram" (example: Black-and-White Nonograms, 10x10, Cherries.png). Preferably in ".png" format.

Pages should be edited by inserting a gallery under subcategory title and then add all images in the same order as the app. Caption of the image should be "category", "subcategory", "name_of_the_nonogram" ("size", "mark") (example: Black-and-White Nonograms, Miniatures Part 1, Ice cream (11x20, Contradiction method)) as this makes the image searchable. Sizes can be omitted, if the category itself is named that way (e.g. 10x10 folder in Black-and-White Nonograms). Marks should be written only if they exists.

File categorization

When files (images) are uploaded they should be categorized in the right categories (list of categories). This can be done by writing [[Category:name_of_category]] (e.g. [[Category:Image/nonogram]] for images of nonograms) in the "Summary" field or going to the file and adding a category there.

Modules

Modules are pieces of code written in Lua, which are meant to generate content on pages, which would be very tedious to do by hand. They also help keep the same format for all pages. Most pages that have some kind of similar information are managed by modules (building levels, crafting, dungeon enemy stats, etc.). The list of all modules can be found at Navigation page > Modules. Modules are usually split into two categories: modules that store data (databases) and modules that generate content from databases. To add new information (e.g. new building level), you don't have to learn how to code. Example for adding a new building level:

1. Go to the building database.
2. Look at how the database is structured.
3. Copy a section from the previous level.
4. Past the section below.
5. Change the variables to match the new building level.

Usually database are structured with tables (with curly brackets). Each entry is usually encapsulated with curly brackets and in there, there are variables (in green text).

Questions can be directed at The Crossblade.

Commenting on edits is recommended.