First pass at documentation updates.

git-svn-id: svn://svn.code.sf.net/p/stella/code/trunk@1601 8b62c5a3-ac7e-4cc8-8f21-d9a121418aba
This commit is contained in:
stephena 2009-01-06 01:40:11 +00:00
parent 7f727528b8
commit b8e821b709
23 changed files with 62 additions and 30 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.7 KiB

After

Width:  |  Height:  |  Size: 5.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.3 KiB

After

Width:  |  Height:  |  Size: 5.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.1 KiB

After

Width:  |  Height:  |  Size: 5.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.2 KiB

After

Width:  |  Height:  |  Size: 5.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.8 KiB

After

Width:  |  Height:  |  Size: 3.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 40 KiB

View File

@ -25,7 +25,7 @@
<li><a href="#Options">Changing Options</a></li> <li><a href="#Options">Changing Options</a></li>
<li><a href="#Keyboard">Keyboard Layout</a></li> <li><a href="#Keyboard">Keyboard Layout</a></li>
<li><a href="#Remapping">Event Remapping / Input Devices</a></li> <li><a href="#Remapping">Event Remapping / Input Devices</a></li>
<li><a href="#ROMInfo">Viewing ROM Info</a></li> <li><a href="#ROMInfo">ROM Launcher</a></li>
<li><a href="#ROMAudit">ROM Audit Mode</a></li> <li><a href="#ROMAudit">ROM Audit Mode</a></li>
<li><a href="#Adaptor">Stelladaptor Support</a></li> <li><a href="#Adaptor">Stelladaptor Support</a></li>
<li><a href="#AtariVox">AtariVox/SaveKey Support</a></li> <li><a href="#AtariVox">AtariVox/SaveKey Support</a></li>
@ -1035,7 +1035,7 @@
height of the ROM launcher and debugger windows, etc. Note that most of the items height of the ROM launcher and debugger windows, etc. Note that most of the items
here require Stella to be restarted to take effect. Specific information about here require Stella to be restarted to take effect. Specific information about
the ROM Info functionality is described in further detail in <b>Section 9 - the ROM Info functionality is described in further detail in <b>Section 9 -
<a href="#ROMInfo">Viewing ROM Info</a></b>. <a href="#ROMInfo">ROM Launcher</a></b>.
<br><br><br> <br><br><br>
@ -1820,52 +1820,84 @@
<!-- ///////////////////////////////////////////////////////////////////////// --> <!-- ///////////////////////////////////////////////////////////////////////// -->
<br><br><br> <br><br>
<p><h1> <p><h1>
<a name="ROMInfo">9. Viewing ROM Info</a></h1> <a name="ROMInfo">9. ROM Launcher</a></h1>
<hr> <hr>
<p>Several options are configurable in the ROM launcher. The size of the
launcher and fonts, as well as the 'ROM info viewer' can be changed in
<b>UI Settings/Launcher</b> dialog, as shown below:</p>
<img src="graphics/launcher_options.png">
<p>Most of the options are self-explanatory, except for the 'ROM Info
viewer', which is described below.</p>
<p>Stella supports viewing snapshots and ROM properties of the currently <p>Stella supports viewing snapshots and ROM properties of the currently
selected ROM in the ROM launcher. Support is automatic, as long as your selected ROM in the ROM launcher. Support is automatic, as long as your
snapshot directory contains snapshots in the appropriate format. An snapshot directory contains snapshots in the appropriate format. An
archive of updated snapshots will be available on the Stella webpage. archive of updated snapshots will be available on the Stella webpage.
This archive may be updated periodically as new ROMs are found, and also This archive may be updated periodically as new ROMs are found, and also
for each new release of Stella.</p> for each new release of Stella. Note that the snapshots can be any size
generated by Stella; they will be resized accordingly.</p>
<p>Currently, there are several restrictions for this feature:</p> <p>Currently, there are several restrictions for this feature:</p>
<ol> <ol>
<li>Only 1x snapshots are supported (maximum size of 320x260). This <li>The ROM info viewer can be shown in 1x or 2x mode only.</li>
means that if you generate your own snapshots, you'll have to switch <li>To view snapshots in 1x mode, the ROM launcher window must be sized at
to 1x zoom mode first before you save them.</li> least 640x480. If the launcher isn't large enough, the functionality
<li>The ROM launcher window must be sized at least 640x480.</li> will be disabled.</li>
<li>The size of the ROM info viewer is tied to the current zoom level <li>To view snapshots in 2x mode, the ROM launcher window must be sized at
of the user interface. So, for example, if you wish to see snapshots least 1000x760. If the launcher isn't large enough, an attempt will
in 2x mode, the minimum screen size to do so is 1280x960 (double the be made to use 1x mode.</li>
size of the minimum 640x480).</li>
</ol> </ol>
<p>Number three in particular is a problem for users with screenmodes <p>The following snapshots illustrate the various font sizes and rom info
smaller than 1280x960. Such users will only be able to view snapshots zoom levels:</p>
(and as a result the entire UI) in 1x mode. The problem is, in 1x mode,
the ROM launcher font is usually illegibly small. Therefore, there's
now support for changing the size of the ROM launcher font to compensate
for this.</p>
<p>Note that most of these restrictions will be fixed in a future release, <p>ROM info viewer in 1x mode, UI sized 800x480, small launcher font:</p>
when the UI becomes completely font-sensitive and configurable, and the size
of the ROM Info viewer will be configurable separately from the UI zoom level.
To illustrate, the following snapshots show the ROM launcher in 1x and 2x
mode:</p>
<p>ROM Launcher in 1x mode, UI sized 800x480, small launcher font:</p>
<img src="graphics/rominfo_1x_small.png"> <img src="graphics/rominfo_1x_small.png">
<p>ROM Launcher in 1x mode, UI sized 1020x700, large launcher font:</p> <p>ROM info viewer in 1x mode, UI sized 1000x760, medium launcher font:</p>
<img src="graphics/rominfo_1x_large.png"> <img src="graphics/rominfo_1x_large.png">
<p>ROM Launcher in 2x mode, UI sized 700x480(*2), small launcher font:</p> <p>ROM info viewer in 2x mode, UI sized 1400x900, large launcher font:</p>
<img src="graphics/rominfo_2x_small.png"> <img src="graphics/rominfo_2x_small.png">
<p>The ROM launcher also contains a context menu, selected by clicking the
right mouse button anywhere in the current window. This context menu
contains the following items:</p>
<p><ol>
<li><p><b>Override properties</b>: Selecting this option shows a dialog whereby
ROM properties can be temporarily overriden. Selecting options from this
dialog will cause all ROMs launched after that to use those properties
you specify. Clicking <b>Default</b> will disable its functionality,
and use ROM properties as defined by the ROM itself. The dialog is as
follows:</p>
<p><img src="graphics/launcher_override.png"></p>
<p>See <b>Section 16 - <a href="#Properties">Game Properties</a></b>
for more information concerning ROM properties.</p></li>
<li><p><b>Filter listing</b>: Selecting this option shows a dialog whereby
one can filter the types of files shown in the listing. The dialog is as
follows:</p>
<p><img src="graphics/launcher_filter.png"></p>
<p>Currently, the choices are as follows:</p>
<p><ul>
<li><b>All files</b> - self explanatory, show all files in the ROM
listing. This is the default, and emulates the behaviour of
all previous versions of Stella.</li>
<li><b>All roms</b> - show only files with a valid ROM extension.
Currently, this means extensions .a26, .bin, .rom, .gz, .zip.</li>
<li><b>ROMs ending with</b> - show only files with a ROM extension
as selected from the checkboxes.</li>
</ul></p>
</li>
<li><b>Reload listing</b>: Selecting this performs a reload of the
current listing. It is an alternative to pressing the Ctrl/Cmd-R
key combo.</li>
</ol></p>
<!-- ///////////////////////////////////////////////////////////////////////// --> <!-- ///////////////////////////////////////////////////////////////////////// -->
<br><br><br> <br><br><br>
@ -1895,8 +1927,8 @@
don't use this function. There is no undo feature, and one won't be don't use this function. There is no undo feature, and one won't be
added.</li> added.</li>
<li>Only filenames that Stella considers to be valid ROMs will be <li>Only filenames that Stella considers to be valid ROMs will be
considered. Currently, this means files that end in '.bin', considered. Currently, this means files that end in '.a26',
'.rom', '.a26', '.zip' and '.gz'. Files which don't have these '.bin', '.rom', '.gz' and '.zip'. Files which don't have these
extensions will be ignored.</li> extensions will be ignored.</li>
<li>If a valid ROM doesn't have a properties entry, it will be <li>If a valid ROM doesn't have a properties entry, it will be
ignored.</li> ignored.</li>