diff --git a/html_text/README.rst b/html_text/README.rst index d740940ae..933a2e9d5 100644 --- a/html_text/README.rst +++ b/html_text/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 - ==================== Text 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/13.0/html_text + :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-13-0/server-tools-13-0-html_text + :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/13.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + This module provides some technical features that allow to extract text from any chunk of HTML, without HTML tags or attributes. You can chose either: @@ -14,6 +33,11 @@ any chunk of HTML, without HTML tags or attributes. You can chose either: It can be used to easily generate excerpts. +**Table of contents** + +.. contents:: + :local: + Usage ===== @@ -48,34 +72,46 @@ Known issues / Roadmap 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 +~~~~~~~ + +* Grupo ESOC Ingeniería de Servicios +* Tecnativa +* Onestein + Contributors ------------- +~~~~~~~~~~~~ -* Jairo Llopis -* Vicent Cubells * Dennis Sluijk +* `Tecnativa `_:", -Do not contact contributors directly about support or help with technical issues. + * Jairo Llopis + * Vicent Cubells + * Víctor Martínez -Maintainer ----------- +Maintainers +~~~~~~~~~~~ + +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_text/static/description/index.html b/html_text/static/description/index.html new file mode 100644 index 000000000..389c5bce8 --- /dev/null +++ b/html_text/static/description/index.html @@ -0,0 +1,462 @@ + + + + + + +Text from HTML field + + + +
+

Text from HTML field

+ + +

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

+

This module provides some technical features that allow to extract text from +any chunk of HTML, without HTML tags or attributes. You can chose either:

+
    +
  • To truncate the result by amount of words or characters.
    • +
  • To append an ellipsis (or any character(s)) at the end of the result.
    • +
+

It can be used to easily generate excerpts.

+

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:

+
+def some_method(self):
+    # Get truncated text from an HTML field. It will 40 words and 100
+    # characters at most, and will have "..." appended at the end if it
+    # gets truncated.
+    truncated_text = self.env["ir.fields.converter"].text_from_html(
+        self.html_field, 40, 100, "...")
+
+

QWeb example:

+
+<t t-esc="env['ir.fields.converter'].text_from_html(doc.html_field)"/>
+
+Try me on Runbot +
+
+

Known issues / Roadmap

+
    +
  • An option could be added to try to respect the basic HTML tags inside the +excerpt (<b>, <i>, <p>, etc.).
    • +
+
+
+

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

+
    +
  • Grupo ESOC Ingeniería de Servicios
    • +
  • 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.

+
+
+
+ +