92
edits
Difference between revisions of "User Manual/TODO"
Jump to navigation
Jump to search
→Add ScummVM and game installation instructions: Maemo is done
(→Reorganize the content as described above: update TO DO) |
(→Add ScummVM and game installation instructions: Maemo is done) |
||
| (29 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Infobox_TODO| | |||
taskname=User Manual TODO| | |||
techcontact=The ScummVM Team| | |||
subsystem=Documentation| | |||
}} | |||
== Introduction == | == Introduction == | ||
I see several ways in which the user might use a ScummVM manual. | I see several ways in which the user might use a ScummVM manual. | ||
| Line 8: | Line 14: | ||
* The last approach is quite different: the user with the ScummVM window in front of him might ask himself ''what is this button? What does it do?'' Here instead of a workflow approach (How To?), we have a GUI oriented approach (What Is?). | * The last approach is quite different: the user with the ScummVM window in front of him might ask himself ''what is this button? What does it do?'' Here instead of a workflow approach (How To?), we have a GUI oriented approach (What Is?). | ||
The following | The following organization tries to address all these approaches. | ||
== Manual | == User Manual Structure == | ||
1. Introduction | 1. Introduction | ||
What is ScummVM? | What is ScummVM? | ||
| Line 53: | Line 59: | ||
6.3 Tools | 6.3 Tools | ||
== Discussion on | == Discussion on the User Manual Structure == | ||
* Do we need a FAQ there? There is already an FAQ on the web site? Maybe we could have a more detailed FAQ, i.e. for each question we would not just have two or three lines but a more complete answer (with illustrations if needed). | * Do we need a FAQ there? There is already an FAQ on the web site? Maybe we could have a more detailed FAQ, i.e. for each question we would not just have two or three lines but a more complete answer (with illustrations if needed). | ||
* For the nearly identical items (e.g. ScummVM's 'Options' and 'Edit game' windows) it would probably be better to duplicating Manual's contents - thus never having to make reservations for numerous tiny peculiarities. | * For the nearly identical items (e.g. ScummVM's 'Options' and 'Edit game' windows) it would probably be better to duplicating Manual's contents - thus never having to make reservations for numerous tiny peculiarities. | ||
* The manual in this structure might not be optimal for users wanting to use the manual on a specific platform. They would have to look for bits on different pages that contains many information not relevant for that platform. | * The manual in this structure might not be optimal for users wanting to use the manual on a specific platform. They would have to look for bits on different pages that contains many information not relevant for that platform. | ||
** We can have a page similar to an index with the list of platforms and for each one links to the relevant parts in the documentation. | |||
** We can have a Platforms page with the info sorted by platform. The content (ScummVM installation, Game installation and controls) could be written in templates so that it is not duplicated and can be used in several places (e.g. User Manual, User Manual Platforms page, wiki platform pages). | |||
* Should the ''ScummVM interface'' and ''Using ScummVM'' section be each on a single page or have on page for each sub-section? I would prefer the later because otherwise we might get very long pages and I think it is easier to find information on several well organized pages than on a single long page. | * Should the ''ScummVM interface'' and ''Using ScummVM'' section be each on a single page or have on page for each sub-section? I would prefer the later because otherwise we might get very long pages and I think it is easier to find information on several well organized pages than on a single long page. | ||
== TODO == | == TODO == | ||
=== Add ScummVM and game installation instructions === | === Add ScummVM and game installation instructions === | ||
We need to add the instructions for the following platforms: | We need to add the instructions for the following platforms on the [[User Manual/Installing ScummVM|Installing ScummVM]] and [[User Manual/Installing a game for use with ScummVM|Installing a game for use with ScummVM]] pages: | ||
* Atari | |||
* BeOS | |||
* Fedora Core / RedHat | * Fedora Core / RedHat | ||
* GP2X | * GP2X / GP2XWiz | ||
* PS2 | * PS2 | ||
* Symbian | * Symbian | ||
| Line 83: | Line 88: | ||
* ask in the port forum if the information is not already there | * ask in the port forum if the information is not already there | ||
* ask directly the port maintainer (I am not sure they all visit the forums). | * ask directly the port maintainer (I am not sure they all visit the forums). | ||
This information is to be displayed on several pages (e.g. the User Manual, the platform pages). To avoid duplication, we can use two templates for each platform, one for ScummVM installation and one for game installation, that contain the relevant information. | |||
=== Add controls for embedded devices === | === Add controls for embedded devices === | ||
We need to add controls for embedded devices (devices that do not use a mouse and keyboard). It is missing for the following platforms: | We need to add controls for embedded devices (devices that do not use a mouse and keyboard) on the [[User Manual/Adding and Running a game in ScummVM|Adding and Running a game in ScummVM]] page. | ||
For the following platforms there is a link to the platform pages. This should be changed so that it is directly visible in the User Manual. | |||
* Windows CE | |||
It is completely missing for the following platforms: | |||
* PS2 | * PS2 | ||
* Symbian | * Symbian | ||
* GameCube | * GameCube | ||
* Wii | * Wii | ||
=== Add | === Requirements === | ||
The | The requirements section on the [[User Manual/Installing ScummVM|Installing ScummVM]] page is incomplete. | ||
* | * Update list of supported platforms, platforms that are not maintained anymore and third party unsupported platforms. The PS2 for example is not in the correct category and the Android port is missing altogether. | ||
* | * Add minimum memory, OS (or firmware) version, screen size... required to run ScummVM on each platform. | ||
* | |||
=== Compiling from source === | |||
The compiling from source section on the [[User Manual/Installing ScummVM|Installing ScummVM]] page needs to be written. Here are some ideas: | |||
* Point to the Compiling ScummVM page, resp. integrate that here. | |||
* List all required libs; where to get them; how to install them | |||
* List all optional libs etc. | |||
* We could separate this by OS, or by compiler/dev system. I think the current split in the README (section 9.0) isn't too bad. | |||
=== Uninstalling ScummVM === | |||
The page [[User Manual/Uninstalling ScummVM|Uninstalling ScummVM]] needs to be written (or removed). I suppose there will be different instructions depending on the platform (e.g. Windows, Linux, Mac, iPhone). | |||
=== Appendix === | === Appendix === | ||
* Write | * Write [[User Manual/Appendix: Config file description|config file description]] | ||
* Write | * Write the [[User Manual/Appendix: Music and sound#Using compressed audio files|Using compressed audio files]] subsection. | ||
* Check the list of tools, their description and their command line arguments are up to date | * Check the [[User Manual/Appendix: Tools|list of tools]], their description and their command line arguments are up to date. | ||