Skip to content

Commit

Permalink
Document 'Map files' prefs page, and start documenting File menu
Browse files Browse the repository at this point in the history
  • Loading branch information
Matthew Mott committed Oct 30, 2019
1 parent 13909d9 commit 54558ef
Show file tree
Hide file tree
Showing 2 changed files with 135 additions and 3 deletions.
41 changes: 41 additions & 0 deletions doc/manual.adoc
View file
Expand Up @@ -1149,6 +1149,7 @@ prefabs are a DarkRadiant-only feature that have no significance to the engine.
You are therefore free to store prefab files wherever you wish, either inside or
outside the game installation directory.

[[ImportPrefab]]
==== Importing a prefab

Either right-click in the 2D window and choose *Insert prefab...*, or open the
Expand Down Expand Up @@ -1370,6 +1371,37 @@ additionally be moved to view the clicked entity.
By enabling the *List visible nodes only* checkbox, you can limit the entity
list to show only entities which are not currently hidden via filters.

== Command reference

=== File menu

*New map*:: Prompt to save and close the current map (if necessary), then start
working on a new empty map.

*Open map...*:: Prompt to save and close the current map (if necessary), then
display a file browser to choose and load an existing map file from disk.

*Import map...*:: Display a file browser to choose and load an existing map file
from disk, merging the contents with the existing map

*Import prefab...*:: Display the <<ImportPrefab,prefab browser>> to choose and
import a prefab from disk.

NOTE: Importing a map and importing a prefab are functionally identical
operations; the only difference is the user interface used for choosing what to
import. The prefab browser is designed to offer a user-friendly workflow for
browsing, previewing and importing from a library of frequently-used map
elements, while *Import map* may be more useful for merging two or more
partially-complete maps.

*Save*:: Save the current map to disk under its existing file name.

*Save as...*:: Display a file browser to choose a new name for the current map,
then save to this new file name in future.

*Save copy as...*:: Display a file browser to choose a new filename to save this
map into, without changing the current map name for future *Save* operations.

== Configuring DarkRadiant

DarkRadiant offers a large number of configurable options which can be used to
Expand Down Expand Up @@ -1596,6 +1628,15 @@ These options control the behaviour of the <<TexturesTab,Textures tab>>.
appear in each texture name. If a texture contains more characters than this,
the texture name will be abbreviated with "..." in the middle.

==== Map files settings

*Number of most recently used files*:: Choose the number of map files to list in
the recent map section at the bottom of the *File* menu.

*Open last map on startup*:: Enable this option to make DarkRadiant
automatically load the most recently-used map every time it starts, rather than
starting with an empty map.

== Features for game distributors

DarkRadiant is designed to work out of the box with a standard Doom 3 or Dark
Expand Down
97 changes: 94 additions & 3 deletions doc/manual.html
View file
Expand Up @@ -499,7 +499,7 @@ <h1>DarkRadiant User Guide</h1>
<li><a href="#_working_with_prefabs">Working with prefabs</a>
<ul class="sectlevel3">
<li><a href="#_exporting_to_a_prefab">Exporting to a prefab</a></li>
<li><a href="#_importing_a_prefab">Importing a prefab</a></li>
<li><a href="#ImportPrefab">Importing a prefab</a></li>
</ul>
</li>
<li><a href="#_using_layers">Using layers</a>
Expand All @@ -517,6 +517,11 @@ <h1>DarkRadiant User Guide</h1>
<li><a href="#_the_entity_list">The entity list</a></li>
</ul>
</li>
<li><a href="#_command_reference">Command reference</a>
<ul class="sectlevel2">
<li><a href="#_file_menu">File menu</a></li>
</ul>
</li>
<li><a href="#_configuring_darkradiant">Configuring DarkRadiant</a>
<ul class="sectlevel2">
<li><a href="#_the_preferences_dialog">The Preferences dialog</a>
Expand All @@ -531,6 +536,7 @@ <h1>DarkRadiant User Guide</h1>
<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>
<li><a href="#_map_files_settings">Map files settings</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -2439,7 +2445,7 @@ <h4 id="_exporting_to_a_prefab">Exporting to a prefab</h4>
</div>
</div>
<div class="sect3">
<h4 id="_importing_a_prefab">Importing a prefab</h4>
<h4 id="ImportPrefab">Importing a prefab</h4>
<div class="paragraph">
<p>Either right-click in the 2D window and choose <strong>Insert prefab&#8230;&#8203;</strong>, or open the
<strong>File</strong> menu and choose <strong>Import prefab&#8230;&#8203;</strong>. This will show the prefab browser.</p>
Expand Down Expand Up @@ -2811,6 +2817,73 @@ <h3 id="_the_entity_list">The entity list</h3>
</div>
</div>
<div class="sect1">
<h2 id="_command_reference">Command reference</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_file_menu">File menu</h3>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>New map</strong></dt>
<dd>
<p>Prompt to save and close the current map (if necessary), then start
working on a new empty map.</p>
</dd>
<dt class="hdlist1"><strong>Open map&#8230;&#8203;</strong></dt>
<dd>
<p>Prompt to save and close the current map (if necessary), then
display a file browser to choose and load an existing map file from disk.</p>
</dd>
<dt class="hdlist1"><strong>Import map&#8230;&#8203;</strong></dt>
<dd>
<p>Display a file browser to choose and load an existing map file
from disk, merging the contents with the existing map</p>
</dd>
<dt class="hdlist1"><strong>Import prefab&#8230;&#8203;</strong></dt>
<dd>
<p>Display the <a href="#ImportPrefab">prefab browser</a> to choose and
import a prefab from disk.</p>
</dd>
</dl>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<img src="img/note.png" alt="Note">
</td>
<td class="content">
Importing a map and importing a prefab are functionally identical
operations; the only difference is the user interface used for choosing what to
import. The prefab browser is designed to offer a user-friendly workflow for
browsing, previewing and importing from a library of frequently-used map
elements, while <strong>Import map</strong> may be more useful for merging two or more
partially-complete maps.
</td>
</tr>
</table>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>Save</strong></dt>
<dd>
<p>Save the current map to disk under its existing file name.</p>
</dd>
<dt class="hdlist1"><strong>Save as&#8230;&#8203;</strong></dt>
<dd>
<p>Display a file browser to choose a new name for the current map,
then save to this new file name in future.</p>
</dd>
<dt class="hdlist1"><strong>Save copy as&#8230;&#8203;</strong></dt>
<dd>
<p>Display a file browser to choose a new filename to save this
map into, without changing the current map name for future <strong>Save</strong> operations.</p>
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_configuring_darkradiant">Configuring DarkRadiant</h2>
<div class="sectionbody">
<div class="paragraph">
Expand Down Expand Up @@ -3168,6 +3241,24 @@ <h4 id="_texture_browser_settings">Texture Browser settings</h4>
</dl>
</div>
</div>
<div class="sect3">
<h4 id="_map_files_settings">Map files settings</h4>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>Number of most recently used files</strong></dt>
<dd>
<p>Choose the number of map files to list in
the recent map section at the bottom of the <strong>File</strong> menu.</p>
</dd>
<dt class="hdlist1"><strong>Open last map on startup</strong></dt>
<dd>
<p>Enable this option to make DarkRadiant
automatically load the most recently-used map every time it starts, rather than
starting with an empty map.</p>
</dd>
</dl>
</div>
</div>
</div>
</div>
</div>
Expand Down Expand Up @@ -3244,7 +3335,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-23 21:01:22 BST
Last updated 2019-10-30 21:02:12 GMT
</div>
</div>
</body>
Expand Down

0 comments on commit 54558ef

Please sign in to comment.