Skip to content

Commit

Permalink
Document the Clipper, Grid and Undo preferences pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Matthew Mott committed Oct 8, 2019
1 parent 639ffb1 commit f1d6637
Show file tree
Hide file tree
Showing 2 changed files with 91 additions and 3 deletions.
30 changes: 30 additions & 0 deletions doc/manual.adoc
Expand Up @@ -490,6 +490,7 @@ brush with sloping sides. However, with a more complex brush shape, the
complexity of the resulting wall geometry increases considerably, so attempting
to hollow out a 7-sided sphere is probably ill-advised.

[[SplittingBrushes]]
==== Splitting brushes

Sometimes it is necessary to divide a brush into two or more pieces, perhaps to
Expand Down Expand Up @@ -1524,6 +1525,35 @@ you have several available.
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.

==== Clipper settings

*Clipper tool uses caulk texture*:: If this option is enabled, the
<<SplittingBrushes,clipper tool>> will texture the newly-created clip face with
the texture specified in the *Caulk shader name* text field. If the option is
disabled, the new face will be given the same texture as the rest of the brush.

==== Grid settings

This page contains a couple of options relating to the appearance and default
behaviour of the grid.

*Default grid size*:: Use this combo box to choose the default grid size used in
new projects (to change the grid size in the _current_ project, use the options
in the *Grid* main menu).

*Major grid style*:: Choose the rendering style for the major grid lines.
Available options are *Lines*, *Dotted Lines*, *More Dotted Lines*, *Crosses*,
*Dots*, *Big Dots*, and *Squares*.

*Minor grid style*:: Choose the rendering style for the minor grid lines.
Available options are the same as the *Major grid style* combo box.

==== Undo settings

*Undo Queue Size*:: Use this spinbox to control the number of operations which
are saved onto DarkRadiant's internal undo stack. Larger values provide a
longer history of undoable operations, at the expense of requiring more memory.

== Features for game distributors

DarkRadiant is designed to work out of the box with a standard Doom 3 or Dark
Expand Down
64 changes: 61 additions & 3 deletions doc/manual.html
Expand Up @@ -456,7 +456,7 @@ <h1>DarkRadiant User Guide</h1>
<li><a href="#CreatingABrush">Creating a brush</a></li>
<li><a href="#_more_complex_brush_shapes">More complex brush shapes</a></li>
<li><a href="#_creating_a_room">Creating a room</a></li>
<li><a href="#_splitting_brushes">Splitting brushes</a></li>
<li><a href="#SplittingBrushes">Splitting brushes</a></li>
<li><a href="#_reshaping_brush_edges">Reshaping brush edges</a></li>
<li><a href="#BrushBasedSelection">Brush-based selection</a></li>
</ul>
Expand Down Expand Up @@ -525,6 +525,9 @@ <h1>DarkRadiant User Guide</h1>
<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>
<li><a href="#_clipper_settings">Clipper settings</a></li>
<li><a href="#_grid_settings">Grid settings</a></li>
<li><a href="#_undo_settings">Undo settings</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -1358,7 +1361,7 @@ <h4 id="_creating_a_room">Creating a room</h4>
</div>
</div>
<div class="sect3">
<h4 id="_splitting_brushes">Splitting brushes</h4>
<h4 id="SplittingBrushes">Splitting brushes</h4>
<div class="paragraph">
<p>Sometimes it is necessary to divide a brush into two or more pieces, perhaps to
create a doorway or other opening. The <strong>Clipper</strong> tool, accessed with the <strong>X</strong>
Expand Down Expand Up @@ -3037,6 +3040,61 @@ <h4 id="_autosave_settings">Autosave settings</h4>
</dl>
</div>
</div>
<div class="sect3">
<h4 id="_clipper_settings">Clipper settings</h4>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>Clipper tool uses caulk texture</strong></dt>
<dd>
<p>If this option is enabled, the
<a href="#SplittingBrushes">clipper tool</a> will texture the newly-created clip face with
the texture specified in the <strong>Caulk shader name</strong> text field. If the option is
disabled, the new face will be given the same texture as the rest of the brush.</p>
</dd>
</dl>
</div>
</div>
<div class="sect3">
<h4 id="_grid_settings">Grid settings</h4>
<div class="paragraph">
<p>This page contains a couple of options relating to the appearance and default
behaviour of the grid.</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>Default grid size</strong></dt>
<dd>
<p>Use this combo box to choose the default grid size used in
new projects (to change the grid size in the <em>current</em> project, use the options
in the <strong>Grid</strong> main menu).</p>
</dd>
<dt class="hdlist1"><strong>Major grid style</strong></dt>
<dd>
<p>Choose the rendering style for the major grid lines.
Available options are <strong>Lines</strong>, <strong>Dotted Lines</strong>, <strong>More Dotted Lines</strong>, <strong>Crosses</strong>,
<strong>Dots</strong>, <strong>Big Dots</strong>, and <strong>Squares</strong>.</p>
</dd>
<dt class="hdlist1"><strong>Minor grid style</strong></dt>
<dd>
<p>Choose the rendering style for the minor grid lines.
Available options are the same as the <strong>Major grid style</strong> combo box.</p>
</dd>
</dl>
</div>
</div>
<div class="sect3">
<h4 id="_undo_settings">Undo settings</h4>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>Undo Queue Size</strong></dt>
<dd>
<p>Use this spinbox to control the number of operations which
are saved onto DarkRadiant&#8217;s internal undo stack. Larger values provide a
longer history of undoable operations, at the expense of requiring more memory.</p>
</dd>
</dl>
</div>
</div>
</div>
</div>
</div>
Expand Down Expand Up @@ -3113,7 +3171,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-10-01 20:41:01 BST
Last updated 2019-10-08 20:46:42 BST
</div>
</div>
</body>
Expand Down

0 comments on commit f1d6637

Please sign in to comment.