From de32b872dbe5516baba3b704ec896c221bb9f1a0 Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Sun, 16 Jun 2019 11:42:27 +0000 Subject: [PATCH] [UPD] README.rst --- web_drop_target/README.rst | 86 ++-- web_drop_target/static/description/index.html | 452 ++++++++++++++++++ 2 files changed, 510 insertions(+), 28 deletions(-) create mode 100644 web_drop_target/static/description/index.html diff --git a/web_drop_target/README.rst b/web_drop_target/README.rst index b0d171b5..568a4c85 100644 --- a/web_drop_target/README.rst +++ b/web_drop_target/README.rst @@ -1,76 +1,106 @@ -.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg - :target: https://www.gnu.org/licenses/agpl-3.0-standalone.html - :alt: License: AGPL-3 - =================== Drop target support =================== +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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/10.0/web_drop_target + :alt: OCA/web +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/web-10-0/web-10-0-web_drop_target + :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/10.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + This module extends the functionality of the web client to support dropping local files into the web client. By default, an attachment will be created when dropping a file on a form. Further, this module is meant as a base drag&drop module supporting other actions after some file is dropped so that other modules can add more features. +**Table of contents** + +.. contents:: + :local: + Usage ===== To use this module, you need to: -#. drag a file from your local computer onto an Odoo form view -#. it should become an attachment of the currently opened record +1. drag a file from your local computer onto an Odoo form view +2. it should become an attachment of the currently opened record -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/162/10.0 +.. image:: https://raw.githubusercontent.com/web_drop_target/static/description/screenshot.png + :alt: Screenshot + +Development +=========== + +**Libraries** + +* `base64js `_. Known issues / Roadmap ====================== * dropping on list or kanban views would be nice too +* handle multiple files * add an upload progress meter for huge files * trigger custom events about different stages of the drop operation for other addons to hook in +* Install document module to display attachments in the sidebar 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 ======= -Images ------- - -* Odoo Community Association: `Icon `_. +Authors +~~~~~~~ -Libraries ---------- - -* `base64js `_. +* Therp BV Contributors ------------- +~~~~~~~~~~~~ * Holger Brunn * Pablo Fuentes +* Akim Juillerat -Do not contact contributors directly about help with questions or problems concerning this addon, but use the `community mailing list `_ or the `appropriate specialized mailinglist `_ for help, and the bug tracker linked in `Bug Tracker`_ above for 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/web `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/web_drop_target/static/description/index.html b/web_drop_target/static/description/index.html new file mode 100644 index 00000000..b0be80a0 --- /dev/null +++ b/web_drop_target/static/description/index.html @@ -0,0 +1,452 @@ + + + + + + +Drop target support + + + +
+

Drop target support

+ + +

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

+

This module extends the functionality of the web client to support dropping local files into the web client.

+

By default, an attachment will be created when dropping a file on a form.

+

Further, this module is meant as a base drag&drop module supporting other actions after some file is dropped so that other modules can add more features.

+

Table of contents

+ +
+

Usage

+

To use this module, you need to:

+
    +
  1. drag a file from your local computer onto an Odoo form view
    2. +
  2. it should become an attachment of the currently opened record
    3. +
+Screenshot +
+
+

Development

+

Libraries

+ +
+
+

Known issues / Roadmap

+
    +
  • dropping on list or kanban views would be nice too
    • +
  • handle multiple files
    • +
  • add an upload progress meter for huge files
    • +
  • trigger custom events about different stages of the drop operation for other addons to hook in
    • +
  • Install document module to display attachments in the sidebar
    • +
+
+
+

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

+
    +
  • Therp BV
    • +
+
+
+

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

+

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

+
+
+
+ +