View source for Ingress Wiki:Manual of Style

Here you can find instructions on how to "style" articles and how certain things are formatted here in the [[Main Page|Ingress Wiki]]:

==General formatting instructions==
===Formatting of numbers===
:There are different systems of formatting numbers round the world mainly regarding [https://en.wikipedia.org/wiki/Decimal_separator decimal separators] and [https://en.wikipedia.org/wiki/Decimal_separator#Digit_grouping digit grouping].
:To avoid any confusions numbers are formatted here as follows:
::Digits are grouped in threes, each group being separated by a space as [https://en.wikipedia.org/wiki/Decimal_separator#Digit_grouping thousands separator(s)] while a (decimal) point is used as the [https://en.wikipedia.org/wiki/Decimal_separator decimal separator].
::&emsp;<kbd>123 456 789.0</kbd>

===Formatting of times and dates===
:There are many different formats for writing date and time in the world but for clarity and consistency they are formatted here as follows:
:&emsp;<kbd><abbr title="The day in two digits followed by a dot. E.g. '05.'">dd.</abbr> <abbr title="The month spelled out in English. E.g. 'November'">Month</abbr> <abbr title="The year in four digits. E.g. '2018'">YYYY</abbr></kbd>
:Time is given in UTC and written in the 24h system with the following format:
:&emsp;<kbd><abbr title="The hours in two digits. E.g. '16'">hh</abbr>:<abbr title="The minutes in two digits. E.g. '00'">mm</abbr> <abbr title="The abbreviation of the time zone, usually UTC, if not UTC then the abbreviated time zone is followed by the offset to UTC in brackets. E.g. 'CEST (UTC+02:00)'">UTC</abbr></kbd>

===Capitalization of certain nouns===
:To avoid ambiguities that could impair ease of readability or understanding (e.g. for none native English speakers) the first letter of some nouns should be capitalized.
::These words include the names of all [[items]] (e.g. <kbd>{{Multi-Hack}}</kbd> or <kbd>{{Heat Sink}}</kbd>) but also words like <kbd>Agent</kbd>, <kbd>[[Control Field|Field]]</kbd>/<kbd>{{Control Field}}</kbd>, <kbd>[[Glyphs|Glyph]]</kbd>, <kbd>([[Glyph Hacking|Glyph]]) [[Hacking|Hack]]</kbd>, <kbd>{{Link}}</kbd>, <kbd>[[Portal]]</kbd>, <kbd>[[Scanner]]</kbd> etc.
:Just look around and read some articles to get a feel for which nouns are capitalized and try to follow that pattern.

===References===
:When adding references/citations to an article (by using the <code><big><nowiki><ref></nowiki></big></code> / <code><big><nowiki></ref></nowiki></big></code>-tag) please make sure not just to add the URL itself but to turn it into a link and adding some link text to it which tells people where the link leads (and preferably even at which date and time you have last seen the cited information on it).
::Good<ref>How it should look: [https://youtu.be/_sv1wDdOxuM Ingress Report EP1 — Ingress (YouTube)]</ref>: <code><big><nowiki><ref>[https://youtu.be/_sv1wDdOxuM Ingress Report EP1 — Ingress (YouTube)]</ref></nowiki></big></code>
::Bad<ref>How it should not look: https://youtu.be/_sv1wDdOxuM</ref>: <code><big><nowiki><ref>https://youtu.be/_sv1wDdOxuM</ref></nowiki></big></code>
:::<references />


==Additional instructions==
===Words & Terms===
:There are certain words and terms that should be replaced with in-universe terms in all wiki articles with in-universe topics (meaning all articles except those that are talking about the game Ingress, the Ingress App (releases/updates/changes etc.) like the [[Ingress|Ingress-]] or [[Ingress Prime|Ingress Prime-articles]]) to keep the immersion within the wiki unless the article describes something like an in-universe conversation in which they are used e.g. in the ''[[Ingress: The Animation]]''-series.
::{| class="article-table"
!Word/Term!!->!!Replacement
|-
|(Ingress) Player||->||Agent
|-
|Ingress App||->||Scanner
|-
|Mobile phone<br/>(running Ingress)||->||Scanner device
|-
|in-game<br/>in-app||->||in-Scanner
<!--
|-
|<text>||->||<text>
-->
|}

===[[Medal|Medals]] vs. [[Medal#Limited Edition Badges|Badges]]===
:Not all of the little hexagons on an Agents profile are created equal. There are two distinct categories, [[Medal|Medals]] and [[Medal#Limited Edition Badges|Badges]]. The difference between the two is simple: [[Medal|Medals]] can only be earned through actions/achievements while [[Medal#Limited Edition Badges|Badges]] can simply be bought in the [[Scanner|in-scanner]] [[Store]] or gained by any other means which does not require any real action within [[Ingress]].

:'''File naming conventions:'''
::To ensure that all templates can use the [[Medal|Medal]]- and [[Medal#Limited Edition Badges|Badge]]-[[Special:NewFiles|image files]] properly they all have to abide by the following naming conventions:
:*Tiered [[Medal|Medals]]:
:::<code>''{Name}''<big>-</big>''{Tier}''<big>.png</big></code>
<blockquote>
::Examples: ''[[Recharger]]''-[[Medal]] and ''Nemesis Perpetua''-[[Anomaly Medals|Anomaly Medal]]
:::{{Bronze}}: <code><big>[[:File:Recharger-bronze.png|Recharger-bronze.png]]</big></code> [[File:Recharger-bronze.png|25px|link=Recharger]]
:::{{Silver}}: <code><big>[[:File:Recharger-silver.png|Recharger-silver.png]]</big></code> [[File:Recharger-silver.png|25px|link=Recharger]]
:::{{Gold}}: <code><big>[[:File:Recharger-gold.png|Recharger-gold.png]]</big></code> [[File:Recharger-gold.png|25px|link=Recharger]]
:::{{Platinum}}: <code><big>[[:File:Recharger-platinum.png|Recharger-platinum.png]]</big></code> [[File:Recharger-platinum.png|25px|link=Recharger]]
:::{{Onyx}} ({{Black}}): <code><big>[[:File:Recharger-black.png|Recharger-black.png]]</big></code> [[File:Recharger-black.png|25px|link=Recharger]]
:::{{Recursed}} {{Onyx}} ({{Black}}): <code><big>[[:File:Recharger-recurse.png|Recharger-recurse.png]]</big></code> [[File:Recharger-recurse.png|25px|link=Recharger]]
:::[[Anomaly Medals|Anomaly Medal]] Tier 1: <code><big>[[:File:Nemesis Perpetua-tier 1.png|Nemesis Perpetua-tier 1.png]]</big></code> [[File:Nemesis Perpetua-tier 1.png|25px]]
:::[[Anomaly Medals|Anomaly Medal]] Tier 2: <code><big>[[:File:Nemesis Perpetua-tier 2.png|Nemesis Perpetua-tier 2.png]]</big></code> [[File:Nemesis Perpetua-tier 2.png|25px]]
:::<code><small>The last two examples are only used if the [[Anomaly Medals|Anomaly Medal]] has Tiers that can not easily be assigned one of the standard Tiers ({{Bronze}}, {{Silver}}, {{Gold}}, {{Platinum}}, {{Onyx}}).</small></code>
</blockquote>
:*Untiered [[Medal|Medals]] and [[Medal#Limited Edition Badges|Badges]]:
:::<code>''{Name}''<big>-medal.png</big></code>
:::<code>''{Name}''<big>-badge.png</big></code>
<blockquote>
::Examples: ''[[Verified]]''-[[Medal]] and ''Hyperion''-[[Medal#Limited Edition Badges|Badge]]
:::[[Medal]]: <code><big>[[:File:Verified-medal.png|Verified-medal.png]]</big></code> [[File:Verified-medal.png|25px|link=Verified]]
:::[[Medal#Limited Edition Badges|Badge]]: <code><big>[[:File:Hyperion-badge.png|Hyperion-badge.png]]</big></code> [[File:Hyperion-badge.png|25px]]
</blockquote>
:*[[Medal|Medals]] and [[Medal#Limited Edition Badges|Badges]] with multiple versions but the same name:
:::<code>''{Name}''<big>-medal (</big>''{Version}''<big>).png</big></code>
:::<code>''{Name}''<big>-badge (</big>''{Version}''<big>).png</big></code>
<blockquote>
::Example: ''NL-PRIME''-[[Medal]]
:::Version A: <code><big>[[:File:NL-PRIME-medal (version A).png|NL-PRIME-medal (version A).png]]</big></code> [[File:NL-PRIME-medal (version A).png|25px]]
:::Version B: <code><big>[[:File:NL-PRIME-medal (version B).png|NL-PRIME-medal (version B).png]]</big></code> [[File:NL-PRIME-medal (version B).png|25px]]
</blockquote>

=== [[Help:Template_types|Template types]] ===
:There are 14 different [[Help:Template_types|template types]] that you can choose from to classify a [[:Category:Templates|template]]. But there are some tricky things that you need to keep in mind, mainly how your [[:Category:Templates|template]] is going to be displayed on mobile devices.
:The main issue regarding this is caused by the [[Help:Template_types|template type]] ''[[Help:Template_types#Infoicon|Infoicon]]''. When this [[Help:Template_types|template type]] is used and the [[:Category:Templates|template]] includes both an image as well as text the latter in not displayed on mobile devices which can cause some issues e.g. with item-templates like the {{Portal Key}}-[[:Category:Templates|template]]. While on PCs [[:Category:Templates|templates]] like the {{Portal Key}}-[[Template:Portal Key|template]] show up on all pages with their text as intended, on mobile devices the same [[File:Portal Key.png|20x20px|link=Portal Key|Portal Key]]-[[Template:Portal Key|template]] suddenly does not display any text at all anymore which makes reading item-articles a real pain.
:But while missing item names are annoying it does not take away from the actual information on the page since with the displayed image you know what was supposed to be written there but there are examples where that is very much not the case, prime example: [[Store]] prices.
:Say you wonder what 10 {{Power Cube|s}} at the Agent's [[Access Level|level]] cost in the [[Store]], so you look at the {{Power Cube|'s}}-page here and find that the infobox there actually includes that information but what you see exactly differs greatly if the [[:Category:Templates|templates]], including the {{CMU}}-[[Template:CMU|template]], are set as [[Help:Template_types|type]] ''[[Help:Template_types#Infoicon|Infoicon]]'':
::{|
! style="text-align: right" |View on PC:<br />&nbsp;
| style="text-align: left" |[[Store]] Price&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
| style="text-align: left" |10 {{Power Cube|s}} (at Agent's [[Access Level|Level]]): {{CMU|1 000}}
|-
! style="text-align: right" |View on mobile device:<br />&nbsp;
| style="text-align: left" |[[Store|STORE]] PRICE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
| style="text-align: left" |10 [[File:Power Cube.gif|20x20px|link=Power Cube|Power Cube]] (at Agent's [[Access Level|Level]]): [[File:CMU-icon.png|18x18px|link=Chaotic Matter Units|Chaotic Matter Units]]
|}
:So what is the solution to that problem? Simple: Completely disregard the [[Help:Template_types|template type]] ''[[Help:Template_types#Infoicon|Infoicon]]'' and always use the [[Help:Template_types|template type]] ''[[Help:Template_types#Unknown|Unknown]]'' instead unless you are absolutely confident that your [[:Category:Templates|template]] only includes, and will only include an image and nothing else.

===Short forms/Slang===
:When writing or editing articles please avoid the use of slang (like ''ain't'' or ''gonna'' etc.) as well as general short forms (like ''isn't'', ''won't'', ''shan't'' etc.) instead please use the "long forms" to ensure easier readability for non-native speakers as well as just an overall better appearance of the articles.

[[Category:Ingress Wiki]]