Revision as of 11:11, 6 August 2010 (view source) Fridge Chesthair (Talk) ← Older edit	Revision as of 11:11, 6 August 2010 (view source) Fridge Chesthair (Talk) m (Protected "Contributor name:Fridge Chesthair" [edit=sysop:move=sysop]) Newer edit →
(No difference)

---

Revision as of 11:11, 6 August 2010

UNOFFICIAL EVELOPEDIA MANUAL OF STYLE

This is an unofficial style guide for the pages within the EVELOPEDIA website. At this time, an official guide does not exist.

This manual includes a series of suggestions It is based on the official wiki

Purpose

The intention of this guide is to encourage clarity, consistency, accessibility, stability, and identification. The quality of page content is supported through quality of style and structure.

Clarity promotes reader comprehension. Clear pages are easy to understand, easy to navigate, and easy to recall.

Consistency accelerates the reader experience. Consistent pages are easy to navigate, easy to understand, and are visually pleasing.

Accessibility increases reader adoption. Accessible pages require little previous knowledge and are contain content appropriate for all users.

Stability discourages unnecessary change. Stable pages promote user retention.

Identification increases content accuracy. Content source and date identification limits obsolescence.

Format

Page Formatting

The page format consists of a few features. Included in the formatting are the page title, section organization, subsection organization, picture integration, and template integration.

Page Title

• A page title should be a specific reference to the page topic (Mining not Making money)
• The title should be the most common name of the subject
• If a topic shares a number of commonly used names, multiple pages should be created and redirected to a main page. (0.0 (space), Null Security Space, and Null Security should redirect to Null Sec)
• The title should be as concise and descriptive as possible.
• The title should be a noun, gerund or noun-like adjective (Jita, Can Tipping, or Red (standing) )
• If a topic is ambiguous or could be confused with another, a descriptor in parenthesis should append the title. (Market (window) and Market (economy) )

Sections

Major page sections should represent the various user interaction types for the subject. Common sections include Exploration, Combat, , Culture, Fiction, History.

Sub Headings

Sub headings are designed to improve the navigation of large or otherwise unwieldy pages.

Paragraph Formatting

The wikitext system includes a number of tools and markup for formatting paragraphs. Preferably, pages only use formatting to improve the readability and organization of the page.

Indentation

Generally, entire paragraphs should not be indented. Quoted paragraphs should use blockquotes.

Lists

Lists are ordered sets of data arranged vertically in a separate rows. Evelopedia supports bulleted lists, numbered lists, and definition lists. Lists should be used for any data sets with a quantity greater than four. Lists may be used for smaller sets of data if list improves readability.

Bulleted lists should be used when the order of the data does not matter. They should be organized in alphabetical order for ease of reference.

Numbered lists should be used when the order of the data does matter. Numbered lists should be organized in the order that best reflects the data.

Definitions

Tables

Tables shoudl be used to organize large sets of two dimensional data.

If the data is a representation of the page subject, then the table should occupy the page width. If the data only represents one aspect of the subject, then the table should be narrower than the current text width.

Cell spacing should be enough to allow for easy reading. Table borders should be wide enough to clearly see but not enough that it interupts reading across rows or down columns. Tables should maintain the standard color scheme of the website.

Images

Images serve to accent and supplement page text. Images should not, however be the main content of a page.

Image examples should be nor more than one quarter the width of thee minimum page width.

Images illustrating a subject or section should be affixe to the right side of the page.

If an image is supplemented with a caption, the image should have a border.

Text Formatting

Text formatting includes all text modification.

Capitalization

Text capitalization should follow the normal rules of the english language. Capitalization Proper names System names Ship names Character Names

Italics

Italics should be used when writing in a different voice.

Bold

Bold should be used to visually stress words.

Underline

Underlines should be used when indicating a formal work like book, piece of music or motion picture.

It should also be used to depict extreme stress. DO NOT underline for just any reason.

Punctuation

Parenthesis should be used when providing examples of a concept (ex. this is an example).

Abbreviations

Not prefered. only if common syntax or proper name aka. COSMOS

Numbers

Unitless quantities

• 1-15: words (one, two, three, four,...fifteen)
• 16+ : NumberS (16, 17, 18, 19...)

For quantities with units

• 1+  : Numbers with units (1m3, 56GJ)

For isk values

• 0+  : Numbers to two decimal points and isk unit (1.00isk, 7.75isk)

1, 2, 3, 4 when combined with units 1isk, 2.2isk, 3LP.

Whitespace

Whitespace should be eliminated as much as posible.

Eliminate whitespace as much as possible. Single spaces between words, double space between sentences,

Page Links

Use the common name. Make sure the link text reflects the

External Links

Are the even available

Color

Colors should be used like bold lettering to emphasize words. Keep within the color palate of the website or Avoid orange, unless refering to page titles as page titles.

Templates

Misc.

No Derp

Writing Style

Pages should be written in standard English in a neutral tone and neutral voice.

Grammar

No l33t speak other than refering to proper names or quotes.

Tone

Since EVElopedia is designed to be used by the entirety of the EVE Online userbase, its tone should be applicable to all. Pages shouldn't comment on the quality of certain gameplay styles or

Voice

Pages should never refer to the reader as such. Pages should maintain a When refering to the player's presence in the game, pages should use the term "character" (ex. CONCORD will shoot any character that remote repairs a pirate NPC). When refering to the player population as a whole, pages should use the tern "pilots"