|
1 User guide for Convert Project Plugin |
|
2 ------------------------------------- |
|
3 |
|
4 Introduction |
|
5 ''''''''''''' |
|
6 This page describes how to use and configure Convert Project plugin. This plugin is |
|
7 used to convert old style configuration structure to Configuration project. The plugin |
|
8 can be used to create files and folders. For a folder you can define using absolute paths |
|
9 or wildcards which files from previous structure are copied to the new structure. For files |
|
10 it is possible just to copy a file from one location to another, create layer and configuration |
|
11 root files. For these more complex type of files you can select which files are included using |
|
12 absolute path or wildcards. |
|
13 |
|
14 |
|
15 Configuring |
|
16 '''''''''''' |
|
17 Plugin is configured by modifying .convertprojectml file that must be located in some layer's implml folder |
|
18 that is included in generated configuration. Typical case is that the plugin is used in products that don't |
|
19 have configuration project and layers. In that case refer to Installation/Running part. |
|
20 |
|
21 Convert Project ML format |
|
22 ~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
23 +------------------+-----------------+----------------+-------------------------------+ |
|
24 | Elements | Attributes | Content model | Description | |
|
25 +==================+=================+================+===============================+ |
|
26 | convertprojectml | xmlns |targetProject | Collective/Top-most element | |
|
27 | | |layer* | defines the namespace used | |
|
28 | | |foreach* | in the file. | |
|
29 +------------------+-----------------+----------------+-------------------------------+ |
|
30 | targetProject | path | | Defines output path. By the | |
|
31 | | validate | | default all the paths later | |
|
32 | | | | are relative to this path. | |
|
33 +------------------+-----------------+----------------+-------------------------------+ |
|
34 | layer | path | folder* | Defines one configuration | |
|
35 | | | file* | layer. Creates new layer | |
|
36 | | | | folder defined in the path. | |
|
37 | | | | Folder and file paths are | |
|
38 | | | | relative to this path. | |
|
39 +------------------+-----------------+----------------+-------------------------------+ |
|
40 | folder | path | filter* | Defines one folder inside a | |
|
41 | | | | layer. Creates new folder | |
|
42 | | | | using path. Filter paths are | |
|
43 | | | | relative to this path. | |
|
44 +------------------+-----------------+----------------+-------------------------------+ |
|
45 | file | path | filter* | Element which can be used | |
|
46 | | type | | for three different purposes. | |
|
47 | | | | Copying files, creating layer | |
|
48 | | | | roots and configuration roots.| |
|
49 | | | | Path defines target filename | |
|
50 | | | | and type which kind of file | |
|
51 | | | | is created. | |
|
52 +------------------+-----------------+----------------+-------------------------------+ |
|
53 | filter | action | | Filter is the element that | |
|
54 | | data | | does all the work. It has | |
|
55 | | remove_includes | | attribute action, which can be| |
|
56 | | | | add, remove, include_file or | |
|
57 | | | | include_layer. Data defines | |
|
58 | | | | the search pattern for action | |
|
59 | | | | Remove_includes can be used to| |
|
60 | | | | remove all existing includes | |
|
61 | | | | from files that are included | |
|
62 | | | | in layer root file. | |
|
63 +------------------+-----------------+----------------+-------------------------------+ |
|
64 |
|
65 |
|
66 Installation/Running |
|
67 ''''''''''''''''''''' |
|
68 1. Download and install ConE according the ConE installation documentation. |
|
69 2. Go to \\epoc32\\rom\\config folder |
|
70 3. Create convertproject and convertproject\\implml folders |
|
71 4. Copy example create_project.convertprojectml to convertproject\\implml folder |
|
72 5. Modify according your needs |
|
73 6. Create a layer root file called root.confml in convertproject folder. Use the following content: |
|
74 |
|
75 .. code-block:: xml |
|
76 |
|
77 <?xml version="1.0" encoding="ASCII"?> |
|
78 <confml:configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
|
79 xmlns:confml="http://www.s60.com/xml/confml/2" |
|
80 xmlns:xi="http://www.w3.org/2001/XInclude" |
|
81 xsi:schemaLocation="http://www.s60.com/xml/confml/2 http://www.s60.com/xml/confml/1#//confml2 http://www.w3.org/2001/XInclude http://www.s60.com/xml/confml/1#//include"> |
|
82 </confml:configuration> |
|
83 |
|
84 7. Create configuration root file called convert.confml in \epoc32\rom\config folder. Use the following content: |
|
85 |
|
86 .. code-block:: xml |
|
87 |
|
88 <?xml version="1.0" encoding="ASCII"?> |
|
89 <confml:configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
|
90 xmlns:confml="http://www.s60.com/xml/confml/2" |
|
91 xmlns:xi="http://www.w3.org/2001/XInclude" |
|
92 xsi:schemaLocation="http://www.s60.com/xml/confml/2 http://www.s60.com/xml/confml/1#//confml2 http://www.w3.org/2001/XInclude http://www.s60.com/xml/confml/1#//include"> |
|
93 <xi:include href="convertproject/root.confml"/> |
|
94 </confml:configuration> |
|
95 |
|
96 8. Run ConE to generate content. |
|
97 |
|
98 :: |
|
99 |
|
100 \epoc32\rom\config>cone --action generate -c convert.confml |
|
101 |
|
102 |
|
103 Examples |
|
104 ''''''''' |
|
105 |
|
106 XSD |
|
107 ''' |
|
108 |
|
109 Download: :download:`projectml.xsd </xsd/projectml.xsd>` |
|
110 |
|
111 |
|
112 FAQ |
|
113 ''''''''' |
|
114 This will be updated based on the questions. |
|
115 |
|
116 |
|
117 |
|
118 |
|
119 |