Difference between revisions of "User Manual/TODO"

Jump to navigation Jump to search

User Manual/TODO (view source)

Revision as of 14:13, 1 August 2009

1,539 bytes removed ,  14:13, 1 August 2009
update list of tasksand update new structure description
(update list of tasksand update new structure description)
Line 11: Line 11:


== Manual Proposed Reorganization ==
== Manual Proposed Reorganization ==
1. Introduction
1. Introduction
  What is ScummVM?


What is ScummVM?
2. Quick Start
  This would look like a platform-independent tutorial of the whole process, up to launching a game. One of the freeware game can be used as an example so that the user can try it himself.
  This should be short and well illustrated. All subsections here would also have a link to the more detailed section.
 
  2.1 Installing ScummVM
  2.2 Installing a game for use with ScummVM
  2.3 Adding a game in ScummVM
  2.4 Running a game in ScummVM
  2.5 Where to get help?


2. Quick Start
3. ScummVM Interface
  3.1 Main Window
  3.2 Options
  3.3 Game settings
  3.4 In-game menu ''(with a list of games that keep to their own menus)''


This would look like a platform-independent tutorial of the whole process, up to launching a game. One of the freeware game can be used as an example so that the user can try it himself.
4. Using ScummVM
  4.1 Installing ScummVM ''(on all platforms)''
  4.2 Configuring ScummVM ''(describing the settings and command-line parameters)''
  4.3 Installing a game for use with ScummVM ''(covering multi-CD games, additional files like kyra.dat, and extracting/converting audio tracks)''
  4.4 Adding and Running a game in ScummVM ''(and creating batch files)''
  4.5 Configuring a game in ScummVM ''(adjusting per-game settings, describing why 3x scaler makes 640x480 games run in a smaller window than oldies...)
  4.6 Removing a game from ScummVM
  4.7 Uninstalling ScummVM ''- ? Why would they even think about that?!''


This should be short and well illustrated. All subsections here would also have a link to the more detailed section.
5. Getting help
  5.1 FAQ ''- ? Would threads like these:
  'Why isn't my Torin's Passage detected by ScummVM?' - 'It is probably not supported by now. See compatibility page here (link).'
  qualify as 'frequently asked'? Or 'There is no sound'? 'My game crashes'?''
  5.2 Contacts
  5.3 Reporting bugs


  2.1 Installing ScummVM
  6. Appendix
2.2 Installing a game for use with ScummVM
  Contains comprehensive technical information.
2.3 Adding a game in ScummVM
 
2.4 Running a game in ScummVM
  6.1 Command line options
2.5 Where to get help?
  6.2 Config file description
 
  6.3 Tools
3. ScummVM Interface
3.1 Main Window
3.2 Options
3.3 Game settings
3.4 In-game menu ''(with a list of games that keep to their own menus)''
 
4. Using ScummVM
4.1 Installing ScummVM ''(on all platforms)''
4.2 Configuring ScummVM ''(describing the settings and command-line parameters)''
4.3 Installing a game for use with ScummVM ''(covering multi-CD games, additional files like kyra.dat, and extracting/converting audio tracks)''
4.4 Adding and Running a game in ScummVM ''(and creating batch files)''
4.5 Configuring a game in ScummVM ''(adjusting per-game settings, describing why 3x scaler makes 640x480 games run in a smaller window than oldies...)
4.6 Removing a game from ScummVM
4.7 Uninstalling ScummVM ''- ? Why would they even think about that?!''
 
5. Getting help
5.1 FAQ ''- ? Would threads like these:
'Why isn't my Torin's Passage detected by ScummVM?' - 'It is probably not supported by now. See compatibility page here (link).'
qualify as 'frequently asked'? Or 'There is no sound'? 'My game crashes'?''
5.2 Contacts
 
6. Appendix
 
Contains comprehensive technical information.
 
6.1 Command line options
6.2 Config file description
6.3 Tools


== Discussion on Proposed Reorganization ==
== Discussion on Proposed Reorganization ==
Line 67: Line 64:
== TODO ==
== TODO ==
=== Reorganize the content as described above ===
=== 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.
Pages have now be renamed or created to complies with the new structure. However some content still needs to be moved from the renamed pages to the created 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.
 
List of pages after reorganization:
+ Introduction
+ Quick Start
ScummVM interface (or everything on one page?)
  + Main Window
  + Options
  + Game settins
  + In-game menu
Using ScummVM
  + Installing ScummVM
  + Configuring ScummVM
  + Installing games for use with ScummVM
  + Adding and running a game in ScummVM
  + Setting up a game in ScummVM
  + Removing a game from ScummVM
  + Uninstalling ScummVM
Getting Help
  + FAQ
  + Contacts
Appendix
  + Command line options
  + Config file description
  + Tools
 
Here is the mapping between the old pages and new pages I intend to do:
Introduction -> Introduction
Getting started -> Installing ScummVM
Running and using ScummVM -> Adding and running a game in ScummVM
Game Specific Instructions -> Installing a game for use with ScummVM
Configuration -> Setting up ScummVM
Appendix: Tools -> Appendix: Tools
 
And a list of pages that will need to be created:
Quick Start
ScummVM interface (one or four pages?)
  + Main Window
  + Options
  + Game settings
  + In-game menu
Setting up a game in ScummVM
Removing a game from ScummVM
Uninstalling ScummVM
FAQ
Contacts
Command line options
Config file description
 
 
I ([[User:Criezy|Criezy]]) would like to reorganize the content of the manual on the weekend of August 1.
 
Here is how I plan to proceed:
# Add a notice on the manual entry page (reorganization of manual structure underway)
# Rename existing pages
# Create new pages (if not already done)
# Update manual entry page
# Fix all links to manual pages/sections.
# Move content around
# Remove notice from manual entry page


=== Add ScummVM and game installation instructions ===
=== Add ScummVM and game installation instructions ===
Line 172: Line 99:
* 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]
* [TODO: complete list]
=== Appendix ===
* Write command line options page
* write config file description
* check the list of tools, their description and their command line arguments are up to date
Criezy
TrustedUser
2,147

edits

Retrieved from "https://wiki.scummvm.org/index.php?title=Special:MobileDiff/11630"

Navigation menu