|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
|
2 <html> |
|
3 <head> |
|
4 <title>Carbide.ct Generation Guide</title> |
|
5 </head> |
|
6 |
|
7 <body> |
|
8 <h2> |
|
9 Generation Overview |
|
10 </h2> |
|
11 <p> |
|
12 With the generation functionality of Carbide.ct users can convert their Configuration Project structure, which |
|
13 contains ConfMLs, implMLs and resources into a format usable by target platform application. Target in this case |
|
14 can be some s60 emulator or a real phone hardware. This allows the user to verify his/her changes on the target platform. |
|
15 </p> |
|
16 <p> |
|
17 The task of generating target files in Carbide.ct is performed by a tool called ConE (Configuration Engine). |
|
18 ConE is a Python API for a Configuration Project. ConE tool is structured around the concept of plug-ins. Plug-ins are structured bundles of code and/or data that contribute function to the system. |
|
19 This makes ConE highly extendable and customizable. |
|
20 </p> |
|
21 <p> |
|
22 ConE tool can perform several operations on a Configuration Project. One of this is to take in a Configuration Project or to be precise a Configuration inside a Configuration Project and produce |
|
23 a resource structure that can be taken to the target device, for example to the mobile hardware. We call this generation. |
|
24 </p> |
|
25 <h2> |
|
26 Preconditions of Generation |
|
27 </h2> |
|
28 <p> |
|
29 The following points must be fulfilled in order to generate successfully |
|
30 <ol> |
|
31 <li>ConE tool must be installed on the user system</li> |
|
32 <li>Carbide.ct has to be configured to use ConE</li> |
|
33 </ol> |
|
34 </p> |
|
35 <h2> |
|
36 Generation steps |
|
37 </h2> |
|
38 <p> |
|
39 Follow these steps to generate successfully |
|
40 <ol> |
|
41 <li>Check that ConE tool is installed on your system. If not download it and install</li> |
|
42 <li>Configure Carbide.ct to use ConE. To do this select <b>Window > Preferences</b><br> |
|
43 <img src="images/prefs.png" ><br> |
|
44 <b>Figure 1</b> Carbide.ct preferences |
|
45 <br><br> |
|
46 In the preferences page select <b>Build Engine</b>. Under <b>ConE Build Properties</b> configure the output folder for the generated files, the layers to include in the output (-1=last layer) |
|
47 and optionally the implimentation filters (e.g. crml, gcfml, ...). <br><br> |
|
48 Under the <b>Installed ConE Tools</b> item specify ConE installations. <br> |
|
49 <img src="images/cones.png" ><br> |
|
50 <b>Figure 2</b> Installed ConEs |
|
51 <br><br> |
|
52 If there are several ConEs in the list. The first one in the list will be used for the generation task. |
|
53 </li> |
|
54 <li>Once preferences are configured the target files can be generated as in the following figure:<br> |
|
55 <img src="images/generate.png" ><br> |
|
56 <b>Figure 2</b> Installed ConEs |
|
57 <br><br> |
|
58 Make sure the that you have a <b>Configuration Project</b> open (<b>test</b> in this case). Select the <b>Configuration</b> that you want to generate (<b>root3.confml</b> in the example) and then press <b>Generate button</b> in the tool bar. |
|
59 </li> |
|
60 <li>Verify generation output. Below figure show example generation output.<br> |
|
61 <img src="images/generate_out.png" ><br> |
|
62 <b>Figure 2</b> Installed ConEs |
|
63 <br><br> |
|
64 You can follow the generation process from <b>Console</b> view. Once the generation is finished you can verify the output in the output folder that you specified in the <b>Preferences Page</b>. |
|
65 </li> |
|
66 </ol> |
|
67 </p> |
|
68 </body> |
|
69 </html> |