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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
|
<?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>Chapter 3. Using WebIssues Client</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="index.html" title="The WebIssues Client Manual" />
<link rel="prev" href="server_admin.html" title="Administering the server" />
<link rel="next" href="folder_window.html" title="Folder 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>
</div>
</div>
<div class="navlinks">
<div class="navleft">« <a accesskey="p" href="server_admin.html">Administering the server</a></div>
<div class="navright"><a accesskey="n" href="folder_window.html">Folder Window</a> »</div>
</div>
<div class="chapter" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title"><a id="using"></a>Chapter 3. Using <span class="application">WebIssues Client</span></h2>
</div>
</div>
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="main_window"></a>Main Window</h2>
</div>
</div>
</div>
<p>The Main Window of the <span class="application">WebIssues Client</span> allows to connect to a <span class="application">WebIssues</span> server. When the client is not connected, the window contains the <a class="link" href="using.html#start_page" title="Start Page">Start Page</a> which allows to reopen a recent connection or create a new connection. After opening a connection, the Main Window allows to work with projects and folders and to access other windows. When the client is connected to a server, the name of the server appears in the title bar of the Main Window. Select <span class="guimenu">WebIssues</span> → <span class="guimenuitem">Connection Information</span> to display more information about the current connection.</p>
<p>The <span class="application">WebIssues Client</span> uses separate windows to display information like folder contents or issue details. You can open multiple windows at the same time, switch between them and close them when you no longer need them. If a particular window already exists it is not opened again, but instead the existing window is activated. Some common commands like <span class="guimenu">Tools</span> → <span class="guimenuitem">WebIssues Settings</span> or <span class="guimenu">Help</span> → <span class="guimenuitem">WebIssues Manual</span> are available in every window.</p>
<div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Tip</h3>
<p>You can close each window when you no longer need it. Closing the Main Window causes the application to automatically close all other windows and quit. If the <a class="link" href="using.html#tray_icon" title="Tray Icon">Tray Icon</a> is used, closing the Main Window hides it leaving the application running and all other windows opened. Clicking on the tray icon opens the Main Window again.</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="projects_tree"></a>Projects Tree</h3>
</div>
</div>
</div>
<div class="screenshot">
<div class="mediaobject">
<img src="main_window.png" />
</div>
</div>
<p>The main part of the Main Window is a tree view of available projects and folders. In addition the type of issues in each folder is displayed. You can expand and collapse individual projects by clicking the icon with a plus or minus symbol. You can open a folder in a new <a class="link" href="folder_window.html" title="Folder Window">Folder Window</a> by double clicking the folder in the tree. Right clicking on a project or folder opens a context menu containing available options.</p>
<p>The tree is periodically updated to synchronize with changes made by other users. You can configure the interval of periodic updates in the <a class="link" href="using.html#webissues_settings" title="WebIssues Settings">WebIssues Settings</a>. The tree is automatically updated after each change you make. You can also manually force updating the tree using the <span class="guimenu">Projects</span> → <span class="guimenuitem">Update Projects</span> option. The status bar at the bottom of the window shows the status of the update.</p>
<p>Options for creating, renaming and deleting projects are only available for server administrators. The names of projects have to be unique. Projects which contain folders cannot be deleted.</p>
<p>Options for creating, renaming and deleting folders are only available for administrators of the project to which the folders belong and for server administrators. The names of folders have to be unique within each projects, but may be duplicated between different projects. When a folder is created, the type of issues it will contain has to be selected; it cannot be changed later. Folders which contain issues cannot be deleted.</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="dashboard_view"></a>Dashboard View</h3>
</div>
</div>
</div>
<div class="screenshot">
<div class="mediaobject">
<img src="main_dashboard.png" />
</div>
</div>
<p>The second tab of the Main Window contains the Dashboard View. It displays summary information for all active folder watches. Folder watches are used to track new issues and modifications to existing issues that match given filtering criteria. You can configure watches for each folder separately by selecting a folder and selecting the <span class="guimenu">Edit</span> → <span class="guimenuitem">Folder Watches</span> option. See the <a class="link" href="using.html#folder_watches" title="Folder Watches">Folder Watches</a> dialog for more information.</p>
<p>When a folder has at least one active watch, its content is periodically updated in the background so that changes can be detected and displayed in the Dashboard View. For each watch, the dashboard shows the total number of issues matching the watch filtering criteria, the number of new issues (i.e. issues which have never been opened since watching had been enabled) and the number of modified issues (i.e. issues which have been modified by other users since last opening). New issues are marked with yellow color and modified issues are marked with green color. This way you can easily see when someone adds or modifies issues that you're interested in - for example bugs which are active and assigned to you. Clicking on the name of the watch opens the <a class="link" href="folder_window.html" title="Folder Window">Folder Window</a> with appropriate filter selected.</p>
<p>Folders which have active watches are also marked with a small dot icon in the Projects Tree. Gray dot indicates that there are no new or modified issues in the folder. Green dot indicates that there are modified issues and yellow dot shows that there are new issues in the folder which match at least one of the watches.</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="main_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="webissues_menu"></a>WebIssues Menu</h4>
</div>
</div>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term">
<span class="guimenuitem">Open Connection</span>
</span>
</dt>
<dd>
<p>Show the <a class="link" href="using.html#login_dialog" title="Login Dialog">Login Dialog</a> which allows to connect to a server.</p>
</dd>
<dt>
<span class="term">
<span class="guimenuitem">Close Connection</span>
</span>
</dt>
<dd>
<p>Disconnect from the server, closing all opened windows except the main window.</p>
</dd>
<dt>
<span class="term">
<span class="guimenu">Client Configuration</span>
</span>
</dt>
<dd>
<div class="variablelist">
<dl>
<dt>
<span class="term">
<span class="guimenuitem">Import</span>
</span>
</dt>
<dd>
<p>Import all column settings, filters and watches from an existing configuration file.</p>
</dd>
<dt>
<span class="term">
<span class="guimenuitem">Export</span>
</span>
</dt>
<dd>
<p>Export all current column settings, filters and watches to a file.</p>
</dd>
</dl>
</div>
</dd>
<dt>
<span class="term">
<span class="guimenuitem">Connection Information</span>
</span>
</dt>
<dd>
<p>Show the URL, name and version of the server and the name, login and access level of the user.</p>
</dd>
<dt>
<span class="term"><span class="guimenuitem">Quit</span> (<span class="shortcut"><strong><span class="keycap"><strong>Ctrl</strong></span>+<span class="keycap"><strong>Q</strong></span></strong></span>)</span>
</dt>
<dd>
<p>Quit the <span class="application">WebIssues Client</span> application.</p>
</dd>
</dl>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="projects_menu"></a>Projects Menu</h4>
</div>
</div>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term">
<span class="guimenuitem">Add Project</span>
</span>
</dt>
<dd>
<p>Create a new project on the server.</p>
</dd>
<dt>
<span class="term"><span class="guimenuitem">Add Folder</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>Create a new folder in the selected project.</p>
</dd>
<dt>
<span class="term"><span class="guimenuitem">Open Folder</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 folder in a new <a class="link" href="folder_window.html" title="Folder Window">Folder Window</a>.</p>
</dd>
<dt>
<span class="term"><span class="guimenuitem">Update Projects</span> (<span class="shortcut"><strong><span class="keycap"><strong>F5</strong></span></strong></span>)</span>
</dt>
<dd>
<p>Update the projects and folders.</p>
</dd>
</dl>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="main_edit_menu"></a>Edit Menu</h4>
</div>
</div>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term"><span class="guimenuitem">Rename</span> (<span class="shortcut"><strong><span class="keycap"><strong>F2</strong></span></strong></span>)</span>
</dt>
<dd>
<p>Rename the selected project or folder.</p>
</dd>
<dt>
<span class="term"><span class="guimenuitem">Delete</span> (<span class="shortcut"><strong><span class="keycap"><strong>Del</strong></span></strong></span>)</span>
</dt>
<dd>
<p>Delete the selected project of folder.</p>
</dd>
<dt>
<span class="term">
<span class="guimenuitem">Project Members</span>
</span>
</dt>
<dd>
<p>Show the members of the selected project in a new <a class="link" href="members_window.html" title="Members Window">Members Window</a>.</p>
</dd>
<dt>
<span class="term">
<span class="guimenuitem">Folder Watches</span>
</span>
</dt>
<dd>
<p>Show the <a class="link" href="using.html#folder_watches" title="Folder Watches">Folder Watches</a> dialog allowing to select active watches for a selected folder.</p>
</dd>
<dt>
<span class="term"><span class="guimenuitem">Find Item</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="using.html#find_dialog" title="Find Dialog">Find Dialog</a> allowing to find an issue, comment or attachment by identifier.</p>
</dd>
</dl>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="tools_menu"></a>Tools Menu</h4>
</div>
</div>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term">
<span class="guimenuitem">User Accounts</span>
</span>
</dt>
<dd>
<p>Open the <a class="link" href="users_window.html" title="Users Window">Users Window</a>.</p>
</dd>
<dt>
<span class="term">
<span class="guimenuitem">Issue Types</span>
</span>
</dt>
<dd>
<p>Open the <a class="link" href="types_window.html" title="Types Window">Types Window</a>.</p>
</dd>
<dt>
<span class="term">
<span class="guimenuitem">Change Password</span>
</span>
</dt>
<dd>
<p>Change your password used to login to the <span class="application">WebIssues</span> server.</p>
</dd>
<dt>
<span class="term">
<span class="guimenuitem">Configure WebIssues</span>
</span>
</dt>
<dd>
<p>Modify the <a class="link" href="using.html#webissues_settings" title="WebIssues Settings">WebIssues Settings</a>.</p>
</dd>
</dl>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="help_menu"></a>Help Menu</h4>
</div>
</div>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term"><span class="guimenuitem">WebIssues Manual</span> (<span class="shortcut"><strong><span class="keycap"><strong>F1</strong></span></strong></span>)</span>
</dt>
<dd>
<p>Open this manual in a web browser.</p>
</dd>
<dt>
<span class="term">
<span class="guimenuitem">About WebIssues</span>
</span>
</dt>
<dd>
<p>Show information about the <span class="application">WebIssues Client</span> application.</p>
</dd>
<dt>
<span class="term">
<span class="guimenuitem">About Qt</span>
</span>
</dt>
<dd>
<p>Show information about the Qt toolkit.</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="start_page"></a>Start Page</h3>
</div>
</div>
</div>
<div class="screenshot">
<div class="mediaobject">
<img src="main_startpage.png" />
</div>
</div>
<p>The program automatically remembers up to 10 recent connections and displays a list containing server name and URL for each connection. You can quickly open a connection by double clicking it. The <a class="link" href="using.html#login_dialog" title="Login Dialog">Login Dialog</a> will appear prompting you for the password unless you select the <span class="guilabel">Remember password</span> option. You can change the URL, login and password of an existing connection or delete a connection by right clicking on it and selecting an option from the context menu.</p>
<p>You can create a new connection by selecting <span class="guimenu">WebIssues</span> → <span class="guimenuitem">New Connection</span> or clicking the <span class="guibutton">New Connection</span> in the bottom part of the window. The <a class="link" href="using.html#login_dialog" title="Login Dialog">Login Dialog</a> will appear prompting you for the URL, login and password.</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="login_dialog"></a>Login Dialog</h3>
</div>
</div>
</div>
<div class="screenshot">
<div class="mediaobject">
<img src="login_dialog.png" />
</div>
</div>
<p>To open the Login Dialog, select <span class="guimenu">WebIssues</span> → <span class="guimenuitem">New Connection</span> or right click on a recent connection and select <span class="guimenuitem">Modify</span>. Enter the URL address of the <span class="application">WebIssues</span> server, including the protocol, i.e. the <code class="literal">http://</code> prefix. Also enter the login and password identifying the user account on the server.</p>
<p>Each successful login is remembered in the list of recent connections. If you select the <span class="guilabel">Remember password</span> option, the password will also be remembered so you don't have to type it again at each login. Note that storing the password is not entirely secure, so use this option with caution.</p>
<p>After filling the required fields and pressing the <span class="guibutton">OK</span> button, the application will connect to the server and authenticate the user. This may take a few seconds. During that time the fields are disabled and an <span class="guibutton">Abort</span> button appears allowing to break the operation if the server takes too long to respond. When login is successful, the dialog is automatically closed and all necessary information is downloaded from the server.</p>
<p>If the connection fails for some reason, the dialog remains open and a status message appears at the bottom. The most common reasons of failure are:</p>
<div class="variablelist">
<dl>
<dt>
<span class="term">
<code class="literal">Connection failed</code>
</span>
</dt>
<dd>
<p>The host name is incorrect or the connection couldn't be established.</p>
</dd>
<dt>
<span class="term">
<code class="literal">Server error (404 Not Found)</code>
</span>
</dt>
<dd>
<p>The URL is incorrect and doesn't exist on the server.</p>
</dd>
<dt>
<span class="term">
<code class="literal">Not a WebIssues server</code>
</span>
</dt>
<dd>
<p>The URL is correct, but it doesn't point to a valid <span class="application">WebIssues</span> server.</p>
</dd>
<dt>
<span class="term">
<code class="literal">Command could not be executed (302 Incorrect Login)</code>
</span>
</dt>
<dd>
<p>The login or password is incorrect or the user account was disabled.</p>
</dd>
</dl>
</div>
<div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Tip</h3>
<p>There is one predefined user account called <code class="literal">admin</code> with initial password entered during the installation of the server. System administrators can create user accounts for other users.</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="folder_watches"></a>Folder Watches</h3>
</div>
</div>
</div>
<div class="screenshot">
<div class="mediaobject">
<img src="folder_watches.png" />
</div>
</div>
<p>The Folder Watches dialog allows to select active watches for selected folder. To open it, select the <span class="guimenu">Edit</span> → <span class="guimenuitem">Folder Watches</span> option. Each watch is associated with filtering criteria, so the list of available watches is the same as the list of <a class="link" href="folder_window.html#manage_filters" title="Managing Filters">predefined filters</a> for a particular type of issues. There is also an item named <code class="literal">(All Issues)</code> which allows to watch all issues in the selected folder. Select or deselect the checkboxes in the list to activate and deactivate watches.</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. The filter will be available for all folders containing the same type of issues as the selected folder.</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="find_dialog"></a>Find Dialog</h3>
</div>
</div>
</div>
<p>The Find Dialog allows to quickly open an issue by entering its identifier. It can also be used to locate a comment or attachment with the given identifier. The dialog can be opened by selecting <span class="guimenu">Edit</span> → <span class="guimenuitem">Find Item</span> from the Main Window's menu or the <a class="link" href="using.html#tray_icon" title="Tray Icon">Tray Icon</a>'s context menu.</p>
<p>If the item is found, the <a class="link" href="issue_window.html" title="Issue Window">Issue Window</a> is automatically opened and if the item is a comment or an attachment, its position in the issue history is automatically located. If the item doesn't exist or is not accessible to the user, an error message is displayed saying that no item with the given identifier was found.</p>
<div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Tip</h3>
<p>Identifiers in <span class="application">WebIssues</span> are always prefixed with the <code class="literal">#</code> (hash) character. They appear in the list of issues and attachments and in the history of the issue. They can also be placed in comments and attribute values for referring to other items (see <a class="link" href="comment_window.html#smart_links" title="Smart Links">Smart Links</a>).</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="webissues_settings"></a>WebIssues Settings</h3>
</div>
</div>
</div>
<p>The settings dialog can be opened by selecting <span class="guimenu">Tools</span> → <span class="guimenuitem">Configure WebIssues</span> from any window's menu. It can be used to change some global settings of the <span class="application">WebIssues Client</span>.</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="general_settings"></a>General Settings</h4>
</div>
</div>
</div>
<div class="screenshot">
<div class="mediaobject">
<img src="settings_general.png" />
</div>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term">
<span class="guilabel">Dock main window in system tray</span>
</span>
</dt>
<dd>
<p>Enable or disable the <a class="link" href="using.html#tray_icon" title="Tray Icon">Tray Icon</a>.</p>
</dd>
<dt>
<span class="term">
<span class="guilabel">Show main window at startup</span>
</span>
</dt>
<dd>
<p>Make the main window initially visible, hidden or restore the previous state when the program was closed. This option is only available if docking is enabled.</p>
</dd>
<dt>
<span class="term">
<span class="guilabel">Restore last connection at startup</span>
</span>
</dt>
<dd>
<p>When the <span class="application">WebIssues Client</span> is started, always connect to the previous server, remain disconnected or restore the connection only if it was active when the program was closed.</p>
<div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Tip</h3>
<p>If you enable this option, it may be useful to also enable the <span class="guilabel">Remember password</span> option in the <a class="link" href="using.html#login_dialog" title="Login Dialog">Login Dialog</a>. This way you won't have to enter your password everytime the <span class="application">WebIssues Client</span> is started.</p>
</div>
</dd>
<dt>
<span class="term">
<span class="guilabel">Start WebIssues when I start Windows</span>
</span>
</dt>
<dd>
<p>On Windows only: automatically start the <span class="application">WebIssues Client</span> after logging to Windows.</p>
<div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Tip</h3>
<p>This option is not available on Linux. Instead, if you leave the <span class="application">WebIssues Client</span> running when you end your session, it will be automatically restarted the next time you log in. This feature is especially useful in connection with the <a class="link" href="using.html#tray_icon" title="Tray Icon">Tray Icon</a> because it makes the application always available with a single mouse click.</p>
</div>
</dd>
</dl>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="connection_settings"></a>Connection Settings</h4>
</div>
</div>
</div>
<div class="screenshot">
<div class="mediaobject">
<img src="settings_connection.png" />
</div>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term">
<span class="guilabel">Proxy used for Internet connections</span>
</span>
</dt>
<dd>
<p>Type of proxy used for connecting to the server. Supported types are HTTP and SOCKS5 proxies.</p>
</dd>
<dt>
<span class="term"><span class="guilabel">Host name</span>, <span class="guilabel">Port number</span></span>
</dt>
<dd>
<p>Name of the proxy server and the port number. These fields are required when a proxy is selected.</p>
</dd>
<dt>
<span class="term"><span class="guilabel">User</span>, <span class="guilabel">Password</span></span>
</dt>
<dd>
<p>User name and password needed if the proxy requires authentication. Only simple authentication method is supported.</p>
</dd>
</dl>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="advanced_settings"></a>Advanced Settings</h4>
</div>
</div>
</div>
<div class="screenshot">
<div class="mediaobject">
<img src="settings_advanced.png" />
</div>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term">
<span class="guilabel">Interval of periodic updates</span>
</span>
</dt>
<dd>
<p>The interval in minutes between periodic updates of the projects, users and issue types which synchronize the client with changes made on the server by other users.</p>
</dd>
<dt>
<span class="term">
<span class="guilabel">Default action for attachments</span>
</span>
</dt>
<dd>
<p>By default when you double click an attachment, a message box is displayed asking if you want to save the attachment or open it directly in the default application. You can change this option to always perform the selected action automatically. If you do this, you can still use the context menu to select another action.</p>
</dd>
<dt>
<span class="term">
<span class="guilabel">Maximum size of attachments cache</span>
</span>
</dt>
<dd>
<p>Downloaded and opened attachments are cached on your hard disk for better performance. You can control the maximum amount of space this cache will take. Note that for each server that you connect to a separate cache is created.</p>
</dd>
<dt>
<span class="term">
<span class="guilabel">Warn when adding attachment larger than</span>
</span>
</dt>
<dd>
<p>A warning message is displayed when you try to upload an attachment larger than this value. Unless your server administrator has configured the server to accept larger attachments, it's recommended to leave the default value of 2 megabytes.</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="tray_icon"></a>Tray Icon</h3>
</div>
</div>
</div>
<div class="screenshot">
<div class="mediaobject">
<img src="tray_icon.png" />
</div>
</div>
<p>The tray icon is not available by default. You can enable it in the <a class="link" href="using.html#webissues_settings" title="WebIssues Settings">WebIssues Settings</a>. It is useful if you frequently use the <span class="application">WebIssues Client</span> and want to keep it running in the background so that it's always accessible with a single mouse click.</p>
<p>If you click on the tray icon with the left mouse button, you can show or hide the Main Window; it is either shown if it's hidden or minimized or hidden if it's visible. You can also hide the Main Window by simply closing it. The application will keep running until you select <span class="guimenu">WebIssues</span> → <span class="guimenuitem">Quit</span> from the menu.</p>
<p>If you click on the tray icon with the right mouse button, a context menu is displayed with some commonly used options like <span class="guimenuitem">Open Connection</span>, <span class="guimenuitem">Close Connection</span>, <span class="guimenuitem">Find Item</span> and <span class="guimenuitem">Quit</span>.</p>
<p>A small lightning appears in the bottom right corner of the icon when the <span class="application">WebIssues Client</span> is connected to a server. The tooltip of the icon displays the name of the server.</p>
<p>If the Main Window is hidden when you quit <span class="application">WebIssues Client</span> or log off from the system, the window will not appear automatically the next time you run the application but it will remain hidden.</p>
</div>
</div>
</div>
<div class="navlinks">
<div class="navleft">« <a accesskey="p" href="server_admin.html">Administering the server</a></div>
<div class="navright"><a accesskey="n" href="folder_window.html">Folder Window</a> »</div>
</div>
<div id="copyright">
<p class="copyright">Copyright © 2007-2008 WebIssues Team</p>
</div>
</body>
</html>
|
