From de6dcbfc005352ee5cb6310c7e058ba1cb5ea8a2 Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Thu, 14 Feb 2019 10:12:54 +0000 Subject: [PATCH] [UPD] README.rst --- html_image_url_extractor/README.rst | 71 ++- .../static/description/index.html | 452 ++++++++++++++++++ 2 files changed, 499 insertions(+), 24 deletions(-) create mode 100644 html_image_url_extractor/static/description/index.html diff --git a/html_image_url_extractor/README.rst b/html_image_url_extractor/README.rst index 06e8284c6..f62cbc07c 100644 --- a/html_image_url_extractor/README.rst +++ b/html_image_url_extractor/README.rst @@ -1,11 +1,30 @@ -.. image:: https://img.shields.io/badge/license-AGPL--3-blue.png - :target: https://www.gnu.org/licenses/agpl - :alt: License: AGPL-3 - ========================== Image URLs from HTML field ========================== +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github + :target: https://github.com/OCA/server-tools/tree/12.0/html_image_url_extractor + :alt: OCA/server-tools +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-html_image_url_extractor + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/149/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + This module includes a method that extracts image URLs from any chunk of HTML, in appearing order. @@ -13,6 +32,11 @@ It is useful for modules such as `website_blog_excerpt_img `_: blog list shows the first image included in the post if haven't a defined cover image. +**Table of contents** + +.. contents:: + :local: + Usage ===== @@ -40,47 +64,46 @@ QWeb example:: -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/149/12.0 - -Known issues / Roadmap -====================== - -* The regexp to find the URL could be better. - Bug Tracker =========== -Bugs are tracked on `GitHub 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. +Bugs are tracked on `GitHub 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 `_. + +Do not contact contributors directly about support or help with technical issues. Credits ======= +Authors +~~~~~~~ + +* Tecnativa +* Onestein + Contributors ------------- +~~~~~~~~~~~~ * Jairo Llopis * Vicent Cubells * Dennis Sluijk * Cristina Martin R. -Do not contact contributors directly about support or help with technical issues. +Maintainers +~~~~~~~~~~~ -Maintainer ----------- +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -This module is maintained by the OCA. - 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. -To contribute to this module, please visit https://odoo-community.org. +This module is part of the `OCA/server-tools `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/html_image_url_extractor/static/description/index.html b/html_image_url_extractor/static/description/index.html new file mode 100644 index 000000000..0ec425295 --- /dev/null +++ b/html_image_url_extractor/static/description/index.html @@ -0,0 +1,452 @@ + + + + + + +Image URLs from HTML field + + + +
+

Image URLs from HTML field

+ + +

Beta License: AGPL-3 OCA/server-tools Translate me on Weblate Try me on Runbot

+

This module includes a method that extracts image URLs from any chunk of HTML, +in appearing order.

+

It is useful for modules such as website_blog_excerpt_img: blog list shows the first +image included in the post if haven’t a defined cover image.

+

Table of contents

+ +
+

Usage

+

This module just adds a technical utility, but nothing for the end user.

+

If you are a developer and need this utility for your module, see these +examples and read the docs inside the code.

+

Python example:

+
+@api.multi
+def some_method(self):
+    # Get images from an HTML field
+    imgs = self.env["ir.fields.converter"].imgs_from_html(self.html_field)
+    for url in imgs:
+        # Do stuff with those URLs
+        pass
+
+

QWeb example:

+
+<!-- Extract first image from a blog post -->
+<t t-foreach="env['ir.fields.converter']
+              .imgs_from_html(blog_post.content, 1)"
+   t-as="url">
+    <img t-att-href="url"/>
+</t>
+
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub 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.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Tecnativa
    • +
  • Onestein
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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/server-tools project on GitHub.

+

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

+
+
+
+ +