You are here

README.txt in css3pie 7.2

Same filename and directory in other branches
  1. 6 README.txt
CSS3PIE is a very simple Drupal module to implement the css3pie.com javascript functionality 
to your Drupal and make the css selectors configurable over user interface. This module creates 
a real css file on Drupal's files folder and adds them via drupal_add_css.

What does this module do for you ?
--------------------------------
The main feature of this module is to implement the css3pie.com library with your custom selected css classes by writing a seperate css file.

- Generate a CSS File
- Assign css3pie lib to a list of selectors

What does this module NOT do for you ?
--------------------------------
Its not part of this module to generate any css3 code for you. This is part of your Theme

- This module generates NO css3 code for you.

Dependencies / Requirements:
--------------
Drupal Modules:
- ctools http://drupal.org/projects/ctools
- libraries http://drupal.org/project/libraries

3rd party libraries:
- Latest version of PIE library from http://css3pie.com

Installation:
--------------
Download the module and install like other drupal modules.
Download the PIE Library from http://css3pie.com and extract the content to /sites/all/libraries/PIE.

You can also use Drush (since css3pie module version 2.1 or current dev version since 2012-02-17):

  Download css3pie module:
  drush dl css3pie

  Enables the module and download the css3lib
  drush en css3pie

  or:
  download the css3lib directly (only on enabled module)
  drush css3pie-download

Configuration:
--------------
Go to admin/config/user-interface/css3pie and configure as you want.

 Selector Textarea:
  In the textarea use one line for every selector (don't use a comma seperated list)
  that you have used in your theme with css3 code.

 CSS3PIE mode:
 The css3pie module supports currently two modes. CSS file or Javascript mode.

   CSS File:
   If you use the css file mode this module generates it's own css file. This is the recommended
   mode because it is the fastest delivery method (a real css file that can be cached).

   Javascript mode:
   In the javascript mode it will be use the new pie.js variant. In this mode the selectors will
   be attached to a javascript function. This is really slow and not recommended because the selectors
   will be processed in real time by the client.

 CSS Settings:
   Display namespace as comment in css file:
   If checked the module namespace will be displayed as comment in the css file. It makes only sense
   for debugging if you implement the hook_css3pie.

   Use PHP Wrapper:
   On some old webservers you run into problems with the file mimetype on .htc files.
   This option sets the mimetype header by using a php file as a wrapper.

Notice:
-------
- The CSS File will be rebuilt if you save the options or clear the cache.
- You don't need to load the PIE.htc file manually in your themes css file.
  If you have done it manually you dont need this module.

Developers:
-----------
If you have a module that uses css3 you can use the hook_css3pie to tell the module about your selectors.

  Example:
  --------
  hook_css3pie() {
    return array('yourmodulename' => array(
      '.class1', '.class2', '.class3',
    ));
  }

If you want to alteri the data from an existing css3pie_hook you can use hook_css3pie_alter() for it.
  hook_css3pie_alter(&$selectors, $mode = 'css') {}

Theme Developers:
-----------------
Instead of using selector configuration you can also add the selectors to your theme info file like this:

  Example:
  --------
  settings[css3pie][selectors][] = ".yourclass"
  settings[css3pie][selectors][] = "#yourid"

File

README.txt
View source
  1. CSS3PIE is a very simple Drupal module to implement the css3pie.com javascript functionality
  2. to your Drupal and make the css selectors configurable over user interface. This module creates
  3. a real css file on Drupal's files folder and adds them via drupal_add_css.
  4. What does this module do for you ?
  5. --------------------------------
  6. The main feature of this module is to implement the css3pie.com library with your custom selected css classes by writing a seperate css file.
  7. - Generate a CSS File
  8. - Assign css3pie lib to a list of selectors
  9. What does this module NOT do for you ?
  10. --------------------------------
  11. Its not part of this module to generate any css3 code for you. This is part of your Theme
  12. - This module generates NO css3 code for you.
  13. Dependencies / Requirements:
  14. --------------
  15. Drupal Modules:
  16. - ctools http://drupal.org/projects/ctools
  17. - libraries http://drupal.org/project/libraries
  18. 3rd party libraries:
  19. - Latest version of PIE library from http://css3pie.com
  20. Installation:
  21. --------------
  22. Download the module and install like other drupal modules.
  23. Download the PIE Library from http://css3pie.com and extract the content to /sites/all/libraries/PIE.
  24. You can also use Drush (since css3pie module version 2.1 or current dev version since 2012-02-17):
  25. Download css3pie module:
  26. drush dl css3pie
  27. Enables the module and download the css3lib
  28. drush en css3pie
  29. or:
  30. download the css3lib directly (only on enabled module)
  31. drush css3pie-download
  32. Configuration:
  33. --------------
  34. Go to admin/config/user-interface/css3pie and configure as you want.
  35. Selector Textarea:
  36. In the textarea use one line for every selector (don't use a comma seperated list)
  37. that you have used in your theme with css3 code.
  38. CSS3PIE mode:
  39. The css3pie module supports currently two modes. CSS file or Javascript mode.
  40. CSS File:
  41. If you use the css file mode this module generates it's own css file. This is the recommended
  42. mode because it is the fastest delivery method (a real css file that can be cached).
  43. Javascript mode:
  44. In the javascript mode it will be use the new pie.js variant. In this mode the selectors will
  45. be attached to a javascript function. This is really slow and not recommended because the selectors
  46. will be processed in real time by the client.
  47. CSS Settings:
  48. Display namespace as comment in css file:
  49. If checked the module namespace will be displayed as comment in the css file. It makes only sense
  50. for debugging if you implement the hook_css3pie.
  51. Use PHP Wrapper:
  52. On some old webservers you run into problems with the file mimetype on .htc files.
  53. This option sets the mimetype header by using a php file as a wrapper.
  54. Notice:
  55. -------
  56. - The CSS File will be rebuilt if you save the options or clear the cache.
  57. - You don't need to load the PIE.htc file manually in your themes css file.
  58. If you have done it manually you dont need this module.
  59. Developers:
  60. -----------
  61. If you have a module that uses css3 you can use the hook_css3pie to tell the module about your selectors.
  62. Example:
  63. --------
  64. hook_css3pie() {
  65. return array('yourmodulename' => array(
  66. '.class1', '.class2', '.class3',
  67. ));
  68. }
  69. If you want to alteri the data from an existing css3pie_hook you can use hook_css3pie_alter() for it.
  70. hook_css3pie_alter(&$selectors, $mode = 'css') {}
  71. Theme Developers:
  72. -----------------
  73. Instead of using selector configuration you can also add the selectors to your theme info file like this:
  74. Example:
  75. --------
  76. settings[css3pie][selectors][] = ".yourclass"
  77. settings[css3pie][selectors][] = "#yourid"