2
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4
Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
7
The contents of this file are subject to the terms of either the GNU
8
General Public License Version 2 only ("GPL") or the Common
9
Development and Distribution License("CDDL") (collectively, the
10
"License"). You may not use this file except in compliance with the
11
License. You can obtain a copy of the License at
12
http://www.netbeans.org/cddl-gplv2.html
13
or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
14
specific language governing permissions and limitations under the
15
License. When distributing the software, include this License Header
16
Notice in each file and include the License file at
17
nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
18
particular file as subject to the "Classpath" exception as provided
19
by Sun in the GPL Version 2 section of the License file that
20
accompanied this code. If applicable, add the following below the
21
License Header, with the fields enclosed by brackets [] replaced by
22
your own identifying information:
23
"Portions Copyrighted [year] [name of copyright owner]"
27
The Original Software is NetBeans. The Initial Developer of the Original
28
Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
29
Microsystems, Inc. All Rights Reserved.
31
If you wish your version of this file to be governed by only the CDDL
32
or only the GPL Version 2, indicate your decision by adding
33
"[Contributor] elects to include this software in this distribution
34
under the [CDDL or GPL Version 2] license." If you do not indicate a
35
single choice of license, a recipient has the option to distribute
36
your version of this file under either the CDDL, the GPL Version 2 or
37
to extend the choice of license to its licensees as provided above.
38
However, if you add GPL Version 2 code and therefore, elected the GPL
39
Version 2 license, then the option applies only if the new code is
40
made subject to such option by the copyright holder.
44
Public ID: "-//NetBeans//DTD API changes list 1.0//EN"
45
Describes format of NetBeans API changes list.
48
<!-- List of styles: -->
49
<!ENTITY % changeliststyles "
61
<!ENTITY % xhtml PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "../external/xhtml1-dtds/xhtml1-strict.dtd">
62
<!-- Override special to include date tags: -->
63
<!ENTITY % special "br | span | bdo | object | img | map | date">
64
<!-- Override lists to include change lists formatted in various ways: -->
65
<!ENTITY % lists "ul | ol | dl | changelist">
66
<!-- Override blocks to include standard-changelists: -->
67
<!ENTITY % blocktext "pre | hr | blockquote | address | standard-changelists">
68
<!-- Now include normal XHTML DTD: -->
74
<!ELEMENT apichanges (apidefs, changes, htmlcontents)>
77
HTML contents of the document, with substitutions.
79
<!ELEMENT htmlcontents (head, body)>
82
List of API changes, in no particular order.
84
<!ELEMENT changes (change)*>
87
One API change. Giving an ID is recommended as it permits external hyperlinking
88
to the generated document (the ID will be used as an HTML anchor) - but if you
89
have one (and only one) associated issue, that will be used as a default stable
90
ID (format "issue-NNNNN"), or the version number will also be used as a default
91
stable ID (format "version-N.NN"). Giving the date is technically optional but
92
should be done for all new changes.
94
<!ELEMENT change (api?, summary, version?, date?, author*, compatibility, description, class*, package*, issue*, branch*)>
100
Information about a Java class that is affected (unqualified name and package).
101
No inner classes please, outer only.
103
<!ELEMENT class EMPTY>
105
package CDATA #REQUIRED
111
An affected Java package name.
113
<!ELEMENT package EMPTY>
120
Date on which the change was made (in the trunk).
122
<!ELEMENT date EMPTY>
124
day (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) #REQUIRED
125
month (1|2|3|4|5|6|7|8|9|10|11|12) #REQUIRED
126
year (1998|1999|2000|2001|2002|2003|2004|2005|2006|2007|2008|2009) #REQUIRED
130
Brief (one sentence) summary of the change.
132
<!ELEMENT summary %Inline;>
135
The API specification version matching this change, if any.
137
<!ELEMENT version EMPTY>
139
major CDATA #REQUIRED
140
minor CDATA #REQUIRED
141
subminor CDATA #IMPLIED
142
subsubminor CDATA #IMPLIED
146
A full textual description of the change, as freeform
147
HTML. May include multiple paragraphs etc.
149
<!ELEMENT description %Flow;>
152
The API group which this change falls under, for categorization.
153
See <apidefs> for the list of choices.
157
name NMTOKEN #REQUIRED
161
What branch the change was made on. By default changes are assumed
162
to have occurred only on the trunk. If you make a change on a branch,
163
you must say so and say when this was done.
165
<!ELEMENT branch (date?, version?)>
167
name (boston|release31|release32|pilsen|release33|release34|sierra) #REQUIRED
171
Mandatory information about compatibility and type of change.
172
At least one of deprecation, addition, deletion, or modification
173
must be set to "yes" (maybe more than one). You may specify
174
whether source and/or binary and/or semantic compatibility has
175
been retained; incompatible changes are listed prominently.
176
There may be some HTML content inside the element describing
177
details of compatibility or possibility of workarounds.
179
<!ELEMENT compatibility %Flow;>
180
<!ATTLIST compatibility
181
binary (compatible|incompatible) "compatible"
182
source (compatible|incompatible) "compatible"
183
semantic (compatible|incompatible) "compatible"
184
deprecation (yes|no) "no"
185
addition (yes|no) "no"
186
deletion (yes|no) "no"
187
modification (yes|no) "no"
191
Optional note about the person(s) committing the change.
192
Note that authors of changes are specified by (CVS)
193
login ID, not full name.
195
<!ELEMENT author EMPTY>
197
login CDATA #REQUIRED
201
Optional issue(s) in IssueZilla justifying the change.
203
<!ELEMENT issue EMPTY>
205
number CDATA #REQUIRED
209
A list of changes, formatted in a predefined way.
211
<!ELEMENT changelist EMPTY>
213
style (%changeliststyles;) #REQUIRED
217
The usually needed change lists.
219
<!ELEMENT standard-changelists EMPTY>
220
<!ATTLIST standard-changelists
221
module-code-name CDATA #REQUIRED
225
Definitions of APIs available.
226
Supply a code name for each and a display name as the element content.
228
<!ELEMENT apidefs (apidef*)>
229
<!ELEMENT apidef %Inline;>
231
name NMTOKEN #REQUIRED