1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Issue Window</title>
<link rel="stylesheet" href="common/style.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.0" />
<meta name="keywords" content="webissues, issue tracking, bug tracking, team collaboration, desktop client" />
<link rel="start" href="index.html" title="The WebIssues Client Manual" />
<link rel="up" href="using.html" title="Chapter 3. Using WebIssues Client" />
<link rel="prev" href="folder_window.html" title="Folder Window" />
<link rel="next" href="comment_window.html" title="Comment Window" />
</head>
<body>
<div id="header">
<div id="header-bar">
<img id="header-logo" src="common/webissues.png" alt="WebIssues" />
<div id="header-title">The <span class="application">WebIssues Client</span> Manual</div>
<div id="header-abstract">Desktop client for the <span class="application">WebIssues</span> system</div>
</div>
<div id="header-links"><a accesskey="h" href="index.html">Home</a> » <a accesskey="u" href="using.html">Using <span class="application">WebIssues Client</span></a></div>
</div>
<div class="navlinks">
<div class="navleft">« <a accesskey="p" href="folder_window.html">Folder Window</a></div>
<div class="navright"><a accesskey="n" href="comment_window.html">Comment Window</a> »</div>
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="issue_window"></a>Issue Window</h2>
</div>
</div>
</div>
<p>The Issue Window shows current details and the full history of a single issue. It allows to modify the values of attributes, add comments and upload and download attachments. You can open this window by double clicking an issue in the <a class="link" href="folder_window.html" title="Folder Window">Folder Window</a>. You can also open the issue by entering its identifier in the <a class="link" href="using.html#find_dialog" title="Find Dialog">Find Dialog</a> or by clicking a <a class="link" href="comment_window.html#smart_links" title="Smart Links">Smart Link</a>.</p>
<p>The details and history of the issue is automatically updated when you open the Issue Window. It is also updated whenever a change is detected after updating the folder containing the issue and after each change that you make. To manually force an update, select <span class="guimenu">Issue</span> → <span class="guimenuitem">Update Issue</span>.</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="details_tab"></a>Details Tab</h3>
</div>
</div>
</div>
<div class="screenshot">
<div class="mediaobject">
<img src="issue_window.png" />
</div>
</div>
<p>The Details Tab displays the name of the issue, its properties (also called system attributes) and the user defined attributes depending on the type of the issue. The links in the name and attribute boxes are clickable (see <a class="link" href="comment_window.html#smart_links" title="Smart Links">Smart Links</a>). You can change the name of the issue by selecting <span class="guimenu">Edit</span> → <span class="guimenuitem">Rename</span> or by clicking the button in the right part of the box containing the name. You can change the value of each attribute by clicking the appropriate button and entering the new value in the <a class="link" href="issue_window.html#value_dialog" title="Value Dialog">Value Dialog</a>.</p>
<p>By default, attributes are displayed in alphabetical order. You can change the order of attributes by selecting <span class="guimenu">Tools</span> → <span class="guimenuitem">Configure Attributes</span>. Select the attribute that you want to move and use the arrow up and down buttons to change its position. The configured order of attributes is remembered for all issues of the same type.</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="history_tab"></a>History Tab</h3>
</div>
</div>
</div>
<div class="screenshot">
<div class="mediaobject">
<img src="issue_history.png" />
</div>
</div>
<p>The History Tab contains a browser displaying the full history of the issue in chronological order since its creation. It combines changes of attribute values, comments and attachments. The header of each change contains the identifier of the comment or attachment, the name of the user who made the change and the date of the change. The history browser displays clickable <a class="link" href="comment_window.html#smart_links" title="Smart Links">Smart Links</a> where appropriate.</p>
<p>All changes of attribute values are automatically recorded. Both the old values and the new values are displayed in the history. Changes made by one user in a short period of time are merged together.</p>
<p>To add a new comment to the issue, select <span class="guimenu">Issue</span> → <span class="guimenuitem">Add Comment</span>. A <a class="link" href="comment_window.html" title="Comment Window">Comment Window</a> will be opened allowing to enter the new comment.</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="attachments_tab"></a>Attachments Tab</h3>
</div>
</div>
</div>
<div class="screenshot">
<div class="mediaobject">
<img src="issue_attachments.png" />
</div>
</div>
<p>The Attachments Tab contains a list of attachments added to the issue. You can open or download an attachment by double clicking it and selecting the appropriate action. If you choose to open the attachment, the appropriate application is automatically started. If you choose to save the attachment, you are prompted for the target location. You can configure WebIssues to always perform the selected action without displaying the message box. You can also right click an attachment and select the action from the context menu.</p>
<p>To add a new attachment, select <span class="guimenu">Issue</span> → <span class="guimenuitem">Add Attachment</span> and choose the file to upload. You can also enter an optional description of the attachment. While uploading or downloading an attachment, a progress bar displays the amount of already transfered data.</p>
<div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Tip</h3>
<p>All opened and downloaded attachments are cached in a temporary location. You can select the maximum size of the attachments cache using the <a class="link" href="using.html#advanced_settings" title="Advanced Settings">Advanced Settings</a> tab of the settings dialog.</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="issue_menubar"></a>Menubar</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="issue_menu"></a>Issue Menu</h4>
</div>
</div>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term"><span class="guimenuitem">Add Comment</span> (<span class="shortcut"><strong><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>N</strong></span></strong></span>)</span>
</dt>
<dd>
<p>Open the <a class="link" href="comment_window.html" title="Comment Window">Comment Window</a> allowing to add a new comment to the issue.</p>
</dd>
<dt>
<span class="term">
<span class="guimenuitem">Add Attachment</span>
</span>
</dt>
<dd>
<p>Add a new file attachment to the issue.</p>
</dd>
<dt>
<span class="term">
<span class="guimenuitem">Update Issue</span>
</span>
</dt>
<dd>
<p>Update the details and history of the issue.</p>
</dd>
<dt>
<span class="term"><span class="guimenuitem">Close</span> (<span class="shortcut"><strong><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>W</strong></span></strong></span>)</span>
</dt>
<dd>
<p>Close the Issue Window.</p>
</dd>
</dl>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="issue_edit_menu"></a>Edit Menu</h4>
</div>
</div>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term"><span class="guimenuitem">Rename Issue</span> (<span class="shortcut"><strong><span class="keycap"><strong>F2</strong></span></strong></span>)</span>
</dt>
<dd>
<p>Rename the issue.</p>
</dd>
<dt>
<span class="term"><span class="guimenuitem">Copy</span> (<span class="shortcut"><strong><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>C</strong></span></strong></span>)</span>
</dt>
<dd>
<p>Copy selected text in the history browser to the clipboard.</p>
</dd>
<dt>
<span class="term"><span class="guimenuitem">Select All</span> (<span class="shortcut"><strong><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>A</strong></span></strong></span>)</span>
</dt>
<dd>
<p>Select all text in the history browser.</p>
</dd>
<dt>
<span class="term"><span class="guimenuitem">Find</span> (<span class="shortcut"><strong><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>F</strong></span></strong></span>)</span>
</dt>
<dd>
<p>Show the <a class="link" href="issue_window.html#find_bar" title="Find Bar">Find Bar</a> allowing to find a word or expression in the history browser.</p>
</dd>
<dt>
<span class="term"><span class="guimenuitem">Find Next</span> (<span class="shortcut"><strong><span class="keycap"><strong>F3</strong></span></strong></span>)</span>
</dt>
<dd>
<p>Find the next occurrence of the searched text in the history browser.</p>
</dd>
<dt>
<span class="term"><span class="guimenuitem">Find Previous</span> (<span class="shortcut"><strong><span class="keycap"><strong>Shift</strong></span>+<span class="keycap"><strong>F3</strong></span></strong></span>)</span>
</dt>
<dd>
<p>Find the previous occurrence of the searched text in the history browser.</p>
</dd>
</dl>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="issue_tools_menu"></a>Tools Menu</h4>
</div>
</div>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term">
<span class="guimenuitem">Configure Attributes</span>
</span>
</dt>
<dd>
<p>Change the order of attributes for all issues of the same type as the current one.</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="value_dialog"></a>Value Dialog</h3>
</div>
</div>
</div>
<div class="screenshot">
<div class="mediaobject">
<img src="value_dialog.png" />
</div>
</div>
<p>The Value Dialog allows to change the value of a single attribute. To open it, switch to the Details Tab and click the button in the right part of the box displaying the value of the attribute that you want to change.</p>
<p>The way the new value is entered depends on the type of the attribute:</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>an edit box is used to enter free text</p>
</li>
<li>
<p>a numeric box with arrow buttons to the right is used to enter a number; it can be an integer value or a fixed point decimal fraction</p>
</li>
<li>
<p>a dropdown list is used to select one of the allowed values or a user; in some cases a custom value can also be entered in the box</p>
</li>
<li>
<p>a combination of boxes is used to select the day, month, year and optionally time</p>
</li>
</ul>
</div>
<p>You can also select the <span class="guilabel">No value</span> option to clear the current value of the attribute. This option is not available if this is a required attribute.</p>
<p>Each change of the attribute value is applied immediately when you click <span class="guibutton">OK</span> in the Value Dialog and automatically appended to the history of the issue.</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="find_bar"></a>Find Bar</h3>
</div>
</div>
</div>
<div class="screenshot">
<div class="mediaobject">
<img src="issue_find.png" />
</div>
</div>
<p>The Find Bar allows to find a word or phrase in the history of the dialog. To open it, switch to the History Tab and select <span class="guimenu">Edit</span> → <span class="guimenuitem">Find</span>. When you type the text in the edit box, matching text is automatically selected in the history view. Use the navigation buttons or the <span class="guimenu">Edit</span> → <span class="guimenuitem">Find Next</span> and <span class="guimenu">Edit</span> → <span class="guimenuitem">Find Previous</span> options to find the next or previous occurrence of the searched text. The <span class="guilabel">Match case</span> check box allows to turn case sensitive searching on or off.</p>
</div>
</div>
<div class="navlinks">
<div class="navleft">« <a accesskey="p" href="folder_window.html">Folder Window</a></div>
<div class="navright"><a accesskey="n" href="comment_window.html">Comment Window</a> »</div>
</div>
<div id="copyright">
<p class="copyright">Copyright © 2007-2008 WebIssues Team</p>
</div>
</body>
</html>
|