mirror of https://github.com/OCA/web.git
105 lines
3.3 KiB
ReStructuredText
105 lines
3.3 KiB
ReStructuredText
========================
|
|
Web Widget Text Markdown
|
|
========================
|
|
|
|
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! 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%2Fweb-lightgray.png?logo=github
|
|
:target: https://github.com/OCA/web/tree/11.0/web_widget_text_markdown
|
|
:alt: OCA/web
|
|
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
|
:target: https://translation.odoo-community.org/projects/web-11-0/web-11-0-web_widget_text_markdown
|
|
:alt: Translate me on Weblate
|
|
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
|
|
:target: https://runbot.odoo-community.org/runbot/162/11.0
|
|
:alt: Try me on Runbot
|
|
|
|
|badge1| |badge2| |badge3| |badge4| |badge5|
|
|
|
|
This module adds a new widget for text field in form view on Odoo:
|
|
|
|
- In readonly mode, it uses text contents to parse and render them to html markdown syntax.
|
|
- In write mode, use [bootstrap-markdown][1]
|
|
|
|
[1]: `bootstrap-markdown <https://github.com/toopay/bootstrap-markdown>`_
|
|
|
|
**Table of contents**
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
Usage
|
|
=====
|
|
|
|
Your XML form view definition should contain::
|
|
|
|
...
|
|
<field name="field_name" widget="bootstrap_markdown"/>
|
|
...
|
|
|
|
Known issues / Roadmap
|
|
======================
|
|
|
|
* Can't create attachments on virtual records
|
|
|
|
* Improve user experience with Odoo specific syntax
|
|
* Improve user experience with Github specific syntax
|
|
|
|
Bug Tracker
|
|
===========
|
|
|
|
Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/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 <https://github.com/OCA/web/issues/new?body=module:%20web_widget_text_markdown%0Aversion:%2011.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
|
|
~~~~~~~
|
|
|
|
* Alexandre Díaz
|
|
* Komit
|
|
* Sudokeys
|
|
|
|
Contributors
|
|
~~~~~~~~~~~~
|
|
|
|
* Nicolas Jeudy <nicolas@sudokeys.com>
|
|
* Nguyen Tan Phuc <phuc.nt@komit-consulting.com>
|
|
* Alexandre Díaz <dev@redneboa.es>
|
|
|
|
Other credits
|
|
~~~~~~~~~~~~~
|
|
|
|
* Komit https://komit-consulting.com
|
|
|
|
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/web <https://github.com/OCA/web/tree/11.0/web_widget_text_markdown>`_ project on GitHub.
|
|
|
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|