124 lines
4.2 KiB
ReStructuredText
124 lines
4.2 KiB
ReStructuredText
====================
|
|
Text from HTML field
|
|
====================
|
|
|
|
..
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! This file is generated by oca-gen-addon-readme !!
|
|
!! changes will be overwritten. !!
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! source digest: sha256:6628757b4f5664095ed2bc62e561ae5ffa46e22b5cd592012b8a1ef2c3526d9c
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
|
|
.. |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/16.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-16-0/server-tools-16-0-html_text
|
|
:alt: Translate me on Weblate
|
|
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
|
|
:target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=16.0
|
|
:alt: Try me on Runboat
|
|
|
|
|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:
|
|
|
|
* 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**
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
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)"/>
|
|
|
|
.. 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/11.0
|
|
|
|
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 <https://github.com/OCA/server-tools/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 <https://github.com/OCA/server-tools/issues/new?body=module:%20html_text%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
|
|
|
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 <https://www.tecnativa.com>`_:",
|
|
* 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.
|
|
|
|
.. image:: https://odoo-community.org/logo.png
|
|
:alt: Odoo Community Association
|
|
:target: https://odoo-community.org
|
|
|
|
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 <https://github.com/OCA/server-tools/tree/16.0/html_text>`_ project on GitHub.
|
|
|
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|