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.

109 lines
3.7 KiB

  1. ==========================
  2. Image URLs from HTML field
  3. ==========================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
  15. :target: https://github.com/OCA/server-tools/tree/12.0/html_image_url_extractor
  16. :alt: OCA/server-tools
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-html_image_url_extractor
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/149/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module includes a method that extracts image URLs from any chunk of HTML,
  25. in appearing order.
  26. It is useful for modules such as `website_blog_excerpt_img
  27. <https://github.com/OCA/website/tree/9.0/website_blog_excerpt_img>`_: blog list shows the first
  28. image included in the post if haven't a defined cover image.
  29. **Table of contents**
  30. .. contents::
  31. :local:
  32. Usage
  33. =====
  34. This module just adds a technical utility, but nothing for the end user.
  35. If you are a developer and need this utility for your module, see these
  36. examples and read the docs inside the code.
  37. Python example::
  38. @api.multi
  39. def some_method(self):
  40. # Get images from an HTML field
  41. imgs = self.env["ir.fields.converter"].imgs_from_html(self.html_field)
  42. for url in imgs:
  43. # Do stuff with those URLs
  44. pass
  45. QWeb example::
  46. <!-- Extract first image from a blog post -->
  47. <t t-foreach="env['ir.fields.converter']
  48. .imgs_from_html(blog_post.content, 1)"
  49. t-as="url">
  50. <img t-att-href="url"/>
  51. </t>
  52. Bug Tracker
  53. ===========
  54. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  55. In case of trouble, please check there if your issue has already been reported.
  56. If you spotted it first, help us smashing it by providing a detailed and welcomed
  57. `feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20html_image_url_extractor%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  58. Do not contact contributors directly about support or help with technical issues.
  59. Credits
  60. =======
  61. Authors
  62. ~~~~~~~
  63. * Tecnativa
  64. * Onestein
  65. Contributors
  66. ~~~~~~~~~~~~
  67. * Jairo Llopis <jairo.llopis@tecnativa.com>
  68. * Vicent Cubells <vicent.cubells@tecnativa.com>
  69. * Dennis Sluijk <d.sluijk@onestein.nl>
  70. * Cristina Martin R. <cristina.martin@tecnativa.com>
  71. Maintainers
  72. ~~~~~~~~~~~
  73. This module is maintained by the OCA.
  74. .. image:: https://odoo-community.org/logo.png
  75. :alt: Odoo Community Association
  76. :target: https://odoo-community.org
  77. OCA, or the Odoo Community Association, is a nonprofit organization whose
  78. mission is to support the collaborative development of Odoo features and
  79. promote its widespread use.
  80. This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/12.0/html_image_url_extractor>`_ project on GitHub.
  81. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.