From e2bb3ca369d1fc289d1fe551d49b63c152ff5a58 Mon Sep 17 00:00:00 2001 From: RichardG867 Date: Sun, 19 Jul 2020 00:35:13 -0300 Subject: [PATCH] Move settings to usage in the navigation structure --- index.rst | 16 +--------------- settings/floppycdrom.rst | 4 ++-- settings/index.rst | 21 +++++++++++++++++++++ settings/removable.rst | 2 +- usage/diskimages.rst | 8 ++++---- usage/gettingstarted.rst | 2 +- 6 files changed, 30 insertions(+), 23 deletions(-) create mode 100644 settings/index.rst diff --git a/index.rst b/index.rst index 48d59eb..777418a 100644 --- a/index.rst +++ b/index.rst @@ -29,25 +29,11 @@ to retro computing and, of course, 86Box. We look forward to hearing from you! :caption: Using 86Box usage/gettingstarted + settings/index usage/machinespecific usage/diskimages usage/ideterqua -.. toctree:: - :maxdepth: 1 - :caption: Settings - - settings/machine - settings/display - settings/input - settings/sound - settings/network - settings/ports - settings/peripherals - settings/hdd - settings/floppycdrom - settings/removable - .. toctree:: :maxdepth: 1 :caption: File formats diff --git a/settings/floppycdrom.rst b/settings/floppycdrom.rst index 97df263..9b81abf 100644 --- a/settings/floppycdrom.rst +++ b/settings/floppycdrom.rst @@ -6,7 +6,7 @@ The *Floppy and CD-ROM drives* page contains settings related to the emulated ma Floppy drives ------------- -Up to four floppy disk drives can be attached to the emulated system, although not all BIOSes provide support for more than two drives. The following options apply to the selected drive: +Up to four floppy disk drives can be attached to the emulated system, although not all BIOSes provide support for more than two drives. The following settings apply to the selected drive: * **Type:** Type of floppy drive to emulate. Some drive types have special properties: @@ -24,7 +24,7 @@ Floppy disk images can be inserted and removed through the status bar or the *Me CD-ROM drives ------------- -Up to four CD-ROM / DVD-ROM optical disc drives can be attached to the emulated system. The following options apply to the selected drive: +Up to four CD-ROM / DVD-ROM optical disc drives can be attached to the emulated system. The following settings apply to the selected drive: * **Bus:** bus to attach the drive to. ATAPI (IDE) and SCSI are supported. * **Channel**/**ID:** where to attach the drive on the selected bus. See :ref:`settings/hdd:Adding a new disk` for more information on IDE channels. diff --git a/settings/index.rst b/settings/index.rst new file mode 100644 index 0000000..bbb7d0c --- /dev/null +++ b/settings/index.rst @@ -0,0 +1,21 @@ +Settings +======== + +The *Settings* window allows you to configure the emulated machine. + +If any changes were made to the settings, you will be asked whether or not you want to save the changes upon pressing *OK* or closing the window. Saving changes will hard reset the emulated machine. Press *Cancel* to immediately discard all changes. + +.. toctree:: + :maxdepth: 1 + :caption: Settings pages + + machine + display + input + sound + network + ports + peripherals + hdd + floppycdrom + removable diff --git a/settings/removable.rst b/settings/removable.rst index 35b14aa..dbf321d 100644 --- a/settings/removable.rst +++ b/settings/removable.rst @@ -6,7 +6,7 @@ The *Other removable devices* page contains settings related to the emulated mac MO / ZIP drives --------------- -Up to four Magneto-Optical and four Iomega ZIP disk drives can be attached to the emulated system. The following options apply to the selected drive: +Up to four Magneto-Optical and four Iomega ZIP disk drives can be attached to the emulated system. The following settings apply to the selected drive: * **Bus:** bus to attach the drive to. ATAPI (IDE) and SCSI are supported. * **Channel**/**ID:** where to attach the drive on the selected bus. See :ref:`settings/hdd:Adding a new disk` for more information on IDE channels. diff --git a/usage/diskimages.rst b/usage/diskimages.rst index c27d3dc..1f41198 100644 --- a/usage/diskimages.rst +++ b/usage/diskimages.rst @@ -64,9 +64,9 @@ Floppy disk detection 2. Data stored in the `DOS BIOS Parameter Block `_. 3. If all else fails, a guess is made based on the file size. -The BIOS Parameter Block detection may result in incorrect behavior on non-DOS-compatible floppy disks. Installation floppies for UNIX and Linux are common examples of non-DOS-compatible disks. Disabling the :ref:`Check BPB ` option is strongly recommended for accessing these, as the inaccurate BPB detection may result in read errors, data corruption and other issues. +The BIOS Parameter Block detection may result in incorrect behavior on non-DOS-compatible floppy disks. Installation floppies for UNIX and Linux are common examples of non-DOS-compatible disks. Disabling the :ref:`Check BPB ` setting is strongly recommended for accessing these, as the inaccurate BPB detection may result in read errors, data corruption and other issues. -.. note:: When using a raw image of a non-DOS-compatible floppy with the Check BPB option disabled, make sure the image file has the right size for its media type, otherwise incorrect behavior may still occur. +.. note:: When using a raw image of a non-DOS-compatible floppy with the Check BPB setting disabled, make sure the image file has the right size for its media type, otherwise incorrect behavior may still occur. CD-ROM / DVD-ROM optical disc images ------------------------------------ @@ -84,6 +84,6 @@ Supported formats: CD audio ^^^^^^^^ -Compact Disc Digital Audio (CDDA) is supported on *Cue sheet* images. CD audio playback is muted on all drives by default; it can be unmuted by unchecking the *Mute* option for the respective CD-ROM drive in the status bar or the Media menu. +Compact Disc Digital Audio (CDDA) is supported on *Cue sheet* images. CD audio playback is muted on all drives by default; it can be unmuted by unchecking the *Mute* box for the respective CD-ROM drive in the status bar or the Media menu. -.. note:: Only raw format (.bin) tracks are supported. Compressed or otherwise encapsulated audio tracks (.wav, .mp3, .ogg, .flac and other formats) are not supported. \ No newline at end of file +.. note:: Only raw format (.bin) tracks are supported. Compressed or otherwise encapsulated audio tracks (.wav, .mp3, .ogg, .flac and other formats) are not supported. diff --git a/usage/gettingstarted.rst b/usage/gettingstarted.rst index 899ce27..e3f1a2c 100644 --- a/usage/gettingstarted.rst +++ b/usage/gettingstarted.rst @@ -23,7 +23,7 @@ In the *About* menu, you can access the *About 86Box* window and see who helped .. rubric:: Step 3: Configure the hardware -When you start a virtual machine, you probably want to configure it with the hardware options you want. This is much like putting together the hardware components to build a PC. To do this, go to the *Tools* menu and select *Settings*. This will bring up the *Settings* window, which has a lot of options to choose from, split into several categories. +When you start a virtual machine, you probably want to configure it with the hardware options you want. This is much like putting together the hardware components to build a PC. To do this, go to the *Tools* menu and select *Settings*. This will bring up the *Settings* window, which has many options to choose from, split into :doc:`a handful of categories <../settings/index>`. .. rubric:: Step 4: Configure the BIOS