diff --git a/base_sequence_default/README.rst b/base_sequence_default/README.rst index 38929e877..3d6ad86d5 100644 --- a/base_sequence_default/README.rst +++ b/base_sequence_default/README.rst @@ -1,35 +1,115 @@ -**This file is going to be generated by oca-gen-addon-readme.** +============================ +Default Fields with Sequence +============================ -*Manual changes will be overwritten.* +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -Please provide content in the ``readme`` directory: +.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png + :target: https://odoo-community.org/page/development-status + :alt: Alpha +.. |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/14.0/base_sequence_default + :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_sequence_default + :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 + :alt: Try me on Runbot -* **DESCRIPTION.rst** (required) -* INSTALL.rst (optional) -* CONFIGURE.rst (optional) -* **USAGE.rst** (optional, highly recommended) -* DEVELOP.rst (optional) -* ROADMAP.rst (optional) -* HISTORY.rst (optional, recommended) -* **CONTRIBUTORS.rst** (optional, highly recommended) -* CREDITS.rst (optional) +|badge1| |badge2| |badge3| |badge4| |badge5| -Content of this README will also be drawn from the addon manifest, -from keys such as name, authors, maintainers, development_status, -and license. +This module extends the defaults functionality to allow filling *Character* +type fields on creation with a predefined sequence. -A good, one sentence summary in the manifest is also highly recommended. +.. IMPORTANT:: + This is an alpha version, the data model and design can change at any time without warning. + Only for development or testing purpose, do not use in production. + `More details on development status `_ +**Table of contents** -Automatic changelog generation -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. contents:: + :local: -`HISTORY.rst` can be auto generated using `towncrier `_. +Configuration +============= -Just put towncrier compatible changelog fragments into `readme/newsfragments` -and the changelog file will be automatically generated and updated when a new fragment is added. +To configure this module, you need to: -Please refer to `towncrier` documentation to know more. +#. Enable developer mode. +#. Go to the form view of the model to which you want to add the new sequential default value. +#. Hover over the field to which you want to add the sequential default value. A tooltip with more info will appear. +#. Make sure the tooltip says *Type: char*. Only those fields will work. +#. Take note of the *Object* and *Field*. +#. Go to *Settings > Technical > Sequences & Identifiers > Sequences*. +#. Create one sequence with code named after this pattern: + ``base_sequence_default.{object}.fields.{field}``. + E.g.: ``base_sequence_default.res.partner.fields.name`` to add a default + sequenced name for new partners. +#. Configure the sequence at will. -NOTE: the changelog will be automatically generated when using `/ocabot merge $option`. -If you need to run it manually, refer to `OCA/maintainer-tools README `_. +Usage +===== + +To use this module, it is necessary to: + +#. Follow the configuration instructions. +#. Create a record of the model you configured. +#. Check that the field defined in the sequence is set to the next value in the sequence. + +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 +~~~~~~~ + +* Moduon + +Contributors +~~~~~~~~~~~~ + +* Rafael Blasco (`Moduon `__) +* Eduardo de Miguel (`Moduon `__) +* Jairo Llopis (`Moduon `__) + +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. + +.. |maintainer-Shide| image:: https://github.com/Shide.png?size=40px + :target: https://github.com/Shide + :alt: Shide + +Current `maintainer `__: + +|maintainer-Shide| + +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/base_sequence_default/static/description/index.html b/base_sequence_default/static/description/index.html new file mode 100644 index 000000000..02ddb8ccc --- /dev/null +++ b/base_sequence_default/static/description/index.html @@ -0,0 +1,458 @@ + + + + + + +Default Fields with Sequence + + + +
+

Default Fields with Sequence

+ + +

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

+

This module extends the defaults functionality to allow filling Character +type fields on creation with a predefined sequence.

+
+

Important

+

This is an alpha version, the data model and design can change at any time without warning. +Only for development or testing purpose, do not use in production. +More details on development status

+
+

Table of contents

+ +
+

Configuration

+

To configure this module, you need to:

+
    +
  1. Enable developer mode.
    2. +
  2. Go to the form view of the model to which you want to add the new sequential default value.
    3. +
  3. Hover over the field to which you want to add the sequential default value. A tooltip with more info will appear.
    4. +
  4. Make sure the tooltip says Type: char. Only those fields will work.
    5. +
  5. Take note of the Object and Field.
    6. +
  6. Go to Settings > Technical > Sequences & Identifiers > Sequences.
    7. +
  7. Create one sequence with code named after this pattern: +base_sequence_default.{object}.fields.{field}. +E.g.: base_sequence_default.res.partner.fields.name to add a default +sequenced name for new partners.
    8. +
  8. Configure the sequence at will.
    9. +
+
+
+

Usage

+

To use this module, it is necessary to:

+
    +
  1. Follow the configuration instructions.
    2. +
  2. Create a record of the model you configured.
    3. +
  3. Check that the field defined in the sequence is set to the next value in the sequence.
    4. +
+
+
+

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

+
    +
  • Moduon
    • +
+
+
+

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.

+

Current maintainer:

+

Shide

+

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.

+
+
+
+ +