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
|
<?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>Attribute Types</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, server" />
<link rel="start" href="index.html" title="The WebIssues Server Manual" />
<link rel="up" href="protocol.html" title="Appendix A. WebIssues Protocol Reference" />
<link rel="prev" href="protocol_arguments.html" title="Arguments" />
<link rel="next" href="protocol_errors.html" title="Error Codes" />
</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 Server</span> Manual</div>
<div id="header-abstract">Issue tracking and team collaboration system</div>
</div>
<div id="header-links"><a accesskey="h" href="index.html">Home</a> » <a accesskey="u" href="protocol.html"><span class="application">WebIssues</span> Protocol Reference</a></div>
</div>
<div class="navlinks">
<div class="navleft">« <a accesskey="p" href="protocol_arguments.html">Arguments</a></div>
<div class="navright"><a accesskey="n" href="protocol_errors.html">Error Codes</a> »</div>
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="protocol_types"></a>Attribute Types</h2>
</div>
</div>
</div>
<p>Attribute definition consists of a type keyword and zero or more metadata separated by single spaces. Each metadata consists of a name and value separated by the equals sign.</p>
<p>Metadata names start with lowercase letters and may contain lowercase letters and hyphens.</p>
<p>Metadata values can be one of the following:</p>
<div class="variablelist">
<dl>
<dt>
<span class="term">integer</span>
</dt>
<dd>
<p>optional minus sign followed by one or more decimal digits</p>
</dd>
<dt>
<span class="term">string</span>
</dt>
<dd>
<p>a sequence of characters enclosed in double qoutes, with double quote and backslash characters escaped as <code class="literal">\"</code> and <code class="literal">\\</code> respectively</p>
</dd>
<dt>
<span class="term">array of strings</span>
</dt>
<dd>
<p>zero or more strings separated by commas and enclosed in curly braces</p>
</dd>
</dl>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="metadata_common"></a>Common Metadata</h3>
</div>
</div>
</div>
<p>The following metadata are supported by all attribute types:</p>
<div class="variablelist">
<dl>
<dt>
<span class="term">default (string)</span>
</dt>
<dd>
<p>initial value of the attribute for new issues (default: '')</p>
</dd>
<dt>
<span class="term">required (int)</span>
</dt>
<dd>
<p>if 1, the value of the attribute cannot be empty and the initial value must be specified (default: 0)</p>
</dd>
</dl>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="metadata_text"></a>Text Attribute</h3>
</div>
</div>
</div>
<p>Keyword: TEXT</p>
<p>Value: any sequence of characters.</p>
<div class="variablelist">
<dl>
<dt>
<span class="term">max-length (int)</span>
</dt>
<dd>
<p>maximum number of characters (default: 80)</p>
</dd>
</dl>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="metadata_enum"></a>Enumeration Attribute</h3>
</div>
</div>
</div>
<p>Keyword: ENUM</p>
<p>Value: one of the predefined values.</p>
<div class="variablelist">
<dl>
<dt>
<span class="term">items (array of strings)</span>
</dt>
<dd>
<p>list of allowed values of the attribute (required)</p>
</dd>
<dt>
<span class="term">editable (int)</span>
</dt>
<dd>
<p>if 1, any other value is also accepted (default: 0)</p>
</dd>
</dl>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="metadata_numeric"></a>Numeric Attribute</h3>
</div>
</div>
</div>
<p>Keyword: NUMERIC</p>
<p>Value: a number with optional fixed-point fraction. Leading zeros are removed. Trailing zeros are added if necessary.</p>
<div class="variablelist">
<dl>
<dt>
<span class="term">min-value (string)</span>
</dt>
<dd>
<p>minimum allowed numeric value</p>
</dd>
<dt>
<span class="term">max-value (string)</span>
</dt>
<dd>
<p>maximum allowed numeric value</p>
</dd>
<dt>
<span class="term">decimal (int)</span>
</dt>
<dd>
<p>number of digits after the decimal point (default: 0)</p>
</dd>
</dl>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="metadata_datetime"></a>Date/Time Attribute</h3>
</div>
</div>
</div>
<p>Keyword: DATETIME</p>
<p>Value: date with optional time. Date format is <code class="literal">yyyy-mm-dd</code>, time format is <code class="literal">hh:mm</code>.</p>
<div class="variablelist">
<dl>
<dt>
<span class="term">time (int)</span>
</dt>
<dd>
<p>if 1, time is also required (default: 0)</p>
</dd>
</dl>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="metadata_text"></a>User Attribute</h3>
</div>
</div>
</div>
<p>Keyword: USER</p>
<p>Value: A user name.</p>
<div class="variablelist">
<dl>
<dt>
<span class="term">member (int)</span>
</dt>
<dd>
<p>if 1, only project members are accepted (default: 0)</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="navlinks">
<div class="navleft">« <a accesskey="p" href="protocol_arguments.html">Arguments</a></div>
<div class="navright"><a accesskey="n" href="protocol_errors.html">Error Codes</a> »</div>
</div>
<div id="copyright">
<p class="copyright">Copyright © 2007-2008 WebIssues Team</p>
</div>
</body>
</html>
|
