2silver / collective.bbcodesnippets Goto Github PK

collective.bbcodesnippets provides pervasive, generic and extensible BBCode Markup integration for Plone.

collective.bbcodesnippets replaces BBCode in the whole generated HTML output. BBCode snippets can be placed everywhere in the site.

At transform time at the end of the chain, before or after Diazo (configurable), the output is parsed and all BBCode will be replaced.

The BBCode parser only replaces configured BBCode snippets. At the control panel all registered BBCodes are listed to be activated. By default all codes are inactive.

This package utilizes the excellent bbcode package from Dan Watson to parse and replace. We register all default formatters as named utilities which are used as factories for the formatter using the Zope Component Architecture (ZCA). Custom parsers can be provided by registering an own named utility. Before parsing at transform time new Parser is created using the configured adapters only.

Further features:

• The Plone toolbar got a new menu to copy BBCode templates for the active BBCodes.
• TinyMCE got a new menu to insert BBCode templates.
• There is a demo page with all activated BBCodes at the portal root under @@bbcodesnippets-demo.
• A boolean index has_bbcodes got added to the portal_catalog. Content with active or inactive BBCcodes in any of their text or richtext Dexterity schema fields are indexed True.

Install collective.bbcodesnippets by adding it to your buildout:

[buildout]

...

eggs =
    collective.bbcodesnippets

and then running buildout.

Afterwards (re)start Plone, go to the controlpanel and install the addon.

Then there is a conrol-panel to control the allowed BBcodes.

The sources are in a GIT DVCS with its main branches at github.

We'd be happy to see many forks and pull-requests to make collective.bbcodesnippets even better.

• Jens W. Klein, Klein & Partner KG- Author
• Michael Graf, FH St.Pölten - Idea and Use Case

Thanks to St. Pölten University of Applied Sciences for initial funding.