Skip to content

Commit

Permalink
Add documentation for Autosave and Multi Monitor preferences
Browse files Browse the repository at this point in the history
  • Loading branch information
Matthew Mott committed Oct 1, 2019
1 parent d67af6d commit 639ffb1
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 1 deletion.
28 changes: 28 additions & 0 deletions doc/manual.adoc
Expand Up @@ -1496,6 +1496,34 @@ the 2D views.
controls whether DarkRadiant will prefer to select the entity (enabled) or the
brush (disabled).

==== Multi Monitor settings

The Multi Monitor page contains a single setting, *Start DarkRadiant on
monitor*, which allows you to choose which monitor DarkRadiant will start on if
you have several available.

==== Autosave settings

*Enable Autosave*:: Controls whether the autosave feature is active or disabled.

*Autosave Interval*:: Use this slider to choose how often DarkRadiant will make
an autosave. By default, autosaves are made every 5 minutes.

*Save Snapshots*:: If this option is enabled, DarkRadiant will make each
autosave into a separate copy of the map file, allowing you to potentially
revert changes which were made several autosaves ago. If this option is
disabled, there will only ever be a single autosave file, which will protect
against DarkRadiant or system crashes but not against long-term erroneous
changes.

*Snapshot folder*:: This specifies the name of the folder used to store snapshot
autosaves, if the *Save Snapshots* option is enabled.

*Max Snapshot size per map*:: This allows you to control the amount of disk
space used for storing snapshots, by specifying a maximum number of megabytes
that will be used for storing the snapshots for a single map. If the disk usage
grows above this limit, DarkRadiant will start to delete old snapshots.

== Features for game distributors

DarkRadiant is designed to work out of the box with a standard Doom 3 or Dark
Expand Down
49 changes: 48 additions & 1 deletion doc/manual.html
Expand Up @@ -523,6 +523,8 @@ <h1>DarkRadiant User Guide</h1>
<ul class="sectlevel3">
<li><a href="#_camera_settings">Camera settings</a></li>
<li><a href="#_orthoview_settings">Orthoview settings</a></li>
<li><a href="#_multi_monitor_settings">Multi Monitor settings</a></li>
<li><a href="#_autosave_settings">Autosave settings</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -2990,6 +2992,51 @@ <h4 id="_orthoview_settings">Orthoview settings</h4>
</dl>
</div>
</div>
<div class="sect3">
<h4 id="_multi_monitor_settings">Multi Monitor settings</h4>
<div class="paragraph">
<p>The Multi Monitor page contains a single setting, <strong>Start DarkRadiant on
monitor</strong>, which allows you to choose which monitor DarkRadiant will start on if
you have several available.</p>
</div>
</div>
<div class="sect3">
<h4 id="_autosave_settings">Autosave settings</h4>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>Enable Autosave</strong></dt>
<dd>
<p>Controls whether the autosave feature is active or disabled.</p>
</dd>
<dt class="hdlist1"><strong>Autosave Interval</strong></dt>
<dd>
<p>Use this slider to choose how often DarkRadiant will make
an autosave. By default, autosaves are made every 5 minutes.</p>
</dd>
<dt class="hdlist1"><strong>Save Snapshots</strong></dt>
<dd>
<p>If this option is enabled, DarkRadiant will make each
autosave into a separate copy of the map file, allowing you to potentially
revert changes which were made several autosaves ago. If this option is
disabled, there will only ever be a single autosave file, which will protect
against DarkRadiant or system crashes but not against long-term erroneous
changes.</p>
</dd>
<dt class="hdlist1"><strong>Snapshot folder</strong></dt>
<dd>
<p>This specifies the name of the folder used to store snapshot
autosaves, if the <strong>Save Snapshots</strong> option is enabled.</p>
</dd>
<dt class="hdlist1"><strong>Max Snapshot size per map</strong></dt>
<dd>
<p>This allows you to control the amount of disk
space used for storing snapshots, by specifying a maximum number of megabytes
that will be used for storing the snapshots for a single map. If the disk usage
grows above this limit, DarkRadiant will start to delete old snapshots.</p>
</dd>
</dl>
</div>
</div>
</div>
</div>
</div>
Expand Down Expand Up @@ -3066,7 +3113,7 @@ <h4 id="_creating_an_assets_lst_file">Creating an assets.lst file</h4>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2019-09-24 20:28:25 BST
Last updated 2019-10-01 20:41:01 BST
</div>
</div>
</body>
Expand Down

0 comments on commit 639ffb1

Please sign in to comment.