You are here

Home » API reference » AutoFloat 6

README.txt in AutoFloat 6

Same filename and directory in other branches
  1. 8 README.txt
  2. 6.2 README.txt
  3. 7.2 README.txt
  4. 7 README.txt
Name: AutoFloat (autofloat)
Author: Martin Postma ('lolandese', http://drupal.org/user/210402)
Drupal: 6.x


-- SUMMARY --

A text format filter that wraps images in a span with odd/even classes to make
them float alternately left and right.

Configurable:
* the starting side
* exclude the module's CSS to use your theme's style.css 
* add classes to target a 'span', e.g. in case a caption is displayed
* add classes to exclude a 'div', e.g. a set of thumbnails. 


-- EXAMPLE --

The filter turns:
  ‹img src="/path/photo.jpg"›
into:
  ‹span class="autofloat-odd"›‹img src="/path/photo.jpg"›‹/span›


-- FEATURES --

Generates an organized layout of images in a text automatically.

Easy for the less technical users.

Saves time.

Avoids inline styling.

Inserting images later doesn't mess up the alternating floating.


-- INSTALLATION AND CONFIGURATION --

Extract the package in your modules directory, e.g. '/sites/all/modules'.

Enable the module under '/admin/modules'.

Add the autofloat filter to one of your text formats under 
'/admin/settings/filters'. Put it below other image related filters in
the 'Arrange' tab.

Configure under '/admin/settings/autofloat'.

Re-save existing nodes you want to apply AutoFloat to. If you still can't see
any changes, try clearing both your site and browser cache as well.


-- USAGE --

Images will float unless they have the class 'nofloat'.

A 'span' with the class 'float' will float the image and other containing 
content, e.g. a caption under it.

Images in a 'div' with the class 'nofloat' do NOT float, e.g. a set of 
thumbnails.

Avoid adding classes manually by defining classes added by other 
modules/filters. Use your browser's inspector to find them.

The class 'nofloat' of a nested element has priority over classes set in the 
parent, thus makes that the parent will not float.

Remember an element floats within the block-element containing it. If that 
doesn't cover the full width, the image might not float as expected. 
Check your CSS before submitting an issue.


-- CSS --

The autofloat.css and autofloat-rtl.css files add a right-margin to left
floating images and a left-margin to right floating images. 

If your images won't float your theme might not use the id or class "content"
to target the node body. Adjust the id or class used in the modules' css files
accordingly.

You can exclude the module's CSS on the configuration page to use your
customized theme's style.css.

File

README.txt
View source 
  1. Name: AutoFloat (autofloat)

  2. Author: Martin Postma ('lolandese', http://drupal.org/user/210402)

  3. Drupal: 6.x

  4. 

  5. 

  6. -- SUMMARY --

  7. 

  8. A text format filter that wraps images in a span with odd/even classes to make

  9. them float alternately left and right.

  10. 

  11. Configurable:

  12. * the starting side

  13. * exclude the module's CSS to use your theme's style.css 

  14. * add classes to target a 'span', e.g. in case a caption is displayed

  15. * add classes to exclude a 'div', e.g. a set of thumbnails. 

  16. 

  17. 

  18. -- EXAMPLE --

  19. 

  20. The filter turns:

  21.   ‹img src="/path/photo.jpg"›

  22. into:

  23.   ‹span class="autofloat-odd"›‹img src="/path/photo.jpg"›‹/span›

  24. 

  25. 

  26. -- FEATURES --

  27. 

  28. Generates an organized layout of images in a text automatically.

  29. 

  30. Easy for the less technical users.

  31. 

  32. Saves time.

  33. 

  34. Avoids inline styling.

  35. 

  36. Inserting images later doesn't mess up the alternating floating.

  37. 

  38. 

  39. -- INSTALLATION AND CONFIGURATION --

  40. 

  41. Extract the package in your modules directory, e.g. '/sites/all/modules'.

  42. 

  43. Enable the module under '/admin/modules'.

  44. 

  45. Add the autofloat filter to one of your text formats under 

  46. '/admin/settings/filters'. Put it below other image related filters in

  47. the 'Arrange' tab.

  48. 

  49. Configure under '/admin/settings/autofloat'.

  50. 

  51. Re-save existing nodes you want to apply AutoFloat to. If you still can't see

  52. any changes, try clearing both your site and browser cache as well.

  53. 

  54. 

  55. -- USAGE --

  56. 

  57. Images will float unless they have the class 'nofloat'.

  58. 

  59. A 'span' with the class 'float' will float the image and other containing 

  60. content, e.g. a caption under it.

  61. 

  62. Images in a 'div' with the class 'nofloat' do NOT float, e.g. a set of 

  63. thumbnails.

  64. 

  65. Avoid adding classes manually by defining classes added by other 

  66. modules/filters. Use your browser's inspector to find them.

  67. 

  68. The class 'nofloat' of a nested element has priority over classes set in the 

  69. parent, thus makes that the parent will not float.

  70. 

  71. Remember an element floats within the block-element containing it. If that 

  72. doesn't cover the full width, the image might not float as expected. 

  73. Check your CSS before submitting an issue.

  74. 

  75. 

  76. -- CSS --

  77. 

  78. The autofloat.css and autofloat-rtl.css files add a right-margin to left

  79. floating images and a left-margin to right floating images. 

  80. 

  81. If your images won't float your theme might not use the id or class "content"

  82. to target the node body. Adjust the id or class used in the modules' css files

  83. accordingly.

  84. 

  85. You can exclude the module's CSS on the configuration page to use your

  86. customized theme's style.css.