Skip to content

Commit bcb5c65

Browse files
authored
Improve clarity in extend-frontend-plugins documentation
Updated formatting and wording for clarity in the documentation on extending frontend plugins.
1 parent 306c218 commit bcb5c65

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/source/how-to/extend-frontend-plugins.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@
44
How to extend built-in components
55
**********************************
66

7-
Existing components can be extended through two type of class mixins.
8-
``djangocms-frontend`` looks for these mixins in two places:
7+
Existing components can be extended through **two type of class mixins**.
8+
``djangocms-frontend`` tries to autodiscover them by looking for these mixins
9+
in two places:
910

1011
#. In the theme module. Its name is specified by the setting
1112
``DJANGOCMS_FRONTEND_THEME`` and defaults to ``theme``.
@@ -32,7 +33,7 @@ The framework module is primarily thought to allow for adaptation of
3233
RenderMixins
3334
============
3435

35-
The render mixins are called "``*PluginName*RenderMixin``", e.g.
36+
The render mixins are called "``<PluginName>RenderMixin``", e.g.
3637
``AlertRenderMixin`` and are applied to the plugin class. This allows
3738
for the redefinition of the ``CMSPlugin.render`` method, especially to
3839
prepare the context for rendering.
@@ -51,7 +52,7 @@ Form mixins are used to add fields to a plugin's admin form. These
5152
fields are available to the render mixins and, of course, to the plugin
5253
templates.
5354

54-
Form mixins are called "``*PluginName*FormMixin``", e.g. ``AlertFormMixin`` and are
55+
Form mixins are called "``<PluginName>FormMixin``", e.g. ``AlertFormMixin`` and are
5556
applied to the editing form class. Form mixins are a subclass of
5657
``entangled.EntangledModelFormMixin``.
5758

@@ -62,8 +63,8 @@ applied to the editing form class. Form mixins are a subclass of
6263
single: Create a theme
6364
single: Themes
6465

65-
Working example
66-
===============
66+
Working example: Extending the ``GridContainerPlugin``
67+
======================================================
6768

6869
Let's say you wanted to extend the ``GridContainerPlugin`` to offer the
6970
option for a background image, and say a blur effect. The way to do it
@@ -313,6 +314,5 @@ information will be preserved.
313314
import ``CMSUIPlugin`` (import from ``djangocms_frontend.cms_plugins``)
314315
as base class for the plugins.
315316

316-
* Create ``models.py``
317-
file for the models (which need to be proxy models of ``FrontendUIItem``
318-
(import from ``djangocms_frontend.models``).
317+
* Create ``models.py`` file for the models (which need to be proxy models
318+
of ``FrontendUIItem`` (import from ``djangocms_frontend.models``).

0 commit comments

Comments
 (0)