From 2ca2abdd22cd7b664cac4d6d7e2713d9bb104a0c Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Wed, 10 Oct 2018 09:51:50 +0000 Subject: [PATCH] [UPD] README.rst --- configuration_helper/README.rst | 111 +++++ .../static/description/index.html | 461 ++++++++++++++++++ 2 files changed, 572 insertions(+) create mode 100644 configuration_helper/README.rst create mode 100644 configuration_helper/static/description/index.html diff --git a/configuration_helper/README.rst b/configuration_helper/README.rst new file mode 100644 index 000000000..724bc286b --- /dev/null +++ b/configuration_helper/README.rst @@ -0,0 +1,111 @@ +==================== +Configuration Helper +==================== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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%2Fserver--tools-lightgray.png?logo=github + :target: https://github.com/OCA/server-tools/tree/11.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 + :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 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +*This module is intended for developer only. It does nothing used alone.* + +It helps to create `config.settings` by providing an abstract Class. + +This class: + + * creates automatically related fields in 'whatiwant.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 + * supported fields: char, text, integer, float, datetime, date, boolean, m2o + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +.. code-block:: python + + from . company import ResCompany + + class WhatiwantClassSettings(orm.TransientModel): + _inherit = ['res.config.settings', 'abstract.config.settings'] + _name = 'whatiwant.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 + _prefix = 'prefixyouchoose_' + + +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 ?) + +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 +~~~~~~~ + +* Akretion + +Contributors +~~~~~~~~~~~~ + +* Yannick Vaucher +* David BEAL +* Sébastien BEAU +* Angel Moya +* Akim Juillerat +* Patrick Tombez + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +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 `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/configuration_helper/static/description/index.html b/configuration_helper/static/description/index.html new file mode 100644 index 000000000..5f06b1c91 --- /dev/null +++ b/configuration_helper/static/description/index.html @@ -0,0 +1,461 @@ + + + + + + +Configuration Helper + + + +
+

Configuration Helper

+ + +

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

+

This module is intended for developer only. It does nothing used alone.

+

It helps to create config.settings by providing an abstract Class.

+

This class:

+
+
    +
  • creates automatically related fields in ‘whatiwant.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
    • +
  • supported fields: char, text, integer, float, datetime, date, boolean, m2o
    • +
+
+

Table of contents

+ +
+

Usage

+
+from . company import ResCompany
+
+class WhatiwantClassSettings(orm.TransientModel):
+    _inherit = ['res.config.settings', 'abstract.config.settings']
+    _name = 'whatiwant.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
+    _prefix = 'prefixyouchoose_'
+
+
+
+

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 ?)
    • +
+
+
+
+

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

+
    +
  • Akretion
    • +
+
+
+

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

+

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

+
+
+
+ +