You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

529 lines
17 KiB

  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
  7. <title>Multiple images base</title>
  8. <style type="text/css">
  9. /*
  10. :Author: David Goodger (goodger@python.org)
  11. :Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
  12. :Copyright: This stylesheet has been placed in the public domain.
  13. Default cascading style sheet for the HTML output of Docutils.
  14. See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
  15. customize this style sheet.
  16. */
  17. /* used to remove borders from tables and images */
  18. .borderless, table.borderless td, table.borderless th {
  19. border: 0 }
  20. table.borderless td, table.borderless th {
  21. /* Override padding for "table.docutils td" with "! important".
  22. The right padding separates the table cells. */
  23. padding: 0 0.5em 0 0 ! important }
  24. .first {
  25. /* Override more specific margin styles with "! important". */
  26. margin-top: 0 ! important }
  27. .last, .with-subtitle {
  28. margin-bottom: 0 ! important }
  29. .hidden {
  30. display: none }
  31. .subscript {
  32. vertical-align: sub;
  33. font-size: smaller }
  34. .superscript {
  35. vertical-align: super;
  36. font-size: smaller }
  37. a.toc-backref {
  38. text-decoration: none ;
  39. color: black }
  40. blockquote.epigraph {
  41. margin: 2em 5em ; }
  42. dl.docutils dd {
  43. margin-bottom: 0.5em }
  44. object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  45. overflow: hidden;
  46. }
  47. /* Uncomment (and remove this text!) to get bold-faced definition list terms
  48. dl.docutils dt {
  49. font-weight: bold }
  50. */
  51. div.abstract {
  52. margin: 2em 5em }
  53. div.abstract p.topic-title {
  54. font-weight: bold ;
  55. text-align: center }
  56. div.admonition, div.attention, div.caution, div.danger, div.error,
  57. div.hint, div.important, div.note, div.tip, div.warning {
  58. margin: 2em ;
  59. border: medium outset ;
  60. padding: 1em }
  61. div.admonition p.admonition-title, div.hint p.admonition-title,
  62. div.important p.admonition-title, div.note p.admonition-title,
  63. div.tip p.admonition-title {
  64. font-weight: bold ;
  65. font-family: sans-serif }
  66. div.attention p.admonition-title, div.caution p.admonition-title,
  67. div.danger p.admonition-title, div.error p.admonition-title,
  68. div.warning p.admonition-title, .code .error {
  69. color: red ;
  70. font-weight: bold ;
  71. font-family: sans-serif }
  72. /* Uncomment (and remove this text!) to get reduced vertical space in
  73. compound paragraphs.
  74. div.compound .compound-first, div.compound .compound-middle {
  75. margin-bottom: 0.5em }
  76. div.compound .compound-last, div.compound .compound-middle {
  77. margin-top: 0.5em }
  78. */
  79. div.dedication {
  80. margin: 2em 5em ;
  81. text-align: center ;
  82. font-style: italic }
  83. div.dedication p.topic-title {
  84. font-weight: bold ;
  85. font-style: normal }
  86. div.figure {
  87. margin-left: 2em ;
  88. margin-right: 2em }
  89. div.footer, div.header {
  90. clear: both;
  91. font-size: smaller }
  92. div.line-block {
  93. display: block ;
  94. margin-top: 1em ;
  95. margin-bottom: 1em }
  96. div.line-block div.line-block {
  97. margin-top: 0 ;
  98. margin-bottom: 0 ;
  99. margin-left: 1.5em }
  100. div.sidebar {
  101. margin: 0 0 0.5em 1em ;
  102. border: medium outset ;
  103. padding: 1em ;
  104. background-color: #ffffee ;
  105. width: 40% ;
  106. float: right ;
  107. clear: right }
  108. div.sidebar p.rubric {
  109. font-family: sans-serif ;
  110. font-size: medium }
  111. div.system-messages {
  112. margin: 5em }
  113. div.system-messages h1 {
  114. color: red }
  115. div.system-message {
  116. border: medium outset ;
  117. padding: 1em }
  118. div.system-message p.system-message-title {
  119. color: red ;
  120. font-weight: bold }
  121. div.topic {
  122. margin: 2em }
  123. h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
  124. h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  125. margin-top: 0.4em }
  126. h1.title {
  127. text-align: center }
  128. h2.subtitle {
  129. text-align: center }
  130. hr.docutils {
  131. width: 75% }
  132. img.align-left, .figure.align-left, object.align-left, table.align-left {
  133. clear: left ;
  134. float: left ;
  135. margin-right: 1em }
  136. img.align-right, .figure.align-right, object.align-right, table.align-right {
  137. clear: right ;
  138. float: right ;
  139. margin-left: 1em }
  140. img.align-center, .figure.align-center, object.align-center {
  141. display: block;
  142. margin-left: auto;
  143. margin-right: auto;
  144. }
  145. table.align-center {
  146. margin-left: auto;
  147. margin-right: auto;
  148. }
  149. .align-left {
  150. text-align: left }
  151. .align-center {
  152. clear: both ;
  153. text-align: center }
  154. .align-right {
  155. text-align: right }
  156. /* reset inner alignment in figures */
  157. div.align-right {
  158. text-align: inherit }
  159. /* div.align-center * { */
  160. /* text-align: left } */
  161. .align-top {
  162. vertical-align: top }
  163. .align-middle {
  164. vertical-align: middle }
  165. .align-bottom {
  166. vertical-align: bottom }
  167. ol.simple, ul.simple {
  168. margin-bottom: 1em }
  169. ol.arabic {
  170. list-style: decimal }
  171. ol.loweralpha {
  172. list-style: lower-alpha }
  173. ol.upperalpha {
  174. list-style: upper-alpha }
  175. ol.lowerroman {
  176. list-style: lower-roman }
  177. ol.upperroman {
  178. list-style: upper-roman }
  179. p.attribution {
  180. text-align: right ;
  181. margin-left: 50% }
  182. p.caption {
  183. font-style: italic }
  184. p.credits {
  185. font-style: italic ;
  186. font-size: smaller }
  187. p.label {
  188. white-space: nowrap }
  189. p.rubric {
  190. font-weight: bold ;
  191. font-size: larger ;
  192. color: maroon ;
  193. text-align: center }
  194. p.sidebar-title {
  195. font-family: sans-serif ;
  196. font-weight: bold ;
  197. font-size: larger }
  198. p.sidebar-subtitle {
  199. font-family: sans-serif ;
  200. font-weight: bold }
  201. p.topic-title {
  202. font-weight: bold }
  203. pre.address {
  204. margin-bottom: 0 ;
  205. margin-top: 0 ;
  206. font: inherit }
  207. pre.literal-block, pre.doctest-block, pre.math, pre.code {
  208. margin-left: 2em ;
  209. margin-right: 2em }
  210. pre.code .ln { color: grey; } /* line numbers */
  211. pre.code, code { background-color: #eeeeee }
  212. pre.code .comment, code .comment { color: #5C6576 }
  213. pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
  214. pre.code .literal.string, code .literal.string { color: #0C5404 }
  215. pre.code .name.builtin, code .name.builtin { color: #352B84 }
  216. pre.code .deleted, code .deleted { background-color: #DEB0A1}
  217. pre.code .inserted, code .inserted { background-color: #A3D289}
  218. span.classifier {
  219. font-family: sans-serif ;
  220. font-style: oblique }
  221. span.classifier-delimiter {
  222. font-family: sans-serif ;
  223. font-weight: bold }
  224. span.interpreted {
  225. font-family: sans-serif }
  226. span.option {
  227. white-space: nowrap }
  228. span.pre {
  229. white-space: pre }
  230. span.problematic {
  231. color: red }
  232. span.section-subtitle {
  233. /* font-size relative to parent (h1..h6 element) */
  234. font-size: 80% }
  235. table.citation {
  236. border-left: solid 1px gray;
  237. margin-left: 1px }
  238. table.docinfo {
  239. margin: 2em 4em }
  240. table.docutils {
  241. margin-top: 0.5em ;
  242. margin-bottom: 0.5em }
  243. table.footnote {
  244. border-left: solid 1px black;
  245. margin-left: 1px }
  246. table.docutils td, table.docutils th,
  247. table.docinfo td, table.docinfo th {
  248. padding-left: 0.5em ;
  249. padding-right: 0.5em ;
  250. vertical-align: top }
  251. table.docutils th.field-name, table.docinfo th.docinfo-name {
  252. font-weight: bold ;
  253. text-align: left ;
  254. white-space: nowrap ;
  255. padding-left: 0 }
  256. /* "booktabs" style (no vertical lines) */
  257. table.docutils.booktabs {
  258. border: 0px;
  259. border-top: 2px solid;
  260. border-bottom: 2px solid;
  261. border-collapse: collapse;
  262. }
  263. table.docutils.booktabs * {
  264. border: 0px;
  265. }
  266. table.docutils.booktabs th {
  267. border-bottom: thin solid;
  268. text-align: left;
  269. }
  270. h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
  271. h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  272. font-size: 100% }
  273. ul.auto-toc {
  274. list-style-type: none }
  275. </style>
  276. </head>
  277. <body>
  278. <div class="document" id="multiple-images-base">
  279. <h1 class="title">Multiple images base</h1>
  280. <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  281. !! This file is generated by oca-gen-addon-readme !!
  282. !! changes will be overwritten. !!
  283. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
  284. <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/12.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-12-0/server-tools-12-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/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
  285. <p>This module extends the functionality of any model to support multiple images
  286. (a gallery) attached to it and allow you to manage them.</p>
  287. <p><strong>Table of contents</strong></p>
  288. <div class="contents local topic" id="contents">
  289. <ul class="simple">
  290. <li><a class="reference internal" href="#installation" id="id1">Installation</a></li>
  291. <li><a class="reference internal" href="#configuration" id="id2">Configuration</a></li>
  292. <li><a class="reference internal" href="#development" id="id3">Development</a></li>
  293. <li><a class="reference internal" href="#known-issues-roadmap" id="id4">Known issues / Roadmap</a></li>
  294. <li><a class="reference internal" href="#bug-tracker" id="id5">Bug Tracker</a></li>
  295. <li><a class="reference internal" href="#credits" id="id6">Credits</a><ul>
  296. <li><a class="reference internal" href="#authors" id="id7">Authors</a></li>
  297. <li><a class="reference internal" href="#contributors" id="id8">Contributors</a></li>
  298. <li><a class="reference internal" href="#other-credits" id="id9">Other credits</a><ul>
  299. <li><a class="reference internal" href="#original-implementation" id="id10">Original implementation</a></li>
  300. </ul>
  301. </li>
  302. <li><a class="reference internal" href="#maintainers" id="id11">Maintainers</a></li>
  303. </ul>
  304. </li>
  305. </ul>
  306. </div>
  307. <div class="section" id="installation">
  308. <h1><a class="toc-backref" href="#id1">Installation</a></h1>
  309. <p>This module adds abstract models to work on. Its sole purpose is to serve as
  310. base for other modules that implement galleries, so if you install this one
  311. manually you will notice no change. You should install any other module based
  312. on this one and this will get installed automatically.</p>
  313. </div>
  314. <div class="section" id="configuration">
  315. <h1><a class="toc-backref" href="#id2">Configuration</a></h1>
  316. <p>To manage all stored images, you need to:</p>
  317. <ul class="simple">
  318. <li>Go to <em>Settings &gt; Technical &gt; Multi images</em>.</li>
  319. </ul>
  320. <p>… but you probably prefer to manage them from the forms supplied by
  321. submodules that inherit this behavior.</p>
  322. </div>
  323. <div class="section" id="development">
  324. <h1><a class="toc-backref" href="#id3">Development</a></h1>
  325. <p>To develop a module based on this one:</p>
  326. <ul>
  327. <li><p class="first">See module <tt class="docutils literal">product_multi_image</tt> as an example.</p>
  328. </li>
  329. <li><p class="first">You have to inherit model <tt class="docutils literal">base_multi_image.owner</tt> to the model that needs
  330. the gallery:</p>
  331. <pre class="literal-block">
  332. class MyOwner(models.Model):
  333. _name = &quot;my.model.name&quot;
  334. _inherit = [&quot;my.model.name&quot;, &quot;base_multi_image.owner&quot;]
  335. # If you need this, you will need ``pre_init_hook_for_submodules`` and
  336. ``uninstall_hook_for_submodules`` as detailed below.
  337. old_image_field = fields.Binary(related=&quot;image_main&quot;, store=False)
  338. </pre>
  339. </li>
  340. <li><p class="first">Somewhere in the owner view, add:</p>
  341. <pre class="literal-block">
  342. &lt;field
  343. name=&quot;image_ids&quot;
  344. nolabel=&quot;1&quot;
  345. context=&quot;{
  346. 'default_owner_model': 'my.model.name',
  347. 'default_owner_id': id,
  348. }&quot;
  349. mode=&quot;kanban&quot;/&gt;
  350. </pre>
  351. </li>
  352. <li><p class="first">If the model you are extending already had an image field, and you want to
  353. trick Odoo to make those images to multi-image mode, you will need to make
  354. use of the provided <cite>~.hooks.pre_init_hook_for_submodules</cite> and
  355. <cite>~.hooks.uninstall_hook_for_submodules</cite>, like the
  356. <tt class="docutils literal">product_multi_image</tt> module does:</p>
  357. <pre class="literal-block">
  358. try:
  359. from odoo.addons.base_multi_image.hooks import (
  360. pre_init_hook_for_submodules,
  361. uninstall_hook_for_submodules,
  362. )
  363. except ImportError:
  364. pass
  365. def pre_init_hook(cr):
  366. &quot;&quot;&quot;Transform single into multi images.&quot;&quot;&quot;
  367. pre_init_hook_for_submodules(cr, &quot;product.template&quot;, &quot;image&quot;)
  368. pre_init_hook_for_submodules(cr, &quot;product.product&quot;, &quot;image_variant&quot;)
  369. def uninstall_hook(cr, registry):
  370. &quot;&quot;&quot;Remove multi images for models that no longer use them.&quot;&quot;&quot;
  371. uninstall_hook_for_submodules(cr, registry, &quot;product.template&quot;)
  372. uninstall_hook_for_submodules(cr, registry, &quot;product.product&quot;)
  373. </pre>
  374. </li>
  375. </ul>
  376. <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>
  377. </div>
  378. <div class="section" id="known-issues-roadmap">
  379. <h1><a class="toc-backref" href="#id4">Known issues / Roadmap</a></h1>
  380. <ul class="simple">
  381. <li><em>OS file</em> storage mode for images is meant to provide a path where Odoo has
  382. read access and the image is already found, <strong>not for making the module store
  383. images there</strong>. It would be nice to add that feature though.</li>
  384. </ul>
  385. </div>
  386. <div class="section" id="bug-tracker">
  387. <h1><a class="toc-backref" href="#id5">Bug Tracker</a></h1>
  388. <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.
  389. In case of trouble, please check there if your issue has already been reported.
  390. If you spotted it first, help us smashing it by providing a detailed and welcomed
  391. <a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20base_multi_image%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
  392. <p>Do not contact contributors directly about support or help with technical issues.</p>
  393. </div>
  394. <div class="section" id="credits">
  395. <h1><a class="toc-backref" href="#id6">Credits</a></h1>
  396. <div class="section" id="authors">
  397. <h2><a class="toc-backref" href="#id7">Authors</a></h2>
  398. <ul class="simple">
  399. <li>Tecnativa</li>
  400. <li>Antiun Ingeniería</li>
  401. <li>S.L.</li>
  402. <li>Sodexis</li>
  403. <li>LasLabs</li>
  404. </ul>
  405. </div>
  406. <div class="section" id="contributors">
  407. <h2><a class="toc-backref" href="#id8">Contributors</a></h2>
  408. <ul class="simple">
  409. <li>Pedro M. Baeza &lt;<a class="reference external" href="mailto:pedro.baeza&#64;serviciosbaeza.com">pedro.baeza&#64;serviciosbaeza.com</a>&gt;</li>
  410. <li>Rafael Blasco &lt;<a class="reference external" href="mailto:rafabn&#64;antiun.com">rafabn&#64;antiun.com</a>&gt;</li>
  411. <li>Jairo Llopis &lt;<a class="reference external" href="mailto:yajo.sk8&#64;gmail.com">yajo.sk8&#64;gmail.com</a>&gt;</li>
  412. <li>Sodexis &lt;<a class="reference external" href="mailto:dev&#64;sodexis.com">dev&#64;sodexis.com</a>&gt;</li>
  413. <li>Dave Lasley &lt;<a class="reference external" href="mailto:dave&#64;laslabs.com">dave&#64;laslabs.com</a>&gt;</li>
  414. <li>Shepilov Vladislav &lt;<a class="reference external" href="mailto:shepilov.v&#64;protonmail.com">shepilov.v&#64;protonmail.com</a>&gt;</li>
  415. </ul>
  416. </div>
  417. <div class="section" id="other-credits">
  418. <h2><a class="toc-backref" href="#id9">Other credits</a></h2>
  419. <div class="section" id="original-implementation">
  420. <h3><a class="toc-backref" href="#id10">Original implementation</a></h3>
  421. <p>This module is inspired in previous module <em>product_images</em> from OpenLabs
  422. and Akretion.</p>
  423. </div>
  424. </div>
  425. <div class="section" id="maintainers">
  426. <h2><a class="toc-backref" href="#id11">Maintainers</a></h2>
  427. <p>This module is maintained by the OCA.</p>
  428. <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
  429. <p>OCA, or the Odoo Community Association, is a nonprofit organization whose
  430. mission is to support the collaborative development of Odoo features and
  431. promote its widespread use.</p>
  432. <p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/12.0/base_multi_image">OCA/server-tools</a> project on GitHub.</p>
  433. <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>
  434. </div>
  435. </div>
  436. </div>
  437. </body>
  438. </html>