Difference between revisions of "The re-PSUPedia:Manual of style"

Revision as of 20:12, 19 August 2009

The manual of style is a guide meant to be used by contributors of the PSUPedia to bring together the content of this site in a consistent, easy-to-read format. Contributors should work together to make the styles detailed here a standard of the site.

Writing an article

The purpose of all articles within the PSUPedia is to relay accurate facts to the readers. As such, all information given must be from an objective standpoint; in other words, straight, unbiased facts. Subjective, opinionated material will be removed.

Also, for the sake of consistency, all articles should be written in American English.

Appropriate use of italics

Italics should be used when referring to the proper title of a work such as a book, magazine, game or movie. For example, "Ambition of the Illuminus is the title of Phantasy Star Universe's first expansion."

Headings and sections

Many articles are divided into individual sections and subsections. Each main section should be created by using double equals signs on both sides of the section title. For example:

== Headings and sections ==

When subsections are used, a series of three equals signs on both sides of the subsection title should be used. For example:

=== Subsection title ===

The first letter of a heading's title and the first letter of all proper nouns following will be capitalized. All other words will be in lowercase.

Capitalization

The standard rules of capitalization in the English language should be applied to the text of all articles. However, there are a few exceptions which are specific to the Phantasy Star Universe series.

• The term TECHNIC will always be completely capitalized. The plural form will retain capitalization, however the s at the end will be in lowercase. TECHNICs, for example.
• When referring to the GUARDIANS as an organization, all letters of the name will be capitalized. GUARDIANS Colony, for example. If you are referring to an individual or group of members from this organization, only the initial G should be capitalized. Example: "Leo Berafort is a Guardian."
• The term SEED will always be completely capitalized when referring to the lifeforms from space.
• Certain manufacturers and their product lines will be completely capitalized. Examples include TENORA WORKS, KUBARA SPREAD and ROAR ROARS. Please refer to in-game usage for further examples.
• All letters of the race name CAST, despite not being a proper noun, are to be capitalized. The plural form of this name retains all capitalization, but the s at the end will be in lowercase. For example, CASTs. All other race names require no capitalization, unless placed at the beginning of a sentence: humans, newmans and beasts.
• Weapon categories, unless as the first word of a sentence or article heading, will be in lowercase. The first letter of the name of a specific weapon will be capitalized. (For example: "The Kazarod is a type of rod.") As a general rule, pay special attention to in-game capitalization, as certain hyphenated names do not seem to follow a specific set of guidelines. (Mira-kikami and Giza-Misaki, for example.)
• All battle type names should be considered proper nouns, thus requiring the capitalization of the first letter of each name. The same applies to the names of all photon arts.
• Line shield names, just as with weapons, are proper nouns and should be capitalized. ("Yohmei produces the line shield Hel-senba.")
• Individual items (recovery items, food, synthesis materials, etc.) are to be considered proper nouns, therefore requiring the capitalization of the first letter of each word. ("GRD-DS sells Moon Atomizers for 350 Meseta.")

Weapon and line shield tables

When editing pages covering a certain category of weapons, use this format to develop a new table or build on an existing one. This example demonstrates how the code works. Examine the code as displayed in the first section, and keep in mind the following:

• If you don't know how Wikitables work, check out the help article on tables at Wikipedia.
• The "Rank" category groups weapons by their general rank and specific star rating.
  • As seen below, this is accomplished with a "rowspan" command that specifies the number of other rows this will cover, as well as the appropriate color for the letter rank and the specific star rating ({{Color-C}} for C, {{Color-B}} for B, {{Color-A}} for A and {{Color-S}} for S).
• Add header rows for every new letter grade of weaponry.
• If one of these weapons is not yet released in the Japanese version of PSU, use the code {{Unreleased item}} in the row divider above it (|-).
• If one of these weapons is only released in the Japanese version of PSU, use the code {{JP item}} in the row divider above it (|-).
• Any items that are exclusive to Ambition of the Illuminus should use the code {{AOTI version}} in the "Ver." column. {{PSU version}} should be used on all other items that are available in all versions of the game.
• {{AOTI SU version}} should be used for any items released after Japan's AOTI supplemental update which feature new models for the PC version while reusing existing models for the PS2 version.
• The "[B]" column displays the availability of synthesis boards for the listed items. {{Unreleased item}} | {{Board icon}} should be used when one is not available in any version of the game. {{Unreleased item}} | {{Board icon}} should be used when one is only available in the Japanese version. {{Board icon}} should be used for boards released in the local version.

What you type:
{| class="wikitable" style="text-align:center"
! Rarity !! Name !! Mfr. !! PP !! Att. !! Acc. !! Req. !! Ver. !! [B] !! Comments
|-
| {{Color-C}} rowspan="3" | 1★
| [[Sample]] || {{Logo-G}} || 230 || 72 || 42 || 27 || {{PSU version}} || {{Board icon}} || --
|-
| [[Samplesou]] || {{Logo-Y}} || 260 || 64 || 38 || 29 || {{PSU version}} || {{Board icon}} || --
|-
| [[Shigga Sample]] || {{Logo-T}} || 200 || 76 || 45 || 30 || {{PSU version}} || {{Board icon}} || Drop: [[Sample Monster]] LV1-9
|-
! Rarity !! Name !! Mfr. !! PP !! Att. !! Acc. !! Req. !! Ver. !! [B] !! Comments
|-
| {{Color-B}} rowspan="1" | 4★
| [[Sample Mk. 2]] || {{Logo-G}} || 333 || 302 || 149 || 164 || {{PSU version}} || {{Board icon}} || --
|- {{JP item}}
| {{Color-B}} rowspan="2" | 6★
| [[Sample Mk. 3]] || {{Logo-G}} || 356 || 450 || 212 || 266 || {{PSU version}} || {{Board icon}} || --
|-
| [[Samplesou Mk. 2]] || {{Logo-Y}} || 403 || 402 || 189 || 281 || {{AOTI SU version}} || {{Board icon}} || --
|-
! Rarity !! Name !! Mfr. !! PP !! Att. !! Acc. !! Req. !! Ver. !! [B] !! Comments
|-
| {{Color-A}} | 7★
| [[Shigga Sample Mk. 2]] || {{Logo-T}} || 340 || 553 || 253 || 325 || {{PSU version}} || {{JP item}} | {{Board icon}} || Drop: [[Sample Monster]] LV80-99
|-
! Rarity !! Name !! Mfr. !! PP !! Att. !! Acc. !! Req. !! Ver. !! [B] !! Comments
|-
| {{Color-S}} | 10★
| [[Shigga Sample Mk. 3]] || {{Logo-T}} || 380 || 732 || 373 || 488 || {{AOTI version}} || {{Unreleased item}} | {{Board icon}} || Drop: [[Sample Monster]] LV100+
|- {{Unreleased item}}
| {{Color-S}} rowspan="1" | 12★
| [[Shigga Samplec]] || {{Logo-K}} || 300 || 625 || 618 || 617 || {{PSU version}} || {{Unreleased item}} | {{Board icon}} || Still unreleased in JP.
|}

The resulting table:

Rarity	Name	Mfr.	PP	Att.	Acc.	Req.	Ver.	[B]	Comments
1★	Sample		230	72	42	27			--
	Samplesou		260	64	38	29			--
	Shigga Sample		200	76	45	30			Drop: Sample Monster LV1-9
Rarity	Name	Mfr.	PP	Att.	Acc.	Req.	Ver.	[B]	Comments
4★	Sample Mk. 2		333	302	149	164			--
6★	Sample Mk. 3		356	450	212	266			--
	Samplesou Mk. 2		403	402	189	281			--
Rarity	Name	Mfr.	PP	Att.	Acc.	Req.	Ver.	[B]	Comments
7★	Shigga Sample Mk. 2		340	553	253	325			Drop: Sample Monster LV80-99
Rarity	Name	Mfr.	PP	Att.	Acc.	Req.	Ver.	[B]	Comments
10★	Shigga Sample Mk. 3		380	732	373	488			Drop: Sample Monster LV100+
12★	Shigga Samplec		300	625	618	617			Still unreleased in JP.

Color-coding for items

A standard has been established for the PSUPedia to help readers differentiate between items that have become available on all servers, those that are only available on the Japanese servers and those which are not available in any version of PSU. These color codes should be used for the background of the cell containing the name of the item in question.

A color-coding system has also been implemented for items to identify their star ranking when listed in a table. This system is based on the color scheme used in-game.

Individual item pages will display a series of color-coded stars (as opposed to a number followed by a star) to identify an item's rarity. This system is based on the in-game color-coding.

{{13 stars}}

The preceding code produces this:

Replace the number within this tag with the appropriate number of stars for the item in question. If the item is a single-star item, remember to make stars singular: {{1 star}}.

Abbreviations

Contributors should avoid the use of non-statistical abbreviations (type names, for example) when writing articles, instead limiting their use to tables and charts. The following list details all accepted abbreviations used in the PSUPedia.

Unlocalized terms and names

When it comes to gathering information on upcoming updates to Phantasy Star Universe, be it a simple content update or a brand new expansion pack, the vast majority of this information comes from Japanese sources. In this case, a speculative translation must be made for things such as character, place and item names. When this is done, the name is considered unofficial and all instances of it should be enclosed in parentheses until an official localization is made. As an example, the mission we now know as Fight for Food was originally known as (Farm Plant Recovery).

Item star rarity

When referencing the rarity of an item, consistently use a ★ as opposed to an asterisk. Of course, as stated on the front page of the PSUPedia, you must have Japanese language support installed on your computer for the star symbol to appear properly. There are two methods of input for this star:

• Copy and paste it from another article.
• Using Japanese IME, type hoshi and then press the space bar to input the symbol.

Individual weapon, line shield, etc. articles

Individual weapon pages should follow the guidelines set forth by these templates.

Individual item articles

For items such as synthesis materials, consumables and traps, the follow page layout should be used.

''The exact in-game item description goes here in italics.''<br/>
{{13 stars}}

== Item details ==
* Random information on this item
* Will be posted in a bulleted list
* Such as this one.

[[Category:--]]

This will create articles such as this and this.

User pages

While all articles within the PSUPedia must follow the standards of this guide, individual user pages are the exception. Please feel free to use whatever style you prefer on your user page.

In-game descriptions

Concerning articles that use italicized in-game descriptions, the exact description as it appears in the game (excluding hyphens for line breaks) must be used. This includes all typos, misspellings, spacing and other miscellaneous errors. However, please do not include [sic] following the incorrect spelling or punctuation.

Use of wiki templates

Pre-made templates should always be used to save space and make writing articles easier. The following table compiles all templates that are currently in use at the PSUPedia and displays their effects to the right.

What you type	What you get
{{Logo-G}}
{{Logo-Y}}
{{Logo-T}}
{{Logo-K}}
{{PSU version}}
{{AOTI version}}
{{AOTI SU version}}
{{Sword icon}}
{{Knuckles icon}}
{{Spear icon}}
{{Double saber icon}}
{{Axe icon}}
{{Twin saber icon}}
{{Twin dagger icon}}
{{Twin claw icon}}
{{Saber icon}}
{{Dagger icon}}
{{Claw icon}}
{{Whip icon}}
{{Slicer icon}}
{{Rifle icon}}
{{Shotgun icon}}
{{Longbow icon}}
{{Grenade icon}}
{{Laser cannon icon}}
{{Twin handgun icon}}
{{Handgun icon}}
{{Crossbow icon}}
{{Card icon}}
{{Machinegun icon}}
{{RCSM icon}}
{{Rod icon}}
{{Wand icon}}
{{TCSM icon}}
{{Color-C}}	C-grade items
{{Color-B}}	B-grade items
{{Color-A}}	A-grade items
{{Color-S}}	S-grade items (10-12★)
{{Color-S2}}	S-grade items (13-15★)
{{JP item}}	Japan-only items
{{Unreleased item}}	Unreleased items
{{Rotational item}}	Seasonal or temporary items
{{1 star}}
{{2 stars}}
{{3 stars}}
{{4 stars}}
{{5 stars}}
{{6 stars}}
{{7 stars}}
{{8 stars}}
{{9 stars}}
{{10 stars}}
{{11 stars}}
{{12 stars}}
{{13 stars}}
{{14 stars}}
{{15 stars}}
{{Crown}}
{{Sword}}
{{Shield}}
{{Boot}}
{{Staff}}
{{Neutral}}
{{Fire}}
{{Ice}}
{{Lightning}}
{{Ground}}
{{Light}}
{{Dark}}
{{C}}
{{B}}
{{A}}
{{S}}
{{Shirt icon}}
{{Pants icon}}
{{Shoes icon}}
{{Top set icon}}
{{Bottom set icon}}
{{Full set icon}}
{{Arm icon}}
{{Torso icon}}
{{Leg icon}}
{{Full parts set icon}}

Aside from these templates, numerous larger templates have been created for use within articles for stat and information tables. A list of these can be found here.

Enemy spawn chart template

All mission articles will contain a spawn chart for identifying which maps will offer a rare enemy spawn. Please see this article for information on how to create this table.

Item order

Keep the following rules in mind when listing items in tables and drop charts.

• Generally speaking, items should be listed based on their star rarity. The item of lowest rarity will be listed first and the item with the highest rarity last.
• When items of various types (i.e. weapons and biomaterials) are listed together, first list them categorically based on the order used by the in-game inventory menus. This order is weapons, line shields, units, recovery items, synthesis materials, room decorations and synthesis boards. Each category of items will then be organized by rarity, per the previous rule.
• Certain item types, such as weapons and synthesis materials, can be divided into smaller categories. This order should be based on the in-game order visible when items are stored in your inventory. In the case of weapons, you can also reference the weapon proficiency chart, starting in the upper left-hand corner with swords and working left-to-right, top-to-bottom to TCSMs. Weapon synthesis boards will be listed in a similar manner.