File: folder_window.html

package info (click to toggle)
webissues 0.9.2-2
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 3,708 kB
  • ctags: 2,637
  • sloc: cpp: 19,365; xml: 400; sh: 180; makefile: 47
file content (238 lines) | stat: -rw-r--r-- 17,090 bytes parent folder | download
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
<?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>Folder 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="using.html" title="Chapter 3. Using WebIssues Client" />
    <link rel="next" href="issue_window.html" title="Issue 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> &raquo; <a accesskey="u" href="using.html">Using <span class="application">WebIssues Client</span></a></div>
    </div>
    <div class="navlinks">
      <div class="navleft">&laquo; <a accesskey="p" href="using.html">Using <span class="application">WebIssues Client</span></a></div>
      <div class="navright"><a accesskey="n" href="issue_window.html">Issue Window</a> &raquo;</div>
    </div>
    <div class="sect1" lang="en" xml:lang="en">
      <div class="titlepage">
        <div>
          <div>
            <h2 class="title" style="clear: both"><a id="folder_window"></a>Folder Window</h2>
          </div>
        </div>
      </div>
      <div class="screenshot">
        <div class="mediaobject">
          <img src="folder_window.png" />
        </div>
      </div>
      <p>The Folder Window shows a list of issues contained in a given folder. It can be opened by double clicking a folder in the <a class="link" href="using.html#main_window" title="Main Window">Main Window</a>. It allows to find issues, view their details and to create new issues.</p>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="issues_list"></a>Issues List</h3>
            </div>
          </div>
        </div>
        <p>The main part of the Folder Window is a list of issues. For each issue the identifier and name is displayed along with a configurable set of system and user defined attributes. The <a class="link" href="folder_window.html#column_settings" title="Column Settings">Columns Settings</a> dialog can be used to select the displayed columns. You can open the details of an issue in a new <a class="link" href="issue_window.html" title="Issue Window">Issue Window</a> by double clicking the issue in the list. Right clicking in the list opens a context menu containing available options.</p>
        <p>The list of issues is automatically updated when you open the Folder Window and when a change is detected after a periodic update. You can also force updating the list manually by selecting <span class="guimenu">Folder</span> → <span class="guimenuitem">Update Folder</span>. The contents of the list is cached so the entire list doesn't have to be downloaded every time, but only the changes made since the last update.</p>
        <p>You can change the <a class="link" href="folder_window.html#filter_settings" title="Filter Settings">Filter Settings</a> to display only issues matching specific criteria. You can also search issues by name using the <a class="link" href="folder_window.html#quick_search" title="Quick Search">Quick Search</a> option. By default, issues are sorted by identifier, i.e. in the same order in which they were created. You can sort the list by any column by clicking on the header of that column. When you hold the mouse pointer above an issue for a short time, a tooltip is displayed which contains the values of all attributes of that issues.</p>
        <p>If the folder has active watches, new and modified issues are marked with a small dot icon. Green dot indicates that the issue was modified since last opening. Yellow dot shows that the issue has never been opened since watching was enabled. When you open an issue, the dot will disappear indicating that the issue is neither new nor modified.</p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="folder_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="folder_menu"></a>Folder Menu</h4>
              </div>
            </div>
          </div>
          <div class="variablelist">
            <dl>
              <dt>
                <span class="term"><span class="guimenuitem">Add Issue</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>Add a new issue to the folder and open it in a new <a class="link" href="issue_window.html" title="Issue Window">Issue Window</a>.</p>
              </dd>
              <dt>
                <span class="term"><span class="guimenuitem">Open Issue</span> (<span class="shortcut"><strong><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>O</strong></span></strong></span>)</span>
              </dt>
              <dd>
                <p>Open the selected issue in a new <a class="link" href="issue_window.html" title="Issue Window">Issue Window</a>.</p>
              </dd>
              <dt>
                <span class="term"><span class="guimenuitem">Update Folder</span> (<span class="shortcut"><strong><span class="keycap"><strong>F5</strong></span></strong></span>)</span>
              </dt>
              <dd>
                <p>Update the list of issues in the folder.</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 Folder Window.</p>
              </dd>
            </dl>
          </div>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="folder_edit_menu"></a>Edit Menu</h4>
              </div>
            </div>
          </div>
          <div class="variablelist">
            <dl>
              <dt>
                <span class="term"><span class="guimenuitem">Change Filter</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>Change the current <a class="link" href="folder_window.html#filter_settings" title="Filter Settings">Filter Settings</a>.</p>
              </dd>
              <dt>
                <span class="term">
                  <span class="guimenuitem">Save Filter As</span>
                </span>
              </dt>
              <dd>
                <p>Save the current filter to the list of predefined filters for all folders of the same type as the current one.</p>
              </dd>
              <dt>
                <span class="term">
                  <span class="guimenuitem">Manage Filters</span>
                </span>
              </dt>
              <dd>
                <p>Open the <a class="link" href="folder_window.html#manage_filters" title="Managing Filters">Manage Filters</a> dialog allowing to create, rename, delete and modify existing filters.</p>
              </dd>
            </dl>
          </div>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="folder_tools_menu"></a>Tools Menu</h4>
              </div>
            </div>
          </div>
          <div class="variablelist">
            <dl>
              <dt>
                <span class="term">
                  <span class="guimenuitem">Configure Columns</span>
                </span>
              </dt>
              <dd>
                <p>Change the <a class="link" href="folder_window.html#column_settings" title="Column Settings">Column Settings</a> for all folders 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="column_settings"></a>Column Settings</h3>
            </div>
          </div>
        </div>
        <div class="screenshot">
          <div class="mediaobject">
            <img src="columns_dialog.png" />
          </div>
        </div>
        <p>The Filter Settings dialog allows to select columns displayed in the list of issues from all available system and user defined attributes. Each type of issue has its own column settings. The dialog can be opened by selecting the <span class="guimenu">Tools</span> → <span class="guimenuitem">Configure Columns</span> option from the menu or by right clicking on a list header and selecting <span class="guimenuitem">Configure Columns</span>.</p>
        <p>The list on the left contains the list of available column and the list on the right contains the list of currently selected columns. You can add the selected column using the button with arrow pointing to the right. New columns are added below the currently selected column in the list on the right. You can remove the selected column using the button with arrow pointing to the left. You can also double click a column to quickly add it or remove it from the list.</p>
        <p>To move the selected column to a different position, use the buttons with arrows pointing up and down. You cannot remove the <code class="literal">ID</code> and <code class="literal">Name</code> columns, but you can change their position.</p>
        <p>The <span class="guibutton">Restore Defaults</span> button restores the default list of columns, which consist of the <code class="literal">ID</code>, <code class="literal">Name</code>, <code class="literal">Modified Date</code> and <code class="literal">Modified By</code> columns.</p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="filter_settings"></a>Filter Settings</h3>
            </div>
          </div>
        </div>
        <div class="screenshot">
          <div class="mediaobject">
            <img src="filter_dialog.png" />
          </div>
        </div>
        <p>To change the Filter Settings of the list of issues, select <span class="guimenu">Edit</span> → <span class="guimenuitem">Change Filter</span>. When a filter is configured, only issues matching the filter criteria are displayed in the list. You can use the filter for example to display only issues with a given status, with highest priority or assigned to you. The number of displayed issues and the total number of issues in the folder is displayed in the bottom right corner of the Folder Window.</p>
        <p>The filter may consist of a number of conditions which are joined using the logical <code class="literal">AND</code> operator. It means that an issue must match all criteria in order to be displayed in the list. You can increase and decrease the number of conditions using the <span class="guibutton">Add</span> and <span class="guibutton">Remove</span> buttons. You can remove all conditions using the <span class="guibutton">Clear</span> button.</p>
        <p>Each condition consists of a system or used defined attribute, an operator and an optional operand. The attribute and operator can be selected using dropdown lists. The available operators depend on the type of the attribute. The value of the operand can be entered using various widgets depending on the type of the attribute and the selected operator.</p>
        <p>Frequently used filters can be saved for quick access. Each type of issue has its own list of saved filters. A saved filter can be selected using the dropdown list in the left part of the filter bar. By default each issue type has two predefined filters: <code class="literal">Created by Me</code> and <code class="literal">Modified in Last 24 Hours</code>. To create a new saved filter, define the criteria using the Filter Settings dialog and select <span class="guimenu">Edit</span> → <span class="guimenuitem">Save Filter As</span>. You will be prompted to enter the name of the filter. You can also overwrite an existing filter.</p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="manage_filters"></a>Managing Filters</h3>
            </div>
          </div>
        </div>
        <div class="screenshot">
          <div class="mediaobject">
            <img src="filter_manage.png" />
          </div>
        </div>
        <p>To manage the predefined filters for all folders containing issues of the same type, select <span class="guimenu">Edit</span> → <span class="guimenuitem">Manage Filters</span>. The window shows a list of all currently defined filters and allows to create new filters and to rename, modify and delete existing filters.</p>
        <p>To create a new filter, click <span class="guibutton">New Filter</span> and use the <a class="link" href="folder_window.html#filter_settings" title="Filter Settings">Filter Settings</a> to define the conditions for the filter. Click <span class="guibutton">OK</span>, enter the name of the filter and click <span class="guibutton">OK</span> again. You will be warned if you are overwritting an existing filter.</p>
        <p>To modify the conditions of an existing filter, double click on it or right click and select <span class="guimenuitem">Modify</span> from the context menu. To rename a filter, select <span class="guimenuitem">Rename</span> from the context menu and enter the new name. You will be warned if the operation overwrites an existing filter. To delete a filter, select the <span class="guimenuitem">Remove</span> option.</p>
        <div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;">
          <h3 class="title">Tip</h3>
          <p>Predefined filters are stored on the client machine, not on the <span class="application">WebIssues</span> server. If you want to share filters, folder watches and column settings between a group of users, use the <span class="guimenu">WebIssues</span> → <span class="guimenuitem">Client Configuration</span> → <span class="guimenuitem">Export</span> option from the Main Window to export all local settings to a file. Then use the <span class="guimenu">WebIssues</span> → <span class="guimenuitem">Client Configuration</span> → <span class="guimenuitem">Import</span> option to import the settings file on a different computer or for a different user.</p>
        </div>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="quick_search"></a>Quick Search</h3>
            </div>
          </div>
        </div>
        <div class="screenshot">
          <div class="mediaobject">
            <img src="folder_filtered.png" />
          </div>
        </div>
        <p>The edit box in the right part of the filter bar allows to find a word or phrase in the name of the issues. When some text is typed in that box, the list is automatically filtered to display only matching issues. The button to the left of the edit box allows to clear the filter and display all issues.</p>
      </div>
    </div>
    <div class="navlinks">
      <div class="navleft">&laquo; <a accesskey="p" href="using.html">Using <span class="application">WebIssues Client</span></a></div>
      <div class="navright"><a accesskey="n" href="issue_window.html">Issue Window</a> &raquo;</div>
    </div>
    <div id="copyright">
      <p class="copyright">Copyright © 2007-2008 WebIssues Team</p>
    </div>
  </body>
</html>