TrustedUser, Bureaucrats, Administrators
442
edits
Difference between revisions of "How to guides/TODO"
Jump to navigation
Jump to search
m
Cadi moved page Documentation/TODO to How to guides/TODO: Redesigns page to contain links to how to pages.
(Added link to main TODO page) |
m (Cadi moved page Documentation/TODO to How to guides/TODO: Redesigns page to contain links to how to pages.) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Infobox_TODO| | |||
taskname=Documentation TODO| | |||
techcontact=The ScummVM Team| | |||
subsystem=Documentation| | |||
}} | |||
See also [[TODO#Docs.2C_Web_site|TODO: Docs, Web site]] | See also [[TODO#Docs.2C_Web_site|TODO: Docs, Web site]] | ||
== User's Guide == | == User's Guide == | ||
| Line 52: | Line 58: | ||
== Enhancing the 'Game' wiki entries == | == Enhancing the 'Game' wiki entries == | ||
It's nice that we have a page for every single game ScummVM supports. But IMO those pages could | It's nice that we have a page for every single game ScummVM supports. But IMO those pages could become a lot more useful with some effort! In particular, it would be nice if one could find all relevant information to a game easily from that game's page -- it would make support work so much easier. Just point people there, and they can help themselves. | ||
Here are some ideas for potential extra information we might consider adding to the game pages: | Here are some ideas for potential extra information we might consider adding to the game pages: | ||
* Disk space requirements | * Disk space requirements | ||
* Memory requirements (will this even run on my device XYZ) | * Memory requirements (will this even run on my device XYZ) | ||
* List of platforms the game is known to work / not to work (using a nice Wiki template, with red,yellow, green fields maybe?) | * List of platforms the game is known to work / not to work (using a nice Wiki template, with red, yellow, green fields maybe?) | ||
* For multi CD games: Instructions on how to handle these (copying both CDs to HD, how to rename files, etc.) | * For multi CD games: Instructions on how to handle these (copying both CDs to HD, how to rename files, etc.) | ||
* Whether we support compressing the datafiles of this game, and how to do that (i.e. link to a Wiki page describing the usage of the relevant compression tool) | * Whether we support compressing the datafiles of this game, and how to do that (i.e. link to a Wiki page describing the usage of the relevant compression tool) | ||
* For games with a Mac CD version: Pointer to a webpage explaining about these (Mac | * For games with a Mac CD version: Pointer to a webpage explaining about these (Mac CDs use a different file system, HFS; tell them which tools to use on Windows/Linux to access them etc.) | ||
* List of | * List of required datafiles for each game, resp. pointer to the datafile page (we already have the pointer, still might consider listing the information also on the game page) | ||
* List of FAQs on the game, resp. known issues / workarounds | * List of FAQs on the game, resp. known issues / workarounds | ||
* Links to important bug reports for the game | * Links to important bug reports for the game | ||
* Info on where you can legally obtain the game | * Info on where you can legally obtain the game | ||
* Link to the relevant part of our screenshots section | * Link to the relevant part of our screenshots section like (for Monkey Island) http://scummvm.org/screenshots.php?cat1=0&cat2=4&view=-1 (instead of directly linking to each screenshot, which is inflexible) -> this end it would be nice if the website code would be changed to also accept http://scummvm.org/screenshots.php?game=monkey | ||
* List of known variants of the games, possibly with a brief explanation what distinguishes that version from others (to stick with the MI example: EGA vs VGA vs AMIGA vs CD version: different graphics, different audio, etc.) | |||
* The compatibility level from the compatibility page could be mirrored | |||