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
 
(41 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
{{ii}} Please also refer to the [[Project:Sample article]].
 +
 
==Article structure==
 
==Article structure==
−
AppleGamingWiki's article structure is directly derived from that of PCGamingWiki. Please refer to [https://www.pcgamingwiki.com/wiki/PCGamingWiki:Editing_guide 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.
+
AppleGamingWiki's article structure is directly derived from that of PCGamingWiki. Please refer to [https://www.pcgamingwiki.com/wiki/PCGamingWiki:Editing_guide 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 sections will eventually be reintroduced.
  
 
This means the inherits from PCGamingWiki the following sections:
 
This means the inherits from PCGamingWiki the following sections:
  
 
<pre>
 
<pre>
 +
Infobox
 +
-Introduction
 +
-General information
 +
Availability
 
Compatibility
 
Compatibility
−
Availability
 
 
Issues resolved
 
Issues resolved
 
Issues unresolved
 
Issues unresolved
 +
Other information
 
</pre>
 
</pre>
  
Line 14: Line 20:
  
 
<pre>
 
<pre>
−
Introduction
 
 
Monetization
 
Monetization
 
Essential improvements
 
Essential improvements
Line 27: Line 32:
 
</pre>
 
</pre>
  
−
==Editing guide==
+
==Infobox==
 +
{{ii}} {{T|Infobox_game}}
 +
{{ii}} See [https://www.pcgamingwiki.com/wiki/PCGamingWiki:Editing_guide/The_infobox 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.
 
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.
  
−
==Cheat sheet==
+
Items that need changing from PCGamingWiki infobox:
−
===Availability===
+
*<code>|release dates=</code> - This now has new macOS/iOS/iPadOS/tvOS release formats. The old Windows/OS X/Linux release dates have been removed.
 +
*<code>|codeweavers=</code> - Codeweavers website.
 +
*<code>|pcgamingwiki=</code> - PCGamingWiki article name.
 +
*<code>|asg=</code> - 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'.
 +
 
 
<pre>
 
<pre>
−
{{Availability|
+
{{Infobox game
−
{{Availability/row| Retail | | Steam | | | macOS }}
+
|cover        = Game article layout.jpg <!-- Try to find the highest resolution of a PC game cover -->
−
{{Availability/row| Gamesplanet | 4509-5 | GOG.com | {{store link|Gamesplanet|4509-12|Game of the Year Edition}} also available. | | macOS }}
+
|developers  =
−
{{Availability/row| Gamesplanet | 4509-1 | Steam | {{store link|Gamesplanet|4509-10|Game of the Year Edition}} also available. | | macOS }}
+
{{Infobox game/row/developer|Developer}}
−
{{Availability/row| GOG.com | frostpunk | DRM-free | {{store link|GOG.com|frostpunk_game_of_the_year_edition|Game of the Year Edition}} also available. | | macOS }}
+
|publishers  =
−
{{Availability/row| Humble | frostpunk | Steam | | | macOS }}
+
{{Infobox game/row/publisher|Publisher}}
−
{{Availability/row| App Store | id1446616993 | MacApp | {{store link|App Store|id1534306371|Complete Edition}} also available. | | macOS }}
+
|engines      =
−
{{Availability/row| Steam | 323190 | Steam | {{store link|Steam-bundle|12261|Game of the Year Edition}} also available. | | macOS }}
+
{{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          =
 +
}}
 +
</pre>
 +
 
 +
{{T|Introduction}} (modified to remove taxonomy sentence):
 +
<pre>
 +
{{Introduction
 +
|release history  =
 +
|current state    =
 
}}
 
}}
 
</pre>
 
</pre>
−
===Compatibility===
+
 
 +
General information goes below Infobox:
 +
<pre>
 +
'''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.
 +
</pre>
 +
 
 +
==Compatibility==
 +
{{ii}} {{T|Compatibility}} and {{T|Rating}}
 +
{{ii}} This is a new AppleGamingWiki template not on PCGamingWiki.
 +
{{ii}} This template does not require a <code>==macOS Compatibility==</code> header as it is built into the template.
 +
Every rating should have a corresponding {{T|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.
 +
 
 
<pre>
 
<pre>
 
{{Compatibility/macOS
 
{{Compatibility/macOS
Line 69: Line 133:
 
playable  - Game can be played through with minor audio or graphical glitches.
 
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.
 
runs      - Starts, maybe runs well, but major glitches/issues prevent game from being completed.
−
loads      - Loads, but crashes in title screen/menu/in-game.
+
menu      - Loads, but crashes in title screen/menu/in-game.
 
unplayable - Crashes when booting/infinite black screen.
 
unplayable - Crashes when booting/infinite black screen.
 
na        - Not available in this method/format.
 
na        - Not available in this method/format.
Line 75: Line 139:
 
</pre>
 
</pre>
  
−
===Fixbox===
+
;Gallery
−
{{ii}} Please read [https://www.pcgamingwiki.com/wiki/PCGamingWiki:Editing_guide/Fixboxes_and_providing_instructions PCGamingWiki:Editing guide/Fixboxes and providing instructions]
+
Galleries can also be added:
 +
<pre>
 +
<gallery>
 +
Conqueror%27s_Blade_Parallels_error.png|Conqueror's Blade Parallels error message
 +
</gallery>
 +
</pre>
 +
*PNG file format preferred.
 +
*No more than 5 images in total in the gallery.
 +
*Purpose is to demonstrate gameplay on M1 or specific bugs.
 +
 
 +
==Availability==
 +
{{ii}} {{T|Availability}}
 +
{{ii}} See [https://www.pcgamingwiki.com/wiki/PCGamingWiki:Editing_guide/Availability 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 <code>{{Availability}}</code> 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]].
 +
 
 +
<pre>
 +
==Availability==
 +
{{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 }}
 +
}}
 +
</pre>
 +
 
 +
If the game is Windows only, then as long as the <code>|pcgamingwiki=</code> is completed in the Infobox, one can simply add a link as follows and it will automatically generate a link to PCGamingWiki article#Availability:
 +
<pre>
 +
==Availability==
 +
{{Availability}}
 +
</pre>
 +
 
 +
==Gameplay videos==
 +
Gameplay videos can be inserted in this format, with a space between each video:
 +
<pre>
 +
==Gameplay videos==
 +
{{#widget:YouTube|id=P9KY30SAeds}} {{#widget:YouTube|id=P9KY30SAeds}} {{#widget:YouTube|id=P9KY30SAeds}} {{#widget:YouTube|id=P9KY30SAeds}}
 +
</pre>
 +
*Maximum of 4 total embeds.
 +
*Prioritise YouTube videos which clerarly demonstrate performance benchmarks in the content and in the description.
 +
*Self-promotion is allowed, but if a 4-video limit is reached then please discuss with [[User:Andytizer|Andytizer]] before deleting another video.
 +
 
 +
==Fixbox==
 +
{{ii}} {{T|Fixbox}}
 +
{{ii}} See [https://www.pcgamingwiki.com/wiki/PCGamingWiki:Editing_guide/Fixboxes_and_providing_instructions PCGamingWiki:Editing guide/Fixboxes and providing instructions]
 
<pre>{{Fixbox|description=Name|ref=<ref>Reference</ref>|fix=
 
<pre>{{Fixbox|description=Name|ref=<ref>Reference</ref>|fix=
 
}}</pre>
 
}}</pre>
  
−
===Referencing===
+
==Referencing==
−
{{ii}} Please read [[Template:Refdevice|Refdevice documentation]] for details on how to read this template.
+
{{ii}} {{T|Refdevice}} is a new template only for AppleGamingWiki. Please read [[Template:Refdevice|Refdevice documentation]] for details on how to read this template.
 
<pre><ref>{{Refdevice|user=|date=yyyy-mm-dd|device=|os=|method=|version=|resolution=|settings=|framerate=|controller=|url=|title=|comment=}}</ref></pre>
 
<pre><ref>{{Refdevice|user=|date=yyyy-mm-dd|device=|os=|method=|version=|resolution=|settings=|framerate=|controller=|url=|title=|comment=}}</ref></pre>
 +
<pre><ref>{{Refdevice|user=Andytizer|date=2020-12-25|device=MacBook Air M1 2020|os=macOS 11.2 Beta|method=Windows 10 ARM Pro Insider Preview Build 20231 on Parallels 16|version=|resolution=1920x1080|settings=Default|framerate=60 FPS|controller=|url=https://www.youtube.com/watch?v=vEFlUgeIuY0|title=Fallout 1, Fallout 2 and Fallout Tactics - M1 Apple Silicon Parallels 16 Windows 10 ARM - MBA 2020|comment=}}</ref></pre>
 
<pre><ref>{{Refurl|url=|title=|date=2021-mm-dd|snippet=}}</ref></pre>
 
<pre><ref>{{Refurl|url=|title=|date=2021-mm-dd|snippet=}}</ref></pre>
 
<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:
 +
<pre>{{References}}</pre>
 +
 +
If there are multiple identical references, group them using name, .e.g:
 +
<pre><ref name=Andytizer>{{Refdevice|user=}}</ref></pre>
 +
<pre><ref name=Andytizer></ref></pre>

Latest revision as of 11:36, 23 April 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 sections 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.
menu       - 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.
Gallery

Galleries can also be added: 

<gallery>
Conqueror%27s_Blade_Parallels_error.png|Conqueror's Blade Parallels error message
</gallery>
  • PNG file format preferred.
  • No more than 5 images in total in the gallery.
  • Purpose is to demonstrate gameplay on M1 or specific bugs.

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|
{{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 }}
}}

If the game is Windows only, then as long as the |pcgamingwiki= is completed in the Infobox, one can simply add a link as follows and it will automatically generate a link to PCGamingWiki article#Availability: 

==Availability==
{{Availability}}

Gameplay videos

Gameplay videos can be inserted in this format, with a space between each video: 

==Gameplay videos==
{{#widget:YouTube|id=P9KY30SAeds}} {{#widget:YouTube|id=P9KY30SAeds}} {{#widget:YouTube|id=P9KY30SAeds}} {{#widget:YouTube|id=P9KY30SAeds}}
  • Maximum of 4 total embeds.
  • Prioritise YouTube videos which clerarly demonstrate performance benchmarks in the content and in the description.
  • Self-promotion is allowed, but if a 4-video limit is reached then please discuss with Andytizer before deleting another video.

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>{{Refdevice|user=Andytizer|date=2020-12-25|device=MacBook Air M1 2020|os=macOS 11.2 Beta|method=Windows 10 ARM Pro Insider Preview Build 20231 on Parallels 16|version=|resolution=1920x1080|settings=Default|framerate=60 FPS|controller=|url=https://www.youtube.com/watch?v=vEFlUgeIuY0|title=Fallout 1, Fallout 2 and Fallout Tactics - M1 Apple Silicon Parallels 16 Windows 10 ARM - MBA 2020|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}}

If there are multiple identical references, group them using name, .e.g: 

<ref name=Andytizer>{{Refdevice|user=}}</ref>
<ref name=Andytizer></ref>
Retrieved from "https://www.applegamingwiki.com/w/index.php?title=AppleGamingWiki:Editing_guide&oldid=3168"