Update docs

Author: fsbraun

docs/source/how-to/add-tab-style.rst

@@ -1,7 +1,7 @@
 How to add the tab editing style to your custom plugins
 =======================================================
 
-If you prefer the tabbed frontend editing style of **djangocms-frontend** you can easily
+If you prefer the tabbed frontend editing style of ``djangocms-frontend`` you can easily
 add it to your own plugins.
 
 If you use the standard editing form, just add a line specifying the

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

@@ -1,8 +1,10 @@
-********************************
- How to extend existing plugins
-********************************
+.. _how-to-extend-frontend-plugins:
 
-Existing plugins can be extended through two type of class mixins.
+**********************************
+ How to extend built-in components
+**********************************
+
+Existing components can be extended through two type of class mixins.
 ``djangocms-frontend`` looks for these mixins in two places:
 
 #. In the theme module. Its name is specified by the setting
@@ -158,7 +160,7 @@ Next, you add some fields to the ``GridContainerForm`` (in
     If you need to add many form mixins, consider turning ``forms.py`` into a
     package, i.e. create a directory ``forms`` and distribute the mixins over
     several files, e.g., ``forms/marketing_forms.py`` etc., and importing the
-    all mixins relevant to **djangocms-frontend** into the directory's
+    all mixins relevant to ``djangocms-frontend`` into the directory's
     ``__init__.py``.
 
 Rendering should be done with the Bootstrap 5 framework. Hence all rendering
@@ -294,14 +296,14 @@ With these three additions, all grid container plugins will now have
 additional fields to define background images to cover the container
 area.
 
-If the theme is taken out of the path djangocms-frontend will fall back
+If the theme is taken out of the path ``djangocms-frontend`` will fall back
 to its basic functionality, i.e. the background images will not be
 shown. As long as plugins are not edited the background image
 information will be preserved.
 
 .. note::
 
-    A few suggestions on extending **djangocms-frontend**:
+    A few suggestions on extending ``djangocms-frontend``:
 
     *   You may think of customizing bootstrap by including a folder ``sass`` in
         your theme app. For more see `Bootstrap 5 documentation on customizing

docs/source/how-to/inline-editing.rst

@@ -1,8 +1,8 @@
 .. _inline_editing_custom_components:
 
-################################################
-How to Use Inline Editing with Custom Components
-################################################
+#########################################################
+How to Use Inline Editing with Custom Frontend Components
+#########################################################
 
 .. versionadded:: 2.0
 
@@ -17,7 +17,7 @@ template tag to enable inline editing for your custom frontend components.
 
 
 Understanding the ``inline_field`` Template Tag
-=============================================
+===============================================
 
 The ``inline_field`` template tag allows you to make specific fields editable directly from
 the page. It works by wrapping a field in an inline editing context, which is recognized by
@@ -41,15 +41,15 @@ If not in edit mode the template tag will render the field as plain text.
     the ``frontend_editable_fields`` property of the plugin. The tag itself is a shortcut
     for django CMS's ``render_model`` tag. Since django CMS 5, this tags works for all
     CMS plugins (and not only for third-party models). For earlier versions of django CMS
-    djangocms-frontend includes a custom extension for frontend plugins to support inline editing.
+    ``djangocms-frontend`` includes a custom extension for frontend plugins to support inline editing.
 
 
-Step-by-Step: Adding Inline Editing to a Custom Component
+Step-by-Step: Adding Inline Editing to a custom frontend component
 =========================================================
 
 1. **Define Your Custom Component Plugin**
 
-   First, create a djangoCMS plugin for your custom component. Example:
+   First, create a djangoCMS plugin for your custom frontend component. Example:
 
    .. code-block:: python
 
@@ -102,7 +102,7 @@ Step-by-Step: Adding Inline Editing to a Custom Component
         python manage.py runserver
 
    - Log in as an admin user and enter **Edit Mode**.
-   - Add your custom component to a page.
+   - Add your custom frontend component to a page.
    - Click on the text fields to edit them inline.
    - Leave the field, and changes will be stored automatically in the database.
 
@@ -112,5 +112,5 @@ Additional Considerations
 
 - **Rich Text Editing:** If the field is a ``HTMLField``, django CMS text will automatically use
   a rich text editor for inline editing.
-- **CSS & JavaScript Adjustments:** In rare cases custom component's styles can interfere
+- **CSS & JavaScript Adjustments:** In rare cases custom frontend component's styles can interfere
   with django CMS text's inline editing interface. More specific rules typically solve the issue.

docs/source/how-to/internal-link-targets.rst

@@ -4,13 +4,13 @@
  How to add internal link targets outside the CMS
 **************************************************
 
-As of version 2 of **djangocms-frontend**, the link/button plugin builds upon
+As of version 2 of ``djangocms-frontend``, the link/button plugin builds upon
 the ``LinkFormField`` of djangocms-link. djangocms-link uses Django admin to
 autodetect linkable models. This means that any model that has a
 ``get_absolute_url()`` method and a ``search_fields`` attribute in its
 ``ModelAdmin`` will be available as an internal link target.
 
-The ``DJANGOCMS_FRONTEND_LINK_MODELS`` setting in djangocms-frontend before
+The ``DJANGOCMS_FRONTEND_LINK_MODELS`` setting in ``djangocms-frontend`` before
 version 2 does not have any effect anymore.
 
 See the README file of `djangocms-link <https://github.com/django-cms/djangocms-link/blob/master/README.rst>`_

docs/source/how-to/migrate-3rd-party-plugins.rst

@@ -2,7 +2,7 @@ How to migrate other plugin packages
 ====================================
 
 The management command ``migrate`` converts any plugin from **djangocms_bootstrap4** and
-**djangocms_styled_link** to **djangocms-frontend**. This behaviour can be extended
+**djangocms_styled_link** to ``djangocms-frontend``. This behaviour can be extended
 adding custom migratation modules to the ``DJANGOCMS_FRONTEND_ADDITIONAL_MIGRATIONS``
 setting.
 

docs/source/how-to/migrate-bootstrap4.rst

@@ -35,7 +35,7 @@ plugins.
    Please do **back up** your database before you do run the management
    command!
 
-For this to work, the both the djangocms-frontend **and** the
+For this to work, the both the ``djangocms-frontend`` **and** the
 djangocms-bootstrap4 apps need to be included in ``INSTALLED_APPS``.
 
 .. warning::

docs/source/how-to/use-frontend-as-component.rst

@@ -6,7 +6,7 @@ How to use frontend plugins as components in templates
 
 .. versionadded:: 2.0
 
-The plugins of **djangocms-frontend** can be used as components in your
+The plugins of ``djangocms-frontend`` can be used as components in your
 templates - even in apps that do not use or integrate with django CMS
 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
@@ -26,7 +26,7 @@ repetition.
     allows you to specify which plugins can be used directly in templates
     without creating database entries.
 
-    * To include all djangocms-frontend plugins, use
+    * To include all ``djangocms-frontend`` plugins, use
       ``djangocms_frontend.cms_plugins.CMSUIPlugin`` in the setting.
 
     * To include all :ref:`custom_components`, use
@@ -86,7 +86,7 @@ use the ``{% plugin %}`` template tag with each plugin.
 
 .. note::
 
-    While this is designed for **djangocms-frontend** plugins primarily, it
+    While this is designed for ``djangocms-frontend`` plugins primarily, it
     will work with many other django CMS plugins.
 
     Since no plugins are created in the database, plugins relying on their

docs/source/index.rst

@@ -20,7 +20,7 @@ and templates.
  Key features
 **************
 
-* **Effortless Development of Custom Components**: Create reusable frontend
+* **Effortless Development of Custom Frontend Components**: Create reusable frontend
   components with ease, utilizing simple templates and declarative form
   classes. These components can function both as CMS plugins and within
   standard Django templates. ​
@@ -34,7 +34,7 @@ and templates.
   of Bootstrap 5 components, streamlining the process of building responsive
   and modern interfaces. ​
 
-* **Extensibility**: Enhance your project by creating custom components with
+* **Extensibility**: Enhance your project by creating custom frontend components with
   minimal code. The system is designed to be extended both within individual
   projects and through separate theme applications. ​
 
@@ -56,7 +56,7 @@ updates to frontend features.
 By providing a suite of Bootstrap 5-based components for layout structuring,
 including grids, components, and forms, django CMS Frontend simplifies the
 process of building responsive and structured page designs. Developers can
-also create custom components with minimal code, ensuring a consistent and
+also create custom frontend components with minimal code, ensuring a consistent and
 efficient development experience.
 
 It is up to you which (if any at all) pre-built components you want to include

docs/source/plugins/common.rst

@@ -5,7 +5,7 @@
  Common plugin settings
 ########################
 
-**djangocms-frontend** offers a set of plugins to allow for an easy and clean
+``djangocms-frontend`` offers a set of plugins to allow for an easy and clean
 structure of your CMS contents.
 
 All plugins are listed in the section "Frontend" when adding a plugin to
@@ -75,7 +75,7 @@ to render the element. You may also add attributes like additional classes as a
     Using the advanced tab requires some technical knowledge on the sites
     installation, e.g., what css classes are available. This is why the advanced
     settings tab should only be used rarely. If you find yourself using it
-    regularly, extending **djangocms-frontend** using a theme might be the more
+    regularly, extending ``djangocms-frontend`` using a theme might be the more
     editor-friendly and more maintainable solution.
 
 The advanced tab label carries a blue-ish dot to indicate that attributes are

docs/source/plugins/components.rst

@@ -88,7 +88,7 @@ documentation.
 Re-usable component example
 ===========================
 
-**djangocms-frontend** plugins can be used as components. They can be
+``djangocms-frontend`` plugins can be used as components. They can be
 used in all your project's templates. Example (if key word arguments are
 skipped they fall back to their defaults):
 
@@ -121,7 +121,7 @@ documentation.
 Re-usable component example
 ===========================
 
-**djangocms-frontend** plugins can be used as components. They can be
+``djangocms-frontend`` plugins can be used as components. They can be
 used in all your project's templates. Example (if key word arguments are
 skipped they fall back to their defaults):
 
@@ -207,7 +207,7 @@ documentation.
 Re-usable component example
 ===========================
 
-**djangocms-frontend** plugins can be used as components. They can be
+``djangocms-frontend`` plugins can be used as components. They can be
 used in all your project's templates. Example (if key word arguments are
 skipped they fall back to their defaults):
 
@@ -256,7 +256,7 @@ specified using the ``DJANGOCMS_FRONTEND_CAROUSEL_TEMPLATES`` setting.
 Re-usable component example
 ===========================
 
-**djangocms-frontend** plugins can be used as components. They can be
+``djangocms-frontend`` plugins can be used as components. They can be
 used in all your project's templates. Example (if key word arguments are
 skipped they fall back to their defaults):
 
@@ -347,7 +347,7 @@ If targets are deleted the link will fallback to regular text.
 Re-usable component example
 ===========================
 
-**djangocms-frontend** plugins can be used as components. They can be
+``djangocms-frontend`` plugins can be used as components. They can be
 used in all your project's templates. Example (if key word arguments are
 skipped they fall back to their defaults):
 
@@ -400,7 +400,7 @@ Media component
 ***************
 
 The media component is another legacy component from djangocms-bootstrap4.
-**djangocms-frontend** recreates it using responsive utilities.
+``djangocms-frontend`` recreates it using responsive utilities.
 
 
 .. index::
@@ -421,7 +421,7 @@ well as responsive embedding of external pictures.
    djangocms-text-ckeditor supports dragging and dropping images into a rich
    text field. If you add the following line to your `settings.py` file,
    djangocms-text-ckeditor will automatically convert an image dropped into it
-   to a djangocms-frontend image component.
+   to a ``djangocms-frontend`` image component.
 
    .. code-block::
 
@@ -475,7 +475,7 @@ Code component
 **************
 
 Have code snippets on your site using this plugin, either inline or as a code block.
-djangocms-frontend offers the `ace code editor <https://ace.c9.io>`_
+``djangocms-frontend`` offers the `ace code editor <https://ace.c9.io>`_
 to enter code bits.
 
 .. warning::
@@ -516,7 +516,7 @@ Tabs component
 Re-usable component example
 ===========================
 
-**djangocms-frontend** plugins can be used as components. They can be
+``djangocms-frontend`` plugins can be used as components. They can be
 used in all your project's templates. Example (if key word arguments are
 skipped they fall back to their defaults):