Difference between revisions of "User Manual"

Revision as of 10:42, 1 August 2009

The structure of the User Manual is being changed. Until it is completed some links might be temporarily dead and the content of the pages might seems strange. Hopefully the manual should be back to normal by Saturday August 1, 16:00 GMT[edit]

WORK IN PROGRESS, HELP NEEDED

If you want to contribute, send us a sample of text you'd write for the new manual, and we will consider adding you an account. You can work on the manual in the Wiki, but if you prefer, supplying us with HTML or TeX sources is fine, too (we will then translate them for the Wiki).

You can have a look at our TODO page for a list of tasks that need to be done.

Introduction

A description of what ScummVM is.

Quick Start

A short guide on how to use ScummVM.

ScummVM Interface

A description of the ScummVM interface, in case you ever wondered what a specific button does.

Using ScummVM

A detailed description on how to use ScummVM.

Installing ScummVM
Configuring ScummVM, describes the settings and command-line parameters that you can use so that it runs games exactly the way you want it to
Installing a game for use with ScummVM, covers multi-CD games, additional files like kyra.dat, and extracting/converting audio tracks
Adding and Running a game in ScummVM
Configuring a game in ScummVM, describes how to adjust per-game settings
Removing a game from ScummVM
Uninstalling ScummVM

Getting Help

FAQ
Contacts, lists places where you can get help

Appendix

Contains comprehensive technical information on various topics.

Command line options a list and descriptions of all the command line options you can use with ScummVM
Config file description, describes the ScummVM configuration file
Tools, a list of the tools available for use with ScummVM (e.g. for compressing audio), along with a description of their usage

The list of games supported by the most recent stable version of ScummVM can be found on the Compatibility page, or the games supported by the current unstable version can be found on the SVN Compatibility page. The Engines page in the wiki also lists these things, along with the engines that are still work-in-progress.

@@ Line 1: / Line 1: @@
-<span style="color:red">'''The structure of the User Manual is being changed. Until it is completed some links might be temporarily dead and the content of the pages might seems strange. Hopefully the manual should be back to normal by Saturday August 1, 12:00 GMT'''</span>{{Edit-first-section}}__NOEDITSECTION__ __NOTOC__
+<span style="color:red">'''The structure of the User Manual is being changed. Until it is completed some links might be temporarily dead and the content of the pages might seems strange. Hopefully the manual should be back to normal by Saturday August 1, 16:00 GMT'''</span>{{Edit-first-section}}__NOEDITSECTION__ __NOTOC__
 {{HelpWithManual}}
-{{ManualSection|location=User_Manual/Introduction|name=Introduction|desc=A description of what ScummVM does, what to do if you find a bug, and how to contact the authors}}
-{{ManualSection|location=User_Manual/Getting_started|name=Getting started|desc=What you need to be able to use ScummVM, where to get it from, and how to install it}}
+{{ManualSection|location=User_Manual/Introduction|name=Introduction|desc=A description of what ScummVM is.}}
-{{ManualSection|location=User_Manual/Running_and_Using_ScummVM|name=Running and using ScummVM|desc=How to use ScummVM, including both graphical and command line usage}}
-{{ManualSection|location=User Manual/Game Specific Instructions|name=Game Specific Instructions|desc=Instructions for installation and in-game hotkeys for some specific games.}}
+{{ManualSection|location=User_Manual/Quick Start|name=Quick Start|desc=A short guide on how to use ScummVM.}}
-{{ManualSection|location=User_Manual/Configuration|name=Configuration|desc=Changing the options of ScummVM so that it runs games exactly the way you want it to}}
-{{ManualSectionNoLink|name=Appendix: Supported games|desc=The list of games supported by the most recent stable version of ScummVM can be found on the [http://www.scummvm.org/compatibility.php?version={{StableVersion}} Compatibility page], or the games supported by the current unstable version can be found on the [http://www.scummvm.org/compatibility.php SVN Compatibility page].
+{{ManualSection|location=User_Manual/ScummVM Interface|name=ScummVM Interface|desc=A description of the ScummVM interface, in case you ever wondered what a specific button does.}}
-The [[Engines|Engines page]] in the wiki also lists these things, along with the engines that are still work-in-progress.}}
-{{ManualSection|name=Appendix: Tools|location=User_Manual/Appendix:_Tools|desc=A list of the tools available for use with ScummVM (e.g. for compressing audio), along with a description of their usage}}
+{{ManualSectionNoLink|name=Using ScummVM|desc=A detailed description on how to use ScummVM.
+# [[User Manual/Installing ScummVM|Installing ScummVM]]
+# [[User Manual/Configuring ScummVM|Configuring ScummVM]], describes the settings and command-line parameters that you can use so that it runs games exactly the way you want it to
+# [[User Manual/Installing a game for use with ScummVM|Installing a game for use with ScummVM]], covers multi-CD games, additional files like kyra.dat, and extracting/converting audio tracks
+# [[User Manual/Adding and Running a game in ScummVM|Adding and Running a game in ScummVM]]
+# [[User Manual/Configuring a game in ScummVM|Configuring a game in ScummVM]], describes how to adjust per-game settings
+#[[User Manual/Removing a game from ScummVM|Removing a game from ScummVM]]
+#[[User Manual/Uninstalling ScummVM|Uninstalling ScummVM]]
+}}
+{{ManualSectionNoLink|name=Getting Help|desc=
+# [[User Manual/FAQ|FAQ]]
+# [[User Manual/Contacts|Contacts]], lists places where you can get help
+}}
+{{ManualSectionNoLink|name=Appendix|desc=Contains comprehensive technical information on various topics.
+# [[User Manual/Appendix: Command line options|Command line options]] a list and descriptions of all the command line options you can use with ScummVM
+# [[User Manual/Appendix: Config file description|Config file description]], describes the ScummVM configuration file
+# [[User Manual/Appendix: Tools|Tools]], a list of the tools available for use with ScummVM (e.g. for compressing audio), along with a description of their usage
+The list of games supported by the most recent stable version of ScummVM can be found on the [http://www.scummvm.org/compatibility.php?version={{StableVersion}} Compatibility page], or the games supported by the current unstable version can be found on the [http://www.scummvm.org/compatibility.php SVN Compatibility page].
+The [[Engines|Engines page]] in the wiki also lists these things, along with the engines that are still work-in-progress.
+}}