source: products/qPloneSkinDump/branches/multipleslots/README.txt @ 1591

Last change on this file since 1591 was 1, checked in by myroslav, 15 years ago

Building directory structure

File size: 4.8 KB
Line 
1Quintagroup Plone Skin Dump
2
3  qPloneSkinDump allows to create Plone product
4  (in file system) from some ZMI based skin folder
5  (eg "custom") from portal_skins.
6
7  So you can easy design new Plone skin with all
8  customized styles, page tamplates, python scripts,
9  ECMA-scripts, Images and other objects, located
10  in some folder of portal_skins. Than dump it to
11  new Plone Skin Product to file system.
12 
13
14Features:
15
16  - Support dumping objects from generated portal's root
17    to Skin Product for adding this objects to
18    destination portal root on iinstalling Skin Product.
19
20  - Dump css and ecma-cripts resources registries from
21    generated portal to Skin Product for right working
22    styles and ecma-scripts.
23   
24  - Allow dumping sorce skin folder with subfolder tree.
25   
26  - Allow add aditional installation functions in config.py
27    module generated Skin Product.
28   
29  - Allow customize slots for generated Skin Product.
30 
31  - All configuration data for Skin Procut can be easy
32    changed in file system, cause all constants has
33    detailed explanations and examples.
34
35
36Installation:
37
38  1. Install qPloneSkinDump as Zope product
39
40  2. Install qPloneSkinDump in your Plone instance with QuickInstaller
41     (Plone Control Panel -> Add/remove Products)
42
43
44Usage
45
46  1. Create standart Plone Folder ( <folder-source> ) in portal_skins
47     or use standard 'custom' folder and fill it with content according
48     to your needs. You can create subfolders in <folder-source>.
49
50  2. Go to the Plone Control Panel, select "qPloneSkinDump Configuration"
51     configlet and edit corresponding form fields:
52
53     - <folder-source> is the name of the folder where all the content
54        and styles are located in ZMI ../portal_skins/<folder-source>.
55
56     - <ZMI Base Skin Name> is name of the Plone Skin, which list of layers
57       will be used for creating new skin. (eg "Plone Tableless").
58
59     - <Erace>  is checkbox for erasing <folder-source> folder
60       from portal_skins after Product creating.
61
62     - <Skin's Name>  is the name of skin folder for new product ( Actually
63        Products/<Product name>/skin/<skin's name> ), that will be based
64        on the <folder-source> staff.
65        This <Skin's Name> also used as name of new Plone skin.
66
67     - <Product name> - the name of new Plone product.
68
69     - <Do customize slots> - Check it for PROVIDING SLOTS CUSTOMIZATION
70        in New Skin Product.
71
72     - <Left portal slots customizing>, <Right portal slots customizing>
73        - left and right slots lists for New Plone Product. You are
74        responsible for leaving only those portlets, which relate to your
75        skin product or are standard for Plone.
76
77     - <Slot's list forming> - slot's list forming control on New Plone
78        Product installation.
79
80     - <Main column> - decide in which column leave same slots, in case
81        of meetings one.
82
83     - <Exporting objects from portal root> - check it for export objects
84       from your Portal root to Skin Product. Than chosed objects will be
85       added to Portal root (where Skin Product will be installed) on
86       installation.
87     
88     - <Import Policy> - define how will be imports objects to portal root
89       on installation Skin Product if will be meeting same named (id)
90       objects.
91     
92     - <Exporting objects> multyselected list for choosing objects from
93       generated portal, which must be imported to portal root on Skin
94       Product's installation.
95       
96     - <Dump portal_CSS registry> - switch on|off dumping portal_css registry
97       resources with all properties sets. Be attentive when switch-off this checkbox.
98       When switch-on - all css-es of your new Skin Product and other portal_css
99       resources will be sets identically to your settings and this guarantee
100       identical look and behavior of your skeen on other Plone site.
101     
102     - <Dump portal_JS registry> - switch on|off dumping portal_javascripts registry
103       resources with all properties sets. Be attentive when switch-off this checkbox.
104       When switch-on - all ECMA-scripts of your new Skin Product and other
105       portal_javascripts resources will be sets identically to your settings
106       and this guarantee identical look and behavior of your skeen on other
107       Plone site.
108     
109  5. For using new Plone product you must reload Zope, and install it in quickinstaller.
110
111  In file system new product located in ../Products/<Product name>.
112
113
114Caution
115
116    If you wish distribute generated Skin Product, you must
117        - (for Plone 2.1+) before run generation remove all non-standard
118          (for Plone dstribution) css and jvascripts resources from
119          plone_css and plone_javascripts registries, which aren't
120          related to new Skin Product (not in the <folder-source>)
121         
122
123Authors
124
125  * Andriy Mylenkyy
126
127
128License
129
130  * ZPL
Note: See TracBrowser for help on using the repository browser.