configurationengine/doc/plugins/thememl-plugin/themelplugin.rst
author terytkon
Thu, 11 Mar 2010 17:04:37 +0200
changeset 0 2e8eeb919028
permissions -rw-r--r--
Adding EPL version of configurationengine.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     1
User guide for Theme Plugin usage in ConE
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     2
-----------------------------------------
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     3
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     4
Introduction
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     5
'''''''''''''
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     6
This page describes how to use ConE Theme plugin. Theme plugin extracts the theme content from the
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     7
.cpf file. It needs a .thememl file in the implml folder
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     8
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     9
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    10
The thememl syntax is a extension of Configuration markup language (confml). The term in confml for this extension 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    11
is implementation method language (implml), which in thememl case is a xml file. 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    12
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    13
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    14
Theme elements
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    15
''''''''''''''
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    16
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    17
The root element of the theme file is always thememl, which defines the xml namespace (xmlns) 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    18
to http://www.s60.com/xml/thememl/1 in the current version. 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    19
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    20
Theme example
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    21
^^^^^^^^^^^^^
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    22
.. literalinclude:: theme.thememl
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    23
   :language: xml
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    24
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    25
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    26
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    27
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    28
carbideuiPath
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    29
^^^^^^^^^^^^^^
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    30
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    31
To create a the Theme plugin uses makepackage.bat file which is under the forder described in
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    32
carbideuiPath tag. If none is setted the default is then C:\Program Files\Nokia\Carbide.ui Theme Edition 3.4 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    33
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    34
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    35
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    36
themeDir
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    37
^^^^^^^^
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    38
Theme plugin available themes from this directory setted as confml ref
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    39
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    40
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    41
activeTheme 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    42
^^^^^^^^^^^
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    43
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    44
One may describe a theme in this tag. You may have them as many as you want.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    45
It may hold one refSetting tag and several platformUID tags 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    46
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    47
**activeTheme attributes**
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    48
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    49
Each flag attribute can have unique hexa values.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    50
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    51
  * uid 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    52
  
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    53
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    54
refSetting 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    55
^^^^^^^^^^
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    56
A ref confml setting key that describes the name of the .tpf file. Tpf file must always locate in the 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    57
content folder
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    58
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    59
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    60
platformUID 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    61
^^^^^^^^^^^
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    62
Is a ref in conml it may contain some value, but it will be replaced in the theme plugin to value
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    63
given by the .pkg file and setted back to configuration. You may have more than one of these 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    64
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    65
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    66
Note 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    67
^^^^^
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    68
The current implementation of the theme plugin relays the the .tpf file contain a .project file and 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    69
it contains themepackage.pkg file
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    70
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    71
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    72
XSD
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    73
'''
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    74
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    75
Download: :download:`thememl.xsd </xsd/thememl.xsd>`
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    76
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    77
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    78
FAQ
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    79
'''
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    80
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    81
Makepackage error
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    82
'''''''''''''''''
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    83
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    84
This problem is related to installation on Carbide.ui you can get it form
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    85
here http://www.forum.nokia.com/info/sw.nokia.com/id/bb173537-4e67-496f-9967-50917d5cfc47/S60_Theme_Studio_for_Symbian_OS.html
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    86
Install it. Goes by default to C:\Program Files\Nokia\Carbide.ui Theme Edition 3.4, but if you install it
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    87
to a different location then you need to set right path to carbideuiPath tag. Chek that your system supports java
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    88
programmin language. OPen command line editor and type java -version should be 1.5 or above 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    89
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    90
My theme is not created to image
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    91
''''''''''''''''''''''''''''''''
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    92
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    93
Change the .tpf file extension to zip and extract it to some folder.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    94
View the contents, there should be .project file and themepackage.pkg file, if not
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    95
then ConE cannot create you a theme to an image. 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    96
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    97
 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    98
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    99