Changeset 3049 in products


Ignore:
Timestamp:
Nov 22, 2010 6:22:32 PM (13 years ago)
Author:
mylan
Message:

Update PKG-INFO file

File:
1 edited

Legend:

Unmodified
Added
Removed
  • quintagroup.themetemplate/trunk/quintagroup.themetemplate.egg-info/PKG-INFO

    r2569 r3049  
    11Metadata-Version: 1.0 
    22Name: quintagroup.themetemplate 
    3 Version: 0.23 
     3Version: 0.26 
    44Summary: Quintagroup theme template for Plone 3 with nested namespace 
    55Home-page: http://svn.quintagroup.com/products/quintagroup.themetemplate 
     
    1717         
    1818        quintagroup.themetemplate package is used for development of all Quintagroup themes 
    19         for Plone 3 (http://skins.quintagroup.com). 
     19        for Plone 3 at http://skins.quintagroup.com. 
    2020         
    2121        Contents 
     
    5151        Use `paster create` command for that:: 
    5252         
    53         >>> paster('create -t qplone3_theme quintagroup.theme.example --no-interactive --overwrite') 
    54         paster create -t qplone3_theme quintagroup.theme.example --no-interactive 
     53        >>> paster('create -t qplone3_theme quintagroup.theme.example --overwrite') 
     54        paster create -t qplone3_theme quintagroup.theme.example ... 
    5555        ... 
    5656         
    5757        You got standard python package content with 
     58         
    5859        - *quintagroup* upper level namespace. 
    59         - *quintagroup.theme.example-configure.zcml* - zcml file 
    60         for adding into package-includes directory 
     60        - *quintagroup.theme.example-configure.zcml* - zcml file for adding into package-includes directory 
    6161         
    6262        Check that:: 
     
    7171        *qplone3_theme* template - creates theme with nested namespace. 
    7272         
    73         By default - theme is placed in 
    74          
    75         quintagroup.theme.<3rd part of dotted package name> namespace 
     73        By default - theme is placed in *quintagroup.theme.<3rd part of dotted package name> namespace* 
    7674         
    7775        in our case - quintagroup.theme.example 
     
    10199         
    102100        Browser directory contains: 
     101         
    103102        - 'templates' resource directory 
    104103        - interfaces.py module with IThemeSpecific marker interface 
    105         - configure.zcml, with registered theme marker interface 
     104        - configure.zcml, with registered theme marker interface:: 
    106105         
    107106        >>> ls('browser') 
     
    130129        creation you can point out your own name. Check this ... 
    131130         
    132         First create configuration file with different skin name 
     131        First create configuration file with different skin name:: 
     132         
    133133        >>> conf_data = """ 
    134134        ... [pastescript] 
     
    137137        >>> file('theme_config.conf','w').write(conf_data) 
    138138         
    139         Create the same theme with your own skin name and check this 
    140         >>> paster('create -t qplone3_theme quintagroup.theme.example --no-interactive --overwrite --config=theme_config.conf') 
     139        Create the same theme with your own skin name and check this:: 
     140         
     141        >>> paster('create -t qplone3_theme quintagroup.theme.example --overwrite --config=theme_config.conf') 
    141142        paster create ... 
    142143        >>> cd(package_dir) 
     
    153154         
    154155        *skins* directory 
    155         ------------------------ 
     156        ----------------- 
    156157         
    157158        It contains only README.txt file and NO SKIN LAYERS YET. 
    158159        This is a job for localcommand ;) 
    159160         
    160         But check whether I am right ... 
     161        But check whether I am right ...:: 
     162         
    161163        >>> cd('quintagroup/theme/example') 
    162164        >>> ls('skins') 
     
    164166         
    165167         
    166         *profiles* directory. 
    167         -------------------------------- 
    168         There is 'default' and uninstall profiles inside 
     168        *profiles* directory 
     169        -------------------- 
     170         
     171        There is 'default' and uninstall profiles inside:: 
     172         
    169173        >>> 'default' in os.listdir('profiles') 
    170174        True 
     
    173177         
    174178        There are the following items in default profile: 
     179         
    175180        - import_steps.xml - for any reason. 
    176         - skins.xml - for registering skins directory 
     181        - skins.xml - for registering skins directory:: 
    177182         
    178183        >>> cd('profiles/default') 
     
    184189        *skins.xml* profile makes your theme default on installation 
    185190        and uses layers list from 'Plone Default' for our theme, 
    186         without any new layers (yet). 
     191        without any new layers (yet):: 
    187192         
    188193        >>> cat('skins.xml') 
     
    190195        ... 
    191196        <object name="portal_skins" ... 
    192         default_skin="My Theme Name"> 
     197        default_skin="My Theme Name" request_varname="plone_skin"> 
    193198        ... 
    194199        <skin-path name="My Theme Name" based-on="Plone Default"> 
     
    199204         
    200205        *import_steps.xml* - call _setupVarious_ function from 
    201         _setuphandlers.py_ module for additional installation steps. 
     206        _setuphandlers.py_ module for additional installation steps:: 
    202207         
    203208        >>> cat('import_steps.xml') 
     
    211216        ... 
    212217         
    213         Look at setuphandlers.py module 
     218        Look at setuphandlers.py module:: 
     219         
    214220        >>> cd('../..') 
    215221        >>> cat('setuphandlers.py') 
     
    239245        IMPORTANT TO NOTE: localcommand (addcontent in our case) should be 
    240246        called in any subdirectory of the generated theme package. And it won't 
    241         work outside this package.. 
     247        work outside this package:: 
    242248         
    243249        >>> paster('addcontent -a') 
     
    267273        ================= 
    268274         
    269         For that case use *skin_layer* subtemplate with *addcontent* local command 
    270          
    271         >>> paster('addcontent --no-interactive skin_layer') 
    272         paster addcontent --no-interactive skin_layer 
     275        For that case use *skin_layer* subtemplate with *addcontent* local command:: 
     276         
     277        >>> paster('addcontent skin_layer') 
     278        paster addcontent skin_layer ... 
    273279        Recursing into profiles 
    274280        ... 
    275281         
    276282        This command adds NEW 'skin_layer' (default name) directory to _skins_ directory, 
    277         with only CONTENT.txt file inside. 
     283        with only CONTENT.txt file inside:: 
    278284         
    279285        >>> 'skin_layer' in os.listdir('skins') 
     
    282288        CONTENT.txt 
    283289         
    284         *skins.xml* profile is also updated: 
     290        *skins.xml* profile is also updated:: 
    285291         
    286292        >>> cat('profiles/default/skins.xml') 
     
    288294        ... 
    289295        <object name="portal_skins" allow_any="False" cookie_persistence="False" 
    290         default_skin="My Theme Name"> 
     296        default_skin="My Theme Name" request_varname="plone_skin"> 
    291297        ... 
    292298        <object name="skin_layer" 
     
    303309         
    304310        We can see, that: 
     311         
    305312        - skin_layer directory was registered as Filesystem Directory View 
    306313        - skin_layer Filesystem Directory View was added to our theme layers list 
     
    308315         
    309316        Adding PORTLET 
    310         ========================== 
    311          
    312         Only initialization files are available in portlets directory before adding new portlet. 
     317        ============== 
     318         
     319        Only initialization files are available in portlets directory before adding new portlet:: 
    313320         
    314321        >>> ls('portlets') 
     
    316323        configure.zcml 
    317324         
    318         Add portlet with *portlet* subtemplate. 
    319          
    320         >>> paster('addcontent --no-interactive portlet') 
    321         paster addcontent --no-interactive portlet 
     325        Add portlet with *portlet* subtemplate:: 
     326         
     327        >>> paster('addcontent portlet') 
     328        paster addcontent portlet ... 
    322329        ... 
    323330        Recursing into portlets 
     
    326333        After executing this local command ... 
    327334         
    328         configure.zcml file in the theme root directory - includes portlets registry: 
     335        configure.zcml file in the theme root directory - includes portlets registry:: 
    329336         
    330337        >>> cat('configure.zcml') 
     
    334341        ... 
    335342         
    336         exampleportlet.pt template and exampleportlet.py script added to portlets directory. 
     343        exampleportlet.pt template and exampleportlet.py script added to portlets directory:: 
     344         
    337345        >>> files = ('exampleportlet.pt', 'exampleportlet.py') 
    338346        >>> [True for d in files if d in os.listdir('portlets')] 
    339347        [True, True] 
    340348         
    341         And portlets/configure.zcml - register new portlet 
     349        And portlets/configure.zcml - register new portlet:: 
     350         
    342351        >>> cat('portlets/configure.zcml') 
    343352        <configure 
     
    355364        ... 
    356365         
    357         Finally, new portlet type is registered in portlets.xml profile 
     366        Finally, new portlet type is registered in portlets.xml profile:: 
    358367         
    359368        >>> cat('profiles/default/portlets.xml') 
     
    371380         
    372381         
    373          
    374382        Adding CSS resource 
    375383        =================== 
    376384         
    377         Use *css_resource* subtemplate. 
    378          
    379         >>> paster("addcontent --no-interactive css_resource") 
    380         paster addcontent --no-interactive css_resource 
     385        Use *css_resource* subtemplate:: 
     386         
     387        >>> paster("addcontent css_resource") 
     388        paster addcontent css_resource ... 
    381389        Recursing into browser 
    382390        ... 
     
    385393         
    386394        This template adds (if does not exist yet) _stylesheets_ directory in _browser_ 
    387         directory 
     395        directory:: 
    388396         
    389397        >>> 'stylesheets' in os.listdir('browser') 
     
    391399         
    392400        In _stylesheets_ resource directory empty main.css stylesheet 
    393         resource added 
     401        resource added:: 
    394402         
    395403        >>> 'main.css' in os.listdir('browser/stylesheets') 
     
    399407         
    400408         
    401         New resource directory was registered in configure.zcml 
     409        New resource directory was registered in configure.zcml:: 
    402410         
    403411        >>> cat('browser/configure.zcml') 
     
    413421         
    414422        And cssregistry.xml profile was added into profiles/default directory with 
    415         registered main.css stylesheet 
     423        registered main.css stylesheet:: 
    416424         
    417425        >>> 'cssregistry.xml' in os.listdir('profiles/default') 
     
    438446         
    439447        This subtemplate has several benefits before registering css as resource layer: 
     448         
    440449        - in dtml file you can use power of dtml language 
    441450        - this resource can be overriden by customer if he needs that 
     
    446455         
    447456         
    448         Use *css_dtml_skin* subtemplate. 
    449          
    450         >>> paster("addcontent --no-interactive css_dtml_skin") 
    451         paster addcontent --no-interactive css_dtml_skin 
     457        Use *css_dtml_skin* subtemplate:: 
     458         
     459        >>> paster("addcontent css_dtml_skin") 
     460        paster addcontent css_dtml_skin ... 
    452461        Recursing into profiles 
    453462        ... 
     
    455464        ... 
    456465         
    457         This template adds main.css.dtml file into skins/skin_layer folder 
     466        This template adds main.css.dtml file into skins/skin_layer folder:: 
    458467         
    459468        >>> 'main.css.dtml' in os.listdir('skins/skin_layer') 
    460469        True 
    461470         
    462         The main.css.dtml file already prepared to use as dtml-document 
     471        The main.css.dtml file already prepared to use as dtml-document:: 
     472         
    463473        >>> cat('skins/skin_layer/main.css.dtml') 
    464474        /* 
     
    471481         
    472482        And cssregistry.xml profile was added into profiles/default directory with 
    473         registered main.css stylesheet 
     483        registered main.css stylesheet:: 
    474484         
    475485        >>> 'cssregistry.xml' in os.listdir('profiles/default') 
     
    490500        -------------------------- 
    491501         
    492         Use *js_resource* subtemplate. 
    493          
    494         >>> paster('addcontent --no-interactive js_resource') 
    495         paster addcontent --no-interactive js_resource 
     502        Use *js_resource* subtemplate:: 
     503         
     504        >>> paster('addcontent js_resource') 
     505        paster addcontent js_resource ... 
    496506        Recursing into browser 
    497507        ... 
     
    500510         
    501511        This template adds (if does not exist yet) _scripts_ directory in _browser_ 
    502         directory 
     512        directory:: 
    503513         
    504514        >>> 'scripts' in os.listdir('browser') 
     
    506516         
    507517         
    508         Empty foo.js javascript file was added to _scripts_ directory 
     518        Empty foo.js javascript file was added to _scripts_ directory:: 
    509519         
    510520        >>> 'foo.js' in os.listdir('browser/scripts') 
     
    514524         
    515525         
    516         New resource directory was registered in configure.zcml, if has not been registered yet. 
     526        New resource directory was registered in configure.zcml, if has not been registered yet:: 
    517527         
    518528        >>> cat('browser/configure.zcml') 
     
    528538         
    529539        cssregistry.xml profile was added into profiles/default directory (if does not exist yet), 
    530         and register new foo.js javascript resource. 
     540        and register new foo.js javascript resource:: 
    531541         
    532542        >>> 'jsregistry.xml' in os.listdir('profiles/default') 
     
    550560         
    551561        There are 2 types of viewlet subtemplates: 
     562         
    552563        - viewlet_order 
    553564        - viewlet_hidden 
     
    560571        ------------------- 
    561572         
    562         Use *viewlet_order* subtemplate 
    563          
    564         >>> paster('addcontent --no-interactive viewlet_order') 
    565         paster addcontent --no-interactive viewlet_order 
     573        Use *viewlet_order* subtemplate:: 
     574         
     575        >>> paster('addcontent viewlet_order') 
     576        paster addcontent viewlet_order ... 
    566577        Recursing into browser 
    567578        ... 
     
    573584        This template adds (if not exist ;)) _viewlets.py_ module in browser directory. 
    574585        With added Example ViewletBase class, which is bound to templates/example_viewlet.pt 
    575         template 
     586        template:: 
    576587         
    577588        >>> 'viewlets.py' in os.listdir('browser') 
     
    587598        <BLANKLINE> 
    588599         
    589         Check template file in templates directory. 
     600        Check template file in templates directory:: 
    590601         
    591602        >>> 'example_viewlet.pt' in os.listdir('browser/templates') 
     
    594605        <BLANKLINE> 
    595606         
    596         New viewlet is registered in configure.zcml 
     607        New viewlet is registered in configure.zcml:: 
    597608         
    598609        >>> cat('browser/configure.zcml') 
     
    610621         
    611622        viewlets.xml profile is added to profiles/default directory with new viewlet 
    612         registration, ordered for specified viewlet manager. 
     623        registration, ordered for specified viewlet manager:: 
    613624         
    614625        >>> 'viewlets.xml' in os.listdir('profiles/default') 
     
    633644        --------------------- 
    634645         
    635         For that case you can use *viewlet_hidden* subtemplate 
    636          
    637         >>> paster('addcontent --no-interactive viewlet_hidden') 
    638         paster addcontent --no-interactive viewlet_hidden 
     646        For that case you can use *viewlet_hidden* subtemplate:: 
     647         
     648        >>> paster('addcontent viewlet_hidden') 
     649        paster addcontent viewlet_hidden ... 
    639650        Recursing into profiles 
    640651        ... 
     
    644655         
    645656        There is viewlet.xml profile in profiles/default directory 
    646         which hides viewlet for specified viewlet manager 
     657        which hides viewlet for specified viewlet manager:: 
    647658         
    648659        >>> 'viewlets.xml' in os.listdir('profiles/default') 
     
    673684        *import_zexps* subtemplate extends your theme with 
    674685        mechanism for importing list of zexp formated files 
    675         into portal root on theme instllation. 
    676          
    677         >>> paster('addcontent --no-interactive import_zexps') 
    678         paster addcontent --no-interactive import_zexps 
     686        into portal root on theme instllation:: 
     687         
     688        >>> paster('addcontent import_zexps') 
     689        paster addcontent import_zexps ... 
    679690        ... 
    680691        Recursing into import 
     
    687698        ... 
    688699         
    689         As we see from the upper log: 
     700        As we see from the upper log 
     701         
    690702        - 'import' directory was added into root of the theme 
    691703        - profiles stuff was updated 
     
    694706         
    695707        1. There was empty 'import' directory added, where you 
    696         will put zexp objects for install into portal root. 
     708        will put zexp objects for install into portal root.:: 
    697709         
    698710        >>> ls('import') 
     
    701713         
    702714        2. import_steps.xml was added in profiles/import_zexps directory, 
    703         which contains additional *quintagroup.theme.example.import_zexps* step. 
     715        which contains additional *quintagroup.theme.example.import_zexps* step:: 
    704716         
    705717        >>> 'import_zexps' in os.listdir('profiles') 
     
    721733         
    722734        3. profiles.zcml configuration updated with new genericsetup profile for zexps 
    723         importing. 
     735        importing:: 
    724736         
    725737        >>> cat('profiles.zcml') 
     
    736748        ... 
    737749         
    738         4. Check setuphandlers.py module - there must be importZEXPs function defined 
     750        4. Check setuphandlers.py module - there must be importZEXPs function defined:: 
    739751         
    740752        >>> cat('setuphandlers.py') 
     
    752764        Before releasing theme - I suggest to clean up setup.py script: 
    753765         
    754         - remove *theme_vars* argument (its value is useful only for 
    755         theme development) 
    756          
    757         - remove *entry_points* argument (same reason). 
    758         It's useless in plone for now. 
    759          
    760         - And remove *paster_plugins* argument too (it has sence 
    761         in conjunction with entry_points during theme developing) 
     766        - remove *theme_vars* argument (its value is useful only for theme development) 
     767         
     768        - remove *entry_points* argument (same reason). It's useless in plone for now. 
     769         
     770        - And remove *paster_plugins* argument too (it has sence in conjunction with entry_points during theme developing) 
    762771         
    763772        Steps mentioned above prevent possible problems with 
    764773        theme distribution/deployment. 
    765774         
     775        Notes: 
     776        ------ 
     777         
     778        * quintagroup.themetemplate v0.25 compatible with ZopeSkel >= 2.15 
     779         
     780         
    766781        Changelog 
    767782        ========= 
     783         
     784        0.25 (2010-06-24) 
     785        ----------------- 
     786         
     787        - Correct version of the pacakge 
     788        [mylan] 
     789        - Fix incompatibility wity ZopeSkel>=2.15 
     790        [mylan] 
     791        - Updated tests 
     792        [mylan] 
     793         
    768794         
    769795        0.2.2 (unreleased) 
     
    827853         
    828854         
    829         Version 0.7 
    830         ----------- 
     855        0.7 (unreleased) 
     856        ---------------- 
    831857         
    832858        * Add uninstall profile to fix skins tool after theme is uninstalled 
     
    834860         
    835861         
    836         Version 0.1 
    837         ----------- 
     862        0.1 (unreleased) 
     863        ---------------- 
    838864         
    839865        * Initial import Theme template with nested namespace. 
Note: See TracChangeset for help on using the changeset viewer.