2,051
edits
Difference between revisions of "User Manual/TODO"
m
typos and cleanup
m (User Manual/TO DO moved to User Manual/TODO: Consistency with all the TODO pages) |
m (typos and cleanup) |
||
| Line 2: | Line 2: | ||
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. | ||
* A new user will arrive: ''I have game XXX and I was told that | * A new user will arrive: ''I have game XXX and I was told that ScummVM can help me to play this game on platform YYY. How can I run this game with ScummVM?''. A good way to help that user would be to have a Quick Start section, something that the current manual is lacking. | ||
* More experienced user (or the same user a bit later) will ask more complex questions or will want more details. ''How can I get a better sound? What sound settings should I use?''. For this kind of more advanced documentation I would simply take the different sections of the Quick Start and break them into different pages in which we can add more details. | * More experienced user (or the same user a bit later) will ask more complex questions or will want more details. ''How can I get a better sound? What sound settings should I use?''. For this kind of more advanced documentation I would simply take the different sections of the Quick Start and break them into different pages in which we can add more details. | ||
| Line 8: | Line 8: | ||
* 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 reorganization tries to address all these approaches. | ||
== Manual Proposed | == Manual Proposed Reorganization == | ||
1. Introduction | 1. Introduction | ||
| Line 56: | Line 56: | ||
6.3 Tools | 6.3 Tools | ||
== Discussion on | == Discussion on Proposed Reorganization == | ||
* 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). | ||
| Line 63: | Line 63: | ||
* 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. I don't know how to improve that. Maybe 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. | * 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. I don't know how to improve that. Maybe 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. | ||
* 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 | * 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 == | ||
=== | === Reorganize the content as described above === | ||
I would like to keep the history and discussion for the existing pages of the current documentation. Therefore some of the pages will be kept or renamed. We will need to create new pages. | I would like to keep the history and discussion for the existing pages of the current documentation. Therefore some of the pages will be kept or renamed. We will need to create new pages. | ||
Until I make all the modifications in the structure, work can go on on the existing pages and the new pages can be created. | Until I make all the modifications in the structure, work can go on on the existing pages and the new pages can be created. | ||
List of pages after | List of pages after reorganization: | ||
+ Introduction | + Introduction | ||
| Line 97: | Line 97: | ||
Appendix | Appendix | ||
+ Command line options | + Command line options | ||
+ Config file | + Config file description | ||
+ Tools | + Tools | ||
| Line 114: | Line 114: | ||
+ Main Window | + Main Window | ||
+ Options | + Options | ||
+ Game | + Game settings | ||
+ In-game menu | + In-game menu | ||
| Line 125: | Line 125: | ||
Command line options | Command line options | ||
Config file | Config file description | ||
| Line 131: | Line 131: | ||
Here is how I plan to proceed: | Here is how I plan to proceed: | ||
# Add a notice on the manual entry page ( | # Add a notice on the manual entry page (reorganization of manual structure underway) | ||
# Rename existing pages | # Rename existing pages | ||
# Create new pages (if not already done) | # Create new pages (if not already done) | ||
| Line 164: | Line 164: | ||
* Wii | * Wii | ||
* Maemo | * Maemo | ||
* ... [ | * ... [TODO: complete list] | ||
=== Add descriptions of GUI features === | === Add descriptions of GUI features === | ||
| Line 171: | Line 171: | ||
* Search field | * Search field | ||
* Launcher's 'Load Game' window (with a list of games that cannot be loaded this way). | * Launcher's 'Load Game' window (with a list of games that cannot be loaded this way). | ||
* [ | * [TODO: complete list] | ||