Asphalt Wiki
(44 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
== Game names ==
 
== Game names ==
  +
As Asphalt games are the main topic of this wiki, there are a few special rules how to mention them.
* Full name (Asphalt 8: Airborne)
 
** First mention on a page
 
* Short name (Asphalt 8)
 
** Second and succeeding mentions on a page.
 
* Abbreviation (A8)
 
** '''Not''' to be used anywhere in articles.
 
=== Full name ===
 
* First mention on a page
 
** Should be a link with <code><nowiki>[[ ]]</nowiki></code>: [[Asphalt 8: Airborne]]
 
=== Short name ===
 
   
=== Abbreviation ===
+
=== Formatting ===
  +
* Asphalt game names are always set in normal font weight and style ({{nobr|i. e.}} not '''bold''' and not in ''italics''). This includes section headings and page titles.
While abbreviations should not be used in articles, they are used as standardized two letter codes by templates, color definitions and CSS classes:
 
  +
* However, names of other games, as well as names of major works of literature and art, are set in ''italics''.
  +
 
=== Linking ===
  +
* If an Asphalt game name is mentioned for the first time on a page, it should be turned into a link by enclosing it in square brackets. Example: <code><nowiki>[[Asphalt 8: Airborne]]</nowiki></code> &rarr; [[Asphalt 8: Airborne]]
  +
* Exception: No links in section headings!
  +
  +
=== Abbreviations ===
  +
Generally, Asphalt game names can be written in three different ways:
  +
 
==== Full name ====
 
The full name ('''Asphalt 8: Airborne''') is used
  +
* when the game is mentioned for the first time on a page.
  +
* in section headings when several Asphalt games are listed, for example on vehicle pages.
  +
The full name should ''not'' be used
 
* for the second and following mentions on a page.
  +
* for disambiguation in page titles.<br>Example: {{xt|Vehicle list (Asphalt 9)}}, ''not'' {{!xt|Vehicle list (Asphalt 9: Legends)}}
  +
* for disambiguation in category names.<br>Example: {{xt|Category:Asphalt 8 images}}, ''not'' {{!xt|Category:Asphalt 8: Airborne images}}
  +
 
==== Medium name ====
 
The medium name ('''Asphalt 8''') is used
  +
* for the second and following mentions on a page.
  +
* for disambiguation in page titles.<br>Example: {{xt|Vehicle list (Asphalt 9)}}, ''not'' {{!xt|Vehicle list (Asphalt 9: Legends)}}
  +
* for disambiguation in category names.<br>Example: {{xt|Category:Asphalt 8 images}}, ''not'' {{!xt|Category:Asphalt 8: Airborne images}}
  +
  +
==== Short name (two letters) ====
  +
The two-letter variant ('''A8''') is used
  +
* ''only'' in template names, color definitions and CSS class names, and always in lower case.
  +
The two-letter variant should ''never'' be used
  +
* anywhere in articles, page titles or category names.
  +
* An exception may be table header cells that would become unnecessarily wide if short or long names were used.
  +
 
=== Code ===
 
While the two-letter variant should not be used in articles, its lower case version serves as unique identifier for templates, color definitions and CSS classes:
 
* <code>a1</code> &ndash; Asphalt Urban GT
 
* <code>a1</code> &ndash; Asphalt Urban GT
 
* <code>a2</code> &ndash; Asphalt Urban GT 2
 
* <code>a2</code> &ndash; Asphalt Urban GT 2
Line 29: Line 53:
 
* <code>as</code> &ndash; Asphalt Street Storm Racing
 
* <code>as</code> &ndash; Asphalt Street Storm Racing
 
* <code>a9</code> &ndash; Asphalt 9: Legends
 
* <code>a9</code> &ndash; Asphalt 9: Legends
  +
* <code>aw</code> &ndash; Asphalt Wiki, used for wiki-specific names
   
 
Examples:
 
Examples:
 
* <code><nowiki>{{a8tokens|100}}</nowiki></code> &rarr; {{a8tokens|100}}
 
* <code><nowiki>{{a8tokens|100}}</nowiki></code> &rarr; {{a8tokens|100}}
* <code><nowiki>{{a9tokens|100}}</nowiki></code> &rarr; {{a9tokens|100}}
+
* <code><nowiki>{{antokens|100}}</nowiki></code> &rarr; {{antokens|100}}
  +
  +
* <code><nowiki>'''{{color|a8rare|Text}}'''</nowiki></code> &rarr; '''{{color|a8rare|Text}}'''
  +
* <code><nowiki>'''{{color|a9rare|Text}}'''</nowiki></code> &rarr; '''{{color|a9rare|Text}}'''
   
 
* <code><nowiki>{{Extra Tank a8}}</nowiki></code> &rarr; {{Extra Tank a8}}
 
* <code><nowiki>{{Extra Tank a8}}</nowiki></code> &rarr; {{Extra Tank a8}}
Line 42: Line 70:
 
|<pre>
 
|<pre>
 
{| class="table-a8"
 
{| class="table-a8"
! Header 1 !! Header 2
+
! Header 1 !! Header 2
|-
+
|-
| Cell 1 || Cell 2
+
| Cell 1 || Cell 2
 
|}
 
|}
 
</pre>
 
</pre>
Line 60: Line 88:
 
|<pre>
 
|<pre>
 
{| class="table-a9"
 
{| class="table-a9"
! Header 1 !! Header 2
+
! Header 1 !! Header 2
|-
+
|-
| Cell 1 || Cell 2
+
| Cell 1 || Cell 2
 
|}
 
|}
 
</pre>
 
</pre>
Line 74: Line 102:
 
|}
 
|}
   
== Editors ==
+
==== Templates ====
  +
When used in template names for disambiguation, game names should always be the last part of the template name, separated with space. Example: <code>Extra Tank a8</code> instead of <code>A8ExtraTank</code>
=== Articles ===
 
  +
* Apart from readability, this has the advantage that all Extra Tank templates are listed together unter '''E''' in categories. The second style would list '''all''' Asphalt 8 templates under '''A''', regardless of their function.
=== Page titles ===
 
  +
* Exception: Currencies and templates that also denote a ''text'' color name listed in {{tl|color code}} (like {{tl|a8tokens}} or {{tl|a8legendary}}) always have the identifier ''at the beginning'' of the word. This has purely historical reasons.
  +
  +
==== CSS ====
  +
CSS class names and variables also use trailing two-letter identifiers for disambiguation. In this case, they are separated with a hyphen as CSS does not allow whitespace as separators. Example: <code>.table-a9</code> for a table class or <code>--bg-a8</code> for a background color variable.
  +
* Exception: Text color variables that have an equivalent in {{tl|color code}} (like <code>--a8tokens</code>) always have the identifier ''at the beginning'' of the word. As with template names, this has purely historical reasons.
  +
  +
== Other naming conventions ==
 
=== Categories ===
 
=== Categories ===
  +
* Don't use upper case in category names at all, except for words that would also be written in upper case in normal text, such as company names, nationalities or fixed in-game terms.<br>Example: {{xt|Category:Asphalt 8 images}}, ''not'' {{!xt|Category:Asphalt 8 Images}}
  +
* Asphalt game names are placed at the beginning of the name, and always in short form.<br>Example: {{xt|Category:Asphalt 8 images}}, ''not'' {{!xt|Category:Asphalt 8: Airborne images}}
   
== Developers ==
 
 
=== Templates ===
 
=== Templates ===
  +
* The use of '''camelCase''' notation for template names is discouraged. Wikitext allows whitespace, so use names like <code>Table row a8</code> instead of <code>A8TableRow</code>.
  +
* Use speaking names and order the parts from general to special. Example: <code>Table header mastery a8</code> instead of <code>A8MasteryChallengeHeader</code>. A template name like <code>A8UpgradePricesCA4.2C</code> makes it impossible for other editors to understand the function. The numbers and letters at the end could denote game versions, template versions, or have yet another meaning.
  +
* Don't use upper case in template names at all. Wiki readers do not see template names, but other editors would have to figure out if a word is a fixed in-game notion with upper case or not (like "nitro" or "credits" which are often used inconsistently even in the same game). There are two exceptions:
  +
** The first letter of a template name which is automatically converted to upper case by the wiki software.
  +
** Templates that are part of a '''modular system''' and denote a gameplay element, like Pro Kit Box or booster templates. In this case, the original in-game notation is kept. In case of an inconsistent use inside the game, the upper case variant is chosen. Example: {{tl|Daily Kit Box}}, {{tl|Double Credits a8}} or {{tl|Double Credits ax}}.
  +
 
=== CSS classes ===
 
=== CSS classes ===
* Don't use class names starting with <code>awtimer</code>. These names are reserved for [[:Category:Countdown templates|countdown]] and timer templates. If you create elements with these class names, they may be altered or just turned off and on by the JavaSccript code behind timers on the same page.
+
* Don't use class names starting with <code>awtimer</code> or <code>awnotimer</code>. These names are reserved for [[:Category:Countdown templates|countdown]] and timer templates. Creating elements with these class names may lead to unexpected results as they may be altered or even removed by the JavaScript code behind timers on the same page.
  +
=== Constants ===
 
  +
== Tables ==
  +
{{main|Asphalt Wiki:Manual of style (tables)}}
  +
  +
[[Category:{{SITENAME}} Manual of style| ]]

Revision as of 16:22, 1 July 2020

Game names

As Asphalt games are the main topic of this wiki, there are a few special rules how to mention them.

Formatting

  • Asphalt game names are always set in normal font weight and style (i. e. not bold and not in italics). This includes section headings and page titles.
  • However, names of other games, as well as names of major works of literature and art, are set in italics.

Linking

  • If an Asphalt game name is mentioned for the first time on a page, it should be turned into a link by enclosing it in square brackets. Example: [[Asphalt 8: Airborne]]Asphalt 8: Airborne
  • Exception: No links in section headings!

Abbreviations

Generally, Asphalt game names can be written in three different ways:

Full name

The full name (Asphalt 8: Airborne) is used

  • when the game is mentioned for the first time on a page.
  • in section headings when several Asphalt games are listed, for example on vehicle pages.

The full name should not be used

  • for the second and following mentions on a page.
  • for disambiguation in page titles.
    Example: Vehicle list (Asphalt 9), not Vehicle list (Asphalt 9: Legends)
  • for disambiguation in category names.
    Example: Category:Asphalt 8 images, not Category:Asphalt 8: Airborne images

Medium name

The medium name (Asphalt 8) is used

  • for the second and following mentions on a page.
  • for disambiguation in page titles.
    Example: Vehicle list (Asphalt 9), not Vehicle list (Asphalt 9: Legends)
  • for disambiguation in category names.
    Example: Category:Asphalt 8 images, not Category:Asphalt 8: Airborne images

Short name (two letters)

The two-letter variant (A8) is used

  • only in template names, color definitions and CSS class names, and always in lower case.

The two-letter variant should never be used

  • anywhere in articles, page titles or category names.
  • An exception may be table header cells that would become unnecessarily wide if short or long names were used.

Code

While the two-letter variant should not be used in articles, its lower case version serves as unique identifier for templates, color definitions and CSS classes:

  • a1 – Asphalt Urban GT
  • a2 – Asphalt Urban GT 2
  • a3 – Asphalt 3: Street Rules
  • a4 – Asphalt 4: Elite Racing
  • a5 – Asphalt 5
  • a6 – Asphalt 6: Adrenaline
  • ar – Asphalt Audi RS 3
  • ad – Asphalt 3D
  • ai – Asphalt Injection
  • a7 – Asphalt 7: Heat
  • a8 – Asphalt 8: Airborne
  • ao – Asphalt Overdrive
  • an – Asphalt Nitro
  • ax – Asphalt Xtreme
  • as – Asphalt Street Storm Racing
  • a9 – Asphalt 9: Legends
  • aw – Asphalt Wiki, used for wiki-specific names

Examples:

  • {{a8tokens|100}}Tokens 100
  • {{antokens|100}}Tokens 100
  • '''{{color|a8rare|Text}}'''Text
  • '''{{color|a9rare|Text}}'''Text
{| class="table-a8"
  ! Header 1 !! Header 2
  |-
  | Cell 1 || Cell 2
|}
 → 
Header 1 Header 2
Cell 1 Cell 2
{| class="table-a9"
  ! Header 1 !! Header 2
  |-
  | Cell 1 || Cell 2
|}
 → 
Header 1 Header 2
Cell 1 Cell 2

Templates

When used in template names for disambiguation, game names should always be the last part of the template name, separated with space. Example: Extra Tank a8 instead of A8ExtraTank

  • Apart from readability, this has the advantage that all Extra Tank templates are listed together unter E in categories. The second style would list all Asphalt 8 templates under A, regardless of their function.
  • Exception: Currencies and templates that also denote a text color name listed in {{Color code}} (like {{A8tokens}} or {{A8legendary}}) always have the identifier at the beginning of the word. This has purely historical reasons.

CSS

CSS class names and variables also use trailing two-letter identifiers for disambiguation. In this case, they are separated with a hyphen as CSS does not allow whitespace as separators. Example: .table-a9 for a table class or --bg-a8 for a background color variable.

  • Exception: Text color variables that have an equivalent in {{Color code}} (like --a8tokens) always have the identifier at the beginning of the word. As with template names, this has purely historical reasons.

Other naming conventions

Categories

  • Don't use upper case in category names at all, except for words that would also be written in upper case in normal text, such as company names, nationalities or fixed in-game terms.
    Example: Category:Asphalt 8 images, not Category:Asphalt 8 Images
  • Asphalt game names are placed at the beginning of the name, and always in short form.
    Example: Category:Asphalt 8 images, not Category:Asphalt 8: Airborne images

Templates

  • The use of camelCase notation for template names is discouraged. Wikitext allows whitespace, so use names like Table row a8 instead of A8TableRow.
  • Use speaking names and order the parts from general to special. Example: Table header mastery a8 instead of A8MasteryChallengeHeader. A template name like A8UpgradePricesCA4.2C makes it impossible for other editors to understand the function. The numbers and letters at the end could denote game versions, template versions, or have yet another meaning.
  • Don't use upper case in template names at all. Wiki readers do not see template names, but other editors would have to figure out if a word is a fixed in-game notion with upper case or not (like "nitro" or "credits" which are often used inconsistently even in the same game). There are two exceptions:
    • The first letter of a template name which is automatically converted to upper case by the wiki software.
    • Templates that are part of a modular system and denote a gameplay element, like Pro Kit Box or booster templates. In this case, the original in-game notation is kept. In case of an inconsistent use inside the game, the upper case variant is chosen. Example: {{Daily Kit Box}}, {{Double Credits a8}} or {{Double Credits ax}}.

CSS classes

  • Don't use class names starting with awtimer or awnotimer. These names are reserved for countdown and timer templates. Creating elements with these class names may lead to unexpected results as they may be altered or even removed by the JavaScript code behind timers on the same page.

Tables

Main article: Asphalt Wiki:Manual of style (tables)