social/mail_preview_base
2022-02-17 15:24:00 +00:00
..
i18n [UPD] Update mail_preview_base.pot 2022-02-17 15:21:22 +00:00
readme [MIG] mail_preview_base: Migration to 14.0 2022-02-02 11:28:09 +05:30
static [UPD] README.rst 2022-02-17 15:24:00 +00:00
views [MIG] mail_preview_base: Migration to 14.0 2022-02-02 11:28:09 +05:30
__init__.py [ADD] mail_preview_base 2022-02-02 11:28:09 +05:30
__manifest__.py [MIG] mail_preview_base: Migration to 15.0 2022-02-03 14:45:04 +05:30
README.rst [UPD] README.rst 2022-02-17 15:24:00 +00:00

============
Mail Preview
============

.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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-LGPL--3-blue.png
    :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
    :alt: License: LGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github
    :target: https://github.com/OCA/social/tree/15.0/mail_preview_base
    :alt: OCA/social
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/social-15-0/social-15-0-mail_preview_base
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
    :target: https://runbot.odoo-community.org/runbot/205/15.0
    :alt: Try me on Runbot

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

This module has two goals:

*  Define a unique system for inheritance that will allow to introduce more
   types for the preview.
*  Define a new widget that will allow to show the preview.

**Table of contents**

.. contents::
   :local:

Usage
=====

Creating a new preview file
~~~~~~~~~~~~~~~~~~~~~~~~~~~

You need to add the configuration in three places:

* Function `_checkAttachment` and `_hasPreview` from `mail.DocumentViewer` on
  Javascript
* Qweb template `DocumentViewer.Content`

To use this module, you need to:

#. Go to Settings > Technical > Attachments
#. Create attachment with image or pdf format
#. Show preview icon in "File content"

As an example, you can check `mail_preview_audio`.

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 smashing it by providing a detailed and welcomed
`feedback <https://github.com/OCA/social/issues/new?body=module:%20mail_preview_base%0Aversion:%2015.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
~~~~~~~

* Creu Blanca

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

* Enric Tobella <etobella@creublanca.es>

* `Tecnativa <https://www.tecnativa.com>`_:

  * Víctor Martínez

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/15.0/mail_preview_base>`_ project on GitHub.

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