|
0
|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
|
2 |
<html>
|
|
|
3 |
<head>
|
|
|
4 |
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
|
|
|
5 |
<title>Editing a metadata file</title>
|
|
|
6 |
<link href="../../book.css" type="text/css" rel="stylesheet">
|
|
|
7 |
</head>
|
|
|
8 |
<body>
|
|
|
9 |
|
|
|
10 |
<h2>Editing a metadata file</h2>
|
|
|
11 |
<p>You can edit the properties of a metadata file by modifying the name, description and subsystem information of an Application Programming Interface (API), as well as filling in information related to releases, libraries, Software Development Kits (SDKs) and attributes.</p>
|
|
|
12 |
<p>To edit a file:</p>
|
|
|
13 |
<ol>
|
|
|
14 |
<li>To open a metadata file (<i>.metaxml</i>) for editing, do any of the following:
|
|
|
15 |
<ul>
|
|
|
16 |
<li>double-click the file in the project view,</li>
|
|
|
17 |
<li>right-click your project and select <b>Open/Open with > Metadata Editor</b> from the context menu,</li>
|
|
|
18 |
<li>go to <b>File > Open File</b> and browse for the file from your workstation.</li>
|
|
|
19 |
</ul>
|
|
|
20 |
<p>The file is opened for editing, as shown in the following example:</p>
|
|
|
21 |
<img src="images/ME_overview.png">
|
|
|
22 |
<p><b>Important:</b> Some of the displayed fields are different depending on whether your file complies with version 1.0 or version 2.0 of API metadata.</p>
|
|
|
23 |
<p>For instructions on converting files from 1.0 to 2.0, see <a href="converting_metadata.htm">Converting metadata files</a>.</p></li>
|
|
|
24 |
<li>For more information on how to modify the fields, see the following tables:
|
|
|
25 |
<ul>
|
|
|
26 |
<li><a href="edit_metadata.htm#general">General API fields</a></li>
|
|
|
27 |
<li><a href="edit_metadata.htm#edit_release">Release information</a></li>
|
|
|
28 |
<li><a href="edit_metadata.htm#add_libraries">Libraries</a></li>
|
|
|
29 |
<li><a href="edit_metadata.htm#edit_attribs">Attributes</a></li>
|
|
|
30 |
<li><a href="edit_metadata.htm#edit_sdk">Extended SDK (only in v.1.0)</a></li>
|
|
|
31 |
</ul></li>
|
|
|
32 |
<li>To save, click <b>File > Save</b>.</li>
|
|
|
33 |
</ol>
|
|
|
34 |
|
|
|
35 |
<h3><a name="general"></a>General API fields</h3>
|
|
|
36 |
<p><b>Name</b>, <b>Description</b> and <b>Subsystem</b> fields can be freely edited.</p>
|
|
|
37 |
<p>The <b>ID</b> and <b>Data version</b> fields cannot be modified because they are created automatically. The <b>ID</b> is a unique identifier for the API, which does not change even if its name did.</p>
|
|
|
38 |
<p>The <b>Type</b> field is automatically set to <i>c++</i>.</p>
|
|
|
39 |
<table border="1" cellspacing="1" cellpadding="2">
|
|
|
40 |
<colgroup><col><col></colgroup>
|
|
|
41 |
<tbody>
|
|
|
42 |
<tr>
|
|
|
43 |
<td width="121"><b>Name</b></td>
|
|
|
44 |
<td width="849"><p>If you change the name of the API, the name of the metadata file will be changed as well and the newly renamed file is opened in the view.</p><p>Note that the renamed file is not opened automatically if the file was opened outside the Carbide.c++ IDE workspace by selecting <b>File > Open File...</b>. In this case, the file is closed and a message is displayed prompting
|
|
|
45 |
you to reopen the file manually for further editing.</p>
|
|
|
46 |
</td>
|
|
|
47 |
</tr>
|
|
|
48 |
<tr>
|
|
|
49 |
<td><b>Description</b></td>
|
|
|
50 |
<td><p>A free-form, short description of what the API is for. It will be visible, for example, in the <b>API Query</b> tool in Carbide.c++ IDE, and also in common SDK documentation if the API belongs to a Software Development Kit (SDK).</p>
|
|
|
51 |
</td>
|
|
|
52 |
</tr>
|
|
|
53 |
<tr>
|
|
|
54 |
<td><i>v. 1.0:</i><br>
|
|
|
55 |
<b>Subsystem</b><br>
|
|
|
56 |
<br>
|
|
|
57 |
<i>v. 2.0:</i><br>
|
|
|
58 |
<b>Collection</b>
|
|
|
59 |
</td>
|
|
|
60 |
<td><p>The collection name that owns the API. It has to be the collection directory name in the source hierarchy and found under the package that exports the API.</p>
|
|
|
61 |
</td>
|
|
|
62 |
</tr>
|
|
|
63 |
</tbody>
|
|
|
64 |
</table>
|
|
|
65 |
|
|
|
66 |
<h3><a name="edit_release"></a>Release information</h3>
|
|
|
67 |
<table border="1" cellspacing="1" cellpadding="2">
|
|
|
68 |
<colgroup><col><col></colgroup>
|
|
|
69 |
<tbody>
|
|
|
70 |
<tr>
|
|
|
71 |
<td><b>Since version</b></td>
|
|
|
72 |
<td><p>Indicates the release in which the API was first visible in the specified category.</p><p>The field is mandatory if the release is <i>SDK</i> or <i> Public</i>, and optional if it is <i>Domain</i> or <i>Platform</i>.</p>
|
|
|
73 |
</td>
|
|
|
74 |
</tr>
|
|
|
75 |
<tr>
|
|
|
76 |
<td><b>Category</b></td>
|
|
|
77 |
<td><p>Indicates the category of the API.</p>
|
|
|
78 |
<ul>
|
|
|
79 |
<li><i>v. 1.0: </i><b> SDK</b> <br>
|
|
|
80 |
<i>v. 2.0: </i> <b> Public</b><br>
|
|
|
81 |
<br>
|
|
|
82 |
Published in SDK for ISVs (Independent Software Vendors).</li>
|
|
|
83 |
<li><i>v. 1.0: </i><b> Domain</b> <br>
|
|
|
84 |
<i>v. 2.0: </i> <b> Platform</b> <br>
|
|
|
85 |
<br>
|
|
|
86 |
Published to other architecture domains (ADO) and can be used from the other ADOs.</li>
|
|
|
87 |
</ul>
|
|
|
88 |
</td>
|
|
|
89 |
</tr>
|
|
|
90 |
<tr>
|
|
|
91 |
<td><b>Deprecated</b></td>
|
|
|
92 |
<td><p>If this box is selected, the API is deprecated, meaning it is not in use anymore. Select the S60 platform version from the <b>Deprecated since </b> menu. </p><p>The <b>Deprecated since</b> value has to be bigger than the value in the <b>Since version</b> menu.</p>
|
|
|
93 |
</td>
|
|
|
94 |
</tr>
|
|
|
95 |
</tbody>
|
|
|
96 |
</table>
|
|
|
97 |
|
|
|
98 |
<h3><a name="add_libraries"></a>Libraries</h3>
|
|
|
99 |
<p>This field lists all the libraries needed to use this API.</p>
|
|
|
100 |
<p><b>Note:</b> In Version 2.0 of the API metadata, this is mandatory to define.</p>
|
|
|
101 |
<p>To add new import libraries (.lib files) to the API metadata file:</p>
|
|
|
102 |
<ol>
|
|
|
103 |
<li>Click <b>Add</b> next to the library list.</li>
|
|
|
104 |
<li>In the dialog that opens, enter the name of the library.</li>
|
|
|
105 |
<li>Click <b>OK</b>.</li>
|
|
|
106 |
</ol>
|
|
|
107 |
|
|
|
108 |
<h3><a name="edit_attribs"></a>Attributes</h3>
|
|
|
109 |
<table border="1" cellspacing="1" cellpadding="2">
|
|
|
110 |
<colgroup><col><col></colgroup>
|
|
|
111 |
<tbody>
|
|
|
112 |
<tr>
|
|
|
113 |
<td><b>HTML Doc provided</b></td>
|
|
|
114 |
<td><p>By default, all SDK APIS should provide documentation in XML format.
|
|
|
115 |
However, in case HTML documentation for an API already exists, the value of
|
|
|
116 |
this field should be <b>Yes</b>.</p></td>
|
|
|
117 |
</tr>
|
|
|
118 |
<tr>
|
|
|
119 |
<td><b>Adaptation</b></td>
|
|
|
120 |
<td><p>This attribute is mandatory and indicates if the API is an adaptation
|
|
|
121 |
API or not. </p><p>Adaptation APIs are interfaces that an S60 licensee needs
|
|
|
122 |
to implement in order to get its platform working.</p></td>
|
|
|
123 |
</tr>
|
|
|
124 |
</tbody>
|
|
|
125 |
</table>
|
|
|
126 |
<h3><a name="edit_sdk"></a>Extended SDK (only in v. 1.0)</h3>
|
|
|
127 |
<p>
|
|
|
128 |
S60 extension SDKs are made to simplify the delivery of non-SDK APIs to 3rd
|
|
|
129 |
party developers. The plug-ins contain APIs that are not in the public SDK
|
|
|
130 |
but are seen important for 3rd parties' business cases. </p><table border="1"
|
|
|
131 |
cellspacing="1" cellpadding="2">
|
|
|
132 |
<colgroup>
|
|
|
133 |
<col>
|
|
|
134 |
<col></colgroup>
|
|
|
135 |
<tbody>
|
|
|
136 |
<tr>
|
|
|
137 |
<td><b>Extended SDK</b></td>
|
|
|
138 |
<td><p>The selection is optional and needs to be specified only if the API
|
|
|
139 |
is a part of an extended SDK.</p>
|
|
|
140 |
</td>
|
|
|
141 |
</tr>
|
|
|
142 |
<tr>
|
|
|
143 |
<td><b>Since version</b></td>
|
|
|
144 |
<td><p>Defines the version since when the API was a part of an extended SDK.</p><p>If the <b>Is Extended SDK</b> box is selected, you must also select the <b>Since version</b> value from the drop-down menu.</p>
|
|
|
145 |
</td>
|
|
|
146 |
</tr>
|
|
|
147 |
<tr>
|
|
|
148 |
<td><b>Deprecated since</b></td>
|
|
|
149 |
<td><p>Defines the version since when the API was deprecated.</p><p>This value has to be bigger than the <b>Since version</b> value.</p>
|
|
|
150 |
</td>
|
|
|
151 |
</tr>
|
|
|
152 |
</tbody>
|
|
|
153 |
</table>
|
|
|
154 |
|
|
|
155 |
<h5>Related tasks</h5>
|
|
|
156 |
<ul>
|
|
|
157 |
<li><a href="create_metadata.htm">Creating a new metadata file</a></li>
|
|
|
158 |
<li><a href="converting_metadata.htm">Converting metadata files</a></li>
|
|
|
159 |
</ul>
|
|
|
160 |
|
|
|
161 |
<div id="footer">Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
|
|
|
162 |
<br>
|
|
|
163 |
License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>.</div>
|
|
|
164 |
</body>
|
|
|
165 |
</html> |