Skip to content

Commit

Permalink
[UPD] README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
@OCA-git-bot
OCA-git-bot committed Feb 17, 2022
1 parent 04380a3 commit 24e4c54
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 34 deletions.
34 changes: 13 additions & 21 deletions base_view_inheritance_extension/README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ Extended view inheritance
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
:alt: License: LGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
:target: https://github.com/OCA/server-tools/tree/14.0/base_view_inheritance_extension
:target: https://github.com/OCA/server-tools/tree/15.0/base_view_inheritance_extension
: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-14-0/server-tools-14-0-base_view_inheritance_extension
:target: https://translation.odoo-community.org/projects/server-tools-15-0/server-tools-15-0-base_view_inheritance_extension
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/149/14.0
:target: https://runbot.odoo-community.org/runbot/149/15.0
:alt: Try me on Runbot

|badge1| |badge2| |badge3| |badge4| |badge5|
Expand All @@ -41,29 +41,21 @@ Usage

.. code-block:: xml
<attribute name="$attribute" operation="python_dict" key="$key">
$new_value
</attribute>
<field position="attributes">
<attribute name="context" operation="update">
{
"key": "value",
}
</attribute>
</field>
Note that views are subject to evaluation of xmlids anyways, so if you need
to refer to some xmlid, say ``%(xmlid)s``.

**Add to values in a list (states for example)**

Deprecated. This feature is now native, use `<attribute name="attrname" separator="," add="something" />`.

**Remove values from a list (states for example)**

Deprecated. This feature is now native, use `<attribute name="attrname" separator="," remove="something" />`.

**Move an element in the view**

This feature is now native, cf the `official Odoo documentation <https://www.odoo.com/documentation/14.0/developer/reference/addons/views.html#inheritance-specs>`_.

Known issues / Roadmap
======================

* On `15.0`, remove `list_add` and `list_remove` fetures.
* Support an ``eval`` attribute for our new node types.

Bug Tracker
Expand All @@ -72,7 +64,7 @@ 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 smashing it by providing a detailed and welcomed
`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20base_view_inheritance_extension%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20base_view_inheritance_extension%0Aversion:%2015.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.

Expand Down Expand Up @@ -105,6 +97,6 @@ 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/14.0/base_view_inheritance_extension>`_ project on GitHub.
This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/15.0/base_view_inheritance_extension>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
23 changes: 10 additions & 13 deletions base_view_inheritance_extension/static/description/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ <h1 class="title">Extended view inheritance</h1>
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" 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" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-tools/tree/14.0/base_view_inheritance_extension"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-tools-14-0/server-tools-14-0-base_view_inheritance_extension"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/149/14.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p><a class="reference external" 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" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-tools/tree/15.0/base_view_inheritance_extension"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-tools-15-0/server-tools-15-0-base_view_inheritance_extension"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/149/15.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This module was written to make it simple to add custom operators for view
inheritance.</p>
<p><strong>Table of contents</strong></p>
Expand All @@ -388,23 +388,20 @@ <h1 class="title">Extended view inheritance</h1>
<h1><a class="toc-backref" href="#id1">Usage</a></h1>
<p><strong>Change a python dictionary (context for example)</strong></p>
<pre class="code xml literal-block">
<span class="nt">&lt;attribute</span> <span class="na">name=</span><span class="s">&quot;$attribute&quot;</span> <span class="na">operation=</span><span class="s">&quot;python_dict&quot;</span> <span class="na">key=</span><span class="s">&quot;$key&quot;</span><span class="nt">&gt;</span>
$new_value
<span class="nt">&lt;/attribute&gt;</span>
<span class="nt">&lt;field</span> <span class="na">position=</span><span class="s">&quot;attributes&quot;</span><span class="nt">&gt;</span>
<span class="nt">&lt;attribute</span> <span class="na">name=</span><span class="s">&quot;context&quot;</span> <span class="na">operation=</span><span class="s">&quot;update&quot;</span><span class="nt">&gt;</span>
{
&quot;key&quot;: &quot;value&quot;,
}
<span class="nt">&lt;/attribute&gt;</span>
<span class="nt">&lt;/field&gt;</span>
</pre>
<p>Note that views are subject to evaluation of xmlids anyways, so if you need
to refer to some xmlid, say <tt class="docutils literal">%(xmlid)s</tt>.</p>
<p><strong>Add to values in a list (states for example)</strong></p>
<p>Deprecated. This feature is now native, use <cite>&lt;attribute name=”attrname” separator=”,” add=”something” /&gt;</cite>.</p>
<p><strong>Remove values from a list (states for example)</strong></p>
<p>Deprecated. This feature is now native, use <cite>&lt;attribute name=”attrname” separator=”,” remove=”something” /&gt;</cite>.</p>
<p><strong>Move an element in the view</strong></p>
<p>This feature is now native, cf the <a class="reference external" href="https://www.odoo.com/documentation/14.0/developer/reference/addons/views.html#inheritance-specs">official Odoo documentation</a>.</p>
</div>
<div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#id2">Known issues / Roadmap</a></h1>
<ul class="simple">
<li>On <cite>15.0</cite>, remove <cite>list_add</cite> and <cite>list_remove</cite> fetures.</li>
<li>Support an <tt class="docutils literal">eval</tt> attribute for our new node types.</li>
</ul>
</div>
Expand All @@ -413,7 +410,7 @@ <h1><a class="toc-backref" href="#id3">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.
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
<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20base_view_inheritance_extension%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20base_view_inheritance_extension%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
Expand All @@ -440,7 +437,7 @@ <h2><a class="toc-backref" href="#id7">Maintainers</a></h2>
<p>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.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/14.0/base_view_inheritance_extension">OCA/server-tools</a> project on GitHub.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/15.0/base_view_inheritance_extension">OCA/server-tools</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div>
</div>
Expand Down

0 comments on commit 24e4c54

Please sign in to comment.