Skip to content

Commit

Permalink
[REF] use new readme conventions. (replace rst by md files)
Browse files Browse the repository at this point in the history
  • Loading branch information
legalsylvain committed Nov 17, 2023
1 parent b498a76 commit 50ccde4
Show file tree
Hide file tree
Showing 7 changed files with 57 additions and 59 deletions.
39 changes: 21 additions & 18 deletions web_theme_classic/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,27 +28,30 @@ Web Theme Classic

|badge1| |badge2| |badge3| |badge4| |badge5|

This module extend the Odoo Community Edition ``web`` module to improve visibility
of form view.
This module extend the Odoo Community Edition ``web`` module to improve
visibility of form view.

**Rational:**
Since Odoo V17, the design is very pure. That's great, but it generates some problem for
users :
**Rational:** Since Odoo V17, the design is very pure. That's great, but
it generates some problem for users :

* buttons and fields are not identifiable. (we can not know exactly where there are
until you hover over them with the cursor)
- buttons and fields are not identifiable. (we can not know exactly
where there are until you hover over them with the cursor)
- there is no indication for the required fields until trying to save
(or exit the screen)

* there is no indication for the required fields until trying to save (or exit the screen)

In a way, this module restores the form display of version 15, but preserving the "save on the fly" new feature.
In a way, this module restores the form display of version 15, but
preserving the "save on the fly" new feature.

**Without this module**

.. figure:: https://raw.githubusercontent.com/OCA/web/17.0/web_theme_classic/static/description/product_template_form_without_module.png
|image1|

**With this module**

.. figure:: https://raw.githubusercontent.com/OCA/web/17.0/web_theme_classic/static/description/product_template_form_with_module.png
|image2|

.. |image1| image:: https://raw.githubusercontent.com/OCA/web/17.0/web_theme_classic/static/description/product_template_form_without_module.png
.. |image2| image:: https://raw.githubusercontent.com/OCA/web/17.0/web_theme_classic/static/description/product_template_form_with_module.png

**Table of contents**

Expand All @@ -58,8 +61,8 @@ In a way, this module restores the form display of version 15, but preserving th
Known issues / Roadmap
======================

* For the time being, the module improves form and search view. Some other improvement could
be done on other part of the UI.
- For the time being, the module improves form and search view. Some
other improvement could be done on other part of the UI.

Bug Tracker
===========
Expand All @@ -75,17 +78,17 @@ Credits
=======

Authors
~~~~~~~
-------

* GRAP

Contributors
~~~~~~~~~~~~
------------

* Sylvain LE GAL (https://www.twitter.com/legalsylvain)
- Sylvain LE GAL (https://www.twitter.com/legalsylvain)

Maintainers
~~~~~~~~~~~
-----------

This module is maintained by the OCA.

Expand Down
1 change: 1 addition & 0 deletions web_theme_classic/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Sylvain LE GAL (<https://www.twitter.com/legalsylvain>)
1 change: 0 additions & 1 deletion web_theme_classic/readme/CONTRIBUTORS.rst

This file was deleted.

21 changes: 21 additions & 0 deletions web_theme_classic/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
This module extend the Odoo Community Edition `web` module to improve
visibility of form view.

**Rational:** Since Odoo V17, the design is very pure. That's great, but
it generates some problem for users :

- Fields are not identifiable. (we can not know exactly
where there are until you hover over them with the cursor)
- there is no indication for the required fields until trying to save
(or exit the screen)

In a way, this module restores the form display of version 15, but
preserving the "save on the fly" new feature.

**Without this module**

![](../static/description/product_template_form_without_module.png)

**With this module**

![](../static/description/product_template_form_with_module.png)
21 changes: 0 additions & 21 deletions web_theme_classic/readme/DESCRIPTION.rst

This file was deleted.

2 changes: 0 additions & 2 deletions web_theme_classic/readme/ROADMAP.rst

This file was deleted.

31 changes: 14 additions & 17 deletions web_theme_classic/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -370,25 +370,22 @@ <h1 class="title">Web Theme Classic</h1>
!! source digest: sha256:b309e66df73fcf5de5629e2cc3645e23340d22335fcd405f771e5cce15341741
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/web/tree/17.0/web_theme_classic"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/web-17-0/web-17-0-web_theme_classic"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/web&amp;target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>This module extend the Odoo Community Edition <tt class="docutils literal">web</tt> module to improve visibility
of form view.</p>
<p><strong>Rational:</strong>
Since Odoo V17, the design is very pure. That’s great, but it generates some problem for
users :</p>
<p>This module extend the Odoo Community Edition <tt class="docutils literal">web</tt> module to improve
visibility of form view.</p>
<p><strong>Rational:</strong> Since Odoo V17, the design is very pure. That’s great, but
it generates some problem for users :</p>
<ul class="simple">
<li>buttons and fields are not identifiable. (we can not know exactly where there are
until you hover over them with the cursor)</li>
<li>there is no indication for the required fields until trying to save (or exit the screen)</li>
<li>buttons and fields are not identifiable. (we can not know exactly
where there are until you hover over them with the cursor)</li>
<li>there is no indication for the required fields until trying to save
(or exit the screen)</li>
</ul>
<p>In a way, this module restores the form display of version 15, but preserving the “save on the fly” new feature.</p>
<p>In a way, this module restores the form display of version 15, but
preserving the “save on the fly” new feature.</p>
<p><strong>Without this module</strong></p>
<div class="figure">
<img alt="https://raw.githubusercontent.com/OCA/web/17.0/web_theme_classic/static/description/product_template_form_without_module.png" src="https://raw.githubusercontent.com/OCA/web/17.0/web_theme_classic/static/description/product_template_form_without_module.png" />
</div>
<p><img alt="image1" src="https://raw.githubusercontent.com/OCA/web/17.0/web_theme_classic/static/description/product_template_form_without_module.png" /></p>
<p><strong>With this module</strong></p>
<div class="figure">
<img alt="https://raw.githubusercontent.com/OCA/web/17.0/web_theme_classic/static/description/product_template_form_with_module.png" src="https://raw.githubusercontent.com/OCA/web/17.0/web_theme_classic/static/description/product_template_form_with_module.png" />
</div>
<p><img alt="image2" src="https://raw.githubusercontent.com/OCA/web/17.0/web_theme_classic/static/description/product_template_form_with_module.png" /></p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
Expand All @@ -405,8 +402,8 @@ <h1 class="title">Web Theme Classic</h1>
<div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#toc-entry-1">Known issues / Roadmap</a></h1>
<ul class="simple">
<li>For the time being, the module improves form and search view. Some other improvement could
be done on other part of the UI.</li>
<li>For the time being, the module improves form and search view. Some
other improvement could be done on other part of the UI.</li>
</ul>
</div>
<div class="section" id="bug-tracker">
Expand Down

0 comments on commit 50ccde4

Please sign in to comment.