TerranRich (talk | contribs) No edit summary |
(→Linking: text moved from Help:Contents) |
||
(17 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
+ | {{shortcut|STOW:STYLE}} |
||
− | ==Mission Articles== |
||
+ | {{guidelines}} |
||
− | Mission articles should be formatted the same way, with the following sections, in order: |
||
+ | {{guideline}} |
||
− | # '''Mission infobox''': See the [[:Template:Missioninfo}missioninfo]] template for details on how this works. |
||
− | # '''Mission Text''': The dialog or text displayed before you accept the mission. |
||
− | # '''Objectives''': A bulleted list of the displayed objectives for the mission. |
||
− | # '''Details''': Step-by-step instructions on how to complete the mission, where to find certain things, and other useful information about the mission. |
||
− | # '''Goal''': The exact, verbatim mission goal from the game. Use the [[Template:Missiongoal|missiongoal]] template for formatting. |
||
− | # '''Rewards''': A bulleted list of the rewards given by the mission-giver for completing this mission. |
||
+ | 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). |
||
− | For a good example of what a mission page should look like, visit: {{mission|Secure the Regulus Sector Block}}. |
||
− | == |
+ | == 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. |
||
− | Articles about playable races should be formatted the same way. Text can be inspired by in-game descriptions, but not copied directly. Required Traits must be in the form of a bulleted list and placed underneath a heading of the same name. |
||
+ | == Neutral style == |
||
− | For a good example what of what a playable race page should look like, visit the [[Klingon]] article. |
||
+ | 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"''. |
||
⚫ | |||
⚫ | |||
− | #* 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. |
||
+ | In guidelines, project pages and talk pages using second-person pronouns is however strongly encouraged. |
||
− | ==Article Naming== |
||
⚫ | |||
− | The folowing naming conventions must be observed when naming certain articles: |
||
⚫ | 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 32: | Line 32: | ||
| NPCs (non-player characters) |
| NPCs (non-player characters) |
||
| (None) |
| (None) |
||
− | | |
+ | | [[Golos Vell]] |
+ | |- |
||
+ | | Starships |
||
+ | | (Prefix) (Name) |
||
+ | | [[U.S.S. Oakland]] |
||
|- |
|- |
||
| Missions |
| Missions |
||
| Mission:(space) |
| Mission:(space) |
||
− | | |
+ | | [[Mission: Stranded In Space]] |
|- |
|- |
||
⚫ | |||
− | | Equipment |
||
− | | |
+ | | (None) |
+ | | [[Disruptor Dual Pistols]] |
||
− | | '''/wiki/Equipment: Body Armor - Pollyalloy Weave Mk VIII'''<br>''(Must also be placed within category "Body Armor" because that is the equipment subcategory name.)'' |
||
|- |
|- |
||
+ | | Skills (all) |
||
− | | Kits |
||
− | | |
+ | | Skill:(space) |
+ | | [[Skill: Tactical Team Leader]] |
||
− | | '''/wiki/Kit: Engineering Kit - Firearms Engineering Mk II'''<br>''(Must also be placed within category "Engineering Kits" because the kit subcatgeory is "Engineering Kit".)'' |
||
|- |
|- |
||
+ | | Trait (all) |
||
− | | Weapons |
||
− | | |
+ | | Trait:(space) |
+ | | [[Trait: Leadership]] |
||
− | | '''/wiki/Weapon: Disruptor Bolt Assault Weapon - Arcwave MK VIII'''<br>''(Must also be placed within category "Disruptor Bolt Assault Weapons", because that is the weapon subcategory name.)'' |
||
|- |
|- |
||
− | | |
+ | | Injury (all) |
− | | ( |
+ | | Injury:(space) |
+ | | [[Injury: Minor Concussion]] |
||
− | | '''/wiki/Bajoran Jumja Stick''' |
||
+ | |- |
||
+ | | 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: |
For the following article types, the corresponding template must be used when linking to it: |
||
Line 67: | Line 84: | ||
| (None) |
| (None) |
||
| <nowiki>[[Malcolm Sissel]]</nowiki> |
| <nowiki>[[Malcolm Sissel]]</nowiki> |
||
+ | |- |
||
+ | | Starships |
||
+ | | [[Template:USS|<nowiki>{{USS}}</nowiki>]], [[Template:IKS|<nowiki>{{IKS}}</nowiki>]], [[Template:IRW|<nowiki>{{IRW}}</nowiki>]] |
||
+ | | <nowiki>{{USS|Oakland}}</nowiki> |
||
|- |
|- |
||
| Missions |
| Missions |
||
− | | <nowiki>{{mission}}</nowiki> |
+ | | [[Template:mission|<nowiki>{{mission}}</nowiki>]] |
− | | <nowiki>{{mission| |
+ | | <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>{{ |
+ | | [[Template:ability|<nowiki>{{ability}}</nowiki>]] |
− | | <nowiki>{{ |
+ | | <nowiki>{{ability|Evasive Maneuvers}}</nowiki> |
|- |
|- |
||
− | | |
+ | | Skills |
− | | <nowiki>{{ |
+ | | [[Template:skill|<nowiki>{{skill}}</nowiki>]] |
− | | <nowiki>{{ |
+ | | <nowiki>{{skill|Science Team Leader}}</nowiki> |
|- |
|- |
||
− | | |
+ | | Traits |
− | | <nowiki>{{ |
+ | | [[Template:trait|<nowiki>{{trait}}</nowiki>]] |
− | | <nowiki>{{ |
+ | | <nowiki>{{trait|Cold Dwelling}}</nowiki> |
|- |
|- |
||
+ | | Injuries |
||
⚫ | |||
+ | | [[Template:injury|<nowiki>{{injury}}</nowiki>]] |
||
− | | (None) |
||
− | | <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: |
||
− | |||
− | # '''NEW!''' Use the [[:Template:Infobox|NEW Infobox Template]]! Read the template page for instructions on how to use it. For a working example of how it works, see the {{equipment|Engineering Kit - Firearms Engineering Mk II}} article. |
||
+ | == See also == |
||
− | '''<u>NOTE:</u>''' Do ''not'' add the "float = no" parameter when using infobox templates in item description pages. That parameter is reserved for use in articles where several infoboxes are to be listed and grouped together. |
||
+ | * The guideline on [[Project:Formatting|formatting]]'' |
Latest revision as of 21:36, 22 May 2021
Assume good faith |
PDBTN |
See also: | |
Policies | Administrators |
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[]
- The guideline on formatting