Advanced Setup
==============

.. _intro-addons:

Addons
------

You can install the following addons to extend the functionality of Juntagrico:

* `juntagrico-billing <https://github.com/juntagrico/juntagrico-billing>`_: create bills, send bills and manage payments.
* `juntagrico-custom-sub <https://github.com/juntagrico/juntagrico-custom-sub>`_: allow the user to select the amount of predefined products in his or her subscription.
* `juntagrico-assignment-request <https://github.com/juntagrico/juntagrico-assignment-request>`_: allow members to request assigments for jobs they have done, that were not announced.
* `juntagrico-godparent <https://github.com/juntagrico/juntagrico-godparent>`_: match new members with more experienced members that help them getting started in your cooperative.
* `juntagrico-pg <https://github.com/juntagrico/juntagrico-pg>`_: postgres database editor for admins.
* `juntagrico-badges <https://github.com/juntagrico/juntagrico-badges>`_: allows distributing virtual badges to members and group and organize them based on these.
* `juntagrico-crowdfunding <https://github.com/juntagrico/juntagrico-crowdfunding>`_: allows you to create (public) crowdfunding campaigns.
* `juntagrico-webdav <https://github.com/juntagrico/juntagrico-webdav>`_: include webdav folders in order to share files with your members.

The linked repositories contain additional information and installation instructions.


.. _intro-rich-text-editor:

Rich Text Editor
----------------

Juntagrico uses django-richtextfields.
You can find more information on the configuration options here https://pypi.org/project/django-richtextfield/

The examples below use the TinyMCE editor, which comes pre-installed with juntagrico. You may use any other editor.

.. _intro-richtext-mailer:

Mailer
^^^^^^

You can customize the rich text field in the mailer in the `settings.py` using:

.. code-block:: python

    from juntagrico import defaults

    DJRICHTEXTFIELD_CONFIG = defaults.richtextfield_config(LANGUAGE_CODE, mailer={
        # your configuration settings
    })


Admin Interface
^^^^^^^^^^^^^^^

The rich text editor in the admin interface allows formatting text of most descriptions, like the job descriptions,
entered through the admin interface,
This feature is disabled by default. Use the steps below to enable it.

.. warning::
    When the rich text editor is enabled, text, when saved, will be saved as HTML.
    Disabling the rich text editor will not convert the text back. The HTML has to be converted back manually.

.. note::
    When text from rich text fields is used in plain text emails the HTML tags need to be removed using the ``striptags`` filter.
    This is done in the default email templates. You will have to do it in your customized email texts as well.

To enable the rich text editor you have to modify the following setting.

.. code-block:: python

    from juntagrico import defaults

    DJRICHTEXTFIELD_CONFIG = defaults.richtextfield_config(LANGUAGE_CODE, use_in_admin=True)


Instead you can also pass your custom configuration to the `admin` argument.

.. code-block:: python

    DJRICHTEXTFIELD_CONFIG = defaults.richtextfield_config(LANGUAGE_CODE, admin={
        # your configuration settings
    })


.. _intro-custom-templates:

Custom Templates
----------------

Templates can be modified, e.g., to change texts or menu entries.
:ref:`See Templates Reference <reference-templates>`.

.. _intro-custom-code:

Custom Code
-----------

You can modify juntagrico with your own code. Use the provided :ref:`Hooks <reference-hooks>`, link to the emitted :ref:`Signals <reference-signals>` or create your own :ref:`Exports <reference-exports>`.

.. Warning::
    juntagrico may change in the future and you will have to maintain your changes accordingly.
    Instead of making complex modifications, try opening a feature request, to either get your modifications included in juntagrico or at least get an official hook to do your changes.

Modifications can be made, once all django apps have been loaded,
i.e. in the ``ready`` method of your app config in ``apps.py`` in the main folder of your project or addon:

.. code-block:: python

    from django.apps import AppConfig
    from juntagrico.util import addons

    class MyConfig(AppConfig):
        name = 'myapp'
        verbose_name = "My App"

        def ready(self):
            addons.config.register_user_menu('my_user_menu.html')
            # register other hooks
            # Add Monkey-Patches ..


.. _intro-modify-text-in-code:

Modifying Text in Code
^^^^^^^^^^^^^^^^^^^^^^

Some text is written directly into code instead of templates. These texts can be modified with :ref:`Custom Code <intro-custom-code>`.

.. code-block:: python

    def ready(self):
        # import the form to patch
        from juntagrico.forms import RegisterMemberForm
        # modify text variable (check the form implementation to see if this is available)
        RegisterMemberForm.text['accept_wo_docs']= 'I accept'
        # modify field labels of a ModelForm
        RegisterMemberForm.base_fields['phone'].label = 'Tel'
        # modify the text in a submit button
        old_init = RegisterMemberForm.__init__

        def my_init(self, *args, **kwargs):
            old_init(self, *args, **kwargs)
            self.helper.layout[-1].fields[0].value = 'Go'

        RegisterMemberForm.__init__ = my_init