PSP2i:Style guide

From PSP2i Wiki

This style guide exists to help make the Wiki easier to read. Articles should be written in a certain way, which makes the language and tone of the wiki consistent, making for a more positive reading experience for users.

Article Titles[edit source]

Pages must have appropriate titles. Names, locations, and titles should all be capitalised, though not the whole title. Block capitals should not be used in titles (e.g. 'Article titles' instead of 'ARTICLE TITLES'). Try to make the article's topic the subject of the first sentence in the article. For example, if talking about Shield-weaves, the page should begin with "Shield-weaves are..." and not "This page is about shield-weaves..." The first instance of the article's topic should also be bolded.

Articles about items, creatures, missions, and non-player characters should be titled exactly as the subject's name appears in-game. If you are unsure about the capitalisation of a word, check in-game before writing it, or correct it shortly thereafter. MediaWiki is case-sensitive when it comes to links as well, so always make sure you have the correct capitalisation.

Words such as articles and short prepositions in titles should be left un-capitalised, unless they are intended to be capitalised. These include words such as 'a', 'the', and 'of'. For example, the item World of Guardians does not have the word of capitalised.

Sections and headings[edit source]

Separating articles into sections makes them easy to read and navigate. Headings are used to split articles into sections.

Markup[edit source]

Use two equal signs (==) style markup for headings. Start with ==, add the heading title, then end with ==.

This section's heading was created with the markup:

==Sections and headings==

This subsection's heading was created with the markup:


Wording[edit source]

  • In a heading, capitalise only the first letter of the first word and the first letter of any proper nouns, and leave all of the other letters in lowercase. This does not apply for any names that may be referred to, such as Photon Arts or mission names, which have every word capitalised.
  • Avoid putting links in headings.
  • Make sure that the heading has an appropriate and accurate title, as this is important to help readers navigate the article. For example, do not make a "Photon Arts" section in an article on ranged weapons, and then list Charge Shots in there alongside bullets, as they are not the same thing. All ambiguity must be avoided. While there are terms used incorrectly that have become common lexicon (such as understanding charge shots as Photon Arts), we hope that the wiki is able to decouple these through consistent proper usage.
  • Keep headings short.

Lead sections[edit source]

A lead (introduction) summarises the most important points of an article, creating interest in the topic. Thus, it should be limited to a few paragraphs. Certain information, such as strategies and trivia, should be in a separate section instead of in the lead. This applies only to articles that are of sufficient length to incorporate a lead.

Text elements[edit source]

Font colours[edit source]

Coloured font can be used sparingly. Make sure that the colour shows up well on both light and dark backgrounds, as both are in use (dark for desktop, light for mobile).

Invisible comments[edit source]

Invisible comments are used to communicate with other editors in the article body. To do so, enclose the text which you intend to be read only by editors within <!-- and -->. For example, using <!-- This is a comment --> will be hidden in the article.

Bulleted lists[edit source]

Bulleted lists can be used for various lists. For example, you can use bullets if you're listing various comments about a Photon Art's mechanics. Do not forget proper punctuation. To add bullets, put an asterisk (*) before the name. For example:

* List name 1
* List name 2
** Sub-list

would come out as:

  • List name 1
  • List name 2
    • Sub-list

Numbered lists[edit source]

All the rules for bulleted lists apply also to numbered lists. Numbered lists can be used for listing steps in a process. To add a numbered list, put a number sign (#) before the list name. For example:

# List name 1
# List name 2
# List name 3

would come out as:

  1. List name 1
  2. List name 2
  3. List name 3

Bold and italics[edit source]

Place two apostrophes (''Italicised text'') on either side of a selection of text to italicise the selection. Italics are mainly used to emphasise certain words, though they should be used sparingly. Also note that Phantasy Star Portable 2 Infinity should always be italicised. Long stretches of italics are hard for some users to read.

Place three apostrophes ('''Boldfaced text''') on either side of a selection of text to boldface the selection. Bold is used as a stronger emphasis than italics, although it should be used extremely sparingly within articles, such as for a few critical points, and ideally not a whole sentence. However, the first appearance of an article's title in the article should always be boldfaced, i.e.:

Swords are one of Hunter's...

Place five apostrophes ('''''Boldfaced and italicised text''''') on either side of a selection to use bold and italics in combination on the selection. Bold and italics combined emphasise selections well, but should be used extremely rarely: bold italics represent more emphasis than is normally ever necessary.

As you can see, bold works well to emphasise sentences as well as short phrases and single words, while italics are a much weaker emphasis for sentences, but work well on short phrases or single words. Bold and italics are used in combination very rarely. Excessive use of any of these text elements will make the entire article difficult to read, so please use them in appropriate situations.

Grammar and spelling[edit source]

Case[edit source]

  • All place names, item names, creature names, NPC names, mission names, (etc) and Photon Arts are proper nouns – always uppercase, per ingame.
  • Other things should have common sense applied on a case by case basis. Normally, it should be easy to work out what to do.

Abbreviations[edit source]

Try not to use abbreviations. For example, use "crossbow" instead of "xbow". Some players may not know what these abbreviations mean. And, as far as looks go, it's much more pleasing to the eye to look at "Charge shots result in higher overall damage output than crossbow normals." than "CS is highest DPS than xbow normals". It's even worse when you type something in "Leet Speak" also known as "1337 5P34K". This wiki's preferred language is English, not numbers.

Punctuation[edit source]

If you are listing multiple things, like different photon arts, each of them should have a serial comma (also known as an Oxford comma) at the end. For example, "Grand Crusher, Tornado Break, and Spinning Break" would be proper, whereas "Grand Crusher, Tornado Break and Spinning Break" would not be.

If ever compiling a sort of list which includes quantities, do not place the quantities in brackets, as this can be confusing alongside other potential bracketed things. Something should be wrote as "5 Phantomite Stones" or "5x Phantomite Stones", not "Phantomite Stones (5)".

Usage and spelling[edit source]

  • Phantasy Star Portable 2 Infinity should be italicised.
  • SEGA should always be spelled as SEGA, not Sega or sega or any other variations.
  • Non-British spelling should be used at all times.
  • For directions and compounds, hyphens should be included. For example:
    • South-west instead of southwest
    • North-east instead of northeast

Tense[edit source]

A rule of thumb is to use present tense in all cases. For example, articles for missions, photon arts, activities, non-player characters, etc. should be written in present tense. An exception to this rule would be events that have occurred in the past, or for in-game content that has been removed. For example, official SEGA events that have already occurred should be written in past tense.

  • Past tense: Past events and history regarding official service
  • Present tense: All other cases

Common grammatical errors[edit source]

then and than

Despite their pronunciations being very similar, they are different in meaning.
Then is used in one of the three following cases:
1. at that time; at the time in question.
"I was living in Cairo then."
2. after that; next; afterward
"She won the first and then the second game."
3. in that case; therefore
"If you do what I tell you, then there's nothing to worry about."
"Well, that's okay, then."
Than is used in comparing two elements in a sentence
"He was much smaller than his son."
or in expressions introducing exceptions or contrasts
"He claims not to own anything other than his home."

its and it's

Its is the possessive adjective and possessive pronoun form of the personal pronoun it.
"He chose this area for its atmosphere."
On the other hand, it's is a contraction (shortcut) for it is OR it has.
it is – "It's my fault."
it has – "It's been a hot day."

their, there, and they're

Their is possessive, referring to an object, or objects, belonging to a certain number of people.
"The ball is their property."
There is an adverb, referring to a certain position or area.
"We went on to Paris and stayed there eleven days."
They're can also be confused with their and there. They're is a contraction for they are and they were, depending on how the sentence is constructed.
"The reason that they're going to the store is to buy more milk."

should of

The reason people write "should of" when they mean should have is because the contraction of should have (should've) is pronounced like "should of". Avoid "should of" like the plague. Instead, write "should have".
"Those rookie editors made the mistake of writing 'should of' when they meant 'should have'".

a herb and an herb

A herb is the correct term as the "h" at the start of herb is not silent. American accents clip the "h", which means that an herb would be incorrect.
"Guam is a herb that can be farmed"

amount and number

Amount refers to a quantity that can be measured. Number refers to a quantity that can be counted.
"Higher levels require a greater amount of experience."
"The maximum number of players in one game is 4."

much and many

As in the above example, much refers to a quantity that can be measured. Many refers to a quantity that can be counted.
"How much experience do you have?"
"How many people are in your game?"

alter and altar

An altar is a piece of furniture used in worship. To alter is to change something.

affect and effect

One thing may affect (or change) another. The result of an action is its effect or effects. Also, to effect is to produce.

your and you're

The word your is the possessive form of the word you.
The word you're is a contraction of the words you are.

duel and dual

You would have a duel against another person.

You would dual-wield two swords, or have a dual personality, meaning you have two sides to you.

Point of view[edit source]

Articles should be written in the third person or objective point of view. Using the word "you" in articles is informal and should be avoided except if it is inside a quotation; try to use "players" or "the player" instead.

For guide articles that are intended to speak to a user to instruct them on how to accomplish something, "you" is acceptable, or imperatives can be used (i.e. Go to the mission counter). Avoiding "you" in this case may be very unnatural.

Images[edit source]

Some general guidelines which should be followed are listed below.

  • All images uploaded to the Wiki should be in the PSP's original resolution with no modifications. Images which are upscaled, rendered at higher resolutions or use texture injection should not be uploaded. All images must remain as faithful and accurate to the original as possible. The original PSP resolution is 160x120.
    • The exception to this are the 160x120 visiphone images for monsters and creatures. These images should be uploaded at a resolution of 320x240 with Bilinear upscaling (Bicubic in PPSSPP), as this enables image previews. They should then be resized to 160x120 on the pages they are used on.
  • Right-alignment is preferred to left- or centre-alignment.
  • If there are too many images in a given article, consider making a gallery with a level two heading.
  • Use captions to explain the relevance of the image to the article.
  • Make large images a thumbnail.
  • Specifying the size of a thumbnail image is not recommended.

Uploading images[edit source]

  • The preferred formats for images are PNG.
  • Please name your files descriptively to avoid confusion. For example if you are uploading a picture of a weapon, name it World of Guardians.png and not just 15startwins.png or wog.png.
  • Don't upload images we already have. Before you upload an image, search the wiki if someone has already uploaded a version of it.

Captions[edit source]

Complete sentences in captions should always end in a full stop (period). If the caption is not a complete sentence, it generally should not have a full stop at the end. Captions should also not be italicised.

Wiki-linking[edit source]

  • Every time an article is mentioned on the page, you don't have to link to every single one. For example, My Room may be mentioned five times. You only have to link to My Room once. You can link to articles more than once if the page is very long.
  • When including wiki-links in an article, there is no need to use underscores or initial capitalisation, since the software produces them automatically. For example, [[twin_sabers]] and [[Twin Sabers]] work the same as [[twin sabers]].

Writing articles[edit source]

Everyone is encouraged to contribute meaningfully to the wiki.

Ownership and bias[edit source]

  • Keep personal bias out of articles. Even if "Absolute Dance is for noobs" or "Shotguns are awesome", we do not need to hear it in the articles.
  • Nobody owns articles. This is a wiki, after all. This means words like "I", "we" or "me" should not be included in articles.
  • Do not include specific names of players or groups of players in articles.

Numbers[edit source]

For numbers, a comma should be used as a thousands separator.

Dates[edit source]

If using dates, the format should be year first, month second, day last. (yyyy/mm/dd - 2007/05/21)

Time zones[edit source]

If times are to be specified, they should be in UTC.

External links[edit source]

Feel free to link to other sites, but if ideal, try to bring their information onto the wiki unless not possible at all.