<h1 class="title">Multiple images base</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/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-tools/tree/15.0/base_multi_image"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-tools-15-0/server-tools-15-0-base_multi_image"><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/149/15.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p> <p>This module extends the functionality of any model to support multiple images (a gallery) attached to it and allow you to manage them.</p> <p><strong>Table of contents</strong></p> <div class="contents local topic" id="contents"> <ul class="simple"> <li><a class="reference internal" href="#installation" id="id1">Installation</a></li> <li><a class="reference internal" href="#configuration" id="id2">Configuration</a></li> <li><a class="reference internal" href="#development" id="id3">Development</a></li> <li><a class="reference internal" href="#known-issues-roadmap" id="id4">Known issues / Roadmap</a></li> <li><a class="reference internal" href="#bug-tracker" id="id5">Bug Tracker</a></li> <li><a class="reference internal" href="#credits" id="id6">Credits</a><ul> <li><a class="reference internal" href="#authors" id="id7">Authors</a></li> <li><a class="reference internal" href="#contributors" id="id8">Contributors</a></li> <li><a class="reference internal" href="#other-credits" id="id9">Other credits</a></li> <li><a class="reference internal" href="#maintainers" id="id10">Maintainers</a></li> </ul> </li> </ul> </div> <a name="installation"></a> <h2><a class="toc-backref" href="#id1">Installation</a></h2> <p>This module adds abstract models to work on. Its sole purpose is to serve as base for other modules that implement galleries, so if you install this one manually you will notice no change. You should install any other module based on this one and this will get installed automatically.</p> <a name="configuration"></a> <h2><a class="toc-backref" href="#id2">Configuration</a></h2> <p>To manage all stored images, you need to:</p> <ul class="simple"> <li>Go to <em>Settings &gt; Technical &gt; Multi images</em>.</li> </ul> <p>... but you probably prefer to manage them from the forms supplied by submodules that inherit this behavior.</p> <a name="development"></a> <h2><a class="toc-backref" href="#id3">Development</a></h2> <p>To develop a module based on this one:</p> <ul> <li><p class="first">See module <code>product_multi_image</code> as an example.</p> </li> <li><p class="first">You have to inherit model <code>base_multi_image.owner</code> to the model that needs the gallery:</p> <pre> <code>class MyOwner(models.Model): _name = &quot;my.model.name&quot; _inherit = [&quot;my.model.name&quot;, &quot;base_multi_image.owner&quot;] # If you need this, you will need ``pre_init_hook_for_submodules`` and ``uninstall_hook_for_submodules`` as detailed below. old_image_field = fields.Binary(related=&quot;image_main&quot;, store=False)</code> </pre> </li> <li><p class="first">Somewhere in the owner view, add:</p> <pre> <code>&lt;field name=&quot;image_ids&quot; nolabel=&quot;1&quot; context=&quot;{ 'default_owner_model': 'my.model.name', 'default_owner_id': id, }&quot; mode=&quot;kanban&quot;/&gt;</code> </pre> </li> <li><p class="first">If the model you are extending already had an image field, and you want to trick Odoo to make those images to multi-image mode, you will need to make use of the provided <cite>~.hooks.pre_init_hook_for_submodules</cite> and <cite>~.hooks.uninstall_hook_for_submodules</cite>, like the <code>product_multi_image</code> module does:</p> <pre> <code>try: from odoo.addons.base_multi_image.hooks import ( pre_init_hook_for_submodules, uninstall_hook_for_submodules, ) except ImportError: pass def pre_init_hook(cr): &quot;&quot;&quot;Transform single into multi images.&quot;&quot;&quot; pre_init_hook_for_submodules(cr, &quot;product.template&quot;, &quot;image&quot;) pre_init_hook_for_submodules(cr, &quot;product.product&quot;, &quot;image_variant&quot;) def uninstall_hook(cr, registry): &quot;&quot;&quot;Remove multi images for models that no longer use them.&quot;&quot;&quot; uninstall_hook_for_submodules(cr, registry, &quot;product.template&quot;) uninstall_hook_for_submodules(cr, registry, &quot;product.product&quot;)</code> </pre> </li> </ul> <a class="reference external image-reference" href="https://runbot.odoo-community.org/runbot/149/10.0"><img alt="Try me on Runbot" src="https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas" /></a> <a name="known-issues-roadmap"></a> <h2><a class="toc-backref" href="#id4">Known issues / Roadmap</a></h2> <ul class="simple"> <li><em>OS file</em> storage mode for images is meant to provide a path where Odoo has read access and the image is already found, <strong>not for making the module store images there</strong>. It would be nice to add that feature though.</li> </ul> <a name="bug-tracker"></a> <h2><a class="toc-backref" href="#id5">Bug Tracker</a></h2> <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/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/server-tools/issues/new?body=module:%20base_multi_image%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="#id6">Credits</a></h2> <a name="authors"></a> <h3><a class="toc-backref" href="#id7">Authors</a></h3> <ul class="simple"> <li>Tecnativa</li> <li>Antiun Ingeniería</li> <li>S.L.</li> <li>Sodexis</li> <li>LasLabs</li> </ul> <a name="contributors"></a> <h3><a class="toc-backref" href="#id8">Contributors</a></h3> <ul class="simple"> <li>Pedro M. Baeza &lt;<a class="reference external" href="mailto:pedro.baeza&#64;serviciosbaeza.com">pedro.baeza&#64;serviciosbaeza.com</a>&gt;</li> <li>Rafael Blasco &lt;<a class="reference external" href="mailto:rafabn&#64;antiun.com">rafabn&#64;antiun.com</a>&gt;</li> <li>Jairo Llopis &lt;<a class="reference external" href="mailto:yajo.sk8&#64;gmail.com">yajo.sk8&#64;gmail.com</a>&gt;</li> <li>Sodexis &lt;<a class="reference external" href="mailto:dev&#64;sodexis.com">dev&#64;sodexis.com</a>&gt;</li> <li>Dave Lasley &lt;<a class="reference external" href="mailto:dave&#64;laslabs.com">dave&#64;laslabs.com</a>&gt;</li> <li>Shepilov Vladislav &lt;<a class="reference external" href="mailto:shepilov.v&#64;protonmail.com">shepilov.v&#64;protonmail.com</a>&gt;</li> <li><a class="reference external" href="https://www.greenice.com">Greenice</a>:<ul> <li>Fernando La Chica &lt;<a class="reference external" href="mailto:fernandolachica&#64;gmail.com">fernandolachica&#64;gmail.com</a>&gt;</li> </ul> </li> </ul> <a name="other-credits"></a> <h3 class="with-subtitle"><a class="toc-backref" href="#id9">Other credits</a></h3> <h3 class="section-subtitle" id="original-implementation"><span class="section-subtitle">Original implementation</span></h3> <p>This module is inspired in previous module <em>product_images</em> from OpenLabs and Akretion.</p> <a name="maintainers"></a> <h3><a class="toc-backref" href="#id10">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/server-tools/tree/15.0/base_multi_image">OCA/server-tools</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>