Skip to content

Commit

Permalink
Add documentation about line number selection.
Browse files Browse the repository at this point in the history
Signed-off-by: Kristian Duske <[email protected]>
  • Loading branch information
kduske committed Sep 15, 2013
1 parent c5ff7a9 commit ba8b6df
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 4 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,5 @@ xcuserdata
Resources/Help/Documentation/images/dev

/Release/

/Windows/TrenchBroom/autosave/
2 changes: 1 addition & 1 deletion Mac/TrenchBroom/TrenchBroom-Info.plist
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>2703</string>
<string>2705</string>
<key>LSMinimumSystemVersion</key>
<string>${MACOSX_DEPLOYMENT_TARGET}</string>
<key>NSHumanReadableCopyright</key>
Expand Down
6 changes: 4 additions & 2 deletions Resources/Help/Documentation/scripts/commands.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ menu_commands["Mac"]["edit_paste_at_original_pos"] = "Edit &raquo; Paste At Ori
menu_commands["Mac"]["edit_select_all"] = "Edit &raquo; Select All - &#8984;A";
menu_commands["Mac"]["edit_select_siblings"] = "Edit &raquo; Select Siblings - &#x2325;&#8984;A";
menu_commands["Mac"]["edit_select_touching"] = "Edit &raquo; Select Touching - &#8984;T";
menu_commands["Mac"]["edit_select_by_file_position"] = "Edit &raquo; Select by Line Numbers...";
menu_commands["Mac"]["edit_select_by_file_position"] = "Edit &raquo; Select by Line Number";
menu_commands["Mac"]["edit_select_none"] = "Edit &raquo; Select None - &#8679;&#8984;A";
menu_commands["Mac"]["edit_rotate_tool"] = "Edit &raquo; Tools &raquo; Rotate Objects Tool - R";
menu_commands["Mac"]["edit_clip_tool"] = "Edit &raquo; Tools &raquo; Clip Tool - C";
Expand All @@ -45,6 +45,7 @@ menu_commands["Mac"]["edit_flip_horizontally"] = "Edit &raquo; Actions &raquo;
menu_commands["Mac"]["edit_flip_vertically"] = "Edit &raquo; Actions &raquo; Flip Vertically - &#x2325;&#8984;F";
menu_commands["Mac"]["edit_duplicate_selection"] = "Edit &raquo; Actions &raquo; Duplicate - &#8984;D";
menu_commands["Mac"]["edit_map_properties"] = "Edit &raquo; Map Properties...";
menu_commands["Mac"]["edit_print_file_position"] = "Edit &raquo; Actions &raquo; Print Line Numbers"

menu_commands["Mac"]["edit_undo"] = "Edit &raquo; Undo - &#8984;Z";
menu_commands["Mac"]["edit_redo"] = "Edit &raquo; Redo - &#8984;Y";
Expand Down Expand Up @@ -82,7 +83,7 @@ menu_commands["Windows"]["edit_paste_at_original_pos"] = "Edit &raquo; Paste At
menu_commands["Windows"]["edit_select_all"] = "Edit &raquo; Select All - Ctrl+A";
menu_commands["Windows"]["edit_select_siblings"] = "Edit &raquo; Select Siblings - Ctrl+Alt+A";
menu_commands["Windows"]["edit_select_touching"] = "Edit &raquo; Select Touching - Ctrl+T";
menu_commands["Windows"]["edit_select_by_file_position"]= "Edit &raquo; Select by Line Numbers...";
menu_commands["Windows"]["edit_select_by_file_position"]= "Edit &raquo; Select by Line Number";
menu_commands["Windows"]["edit_select_none"] = "Edit &raquo; Select None - Ctrl+Shift+A";
menu_commands["Windows"]["edit_rotate_tool"] = "Edit &raquo; Tools &raquo; Rotate Objects Tool - R";
menu_commands["Windows"]["edit_clip_tool"] = "Edit &raquo; Tools &raquo; Clip Tool - C";
Expand All @@ -92,6 +93,7 @@ menu_commands["Windows"]["edit_flip_horizontally"] = "Edit &raquo; Actions &raq
menu_commands["Windows"]["edit_flip_vertically"] = "Edit &raquo; Actions &raquo; Flip Vertically - Ctrl+Alt+F";
menu_commands["Windows"]["edit_duplicate_selection"] = "Edit &raquo; Actions &raquo; Duplicate - Ctrl+D";
menu_commands["Windows"]["edit_map_properties"] = "Edit &raquo; Map Properties...";
menu_commands["Windows"]["edit_print_file_position"] = "Edit &raquo; Actions &raquo; Print Line Numbers"

menu_commands["Windows"]["edit_undo"] = "Edit &raquo; Undo - Ctrl+Z";
menu_commands["Windows"]["edit_redo"] = "Edit &raquo; Redo - Ctrl+Y";
Expand Down
3 changes: 3 additions & 0 deletions Resources/Help/Documentation/solving_problems.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
<div id="container">
<h2>Solving Problems</h2>
<p></p>
<a name="solving_problems_line_numbers"></a><h3>Finding Objects by Line Numbers</h3>
<p>If the map compilers detect a problem with a map file, they often print a line number with the error message. To find the offending objects, select <script>print_menu_command("edit_select_by_file_position");</script> from the menu and enter a space-separated list of line numbers. All objects matching these line numbers will be selected by the editor. If you would like to know the line number of the currently selected objects, select <script>print_menu_command("edit_print_file_position");</script> from the menu.</p>

<a name="solving_problems_leaks"></a><h3>Leaks and Pointfiles</h3>
<p>During mapping, you may inadvertently leave holes that lead outside of the map into the void. These are known as leaks. You will not be able to properly compile and vis your map until it is fully sealed from the void.</p>
<p>Your QBSP tool already has some functionality built in that facilitates in finding leaks, but there is an editor side as well. When QBSP detects a leak, it generates a 'pointfile'. This is a file with the .pts extension and provides a way for a map editor to communicate the QBSP tool's findings. In order to make use of this file, you must place it alongside the map file as it is loaded in Trenchbroom, so if you have a separate folder where you compile your maps, you will need to copy the .pts file back into the map folder. Once this is done, use the <b>Load Pointfile</b> command (<script>print_menu_command("file_load_pointfile");</script>) and Trenchbroom will draw a line which will help you find where the leak in your map is. You can use the <script>print_menu_command("view_camera_move_to_next_pt");</script> and <script>print_menu_command("view_camera_move_to_prev_pt");</script> commands to navigate the camera along the line.</p>
Expand Down
1 change: 1 addition & 0 deletions Resources/Help/Documentation/toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@
<li>
<a href="solving_problems.html" target="content">Solving Problems</a>
<ul>
<li><a href="solving_problems.html#solving_problems_line_numbers" target="content">Finding Objects by Line Numbers</a></li>
<li><a href="solving_problems.html#solving_problems_leaks" target="content">Leaks and Pointfiles</a></li>
<li><a href="solving_problems.html#solving_problems_textures_not_matching" target="content">Texture alignment not matching in-game</a></li>
<li><a href="solving_problems.html#solving_problems_dropped_brushes" target="content">Dropped Brushes</a></li>
Expand Down
2 changes: 1 addition & 1 deletion Windows/TrenchBroom/BuildNo
Original file line number Diff line number Diff line change
@@ -1 +1 @@
347
350

0 comments on commit ba8b6df

Please sign in to comment.