https://github.com/collective/collective.bbcodesnippets

Provides pervasive, generic and extensible BBCode markup integration for Plone.
https://github.com/collective/collective.bbcodesnippets

Last synced: 8 days ago
JSON representation

Provides pervasive, generic and extensible BBCode markup integration for Plone.

• Host: GitHub
• URL: https://github.com/collective/collective.bbcodesnippets
• Owner: collective
• License: other
• Created: 2021-02-22T11:35:09.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-11-28T08:09:44.000Z (12 months ago)
• Last Synced: 2024-10-06T07:08:53.350Z (about 1 month ago)
• Language: Python
• Size: 153 KB
• Stars: 1
• Watchers: 10
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE.rst

Awesome Lists containing this project

• awesome-plone - collective.bbcodesnippets - Provides generic and extensible BBCode markup integration for Plone. (Content and utilities for content)

README

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

Functionality

=============

*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``.

Installation

------------

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.

Source Code

===========

.. image:: https://github.com/collective/collective.bbcodesnippets/actions/workflows/tests.yaml/badge.svg

    :target: https://github.com/collective/collective.bbcodesnippets/actions/workflows/tests.yaml

    :alt: Build and Test

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.

Contributors

============

- `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.