File: types_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 (267 lines) | stat: -rw-r--r-- 12,812 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
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
<?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>Types 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="members_window.html" title="Members Window" />
    <link rel="next" href="credits.html" title="Chapter 4. Credits and License" />
  </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="members_window.html">Members Window</a></div>
      <div class="navright"><a accesskey="n" href="credits.html">Credits and License</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="types_window"></a>Types Window</h2>
          </div>
        </div>
      </div>
      <div class="screenshot">
        <div class="mediaobject">
          <img src="types_window.png" />
        </div>
      </div>
      <p>The Types Window shows all issue types defined on the server and their attributes. It allows server administrators to create new types and to modify existing ones by adding, removing and modifying attributes. To open the Types Window, go to the <a class="link" href="using.html#main_window" title="Main Window">Main Window</a> and select <span class="guimenu">Tools</span> → <span class="guimenuitem">Issue Types</span>.</p>
      <p>When the <span class="application">WebIssues</span> server is installed, it contains three predefined issue types: <code class="literal">Bugs</code>, <code class="literal">Features</code> and <code class="literal">Tasks</code> with some example attributes. System administrators can customize these types and create new types based on their needs and the purpose of the system. Issue types can be modified during the entire lifetime of the system, even if there are existing issues of these types.</p>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="types_tree"></a>Types Tree</h3>
            </div>
          </div>
        </div>
        <p>The main part of the Types Window is a tree view of issue types and their attributes. For each attribute its type, default value and details are displayed. You can expand and collapse individual types by clicking the icon with a plus or minus symbol. You can open the <a class="link" href="types_window.html#attribute_dialog" title="Attribute Dialog">Attribute Dialog</a> by double clicking an attribute in the tree. Right clicking on a type or attribute opens a context menu containing available options.</p>
        <p>The tree is periodically updated to synchronize with changes made by other users and after each change you make. You can also manually force updating the tree using the <span class="guimenu">Types</span> → <span class="guimenuitem">Update Types</span> option.</p>
        <p>Options for creating, renaming and deleting types and attributes are only available for server administrators. The names of types have to be unique. The names of attributes of a single type also have to be unique, but different issue types may contains attributes with the same name. Issue types which have been assigned to folders cannot be deleted.</p>
        <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
          <h3 class="title">Warning</h3>
          <p>Deleting an attribute will irreversibly delete all its values and all historical changes of this attribute for existing issues of the particular type.</p>
        </div>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="types_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="types_menu"></a>Types Menu</h4>
              </div>
            </div>
          </div>
          <div class="variablelist">
            <dl>
              <dt>
                <span class="term">
                  <span class="guimenuitem">Add Type</span>
                </span>
              </dt>
              <dd>
                <p>Create a new issue type.</p>
              </dd>
              <dt>
                <span class="term"><span class="guimenuitem">Add Attribute</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 attribute to the current issue type.</p>
              </dd>
              <dt>
                <span class="term">
                  <span class="guimenuitem">Update Types</span>
                </span>
              </dt>
              <dd>
                <p>Update the types and attributes.</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 Types Window.</p>
              </dd>
            </dl>
          </div>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="types_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 type or attribute.</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 type or attribute.</p>
              </dd>
              <dt>
                <span class="term">
                  <span class="guimenuitem">Modify Attribute</span>
                </span>
              </dt>
              <dd>
                <p>Modify the definition of the selected attributes.</p>
              </dd>
            </dl>
          </div>
        </div>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="attribute_dialog"></a>Attribute Dialog</h3>
            </div>
          </div>
        </div>
        <div class="screenshot">
          <div class="mediaobject">
            <img src="attribute_dialog.png" />
          </div>
        </div>
        <p>The Attribute Dialog is used to specify the definition of a new attribute or to modify the definition of an existing attribute. You can open this dialog by double clicking an attribute or by selecting <span class="guimenu">Types</span> → <span class="guimenuitem">Add Attribute</span>.</p>
        <p>The Attribute Dialog contains the following options:</p>
        <div class="variablelist">
          <dl>
            <dt>
              <span class="term">
                <span class="guilabel">Name</span>
              </span>
            </dt>
            <dd>
              <p>Only when creating a new attribute: the name of the attribute.</p>
            </dd>
            <dt>
              <span class="term">
                <span class="guilabel">Type</span>
              </span>
            </dt>
            <dd>
              <p>The type of the attribute (see <a class="link" href="types_window.html#attribute_types" title="Attribute Types">Attribute Types</a>).</p>
            </dd>
            <dt>
              <span class="term">
                <span class="guilabel">Details</span>
              </span>
            </dt>
            <dd>
              <p>Additional parameters depending on the selected type.</p>
            </dd>
            <dt>
              <span class="term">
                <span class="guilabel">Attribute is required</span>
              </span>
            </dt>
            <dd>
              <p>If selected, the attribute cannot have an empty value.</p>
            </dd>
            <dt>
              <span class="term">
                <span class="guilabel">Default value</span>
              </span>
            </dt>
            <dd>
              <p>The initial value of this attribute for new issues. It must be entered if the attribute is required.</p>
            </dd>
          </dl>
        </div>
        <p>Changing the definition of an existing attribute doesn't affect its current values. Only when a value of the attribute is changed the new definition is taken into account.</p>
        <p>If a new attribute is added to an issue type, existing issues of this type don't have any value for this attribute assigned even if a default value is specified in the definition.</p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="attribute_types"></a>Attribute Types</h3>
            </div>
          </div>
        </div>
        <p>The following types of attributes are available:</p>
        <div class="variablelist">
          <dl>
            <dt>
              <span class="term">
                <span class="guilabel">Text</span>
              </span>
            </dt>
            <dd>
              <p>Any text with an optional length limit can be entered.</p>
            </dd>
            <dt>
              <span class="term">
                <span class="guilabel">Dropdown List</span>
              </span>
            </dt>
            <dd>
              <p>One of the items from the list can be selected. In editable mode, any text can be entered or one of predefined items can be selected.</p>
            </dd>
            <dt>
              <span class="term">
                <span class="guilabel">Numeric</span>
              </span>
            </dt>
            <dd>
              <p>An integer or fixed-point decimal fraction can be entered. Optionally a minimum and maximum value can be defined.</p>
            </dd>
            <dt>
              <span class="term">
                <span class="guilabel">Date &amp; Time</span>
              </span>
            </dt>
            <dd>
              <p>A date with optional time can be specified.</p>
            </dd>
            <dt>
              <span class="term">
                <span class="guilabel">User</span>
              </span>
            </dt>
            <dd>
              <p>A user can be selected from a list of all users or from members of the project the issue belongs to.</p>
            </dd>
          </dl>
        </div>
      </div>
    </div>
    <div class="navlinks">
      <div class="navleft">&laquo; <a accesskey="p" href="members_window.html">Members Window</a></div>
      <div class="navright"><a accesskey="n" href="credits.html">Credits and License</a> &raquo;</div>
    </div>
    <div id="copyright">
      <p class="copyright">Copyright © 2007-2008 WebIssues Team</p>
    </div>
  </body>
</html>