Difference between revisions of "User Manual/TODO"

Jump to navigation Jump to search
259 bytes removed ,  18:59, 7 October 2011
 
(18 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 65: Line 71:


== TODO ==
== TODO ==
=== Reorganize the content as described above ===
Most of the work to comply with the structure described above has already been done. However some content may still need to be moved from one page to another. We need to read all the pages and check that everything is at its intended place and that all the links are correct.
=== Add ScummVM and game installation instructions ===
=== Add ScummVM and game installation instructions ===
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:
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
* Maemo
* Nintendo DS
* PS2
* PS2
* Symbian
* Symbian
Line 85: 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) on the [[User Manual/Adding and Running a game in ScummVM|Adding and Running a game in ScummVM]] page.
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.
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.
* iPhone
* Dreamcast
* PSP
* Windows CE
* Windows CE
It is completely missing for the following platforms:
It is completely missing for the following platforms:
Line 98: Line 101:
* GameCube
* GameCube
* Wii
* Wii
* Maemo
* ... [TODO: complete list]
=== Add descriptions of GUI features ===
The [[User Manual/ScummVM Interface|ScummVM Interface]] page is incomplete. The descriptions for the following GUI features need to be added or completed.
* Scumm in-game menu


=== Requirements ===
=== Requirements ===
Line 116: Line 113:
* List all optional libs etc.
* 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.
* 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.
=== Configuring a game in ScummVM ===
The page [[User Manual/Configuring a game in ScummVM|Configuring a game in ScummVM]] needs to be written.


=== Uninstalling ScummVM ===
=== Uninstalling ScummVM ===
Line 125: Line 119:
=== Appendix ===
=== Appendix ===
* Write [[User Manual/Appendix: Config file description|config file description]]
* Write [[User Manual/Appendix: Config file description|config file description]]
* Check the [[User Manual/Appendix: Tools|list of tools]], their description and their command line arguments are up to date
* Write the [[User Manual/Appendix: Music and sound#Using compressed audio files|Using compressed audio files]] subsection.
* Check the [[User Manual/Appendix: Tools|list of tools]], their description and their command line arguments are up to date.
92

edits

Navigation menu