Update docs

Author: fsbraun

djangocms_frontend/common/bootstrap5/spacing.py

@@ -196,6 +196,7 @@ class Meta:
     margin_devices = DeviceChoiceField(
         label=_("Apply margin on device"),
         required=False,
+        initial=[size for size, _ in settings.DEVICE_CHOICES],
         help_text=_(
             "Select only devices on which the margin should be applied. On other devices "
             "larger than the first selected device the margin will be set to zero."
@@ -228,6 +229,7 @@ class Meta:
     padding_devices = DeviceChoiceField(
         label=_("Apply padding on device"),
         required=False,
+        initial=[size for size, _ in settings.DEVICE_CHOICES],
         help_text=_(
             "Select only devices on which the padding should be applied. On other devices "
             "larger than the first selected device the padding will be set to zero."

djangocms_frontend/component_base.py

@@ -50,6 +50,9 @@ class CMSFrontendComponent(forms.Form):
     _admin_form = None
     _model = None
     _plugin = None
+    META_FIELDS = ["is_local", "disable_edit", "disable_child_plugins", "show_plugin_add_form",
+                   "frontend_editable_fields", "link_fieldset_position", "require_parent",
+                   "parent_classes"]
 
     @classmethod
     def admin_form_factory(cls, **kwargs) -> type:
@@ -138,17 +141,17 @@ def plugin_factory(cls) -> type:
                     "module": getattr(cls._component_meta, "module", _("Components")),
                     "model": cls.plugin_model_factory(),
                     "form": cls.admin_form_factory(),
-                    "allow_children": getattr(cls._component_meta, "allow_children", False) or slots,
-                    "require_parent": getattr(cls._component_meta, "require_parent", False),
+                    "allow_children": slots or getattr(cls._component_meta, "allow_children", False),
                     "child_classes": getattr(cls._component_meta, "child_classes", []) + list(slots.keys()),
-                    "parent_classes": getattr(cls._component_meta, "parent_classes", []),
                     "render_template": getattr(cls._component_meta, "render_template", CMSUIPluginBase.render_template),
                     "fieldsets": getattr(cls, "fieldsets", cls._generate_fieldset()),
                     "change_form_template": "djangocms_frontend/admin/base.html",
                     "slots": slots,
-                    "frontend_editable_fields": getattr(cls._component_meta, "frontend_editable_fields", []),
                     "save_model": cls.save_model,
-                    "link_fieldset_position": getattr(cls._component_meta, "link_fieldset_position", 1),
+                    **{
+                        field: getattr(cls._component_meta, field) for field in cls.META_FIELDS
+                        if hasattr(cls._component_meta, field)
+                    },
                     **(
                         {
                             "get_render_template": cls.get_render_template,

djangocms_frontend/contrib/accordion/forms.py

@@ -76,6 +76,7 @@ class Meta:
 
     accordion_item_header = forms.CharField(
         label=_("Header"),
+        initial=_("New accordion item"),
         required=True,
     )
     accordion_item_open = forms.BooleanField(

djangocms_frontend/contrib/accordion/models.py

@@ -13,11 +13,8 @@ class Meta:
         proxy = True
         verbose_name = _("Accordion")
 
-    def get_children_count(self):
-        return self.cmsplugin_set.count()
-
     def get_short_description(self):
-        return _("({} entries)").format(self.get_children_count())
+        return _("({} entries)").format(len(self.child_plugin_instances or []))
 
 
 class AccordionItem(FrontendUIItem):

djangocms_frontend/contrib/utilities/cms_plugins.py

@@ -62,6 +62,7 @@ class HeadingPlugin(mixin_factory("Heading"), AttributesMixin, SpacingMixin, CMS
 
     render_template = "djangocms_frontend/heading.html"
     allow_children = True
+    is_local = False
 
     fieldsets = [
         (
@@ -129,6 +130,7 @@ class TOCPlugin(mixin_factory("TOC"), AttributesMixin, CMSUIPlugin):
 
     fieldsets = settings.EMPTY_FIELDSET
     edit_disabled = True
+    is_local = False
 
     def render(self, context, instance, placeholder):
         if hasattr(context["request"], "TOC"):

djangocms_frontend/helpers.py

@@ -26,7 +26,7 @@ def get_related_object(scope, field_name):
     try:
         Model = apps.get_model(scope[field_name]["model"])
         relobj = Model.objects.get(pk=scope[field_name]["pk"])
-    except (ObjectDoesNotExist, LookupError):
+    except (ObjectDoesNotExist, LookupError, TypeError):
         relobj = None
     return relobj
 

djangocms_frontend/templatetags/frontend.py

@@ -156,13 +156,17 @@ class Plugin(AsTag):
     )
 
     def message(self, message):
+        import warnings
+
+        warnings.warn(message, stacklevel=5)
         return f"<!-- {message} -->" if django_settings.DEBUG else ""
 
     def get_value(self, context, name, kwargs, nodelist):
         from djangocms_frontend.plugin_tag import plugin_tag_pool
 
         if name not in plugin_tag_pool:
-            return self.message(f'Plugin "{name}" not found in pool for plugins usable with {{% plugin %}}')
+            return self.message(f'To use "{name}" with the {{% plugin %}} template tag, add its plugin class to '
+                                f'the CMS_COMPONENT_PLUGINS setting')
         context.push()
         instance = plugin_tag_pool[name]["defaults"]
         plugin_class = plugin_tag_pool[name]["class"]

docs/source/components.rst

@@ -17,8 +17,7 @@ documentation.
 
 .. note::
 
-    Custom components can easily be added using the components contrib
-    package. For more information see :ref:`custom_components`.
+    Custom components can easily be added using :ref:`custom_components`.
 
 .. index::
     single: Accordion

docs/source/custom_components.rst

@@ -1,3 +1,5 @@
+.. _custom_components: Custom Components
+
 #################
 Custom Components
 #################

docs/source/getting_started.rst

@@ -445,12 +445,21 @@ otherwise. This is useful if you want use exactly the same markup for, say,
 buttons, links, the grid both in pages managed with django CMS and in
 other parts of your project without duplicating HTML code.
 
-This feature introduces a simple and flexible way to re-use djangocms-frontend
+This feature introduces a simple and flexible way to reuse django CMS
 plugins directly in templates without needing to create database entries for
 them. This allows developers to maintain clean, reusable, and dynamic
 components, such as buttons, cards, links, and more, while minimizing code
 repetition.
 
+.. note::
+
+    To make plugins available as components, ensure that the 
+    ``CMS_COMPONENT_PLUGINS`` setting in your project's ``settings.py`` 
+    includes the necessary plugin classes and their subclasses. This setting 
+    allows you to specify which plugins can be used directly in templates 
+    without creating database entries. To include all djangocms-frontend 
+    plugins, use ``djangocms_frontend.cms_plugins.CMSUIPlugin`` in the setting.
+
 To use a frontend plugin in a template you need to load the ``frontend`` tags
 and then use the ``plugin`` template tag to render a frontend plugin.