Book of Travels Wiki:Editors Guide

From Book of Travels Wiki
Jump to navigation Jump to search

Create or Claim an Account

In order to edit, you need to create a wiki.gg account. If you prefer to, you may claim your Fandom account into wiki.gg.

General Rules

  • Information provided should accurately reflect what is in the live game (not the beta servers) at time of update or page creation.
    • All uploaded information should be obtainable through gameplay alone.
    • The Wiki has agreed to use extracted data from game files only if the content is available through gameplay in the live game. An acceptable example is uploading a high-resolution image of an item which is available from a merchant in the live game.
    • Do not upload audio without speaking to an Admin.
  • Linking between articles creates a strong wiki.
    • Link to another page in the first instance it is appropriate and not again for the rest of that article.
  • Maintain consistent language, page formats, and templates.
  • Mentions of outmarks (secret areas accessible by the door icon and not the compass icon) should be hidden using a Collapsible Template in the templates section below.
  • Before creating a new page, first perform a general search and look for a similarly titled page that might have small variations in punctuation and spelling. If you find one, confirm whether its trade value, picture (if it has one), and stats are identical. If you decide it is appropriate, you can rename the page by moving it using the Move button in the More tab.

Styling

Maintain Consistent Language

Try your best to use the same type of language used on pages for similar subjects, so all teahouse pages would read about the same, as would the pages for colours and unions.

Maintain an Encyclopedic Tone

  • Remain objective and focused on the facts
  • Avoid speculation and applying an interpretation of the facts
  • Write using the third-person perspective: the he/she/they/it perspective

Write in English (United Kingdom)

  • Book of Travels uses English (United Kingdom) spellings such as colour, armour and dialogue.

Write in Plain Language

  • Plain language is written simply and consistently in a way that is easy to understand.
  • Plain language additionally avoids certain linguistic conventions, which are listed with examples in the collapsible below:
    • Slang
      • Example: Sen Vaska-bro can be found in his shop, Sen Vaska Smithy, in Crossings at any time of day.
    • Complicated language and words
      • Example: Sen Vaska can be found in his emporium, Sen Vaska Smithy, in Crossings at any time of day.
    • Colloquialisms:
      • Abbreviations
        • Example: Sen Vaska can be found in his shop, Sen Vaska Smithy, in Crossings AATOD.
      • Contractions
        • Example (if the sentence was "Sen Vaska can not be found in his shop, Sen Vaska Smithy, in Crossings at any time of day"): Sen Vaska can't be found in his shop, Sen Vaska Smithy, in Crossings at any time of day.
      • Idioms
        • Example: Sen Vaska can be found in his shop, Sen Vaska Smithy, in Crossings 24/7.
      • Turns-of-phrase
        • Example: Sen Vaska, steadfast as the old oak tree, can be found in his shop, Sen Vaska Smithy, in Crossings at any time of day.
      • Informal words and phrases known to most native speakers of a language or dialect
        • Example: Sen Vaska chills in his shop, Sen Vaska Smithy, in Crossings at any time of day.
  • A number of organizations have created guidelines related to the application of plain language in writing, including the government of the United States of America, which has published guidance on the topic:

Default to Gender-Neutral Language

Unless specifically indicated, such as how Lyre Turikett is referred to as Ninian Turikett's daughter, use gender-neutral language, including they/them or it/its pronouns, as appropriate, for NPCs.

For some entities, it is not necessarily clear whether they should be referred to with either they/them or it/its pronouns. For those entities, guidance and the associated reasoning is provided below:

Entity Pronouns Reason
Sefra They/Them A Sefra referring to another:
"Just look at the effect the water has on my dearest sister!"

Capitalize Key Words

  • Some words may have special meaning if they are related to game mechanics and should be capitalized in those instances. These key words include:
  • Some words may have special meaning if they have been defined for categorization purposes on the wiki and may be capitalized in certain instances. These key words include:

Citations

Whenever possible, include citations with links to sources:

  • Sources may be other articles on the wiki
  • Sources may be from websites outside the wiki and use this format: Author. (Date of Publication). Article Title - Article Home. Article Website Address

See General Wiki Editing Resources for a link to guidance on creating citations.

Categorization

  • All pages and files must be categorized in a way that makes sense to the typical reader and typical editor.
  • Certain categories may not be immediately obvious to editors and are described below:
    • An Event is a specific occurrence that significantly changes its environment.
      • While most Events occur in the same place every time, this is not always the case.
      • Ways an Event significantly changes its environment:
        • Additional quest NPCs, merchant NPCs, or other NPCs
          • These additional quest NPCs and merchant NPCs must have their own article
          • Sometimes an additional NPC is not able to be interacted with
          • Any additional NPCs with limited individuality are included in the Event article, rather than receiving their own article
        • Additional fixed objects
        • Changed application of visual or audio effects
    • A Group is a specific occurrence that does not significantly change its environment.
      • Instances where multiple NPCs appear without significantly changing their environment are Groups.
      • Groups sometimes share spawn points with Events.
    • A Quest is a task in which the player brings a specific item or items to a certain NPC for a specific result.
    • An Exchange is a task in which the player brings an item from a broader range of items to a certain NPC for a specific reward item or items.
    • An Endeavour is either:
      • Fixed Outcome - where the reward for Endeavour completion is always the same
      • Random Outcome - where the reward for Endeavour completion is randomized

Tables

Presenting information in a table is a nightmare and should be avoided wherever possible. Unfortunately, there are instances where information is best provided in table format and so we suffer through them.

When creating a table, enhancements can be made using Visual Editor. When appropriate:

  • Make the columns sortable
  • Make the table collapsible
    • Make the table load collapsed
  • Align cell contents to
    • Make the table more visually appealing to readers and
    • Align column headers with row data

See System Requirements for an example of a strong table that was created using some of these tips as well as the guidance and table generator tool linked in General Wiki Editing Resources.

Images

  • Images uploaded must be for use on the wiki
  • Icons (ItemIcons, Emotes, Symbols) or Objects (Fixed Objects, Reagents) images must be assets extracted from the game instead of screenshots.
    If you do not know how extract game assets, you can request an admin upload the needed images in the wiki Discord.png Discord.
  • File extracts can be used to upload high-resolution images of content available in the live game. The Wiki has agreed to only upload images of Items, NPCs and Locations that are accessible through gameplay in the live game (not through beta servers, or unreleased game files).
  • When uploading images:
    • Use the PNG file type
    • Confirm the file extension is in lowercase ("PNG" is written as "png")
    • Specify the license or copyright that allows use of the image
    • Categorize it appropriatelyCategory:Images
    • Use official (game file) image titles - if no official image title is available, describe or name the image in a way that fits styling guidelines and will make it accessible to other editors

Interactive Maps

Look into our Interactive Map Guide to see how to make interactive maps!

Resources

General Wiki Editing Resources

wiki.gg uses MediaWiki software (the software also used for Wikipedia).

Page Layouts

Common Templates

{{Quote}}

Read template documentation

Used for a quote at the beginning of an article 

{{Quote
| Hi
| [[Post Warden]]
}}

{{QuoteTable}}

Read template documentation

QuoteTable Template consists of 3 templates that interact with one another: QuoteTable Start, QuoteTable Content, and QuoteTable End.

Creates a table that allows for the insertion of as many rows as necessary for NPCs and their dialogue 

{{QuoteTable Start|CHeader=CustomHeader(not included = default to "Dialogue conditions"}}
{{QuoteTable Content
|[[NPC 1]]
|Their words
}}
{{QuoteTable Content
|[[NPC 2]]
|Their words
}}
{{QuoteTable Content
|[[NPC 3]]
|Their words
}}
{{QuoteTable End}}

{{CollapsibleStart}}

Read template documentation

{{CollapsibleEnd}}

Read template documentation

Collapsible Template consists of 2 templates that interact with one another: CollapsibleStart and CollapsibleEnd.

Hides content between the templates 

{{CollapsibleStart|toggle=CustomHeader(Default is "Show/Hide"Content)}}
Hide content here
{{CollapsibleEnd}}

{{Spoiler Warning}}

Read template documentation

A MaD frog will warn the reader of spoilers:

Take note, Khelim!
Spoiler frog.png This page contains SPOILERS from Book of Travels.

  • Circle.png {{Compass}}
  • Endeavour Symbol Mechanical.png {{Mech Icon}}
  • Endeavour Symbol Physical.png {{Physical Icon}}
  • Endeavour Symbol Esoterical.png {{Spirit Icon}}
  • Endeavour Symbol Social.png {{Social Icon}}
  • ItemSymbol Ward.png {{Ward Icon}}
  • ItemSymbol Force.png {{Force Icon}}
  • ItemSymbol Burden shadow.png {{Burden Icon}}
  • ItemSymbol Speed shadow.png {{Speed Icon}}

Retrieved from "https://bookoftravels.wiki.gg/index.php?title=Book_of_Travels_Wiki:Editors_Guide&oldid=71247"