Anonymous edits have been disabled on the wiki. If you want to contribute please login or create an account.

Difference between revisions of "AppleGamingWiki:Editing guide"

From AppleGamingWiki, the wiki about gaming on M1 Apple silicon Macs
Line 170: Line 170:
 
<pre><ref>{{Refcheck|user=User|date=2021-03-14|comment=Comment (optional)}}</ref></pre>
 
<pre><ref>{{Refcheck|user=User|date=2021-03-14|comment=Comment (optional)}}</ref></pre>
 
This should be placed at the end of every article:
 
This should be placed at the end of every article:
−
<pre><ref>{{References}}</ref></pre>
+
<pre>{{References}}</pre>

Revision as of 00:04, 28 March 2021

Please also refer to the Project:Sample article.

Article structure

AppleGamingWiki's article structure is directly derived from that of PCGamingWiki. Please refer to PCGamingWiki's Editing guide for specific instructions on specific details on how to format an article. On AppleGamingWiki, our article structure (to begin with) purposefully reduces the complexity of the articles, however other sectins will eventually be reintroduced.

This means the inherits from PCGamingWiki the following sections: 

Infobox
-Introduction
-General information
Availability
Compatibility
Issues resolved
Issues unresolved
Other information

Our articles omit the following sections: 

Monetization
Essential improvements
Game data
Video
Input
Audio (and Localizations)
Network
VR support
Other information (and API)
System requirements

Infobox

{{Infobox_game}}
See PCGamingWiki:Editing guide/The infobox

Many articles have the PCGamingWiki article structure as a basis. Therefore to save time it should be possible to directly copy the Infobox of any PCGamingWiki article into an AppleGamingWiki article.

Items that need changing from PCGamingWiki infobox:

  • |release dates= - This now has new macOS/iOS/iPadOS/tvOS release formats. The old Windows/OS X/Linux release dates have been removed.
  • |codeweavers= - Codeweavers website.
  • |pcgamingwiki= - PCGamingWiki article name.
  • |asg= - Apple Silicon Games article link.

Other differences:

  • No longer have different namespace for developers, publishers, engines or series.
  • Removal of taxonomy fields - this may be reintroduced in the future, the only one that remains is 'series'.
{{Infobox game
|cover        = Game article layout.jpg <!-- Try to find the highest resolution of a PC game cover -->
|developers   = 
{{Infobox game/row/developer|Developer}}
|publishers   = 
{{Infobox game/row/publisher|Publisher}}
|engines      = 
{{Infobox game/row/engine|Engine}}
|release dates= 
{{Infobox game/row/date|macOS|Month dd, yyyy}} <!-- (Example: January 3, 2012) -->
{{Infobox game/row/date|iOS|Month dd, yyyy}}
{{Infobox game/row/date|iPadOS|Month dd, yyyy}}
{{Infobox game/row/date|tvOS|Month dd, yyyy}}
|reception    =
{{Infobox game/row/reception|Metacritic|deus-ex-mankind-divided|83}} <!-- (Example: URL section and score - Deus Ex: Mankind Divded) -->
{{Infobox game/row/reception|Opencritic|1812/deus-ex-mankind-divided|81}}
{{Infobox game/row/reception|IGDB|deus-ex-mankind-divided|83}}
|taxonomy     =
{{Infobox game/row/taxonomy/series            | Seriesname }}
|steam appid  = 277430
|steam appid side = 10
|gogcom id    = 1207658682
|gogcom id side = 
|official site= https://example.com/
|hltb         =
|igdb         = 
|strategywiki = 
|mobygames    = 
|wikipedia    = PCGamingWiki
|winehq       = 2
|license      = 
|pcgamingwiki =
|codeweavers  =
|asg          =
}}

{{Introduction}} (modified to remove taxonomy sentence): 

{{Introduction
|release history   = 
|current state     = 
}}

General information goes below Infobox: 

'''General information''' <!-- Include links to large forums and any Mac-specific subforums -->
{{mm}} [http://forums.sleepingdogs.net/viewforum.php?f=2 Official Forum] - this is a very active official forum
{{GOG.com links|1207658924|the_witcher}}
{{mm}} [https://steamcommunity.com/app/00000/discussions/ Steam Community Discussions]
{{mm}} If still relevant, state where bugs can be reported.

Compatibility

{{Compatibility}} and {{Rating}}
This is a new AppleGamingWiki template not on PCGamingWiki.
This template does not require a ==macOS Compatibility== header as it is built into the template.

Every rating should have a corresponding {{Refdevice}} confirming what settings were used to attempt a compatibility test. Currently this does not track properties yet but will do in the future so that lists can be automatically built. 

{{Compatibility/macOS
|native               = na
|native notes         = 
|rosetta 2            = na
|rosetta 2 notes      = 
|ios-ipados app       = na
|ios-ipados app notes = 
|crossover            = na
|crossover notes      = 
|wine                 = na
|wine notes           = 
|parallels            = na
|parallels notes      = 
|windows 10 arm       = na
|windows 10 arm notes = 
|linux arm            = na
|linux arm notes      = 
}}

perfect    - Game can be played with no issues.
playable   - Game can be played through with minor audio or graphical glitches.
runs       - Starts, maybe runs well, but major glitches/issues prevent game from being completed.
loads      - Loads, but crashes in title screen/menu/in-game.
unplayable - Crashes when booting/infinite black screen.
na         - Not available in this method/format.
unknown    - Method hasn't been tested yet.

Availability

{{Availability}}
See PCGamingWiki:Editing guide/Availability

The main difference is that this table will not track Windows or Linux, but has new fields for macOS, iOS, iPadOS and tvOS instead.

If a game has no macOS native version then using is still appropriate - it will link to the corresponding PCGamingWiki table (if it is defined in the Infobox). This should be the case for all Windows/Linux games that are not on macOS e.g. Fallout 4. 

{{Availability|
{{Availability/row| Retail | | EGS | Example: retail copy of a macOS game activating on Epic Games Launcher. |  | macOS }}
{{Availability/row| App Store | id1527064732 | App Store | Example: iOS/iPadOS game available through the App Store. |  | iOS, iPadOS }}
{{Availability/row| Developer | http://www.soldak.com/Depths-of-Peril/Buy.html | DRM-free | Example: game released directly from website. | Steam | macOS  }}
{{Availability/row| GOG.com | legend_of_grimrock | DRM-free | Example: game available through GOG.com. |  | macOS  }}
{{Availability/row| Origin | the-sims/the-sims-4 | Origin | Example: game available through Origin. |  | macOS }}
{{Availability/row| Steam | 207170 | Steam | Example: game available through Steam. |  | macOS }}
}}

Fixbox

{{Fixbox}}
See PCGamingWiki:Editing guide/Fixboxes and providing instructions
{{Fixbox|description=Name|ref=<ref>Reference</ref>|fix=
}}

Referencing

{{Refdevice}} is a new template only for AppleGamingWiki. Please read Refdevice documentation for details on how to read this template.
<ref>{{Refdevice|user=|date=yyyy-mm-dd|device=|os=|method=|version=|resolution=|settings=|framerate=|controller=|url=|title=|comment=}}</ref>
<ref>{{Refurl|url=|title=|date=2021-mm-dd|snippet=}}</ref>
<ref>{{Refcheck|user=User|date=2021-03-14|comment=Comment (optional)}}</ref>

This should be placed at the end of every article: 

{{References}}
Retrieved from "https://www.applegamingwiki.com/w/index.php?title=AppleGamingWiki:Editing_guide&oldid=901"