You are here

Home » API reference » Caption Filter 7

README.txt in Caption Filter 7

Same filename and directory in other branches
  1. 6 README.txt
  2. 7.2 README.txt
Caption Filter is a module that converts WordPress-style [caption] tags into
HTML markup. It also allows floating images left or right in a way that avoids
allowing users access to "style" attributes, moving both the image and the
caption at the same time.

Installation
------------

1. Enable the module on the modules page.

2. Go to the admin/config/content/formats page and enable the "Caption filter"
   to the text format(s) that should be allowed to use this filter.

3. IMPORTANT: After enabling the fitler, check the "Filter processing order"
   section within the input format configuration. Make sure that the "Caption
   filter" is run AFTER the "HTML filter" (if enabled). Generally having the
   Caption filter as the last filter run will be appropriate.

Usage
-----

While entering content, choose an input format that utilizes the caption filter.
In a plain textarea, the entered code should look like this:

A simple caption:
[caption caption="This is an image caption"]<img src="" alt="" />[/caption]

Aligned Caption (can be left, center or right):
[caption caption="This is a right aligned caption" align="right"]<img src="" alt="" />[/caption]

File

README.txt
View source 
  1. Caption Filter is a module that converts WordPress-style [caption] tags into

  2. HTML markup. It also allows floating images left or right in a way that avoids

  3. allowing users access to "style" attributes, moving both the image and the

  4. caption at the same time.

  5. 

  6. Installation

  7. ------------

  8. 

  9. 1. Enable the module on the modules page.

  10. 

  11. 2. Go to the admin/config/content/formats page and enable the "Caption filter"

  12.    to the text format(s) that should be allowed to use this filter.

  13. 

  14. 3. IMPORTANT: After enabling the fitler, check the "Filter processing order"

  15.    section within the input format configuration. Make sure that the "Caption

  16.    filter" is run AFTER the "HTML filter" (if enabled). Generally having the

  17.    Caption filter as the last filter run will be appropriate.

  18. 

  19. Usage

  20. -----

  21. 

  22. While entering content, choose an input format that utilizes the caption filter.

  23. In a plain textarea, the entered code should look like this:

  24. 

  25. A simple caption:

  26. [caption caption="This is an image caption"][/caption]

  27. 

  28. Aligned Caption (can be left, center or right):

  29. [caption caption="This is a right aligned caption" align="right"][/caption]