# Text from HTML field

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
- Known issues / Roadmap
- Bug Tracker
- Credits
  - Authors
  - Contributors
  - Maintainers

# 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)"/>

# 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 to smash 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

- Dennis Sluijk <d.sluijk@onestein.nl>
- Tecnativa:”,
- Helly kapatel <helly.kapatel@initos.com>
- Mantas Šniukas <mantas@vialaurea.lt>
- Dhara Solanki <dhara.solanki@initos.com>
  - Jairo Llopis
  - Vicent Cubells
  - Víctor Martínez

## Maintainers

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.

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.