Author: |
Creu Blanca,Odoo Community Association (OCA) |
License: |
LGPL-3 |
Branch: |
15.0 |
Repository: |
OCA/social |
Dependencies: |
base,
and
mail |
Languages: |
HTML (361, 57.6%),
JavaScript (136, 21.7%),
Python (19, 3.0%),
Sass (3, 0.5%),
XML (43, 6.9%),
and
reStructuredText (65, 10.4%) |
Other branches: |
12.0,
13.0,
13.0-ocabot-merge-pr-476-by-simahawk-bump-nobump,
14.0,
14.0-ocabot-merge-pr-708-by-dreispt-bump-nobump,
and
14.0-ocabot-merge-pr-708-by-etobella-bump-nobump |
Other repositories: |
ACCOMODATA-BVBA/social,
Change2improve/social,
CompassionCH/social,
Digital5-Odoo/social,
Dobtor-OCA/social,
ERPLibre/social,
ForgeFlow/social,
Gabinete-Digital/social,
Ingeos/social,
Jarsa/social,
NeatNerdPrime/social,
NextERP-Romania/social,
Rad0van/social,
SequarSrl/social,
SeuMarco/social,
StefanRijnhart/social,
Studio73/social,
TRESCLOUD/social,
Tecnativa/social,
Vauxoo/social,
aaltinisik/social,
acsone/social,
adhoc-dev/social,
agrista/odoo-social,
akretion/social,
anhvu-sg/social,
aurestic/social,
brain-tec/social,
camptocamp/social,
coopiteasy/social,
daramousk/social,
diggy128/social,
eLBati/social,
emagdalenaC2i/social,
focusate/oca-social,
grindtildeath/social,
hbrunn/social,
hibou-io/oca-social,
legalsylvain/social,
lincersolucoes/oca-social,
mozaik-association/social,
nilshamerlinck/social,
odoogap/social,
pegonzalezspesol/social,
sergiocorato/social,
simahawk/social,
skeller1/social,
steingabelgaard/social,
sunflowerit/social,
sygel-technology/social,
tafaRU/social,
takinobori/oca-social,
takobi-online/social,
tegin/social,
tirma-sa/social,
ursais/social,
versada/social,
and
xcgd/social |
<h1 class="title">Mail Preview</h1>
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/social/tree/15.0/mail_preview_base"><img alt="OCA/social" src="https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/social-15-0/social-15-0-mail_preview_base"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/205/15.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This module has two goals:</p>
<ul class="simple">
<li>Define a unique system for inheritance that will allow to introduce more
types for the preview.</li>
<li>Define a new widget that will allow to show the preview.</li>
</ul>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id4">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="usage"></a>
<h2 class="with-subtitle"><a class="toc-backref" href="#id1">Usage</a></h2>
<h2 class="section-subtitle" id="creating-a-new-preview-file"><span class="section-subtitle">Creating a new preview file</span></h2>
<p>You need to add the configuration in three places:</p>
<ul class="simple">
<li>Function <cite>_checkAttachment</cite> and <cite>_hasPreview</cite> from <cite>mail.DocumentViewer</cite> on
Javascript</li>
<li>Qweb template <cite>DocumentViewer.Content</cite></li>
</ul>
<p>To use this module, you need to:</p>
<ol class="arabic simple">
<li>Go to Settings > Technical > Attachments</li>
<li>Create attachment with image or pdf format</li>
<li>Show preview icon in "File content"</li>
</ol>
<p>As an example, you can check <cite>mail_preview_audio</cite>.</p>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id2">Bug Tracker</a></h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/social/issues">GitHub Issues</a>.
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
<a class="reference external" href="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**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id3">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id4">Authors</a></h3>
<ul class="simple">
<li>Creu Blanca</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id5">Contributors</a></h3>
<ul class="simple">
<li>Enric Tobella <<a class="reference external" href="mailto:etobella@creublanca.es">etobella@creublanca.es</a>></li>
<li><a class="reference external" href="https://www.tecnativa.com">Tecnativa</a>:<ul>
<li>Víctor Martínez</li>
</ul>
</li>
</ul>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id6">Maintainers</a></h3>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>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.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/social/tree/15.0/mail_preview_base">OCA/social</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
Dependency Graph