Skip to content

Commit

Permalink
Add initial documentation for the Texture Browser prefs page
Browse files Browse the repository at this point in the history
  • Loading branch information
Matthew Mott committed Oct 23, 2019
1 parent 3c71c16 commit 13909d9
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 3 deletions.
18 changes: 18 additions & 0 deletions doc/manual.adoc
Expand Up @@ -734,6 +734,7 @@ provides easy access to a user-chosen group of textures, and can be accessed by
choosing the *Show Favourites* radio button at the top of the panel.
|===

[[TexturesTab]]
==== The Textures tab

The *Textures* tab provides a scrollable canvas containing preview swatches of
Expand Down Expand Up @@ -1578,6 +1579,23 @@ textures. These values can be set on a per-object basis using the
the <<SurfaceInspector,Surface Inspector>> section for more details on this
feature.

==== Texture Browser settings

These options control the behaviour of the <<TexturesTab,Textures tab>>.

*Uniform texture thumbnail size*:: Choose the size in pixels that will be used
for texture thumbnails.

*Texture scrollbar*:: Hide or show the scrollbar in the textures tab. If the
scrollbar is hidden, scrolling is only possible with the mouse wheel.

*Mousewheel increment*:: This option determines how much the window is scrolled
when the mouse wheel is rotated.

*Max shadername length*:: Choose the maximum number of characters that may
appear in each texture name. If a texture contains more characters than this,
the texture name will be abbreviated with "..." in the middle.

== Features for game distributors

DarkRadiant is designed to work out of the box with a standard Doom 3 or Dark
Expand Down
38 changes: 35 additions & 3 deletions doc/manual.html
Expand Up @@ -472,7 +472,7 @@ <h1>DarkRadiant User Guide</h1>
<li><a href="#_applying_textures">Applying textures</a>
<ul class="sectlevel3">
<li><a href="#MediaTab">The Media tab</a></li>
<li><a href="#_the_textures_tab">The Textures tab</a></li>
<li><a href="#TexturesTab">The Textures tab</a></li>
<li><a href="#SurfaceInspector">Using the Surface Inspector</a></li>
</ul>
</li>
Expand Down Expand Up @@ -530,6 +530,7 @@ <h1>DarkRadiant User Guide</h1>
<li><a href="#_selection_settings">Selection settings</a></li>
<li><a href="#_undo_settings">Undo settings</a></li>
<li><a href="#_primitives_settings">Primitives settings</a></li>
<li><a href="#_texture_browser_settings">Texture Browser settings</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -1751,7 +1752,7 @@ <h4 id="MediaTab">The Media tab</h4>
</table>
</div>
<div class="sect3">
<h4 id="_the_textures_tab">The Textures tab</h4>
<h4 id="TexturesTab">The Textures tab</h4>
<div class="paragraph">
<p>The <strong>Textures</strong> tab provides a scrollable canvas containing preview swatches of
all the textures which are currently loaded in the current map.</p>
Expand Down Expand Up @@ -3136,6 +3137,37 @@ <h4 id="_primitives_settings">Primitives settings</h4>
</dl>
</div>
</div>
<div class="sect3">
<h4 id="_texture_browser_settings">Texture Browser settings</h4>
<div class="paragraph">
<p>These options control the behaviour of the <a href="#TexturesTab">Textures tab</a>.</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>Uniform texture thumbnail size</strong></dt>
<dd>
<p>Choose the size in pixels that will be used
for texture thumbnails.</p>
</dd>
<dt class="hdlist1"><strong>Texture scrollbar</strong></dt>
<dd>
<p>Hide or show the scrollbar in the textures tab. If the
scrollbar is hidden, scrolling is only possible with the mouse wheel.</p>
</dd>
<dt class="hdlist1"><strong>Mousewheel increment</strong></dt>
<dd>
<p>This option determines how much the window is scrolled
when the mouse wheel is rotated.</p>
</dd>
<dt class="hdlist1"><strong>Max shadername length</strong></dt>
<dd>
<p>Choose the maximum number of characters that may
appear in each texture name. If a texture contains more characters than this,
the texture name will be abbreviated with "&#8230;&#8203;" in the middle.</p>
</dd>
</dl>
</div>
</div>
</div>
</div>
</div>
Expand Down Expand Up @@ -3212,7 +3244,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-16 20:53:04 BST
Last updated 2019-10-23 21:01:22 BST
</div>
</div>
</body>
Expand Down

0 comments on commit 13909d9

Please sign in to comment.