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