| 1 | Introduction |
|---|
| 2 | ============ |
|---|
| 3 | |
|---|
| 4 | waeup.plonetheme.ngren3 integrates Twitter Bootstrap CSS/JS framework |
|---|
| 5 | into Plone. You can checkout the framework at http://twitter.github.com/bootstrap |
|---|
| 6 | |
|---|
| 7 | It overrides some templates and uses javascript to transform |
|---|
| 8 | some markup in order for it to work correctly. |
|---|
| 9 | |
|---|
| 10 | It's not perfect, but it's close. |
|---|
| 11 | |
|---|
| 12 | Dependencies |
|---|
| 13 | ============== |
|---|
| 14 | |
|---|
| 15 | Latest Twitter Bootstrap requires jQuery 1.7.x, you can install |
|---|
| 16 | it in Plone pinning plone.app.jquery in your buildout to version 1.7.2. |
|---|
| 17 | You will also need to pin plone.app.jquerytools to version |
|---|
| 18 | 1.5.1 to guarantee jQuery 1.7.x compatibility:: |
|---|
| 19 | |
|---|
| 20 | [versions] |
|---|
| 21 | ... |
|---|
| 22 | plone.app.jquery = 1.7.2 |
|---|
| 23 | plone.app.jquerytools = 1.5.1 |
|---|
| 24 | ... |
|---|
| 25 | |
|---|
| 26 | Twitter Boostrap itself is provided as browser resources by the addon |
|---|
| 27 | `collective.js.bootstrap`_. |
|---|
| 28 | |
|---|
| 29 | Documentation |
|---|
| 30 | =============== |
|---|
| 31 | |
|---|
| 32 | This product is based in Twitter Bootstrap version 2.3.x. |
|---|
| 33 | |
|---|
| 34 | This product adds both the basic CSS file and also the Responsive one to have |
|---|
| 35 | a mobile-enabled site from the start. |
|---|
| 36 | |
|---|
| 37 | The generated markup is based on 'fluid CSS' and it contains a 12 column grid. |
|---|
| 38 | |
|---|
| 39 | The basic HTML markup is a mix of `plonetheme.sunburst`_ and Twitter Bootstrap |
|---|
| 40 | and it uses the same approach of constructing the columns as Sunburst Theme: |
|---|
| 41 | a simple view that returns the classes needed to have the correct column widths. |
|---|
| 42 | |
|---|
| 43 | If you want to change those widths, just override the view following the common |
|---|
| 44 | Plone overriding patterns. |
|---|
| 45 | |
|---|
| 46 | This product is intended to be used in two scenarios: |
|---|
| 47 | |
|---|
| 48 | - As a theme from Plone |
|---|
| 49 | - As a base theme to build Plone themes for your site following 'old practices' |
|---|
| 50 | |
|---|
| 51 | Some designers prefer to work following the old best-practices instead of using |
|---|
| 52 | the Diazo-way-of-theming, this product is for them. You can create a theme package |
|---|
| 53 | (check `templer skeleton generator`_), and base your them on this one. |
|---|
| 54 | |
|---|
| 55 | If you have any problem using this product or find any bug, please report it |
|---|
| 56 | using the `GitHub issue tracker`_. |
|---|
| 57 | |
|---|
| 58 | Upgrade |
|---|
| 59 | ========= |
|---|
| 60 | |
|---|
| 61 | To upgrade from version 1.0a1, just go to the add-on controlpanel and click |
|---|
| 62 | on upgrade. Old skin paths and javascripts will be disabled and new ones imported |
|---|
| 63 | |
|---|
| 64 | |
|---|
| 65 | |
|---|
| 66 | Authors |
|---|
| 67 | ========= |
|---|
| 68 | |
|---|
| 69 | - Nathan van Gheem, initial author |
|---|
| 70 | - Mikel Larreategi, update to Twitter Bootstrap 2.3.x, current mantainer |
|---|
| 71 | |
|---|
| 72 | |
|---|
| 73 | |
|---|
| 74 | .. _`plonetheme.sunburst`: http://pypi.python.org/pypi/plonetheme.sunburst |
|---|
| 75 | .. _`templer skeleton generator`: http://templer-manual.readthedocs.org/en/latest/ |
|---|
| 76 | .. _`GitHub issue tracker`: https://github.com/collective/waeup.plonetheme.ngren3/issues |
|---|
| 77 | .. _`collective.js.bootstrap`: https://pypi.python.org/pypi/collective.js.bootstrap |
|---|
