social/mail_activity_form

===============================
Simple forms in mail activities
===============================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:a913b625ad92591c55f7ef6e888b40e845d2fcf04e01461eb8e43b591a602dda
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github
    :target: https://github.com/OCA/social/tree/13.0/mail_activity_form
    :alt: OCA/social
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/social-13-0/social-13-0-mail_activity_form
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/social&target_branch=13.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module allows you to provide some markup in the ``default_description``
field of ``mail.activity.type``, which makes some portions of the ``note``
field of resulting ``mail.activity`` records editable and others computed.

With this, you can implement form based workflows where you have to fill in
certain forms at certain times, and have to prove later what you filled in
when as mail activities, while still being able to access the data filled
in programmatically afterwards.

**Table of contents**

.. contents::
   :local:

Usage
=====

This module adds some attributes that can be used in the
``default_description`` field of ``mail.activity.type``:

data-form-id
    A name used to refer to the content of this node afterwards
data-form-type
    One of 'float', 'int', 'str'
data-form-editable
    Only nodes marked with this attribute may be edited in activities
data-form-compute
    An expression to evaluate, ``object`` can be used to access values of the
    object the activity is attached to, and ``activity`` for the activity
    itself

Note that the above implies that you shouldn't use ``object`` and ``activity``
in the ``data-form-id`` attribute.

Known issues / Roadmap
======================

* client side support for editing attributes without switching to the source code view
* client side support for blocking edits to non-editable nodes
* client side support for updating computed nodes on input
* better error messages for wrong types/names

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/social/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/social/issues/new?body=module:%20mail_activity_form%0Aversion:%2013.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
~~~~~~~

* Hunki Enterprises BV

Contributors
~~~~~~~~~~~~

* Holger Brunn <mail@hunki-enterprises.com>

Maintainers
~~~~~~~~~~~

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

This module is part of the `OCA/social <https://github.com/OCA/social/tree/13.0/mail_activity_form>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.