Help:GTWiki style guide

From Ghost Trappers Wiki
Jump to: navigation, search
Gtwiki header.gif

Contents



General info


No-nos

Do not upload images of game items that have not been released yet in the game.

You're not clever because you've found the repository — and you're not the only one who knows where those images are.

Respect the developers' preferences, and stay out of that repository.

Adding un-released items to the wiki is grounds for immediately having your wiki account banned.

Dates

Dates in the GTwiki should always be in the form DD month YYYY (so this page was first created on 2 November 2009).

Numbers

We use Western/USA conventions for number separators: so 24,852, not 24.852.

Minus

Please don't use a '-' character to indicate a negative value. Instead, use the string "& m i n u s;" as the way to show a proper minus sign. So for a cooldown change of 3 minutes, it'd be −3 not -3 (& m i n u s;3 not - 3. (extra spaces added so that the wiki software wouldn't automatically turn the strings into minus signs).

Spelling

We use both British and US spelling conventions interchangeably.

We silently correct a number of in-game mis-spellings (and the sysop then periodically passes a list of the mis-spellings, unnecessary capitalizations, grammar boo-boos, etc. back to the devs for cleanup).

Fonts and sizing

Except in a very few instances, we do not use a specific font size nor do we encourage the use of tags such as <big> and <small>. We recognize that people view the wiki on machines with a variety of monitor sizes and type preferences and we prioritize clean delivery of the information.

This means, among other things, that we do not optimize column widths or type size so that a page looks "pretty" on any particular sized monitor.

<nowrap>

We do use the <nowrap> tag around the names of ghosts, mechanisms, and magic circles in the first column of tables so that readers can easily identify the subject of that row of information.

Table column sorting

Certain tables are deliberately arranged in a particular order so that items, such as mechanisms, are displayed in the order in which they are encountered in the game. These tables are regularly set to be unsortable. Other tables are set up to be sorted by only some categories of information. Please do not change those table settings without checking with the Sysop first.

Names


We try to be very consistent in our name usage, to simplify pages and to minimize the number of searches a player must do to find a certain game item.

To accomplish that consistency, we have several different variables that can be used on a particular page.

The name variables you will see most often are:

  • {{PAGENAME}}
  • {{uc name}}
  • {{lc name}}
  • {{lc init name}}

As much as possible, use the {{PAGENAME}} variable or the {{uc name}} variable at the beginning of sentences whenever you're referring to the item a particular page is about.

When you are referring to an item a page is about in the middle of a sentence, use the {{lc name}} variable should be used instead. (Hint: If the sentence needs an article such as "a", "an", or "the" before the item name to read correctly, in English, then the item name should not be upper-cased, and the {{lc name}} variable should be used.

Obviously, you will continue to use the PAGENAME (or UC NAME) variables when you are referring to a contract that is a person's name, etc.

The {{lc init name}} variable is a special use case — it is used with things like the little H.O.U.N.D. companion, where there is no need to maintain capitalization on the first word in the item name, but later capitalization should be maintained.

Highlighting


Section headers are bolded automatically. A very few links are bolded.

In general, please try to limit your use of bold and highlighted text. We want to keep most pages relatively short and uncluttered so that it's easy to read and interpret the information on them. Too much highlighting is distracting and not useful.

Virtual Scotland

When we refer to Virtual Scotland it should always be italicized.

Specific highlighting "do-nots"

  • Do not bold the name of the ghost, trap, contract, etc. that is the subject of the page.
  • Do not bold the word "not" as I did in the previous item.
  • Do not use capital letters to try to highlight a word or phrase.

If you see any of these things done on a page, feel free to remove the highlighting.

Table highlighting will be discussed elsewhere.

Links


Whenever possible, use links to refer to other topics that already exist in GTWiki. Don't assume that the reader knows that a certain type of information is present — use the links. Any item that is within Ghost Trappers should have a page of its own or be included on another page. Use the wiki search box if you're not sure what the correct link for an item is.

Links to pages

Lowercase the name of most pages when you are referring to the item that is described on a given page. Only keep the page name capitalized when it is either:

Links back to the game

We often refer to parts of the game interface (Inventory, Office, etc.) and it sometimes makes sense to link to the game rather than linking to additional information about that piece of the interface. You can particularly see this with the links back to the in-game message boards for trading juices, vintage whiskys, Nessy's, etc.

Other external links

We limit links to non-game external links severely. We do allow links to Paypal and Cherry Credits as donation processing agents. We link to a bar that was explicitly credited with being the inspiration of one of the cocktails.

We do not link to sites that show images that someone thinks is the inspiration for the artwork for a particular ghost, mechanism, contract, etc. Those links will be removed if found.

Periodically we get people spamming things like term paper writing urls on wiki pages. Delete such links if you find them, and send the Sysop a message about the vandalism.

Name changes


Periodically names of ghosts or of other game elements may be changed. To preserve the overall history of the game, we will move the contents of the original item page to the new name (so if a new page is created for the new name, it will be overwritten).

Preserve the original name

We will preserve the original name of the ghost or item in the initial history items (i.e., remove the "PAGENAME" variable from the original history items that were created prior to the name change and replace them with the original name. All references to the original name (use the "What links here" item from the left hand side-bar to locate the references to the original name) should be updated to the new name.

Images


Image naming conventions

To make the images for primary game elements easier to sort and identify, we using the following naming convention:

  • Category-{{PAGENAME}}.jpg
  • Spaces in the Category and in the {{PAGENAME}} are replaced by an underscore.
  • Between the Category and the {{PAGENAME}} insert a dash.
  • Use capital letters only at the beginning of the name, unless they are used elsewhere in the {{PAGENAME}}.

Examples:

  • Ghosts-Aiming_cricket_ghost.jpg
  • Ghosts-Bizarre_Superghost.jpg
  • Magic_potions-Moormist_purple.jpg
  • Magic_potions-Whisperwind_blue.jpg
  • Mocktails-Midnight_smash.jpg
  • Companions_lvl5-Ghost_ferret.jpg
  • Companions_icon-Ghost_ferret.jpg
  • Mechanisms-Sleeping_dragon.jpg
  • Magic_circles-Black_candle.jpg
  • Molding_pieces-Wax_pyramids_1/2.jpg
  • Locations-Loch_Trool.jpg

Images that are not named according to these conventions will be deleted from the wiki's database.

Image usage

For companions, we only use the level 5 image of the companion in its basket. Do not upload images of the companion at levels 1–4.

Whenever possible, we prefer to have images saved as .jpg files.

Section titles and headings


Keep titles short. Avoid punctuation in titles, particularly as the final character.

Page and section titles should generally be of the form "Noun" or "Noun phrase". Try not to repeat the page name in the title of a section.

So, "Catching ghosts" rather than "About catching ghosts".

Assume that words in the page title or another section on the page do not need to be repeated or referred to. (so, a section on the Mr. Bastian Shaw contract page does not need to be labelled as "Mr Bastian Shaw contract bonuses" but could be "Bonuses".

Section titles and heads should strike a balance between being overly-broad and overly-narrow — this is somewhat of an "I know if when I see it" situation/judgment. I'll try to add some examples as I find them.

Standardized headings

We are working to standardize headings on ghost pages, on contract pages, on companion pages ... pretty much any page where the item is one of many similar things.

Do not change those standardized headings -- the list of currently standardized headings for each page type will be posted soon.

Formatting section headings

Very few pages in GTWiki are highly complex, so we, as a general rule, do not need all of the heading levels that are available.

Specifically:

  • Do not use a Level 2 ("==") heading.
  • The primary sections on most GTWiki pages should be a Level 3 ("===") heading. That heading level should always be followed by a horizontal rule.

Example of a Level 3 head, followed by a horizontal rule


Sections related to a Level 3 heading, (such as "Locations", "Ghosts", etc., on a type of loot), should be give a Level 4 ("====") heading.

Items such as the "History" section and a "See also" section on item pages should always get a Level 3 head, followed by the horizontal rule.

Capitalisation and section titles

In general, only capitalise the first word of a section title.

Exceptions may include things like:

  • Where the section title is the name of a person or item in the game (capitalisation of names within GT is erratic; we generally try to match the in-game usage).
  • Where the section title is the name of an event (i.e., "Haunted Week III")

Changing section titles

Remember to check on the pages that refer to an existing section title before changing that title. You can find those links in the left-hand column under "What links here".

If you change a title, change all the links that were pointing to that section so that they now point either to the new section title or to the page title.

Templates


We have lots of templates and will try to generate a list of the ones most used by editors soon.

We use templates to standardize content ordering (so, for example, on ghost pages, the description section always comes before the info section), to standardize content (as in the way the same attribute is described the same way in the graphic box at the top of each contract page), and to make updating easier.

If for example, there's suddenly a totally new icon for XP, we can accomplish a transition to using it by updating the appropriate template or templates, and the pages will automatically reflect those changes the next time they are opened. That way we've accomplished about 99% of the work in a very small amount of time and can concentrate on finding all the other places we use that icon.

Templates come in two flavors:

  • Templates included by reference (looks like: {{template-name}} or {{template-name|value}} ).
  • Templates substituted in (in these instances, you are unlikely to see a specific reference).

The templates that are substituted in are generally composed of a number of smaller templates (so that we still get the benefit of automatic updating) but also give us the ability to delete sections or items that are irrelevant to a particular page.

Templates that are substituted in are templates where there is content that *if present* we'd like to be consistent across all wiki pages (for example, the top box on a companion page that is right-aligned), but some of the content will not be present on a significant percentage of the pages.

Formatting templates

We use some templates to easily and cleanly control certain types of formatting or presentation:

Sorting

We often substitute undisplayed span elements with numeric content to enable us to easily sort, for example, by ghost scare factor. The "sms" template allows you to do this without having to write out the entire syntax. Instead you type {{sms|numeric-value}}Scary or other appropriate scare factor and the text will sort in order of the scare factors.

Breaking after a table

Wikimedia software likes to fill up a page with text, and will often put a new section that we intend to follow a table in a separate column top aligned with the top of the table, rather than having it follow as was intended. You can foil this behavior by using the "-" template. {{-}} forces the software to clear its buffer following the table and essentially not recognize that there's available width up column.

Personal tools
Equipment stats