OCA
/
server-tools
5
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Browse Source

[UPD] README.rst

12.0-mig-module_prototyper_last
OCA-git-bot 5 years ago
parent
16333eb974
commit
8d3781ba27
2 changed files with 18 additions and 18 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 20
      configuration_helper/README.rst
  2. 16
      configuration_helper/static/description/index.html

20
configuration_helper/README.rst
View File

@ -14,13 +14,13 @@ Configuration Helper
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
:target: https://github.com/OCA/server-tools/tree/11.0/configuration_helper
:target: https://github.com/OCA/server-tools/tree/12.0/configuration_helper
: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-11-0/server-tools-11-0-configuration_helper
:target: https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-configuration_helper
: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/11.0
:target: https://runbot.odoo-community.org/runbot/149/12.0
:alt: Try me on Runbot
|badge1| |badge2| |badge3| |badge4| |badge5|
@ -31,7 +31,7 @@ It helps to create `config.settings` by providing an abstract Class.
This class:
* creates automatically related fields in 'whatiwant.config.settings'
* creates automatically related fields in 'res.config.settings'
using those defined in 'res.company': it avoids duplicated field definitions.
* company_id field with default value is created
* onchange_company_id is defined to update all related fields
@ -49,13 +49,13 @@ Usage
from . company import ResCompany
class WhatiwantClassSettings(orm.TransientModel):
class WhatiwantConfigSettings(models.TransientModel):
_inherit = ['res.config.settings', 'abstract.config.settings']
_name = 'whatiwant.config.settings'
_name = 'res.config.settings'
# fields must be defined in ResCompany class
# related fields are automatically generated from previous definitions
_companyObject = ResCompany
# all prefixed field with _prefix in res.company, will be available in 'whatiwant.config.settings' model
# all prefixed field with _prefix in res.company, will be available in 'res.config.settings' model
_prefix = 'prefixyouchoose_'
@ -63,7 +63,7 @@ Known issues / Roadmap
======================
* support (or check support) for these field types : o2m, m2m, reference, property, selection
* automatically generate a default view for 'whatiwant.config.settings' (in --debug ?)
* automatically generate a default view for 'res.config.settings' (in --debug ?)
Bug Tracker
===========
@ -71,7 +71,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:%20configuration_helper%0Aversion:%2011.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:%20configuration_helper%0Aversion:%2012.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.
@ -106,6 +106,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/11.0/configuration_helper>`_ project on GitHub.
This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/12.0/configuration_helper>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

16
configuration_helper/static/description/index.html
View File

@ -367,13 +367,13 @@ ul.auto-toc {
!! 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/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" href="https://github.com/OCA/server-tools/tree/11.0/configuration_helper"><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-11-0/server-tools-11-0-configuration_helper"><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/11.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/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" href="https://github.com/OCA/server-tools/tree/12.0/configuration_helper"><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-12-0/server-tools-12-0-configuration_helper"><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/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p><em>This module is intended for developer only. It does nothing used alone.</em></p>
<p>It helps to create <cite>config.settings</cite> by providing an abstract Class.</p>
<p>This class:</p>
<blockquote>
<ul class="simple">
<li>creates automatically related fields in ‘whatiwant.config.settings’
<li>creates automatically related fields in ‘res.config.settings’
using those defined in ‘res.company’: it avoids duplicated field definitions.</li>
<li>company_id field with default value is created</li>
<li>onchange_company_id is defined to update all related fields</li>
@ -399,13 +399,13 @@ using those defined in ‘res.company’: it avoids duplicated field definitions
<pre class="code python literal-block">
<span class="kn">from</span> <span class="nn">.</span> <span class="nn">company</span> <span class="kn">import</span> <span class="n">ResCompany</span>
<span class="k">class</span> <span class="nc">WhatiwantClassSettings</span><span class="p">(</span><span class="n">orm</span><span class="o">.</span><span class="n">TransientModel</span><span class="p">):</span>
<span class="k">class</span> <span class="nc">WhatiwantConfigSettings</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">TransientModel</span><span class="p">):</span>
<span class="n">_inherit</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'res.config.settings'</span><span class="p">,</span> <span class="s1">'abstract.config.settings'</span><span class="p">]</span>
<span class="n">_name</span> <span class="o">=</span> <span class="s1">'whatiwant.config.settings'</span>
<span class="n">_name</span> <span class="o">=</span> <span class="s1">'res.config.settings'</span>
<span class="c1"># fields must be defined in ResCompany class</span>
<span class="c1"># related fields are automatically generated from previous definitions</span>
<span class="n">_companyObject</span> <span class="o">=</span> <span class="n">ResCompany</span>
<span class="c1"># all prefixed field with _prefix in res.company, will be available in 'whatiwant.config.settings' model</span>
<span class="c1"># all prefixed field with _prefix in res.company, will be available in 'res.config.settings' model</span>
<span class="n">_prefix</span> <span class="o">=</span> <span class="s1">'prefixyouchoose_'</span>
</pre>
</div>
@ -414,7 +414,7 @@ using those defined in ‘res.company’: it avoids duplicated field definitions
<blockquote>
<ul class="simple">
<li>support (or check support) for these field types : o2m, m2m, reference, property, selection</li>
<li>automatically generate a default view for ‘whatiwant.config.settings’ (in –debug ?)</li>
<li>automatically generate a default view for ‘res.config.settings’ (in –debug ?)</li>
</ul>
</blockquote>
</div>
@ -423,7 +423,7 @@ using those defined in ‘res.company’: it avoids duplicated field definitions
<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:%20configuration_helper%0Aversion:%2011.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:%20configuration_helper%0Aversion:%2012.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">
@ -452,7 +452,7 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
<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/11.0/configuration_helper">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/12.0/configuration_helper">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>

Write Preview
Loading…
Cancel
Save