django-lite-cms-core
====================

.. toctree::
    :maxdepth: 4

.. warning::
    The docs is work in progress, so it is not completed by now and will
    be subject to change.

**django-lite-cms** is a lightweight and modular CMS addon for Django. This
package contains the core classes that are needed to get basic CMS properties.


Installation
------------

``django-lite-cms-core`` can be found on pypi. Run::

    pip install django-lite-cms-core

to install the package on your machine or in your virtual environment.


Dependencies
------------

If you install ``django-lite-cms-core`` the following modules will be
installed, because ``django-lite-cms-core`` depends on them:

- django-bootstrap5
    Currently the templates used in ``django-lite-cms-core`` use
    django-bootstrap5. You can avoid this dependency by overriding
    the templates to use none or another css framework.

- django-admin-sortable2
    The ``AdminOrderMixin`` is based on django-admin-sortable2. If you
    don't use the ordering, you can remove the dependency.

- django-tinymce
    django-tinymce provides the HTML field for the ``ContentFieldMixin``.

- django-filebrowser-no-grappelli
    The django-filebrowser-no-grappelli library provides the media
    management for the tinymce HTML field.

- Pillow
    Pillow is a dependency of django-filebrowser-no-grappelli


Settings
--------

``django-lite-cms-core`` doesn't need any specific settings. But most of
the dependencies need some settings. Please refer to the specific modules
documentation to get the settings docs:

- django-bootstrap5: https://django-bootstrap5.readthedocs.io/en/latest/settings.html

- django-tinymce: https://django-tinymce.readthedocs.io/en/latest/installation.html#configuration

- django-filebrowser-no-grappelli: https://django-filebrowser.readthedocs.io/en/latest/settings.html

.. note::
    django-filebrowser-no-grappelli doesn't provide any explicit documentation but refers to the
    django-filebrowser (with grappelli) version.


Getting Started
---------------

To integrate ``django-lite-cms-core`` with your site, follow the steps as listed:

1.  Add this application in the ``INSTALLED_APPS`` portion of your settings
    file. Your settings file will look something like::

        INSTALLED_APPS = (
            # ...
            'lite_cms_core',
        )

2.  Add the lite_cms_core urls to the end of your root urlconf. Your urlconf
    will look something like::

        urlpatterns = [
            # ...
            path('lite_cms_core/', include('lite_cms_core.urls')),
        ]

.. note::
    You need to include the url patterns ony if you want to use the search functionality.

To make use of the classes create a model that inhertits from them like this::

    class BlogPost(ContentFieldMixin, TimeStampedMixin, SluggedMixin, BaseEntity):
        """
        A blog post.
        """

        class Meta:
            verbose_name = _("Blog post")
            verbose_name_plural = _("Blog posts")
            ordering = ("-created",)

        def __str__(self):
            return self.title

        author = models.ForeignKey(
            User, verbose_name=_('Author'), on_delete=models.PROTECT
        )
        categories = models.ManyToManyField(
            "BlogCategory", verbose_name=_("Categories"),
            blank=True, related_name="blogposts"
        )

        # Specify the fields for searching
        search_fields = {"title", "content"}

        def get_absolute_url(self):
            return reverse('blog:blogpost-detail', args=[str(self.slug)])

Model Classes
-------------

.. automodule:: lite_cms_core.models
    :members:

Model Managers
--------------

.. automodule:: lite_cms_core.managers
    :members:

Views
-----

.. automodule:: lite_cms_core.views
    :members:

Template Tags
-------------

.. automodule:: lite_cms_core.templatetags.base_tags
    :members:

Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`