You are here

README.txt in Extensible BBCode 7

Same filename and directory in other branches
  1. 8 README.txt
  2. 8.2 README.txt
  3. 5 README.txt
  4. 6 README.txt
-- SUMMARY --

The Extensible BBCode provides a BBCode parser that can be extended
with custom tag macros. If you install it on your Drupal site, 
it will create a text format 
named "BBCode" that can generate HTML out of user-entered text markup like this:

    This text is [b]bold[/b] and [i]italic[/i].

Activating the "Basic" submodule will add the most commonly available 
markup tags. Beyond that, it is also possible to create new tags
that either generate static output or use PHP code to determine how
the tag is rendered.

-- REQUIREMENTS --

None. However, the core PHP module must be enabled in order to create
tags that use PHP code.

-- UPGRADING FROM BBCODE MODULE --

The BBCode module (https://drupal.org/project/bbcode) provides a subset of
Extensible BBCode's functionality. To upgrade from BBCode to Exensible BBCode:

  * Enable the "xbbcode" and "xbbcode_basic" modules via Drush, or both the
    "Extensible BBCode" and "Basic Tags" modules via the admin/modules page.
  * Go through the text filters and find ones that previously used BBCode.
    * On these text filters, enable the "Extensible BBCode" filter.
    * Sort the "Extensible BBCode" filter so it is either directly before or
      directly after the "Convert BBCode to HTML" filter.
    * It may be worthwhile enabling the "Automatically close tags left open at
      the end of the text" setting.
    * Disable the "Convert BBCode to HTML" filter.
  * If Features is being used, export the text format settings again.
  * Do not disable the BBCode module until the new filters have been activated.

This will not provide a 100% functionality match, but should be close enough for
the majority of sites.

File

README.txt
View source
  1. -- SUMMARY --
  2. The Extensible BBCode provides a BBCode parser that can be extended
  3. with custom tag macros. If you install it on your Drupal site,
  4. it will create a text format
  5. named "BBCode" that can generate HTML out of user-entered text markup like this:
  6. This text is [b]bold[/b] and [i]italic[/i].
  7. Activating the "Basic" submodule will add the most commonly available
  8. markup tags. Beyond that, it is also possible to create new tags
  9. that either generate static output or use PHP code to determine how
  10. the tag is rendered.
  11. -- REQUIREMENTS --
  12. None. However, the core PHP module must be enabled in order to create
  13. tags that use PHP code.
  14. -- UPGRADING FROM BBCODE MODULE --
  15. The BBCode module (https://drupal.org/project/bbcode) provides a subset of
  16. Extensible BBCode's functionality. To upgrade from BBCode to Exensible BBCode:
  17. * Enable the "xbbcode" and "xbbcode_basic" modules via Drush, or both the
  18. "Extensible BBCode" and "Basic Tags" modules via the admin/modules page.
  19. * Go through the text filters and find ones that previously used BBCode.
  20. * On these text filters, enable the "Extensible BBCode" filter.
  21. * Sort the "Extensible BBCode" filter so it is either directly before or
  22. directly after the "Convert BBCode to HTML" filter.
  23. * It may be worthwhile enabling the "Automatically close tags left open at
  24. the end of the text" setting.
  25. * Disable the "Convert BBCode to HTML" filter.
  26. * If Features is being used, export the text format settings again.
  27. * Do not disable the BBCode module until the new filters have been activated.
  28. This will not provide a 100% functionality match, but should be close enough for
  29. the majority of sites.