agree on and document a naming convention for plugin models and classes

Especially for beginners it can be very confusing if the plugin model and the plugin base have the same name. And problems like http://stackoverflow.com/questions/20334029/django-app-cannot-assign-imagetext-link-must-be-a-link-instance arise, which could be avoided if we have one naming standard. Since we don’t have a recommended, documented way of doing things there are all sorts of variations out in the wild.

Naming proposition

Plugin Models (models.py):

from cms.models import CMSPlugin
class TextPlugin(CMSPlugin):
    title = models.CharField(max_length=255)
    body = models.TextField(blank=True, default='')

Plugins (cms_plugins.py):

from cms.plugin_base import CMSPluginBase
class Text(CMSPluginBase):
    model = TextPlugin
    render_template = '....'

[jakob-o]

Hey,

I checked our code base and we use MyPlugin and MyPluginModel for the plugin and it’s plugin model respectively. It may not be too beautiful, but it is clear what is meant when you are talking about the concepts of plugin and plugin model which where introduced and will likely stick around. So for anyone who does not know the documentation by heart it is impossible to deduce whether the CMS prefix is identifying the plugin or it’s model. So for the sake of simplicity and clarity I would prefer the Plugin and PluginModel suffixes over any other. Think of all the time and pain saved for sacrificing the a-model-suffix-is-not-beautiful argument.

My two cents

Jakob

[stale[bot]]

This will now be closed due to inactivity, but feel free to reopen it.