diff --git a/web_responsive/README.rst b/web_responsive/README.rst index 8717f067..8f5fcfb0 100644 --- a/web_responsive/README.rst +++ b/web_responsive/README.rst @@ -1,11 +1,30 @@ -.. image:: https://img.shields.io/badge/license-LGPL--3-blue.svg - :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html - :alt: License: LGPL-3 - ============== Web Responsive ============== +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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-LGPL--3-blue.png + :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html + :alt: License: LGPL-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_responsive + :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_responsive + :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 provides a mobile compliant interface for Odoo Community web. Features: @@ -13,20 +32,16 @@ Features: * New navigation with an App drawer * Keyboard shortcuts for easier navigation * Display kanban views for small screens if an action or field One2x + * Set chatter side (Optional per user) +**Table of contents** -Installation -============ - -Configuration -============= +.. contents:: + :local: Usage ===== -Keyboard Shortcuts ------------------- - The following keyboard shortcuts are implemented: * Toggle App Drawer - `ActionKey ` + ``A`` @@ -34,10 +49,6 @@ The following keyboard shortcuts are implemented: * Type to select App Links * ``esc`` to close App Drawer -.. 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/11.0 - Known issues / Roadmap ====================== @@ -54,43 +65,48 @@ this module. great styles, but also `JavaScript that causes issues on mobile `_ - 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 ------- +Authors +~~~~~~~ -* Odoo Community Association: `Icon `_. +* LasLabs +* Tecnativa +* Alexandre Díaz Contributors ------------- +~~~~~~~~~~~~ * Dave Lasley * Jairo Llopis * Dennis Sluijk * Sergio Teruel +* Alexandre Díaz -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/web `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/web_responsive/static/description/index.html b/web_responsive/static/description/index.html new file mode 100644 index 00000000..678c500e --- /dev/null +++ b/web_responsive/static/description/index.html @@ -0,0 +1,461 @@ + + + + + + +Web Responsive + + + +
+

Web Responsive

+ + +

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

+

This module provides a mobile compliant interface for Odoo Community web.

+

Features:

+
+
    +
  • New navigation with an App drawer
    • +
  • Keyboard shortcuts for easier navigation
    • +
  • Display kanban views for small screens if an action or field One2x
    • +
  • Set chatter side (Optional per user)
    • +
+
+

Table of contents

+ +
+

Usage

+

The following keyboard shortcuts are implemented:

+
    +
  • Toggle App Drawer - ActionKey <https://en.wikipedia.org/wiki/Access_key#Access_in_different_browsers> + A
    • +
  • Navigate Apps Drawer - Arrow Keys
    • +
  • Type to select App Links
    • +
  • esc to close App Drawer
    • +
+
+
+

Known issues / Roadmap

+

Note: Data added to the footer support_branding is not shown while using +this module.

+
    +
  • Provide full menu search feature instead of just App search
    • +
  • Drag drawer from left to open in mobile
    • +
  • Figure out how to test focus on hidden elements for keyboard nav tests
    • +
  • If you resize the window, body gets a wrong overflow: auto css property +and you need to refresh your view or open/close the app drawer to fix that.
    • +
  • Override LESS styling to allow for responsive widget layouts
    • +
  • Adding oe_main_menu_navbar ID to the top navigation bar triggers some +great styles, but also JavaScript that causes issues on mobile
    • +
+
+
+

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

+
    +
  • LasLabs
    • +
  • Tecnativa
    • +
  • Alexandre Díaz
    • +
+
+
+

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.

+
+
+
+ +