Star Trek Online Wiki
Don't have an account?
Register
Register
Star Trek Online Wiki
Star Trek Online Wiki
20,301
pages
in: STOWiki, Guidelines

Changes: STOWiki:Manual of Style

Back to page
Edit source
No edit summary
(→‎Linking: text moved from Help:Contents)
 
(23 intermediate revisions by 5 users not shown)
Line 1: Line 1:
  +
{{shortcut|STOW:STYLE}}
⚫
==Article Titles & Contents==
  
  +
{{guidelines}}
⚫
# The first occurrence of the article title (or a variant thereof, e.g. plural) in the article itself must be in '''bold'''. For example, in the article for Ensign [[Zihr]], the beginning reads: "Ensign '''Zihr''' is...".
  
  +
{{guideline}}
⚫
# Article titles must not contain capitalized words unless they are proper nouns, such as "Federation", "Cardassian", "Sulu", ranks (when used as part of name), and "Spacedock" in the phrase "Earth Spacedock" (because it is itself a proper noun consisting of more than one word, each of which must be capitalized.
  
−
#* Examples of what ''not'' to capitalize include "vessels" within "Federation vessels", as it is not a proper noun nor a name.
  
−
# Article titles must not contain ranks for characters in the game. For example, [[Quinn]] is an acceptable title for the article on Admiral Quinn; "Admiral Quinn", however, is not.
  
   
  +
This guideline discusses best practices with regard to the writing style. We strive to achieve a consistent style across all articles. This however is only a guideline, not a policy. Violations against these suggestions should be corrected, but not frowned upon (see also [[Project:Please_do_not_bite_the_newcomers|Please do not bite the newcomers]] guideline).
−
==Article Naming==
  
   
  +
== Tense ==
−
The folowing naming conventions must be observed when naming certain articles:
  
  +
All articles discussing in-game elements or aspects are written from a [[2409]] perspective. That means, that in general we use the present tense, as a contemporary encyclopedia does. Articles about [[Cryptic Studios]] or other meta-elements like the [[C-Store]] are written in a contemporary style, i.e. present tense for ongoing and current developments, past tense for completed and past developments and future tense for announcements etc. Articles that are specific to the [[STOWiki]] like the [[Main Page]], these guidelines or talk pages should also use the present tense where appropriate.
  +
  +
== Neutral style ==
  +
Outside of [[:Category:Guides|guides]], [[:Category:Mission walkthroughs|walkthroughs]] and talk pages, which are intended to give room for personal and subjective opinions, adhere to a neutral point of view. E.g. do not evaluate an item or ability when presenting it upfront. You may however add some information on its usefulness and relation to others of its kind in a ''Notes'' sub-section. This however should be backed not only by your personal opinion, but by external references like a profound forum discussion or a developer interview. Of course you can also present original research, but base your findings transparently on numbers, that everyone can reproduce.
  +
  +
== Addressing the reader ==
  +
Using second-person pronouns (''you'', ''your'') is discouraged in articles with an in-game (e.g. items, skills, NPCs) or meta-game (e.g. a developer article, user interface, C-Store) subject. Try to find a neutral point of view and talk about the player in the third person. For example ''"the player's starship"'' instead of ''"your starship"''. Also try to differentiate between the player and the character. So in an article you might want to elaborate on ''"the character's health"'' instead of ''"the player's health"''.
  +
  +
In guidelines, project pages and talk pages using second-person pronouns is however strongly encouraged.
  +
  ⚫
== Article titles ==
  ⚫
In general, we prefer singular, lower case article names, if the game does not use the article title as a proper name. Article titles must not contain capitalized words unless they are proper nouns, such as "Federation", "Cardassian", "Sulu", ranks (when used as part of name), and "Spacedock" in the phrase "Earth Spacedock" (because it is itself a proper noun consisting of more than one word, each of which must be capitalized. Item names may be capitalized as they are in the game.
  +
  +
So for example an article would be named ''[[bridge officer]]'', not ''bridge officers'' or ''Bridge Officers''. Items are capitalized as in the game: ''[[Tribble of Borg]]'' instead of ''tribble of borg'' or ''Tribble Of Borg''. Locations are generally capitalized: ''[[Sol System]]'' instead of ''Sol'' or ''Sol system''; ''[[Fluidic Space]]'' instead of ''fluidic space''; ''[[Alpha Quadrant]]'' instead of ''alpha quadrant'' or ''Alpha quadrant''. Article titles must not contain ranks for characters in the game. For example, ''[[Jorel Quinn]]'' instead of ''Admiral Quinn''.
  +
  ⚫
The first occurrence of the article title (or a variant thereof, e.g. plural) in the article itself must be in '''bold'''. An exception are NPCs, who are always addressed with their rank in-game For example, in the article for [[Zihr]] starts with "'''Ensign Zihr''' is..." instead of "Ensign '''Zihr''' is...".
  +
  +
In order to distinguish identically named entities like the [[Accolade]] ''{{accolade|Lucky}}'' and the [[Trait]] ''{{trait|Lucky}}'' the respective articles get separate prefixes.
   
 
{| class="wikitable"
  
{| class="wikitable"
Line 16: Line 32:
 
| NPCs (non-player characters)
  
| NPCs (non-player characters)
 
| (None)
  
| (None)
−
| '''/wiki/Golos Vell'''
 +
| [[Golos Vell]]
 
|-
  
|-
  +
| Starships
⚫
| Items
  
−
| (None)
 +
| (Prefix) (Name)
  +
| [[U.S.S. Oakland]]
−
| '''/wiki/Firearms Engineering Mk II'''
  
 
|-
  
|-
 
| Missions
  
| Missions
 
| Mission:(space)
  
| Mission:(space)
−
| '''/wiki/Mission: Azure Blues'''
 +
| [[Mission: Stranded In Space]]
 
|-
  
|-
  +
| Items (all)
−
| Equipment
  
−
| Equipment:(space)
 +
| (None)
  +
| [[Disruptor Dual Pistols]]
−
| '''/wiki/Equipment: Pollyalloy Weave Mk VIII'''<br>''(Must also be placed within category "Body Armor" because the equipment name is preceded by that phrase within the game.)''
  
  +
|-
  +
| Skills (all)
  +
| Skill:(space)
  +
| [[Skill: Tactical Team Leader]]
  +
|-
  +
| Trait (all)
  +
| Trait:(space)
  +
| [[Trait: Leadership]]
 
|-
  
|-
  +
| Injury (all)
−
| Kits
  
−
| Kit:(space)
 +
| Injury:(space)
  +
| [[Injury: Minor Concussion]]
−
| '''/wiki/Kit: Firearms Engineering Mk II'''<br>''(Must also be placed within category "Engineering Kits" because the kit name is preceded by "Engineering Kit" in the game.)''
  
 
|-
  
|-
  +
| Accolade (all)
−
| Weapons
  
−
| Weapon:(space)
 +
| Accolade:(space)
  +
| [[Accolade: Affluent]]
−
| '''/wiki/Weapon: Arcwave MK VIII'''<br>''(Must also be placed within category "Disruptor Bolt Assault Weapons", because the weapon name is preceded by that phrase within the game.)''
  
  +
|-
  +
| Guide (all)
  +
| Guide:(space)
  +
| [[Guide: Basics]]
 
|}
  
|}
   
−
==Article Linking==
 +
=== Lists ===
  +
An exception from the article naming guideline on plural forms are lists. The most prominent example is the [[list of missions]].
  +
  +
=== Categories ===
  +
Categories should adhere to the usual article naming guidelines, but in fact many are not. The [[:Category: Federation Starships]] is such an example. Since it is a lot of work, to rename an established category with many members, users are encouraged to pay special attention to creating new categories.
   
  +
== Linking ==
 
For the following article types, the corresponding template must be used when linking to it:
  
For the following article types, the corresponding template must be used when linking to it:
   
Line 52: Line 85:
 
| <nowiki>[[Malcolm Sissel]]</nowiki>
  
| <nowiki>[[Malcolm Sissel]]</nowiki>
 
|-
  
|-
  +
| Starships
⚫
| Items
  
  +
| [[Template:USS|<nowiki>{{USS}}</nowiki>]], [[Template:IKS|<nowiki>{{IKS}}</nowiki>]], [[Template:IRW|<nowiki>{{IRW}}</nowiki>]]
−
| (None)
  
−
| <nowiki>[[Firearms Engineering Mk II]]</nowiki>
 +
| <nowiki>{{USS|Oakland}}</nowiki>
 
|-
  
|-
 
| Missions
  
| Missions
−
| <nowiki>{{mission}}</nowiki>
 +
| [[Template:mission|<nowiki>{{mission}}</nowiki>]]
−
| <nowiki>{{mission|Azure Blues}}</nowiki>
 +
| <nowiki>{{mission|Assimilation}}</nowiki>
  +
|- valign="top"
  ⚫
| ALL Items
  ⚫
| [[Template:item|<nowiki>{{item}}</nowiki>]]
  +
| <nowiki>{{item|Body Armor - Energy Dampening|Mk II|common}}</nowiki><br /><nowiki>{{item|Livanian Beet||common}}</nowiki>
 
|-
  
|-
  +
| Abilities
−
| Equipment
  
−
| <nowiki>{{equipment}}</nowiki>
 +
| [[Template:ability|<nowiki>{{ability}}</nowiki>]]
−
| <nowiki>{{equipment|Body Armor|Energy Dampening Mk II|common}}</nowiki>
 +
| <nowiki>{{ability|Evasive Maneuvers}}</nowiki>
 
|-
  
|-
−
| Kits
 +
| Skills
−
| <nowiki>{{kit}}</nowiki>
 +
| [[Template:skill|<nowiki>{{skill}}</nowiki>]]
−
| <nowiki>{{kit|Engineering Kit|Firearms Engineering Mk II|uncommon}}</nowiki>
 +
| <nowiki>{{skill|Science Team Leader}}</nowiki>
 
|-
  
|-
−
| Weapons
 +
| Traits
−
| <nowiki>{{weapon}}</nowiki>
 +
| [[Template:trait|<nowiki>{{trait}}</nowiki>]]
−
| <nowiki>{{weapon|Disruptor Bolt Assault Weapon|Arcwave Mk VIII|uncommon}}</nowiki>
 +
| <nowiki>{{trait|Cold Dwelling}}</nowiki>
  +
|-
  +
| Injuries
  +
| [[Template:injury|<nowiki>{{injury}}</nowiki>]]
  ⚫
| <nowiki>{{injury|Minor concussion}}</nowiki>
  +
|-
  +
| Accolades
  +
| [[Template:accolade|<nowiki>{{accolade}}</nowiki>]]
  ⚫
| <nowiki>{{accolade|Affluent}}</nowiki>
 
|}
  
|}
   
  +
* ''LINKING:'' Should a new entry be created on the STO Wiki? Or should it be linked to the Memory Alpha wiki? If it is a link-worthy article, but is only mentioned in passing, then link to Memory Alpha [[ma:Star Trek|like so]]. Otherwise, create a new article and/or add content to the article.
−
==Item InfoBoxes==
  
  +
* ''ONLY LINK ONCE:'' While we encourage linking as much relevant information as possible to new articles, only one link per page is necessary. So if the Romulans are referenced more than once, only the first reference may be linked.
−
[[File:EngineeringKit_FirearmsEngineeringMkII.png|250px|thumb|right|Sample in-game info box.]]
  
−
Like in the game, and as can be seen in the screenshot to the right, each item within the game has a specially formatted information box. This convention must be observed on this wiki as well; all items will have a corresponding info box. Here is what you should do:
  
−  
−
# Navigate to a new article titled '''Infobox: Name of Item'''. Add the InfoBox code in this page. A quick style and formatting tutorial is below.
  
−
# On the item page, add '''<nowiki>{{iteminfobox|Name of Item}}</nowiki>''' to the '''top'''. "Name of Item" must match with the above step.
  
−  
−
For example, in the article {{equipment|Engineering Kit|Firearms Engineering Mk II|uncommon}}, the following would appear '''''at the top of the article''''', to insert its InfoBox:
  
−  
−
<nowiki>{{iteminfobox|Firearms Engineering Mk II}}</nowiki>
  
−  
−
This would then call up '''Infobox: Personal Shield Mk II''', where you must then enter the proper formatting, as illustrated directly below.
  
−  
−
'''<u>NOTE:</u>''' Do ''not'' add the "nofloat" parameter when using iteminfobox templates in item description pages. That parameter is reserved for use in articles where several InfoBoxes are to be listed and grouped together.
  
−  
−
===Item InfoBox Formatting===
  
−
* In the example above, the title is in a narrow green font, since the item is <span class="item uncommon">Uncommon</span>. To specify the infobox title, use the following template:
  
−  
−
<nowiki>{{it|Engineering Kit - Firearms Engineering Mk II|uncommon}}</nowiki>
  
−  
−
The '''it''' template (which stands for "'''<u>I</u>'''tem '''<u>T</u>'''itle") specifies the correct font and size for the title, and the <b>uncommon</b> parameter formats the color for the corresponding rarity. Only use '''uncommon''', '''common''', '''epic''', and '''rare''' for the second parameter (or omit it altogether for '''common''' items).
  
−  
−
* For the text directly below the title, "Uncommon Kit", use the following formatting:
  
−  
−
<nowiki>{{r|Uncommon Kit|uncommon}}</nowiki>
  
−  
−
The '''uncommon''' parameter again colors it {{r|green|uncommon}} for being an Uncommon item. You can omit this as well for {{r|Common}} items. Use this for any text where the entire line must be displayed in the corresponding rarity color.
  
−  
−
* For text that is light aqua, use the following template:
  
−  
−
<nowiki>{{blue|KDF Engineer, Starfleet Engineer}}</nowiki>
  
−  
−
* For subtitle text (such as "Quick Fix 1" and "Expose Attack" in the example above), use the following template:
  
−  
⚫
<nowiki>{{st|Quick Fix 1}}</nowiki>
  
−  
−
and
  
−  
−
<nowiki>{{st|Expose Attack|yellow}}</nowiki>
  
−  
−
When the '''<u>s</u>'''ub'''<u>t</u>'''itle is green, you can omit the second color parameter.
  
−  
−
* If there is a label for a required rank for item usage, specify it like so:
  
−  
⚫
<nowiki>{{rank|Captain}}</nowiki>
  
−  
−
This will automatically right-align and color the text, as it is formatted in the game's item information boxes.
  
−  
−
* To indent text as shown above, use regular wiki formatting:
  
−  
−
<nowiki>:</nowiki>24 Hit Points to Fabrications
  
−
<nowiki>:</nowiki>25% chance: to self: AICommand
  
−
<nowiki>:</nowiki>...
  
−  
−
This can be nested to indent on more than one level, like so:
 
−  
−
<nowiki>:</nowiki>...
  
−
<nowiki>:</nowiki>to target: Applies &lt;span class="blue"&gt;Quick Fix Applied&lt;/span&gt; for 12 sec
  
−
<nowiki>::</nowiki>Removes up to 1 effects
  
−
<nowiki>:</nowiki>+9% All Damage strength to Ranged Weapons for 12 sec
  
−
<nowiki>:</nowiki>...
  
−  
−
* Finally, for the cost of the item, use the following template:
  
−  
⚫
<nowiki>{{c|2,285|EC}}</nowiki>
  
−  
−
The '''EC''' specifies the currency as EC, or "Energy Credits", and uses the corresponding currency icon.
  
   
  +
== See also ==
−
* To view an example of how the above info box would be formatted in its entirety, please visit: [[Example: Item InfoBox Formatting]].
  
  +
* The guideline on [[Project:Formatting|formatting]]''

Latest revision as of 21:36, 22 May 2021

Icon-shortcut Shortcut: STOW:STYLE

Icon-policy STOWiki Guidelines

Assume good faith
Archival
Be bold!
Fan fiction
Formatting
Images
Manual of Style

PDBTN
Signatures
Subpages
Talk pages
Text removal
Foundry missions
Wikiquette

See also:
Policies Administrators
 
Guideline

This page is considered a guideline on STOWiki.

It illustrates standards of conduct, which many editors agree with in principle. However, it is not policy.

This guideline discusses best practices with regard to the writing style. We strive to achieve a consistent style across all articles. This however is only a guideline, not a policy. Violations against these suggestions should be corrected, but not frowned upon (see also Please do not bite the newcomers guideline).

Tense[]

All articles discussing in-game elements or aspects are written from a 2409 perspective. That means, that in general we use the present tense, as a contemporary encyclopedia does. Articles about Cryptic Studios or other meta-elements like the C-Store are written in a contemporary style, i.e. present tense for ongoing and current developments, past tense for completed and past developments and future tense for announcements etc. Articles that are specific to the STOWiki like the Main Page, these guidelines or talk pages should also use the present tense where appropriate.

Neutral style[]

Outside of guides, walkthroughs and talk pages, which are intended to give room for personal and subjective opinions, adhere to a neutral point of view. E.g. do not evaluate an item or ability when presenting it upfront. You may however add some information on its usefulness and relation to others of its kind in a Notes sub-section. This however should be backed not only by your personal opinion, but by external references like a profound forum discussion or a developer interview. Of course you can also present original research, but base your findings transparently on numbers, that everyone can reproduce.

Addressing the reader[]

Using second-person pronouns (you, your) is discouraged in articles with an in-game (e.g. items, skills, NPCs) or meta-game (e.g. a developer article, user interface, C-Store) subject. Try to find a neutral point of view and talk about the player in the third person. For example "the player's starship" instead of "your starship". Also try to differentiate between the player and the character. So in an article you might want to elaborate on "the character's health" instead of "the player's health".

In guidelines, project pages and talk pages using second-person pronouns is however strongly encouraged.

Article titles[]

In general, we prefer singular, lower case article names, if the game does not use the article title as a proper name. Article titles must not contain capitalized words unless they are proper nouns, such as "Federation", "Cardassian", "Sulu", ranks (when used as part of name), and "Spacedock" in the phrase "Earth Spacedock" (because it is itself a proper noun consisting of more than one word, each of which must be capitalized. Item names may be capitalized as they are in the game.

So for example an article would be named bridge officer, not bridge officers or Bridge Officers. Items are capitalized as in the game: Tribble of Borg instead of tribble of borg or Tribble Of Borg. Locations are generally capitalized: Sol System instead of Sol or Sol system; Fluidic Space instead of fluidic space; Alpha Quadrant instead of alpha quadrant or Alpha quadrant. Article titles must not contain ranks for characters in the game. For example, Jorel Quinn instead of Admiral Quinn.

The first occurrence of the article title (or a variant thereof, e.g. plural) in the article itself must be in bold. An exception are NPCs, who are always addressed with their rank in-game For example, in the article for Zihr starts with "Ensign Zihr is..." instead of "Ensign Zihr is...".

In order to distinguish identically named entities like the Accolade Lucky and the Trait Lucky the respective articles get separate prefixes.

Article Type Prefix Example
NPCs (non-player characters) (None) Golos Vell
Starships (Prefix) (Name) U.S.S. Oakland
Missions Mission:(space) Mission: Stranded In Space
Items (all) (None) Disruptor Dual Pistols
Skills (all) Skill:(space) Skill: Tactical Team Leader
Trait (all) Trait:(space) Trait: Leadership
Injury (all) Injury:(space) Injury: Minor Concussion
Accolade (all) Accolade:(space) Accolade: Affluent
Guide (all) Guide:(space) Guide: Basics

Lists[]

An exception from the article naming guideline on plural forms are lists. The most prominent example is the list of missions.

Categories[]

Categories should adhere to the usual article naming guidelines, but in fact many are not. The Category: Federation Starships is such an example. Since it is a lot of work, to rename an established category with many members, users are encouraged to pay special attention to creating new categories.

Linking[]

For the following article types, the corresponding template must be used when linking to it:

Article Type Template Example
NPCs (non-player characters) (None) [[Malcolm Sissel]]
Starships {{USS}}, {{IKS}}, {{IRW}} {{USS|Oakland}}
Missions {{mission}} {{mission|Assimilation}}
ALL Items {{item}} {{item|Body Armor - Energy Dampening|Mk II|common}}
{{item|Livanian Beet||common}}
Abilities {{ability}} {{ability|Evasive Maneuvers}}
Skills {{skill}} {{skill|Science Team Leader}}
Traits {{trait}} {{trait|Cold Dwelling}}
Injuries {{injury}} {{injury|Minor concussion}}
Accolades {{accolade}} {{accolade|Affluent}}
  • LINKING: Should a new entry be created on the STO Wiki? Or should it be linked to the Memory Alpha wiki? If it is a link-worthy article, but is only mentioned in passing, then link to Memory Alpha like so. Otherwise, create a new article and/or add content to the article.
  • ONLY LINK ONCE: While we encourage linking as much relevant information as possible to new articles, only one link per page is necessary. So if the Romulans are referenced more than once, only the first reference may be linked.

See also[]

Community content is available under CC BY-NC-SA unless otherwise noted.
More Fandoms