From 6372c2a515169e75972c4e4841bdeaeb9686c306 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Bidoul=20=28ACSONE=29?= Date: Sun, 16 Jun 2019 13:32:20 +0200 Subject: [PATCH] [FIX] intrastat_product USAGE.rst title level --- intrastat_product/README.rst | 80 +-- intrastat_product/readme/USAGE.rst | 3 +- .../static/description/index.html | 467 ++++++++++++++++++ 3 files changed, 520 insertions(+), 30 deletions(-) create mode 100644 intrastat_product/static/description/index.html diff --git a/intrastat_product/README.rst b/intrastat_product/README.rst index 8e769ea..92ef742 100644 --- a/intrastat_product/README.rst +++ b/intrastat_product/README.rst @@ -1,12 +1,31 @@ -.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg - :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html - :alt: License: AGPL-3 - ================= Intrastat Product ================= -This module contains common objects and fields for the Intrastat Product reporting, such as the *H.S. codes* (if you are not familiar with H.S. codes, read `Wikipedia `) and the *country of origin* on the products. +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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%2Fintrastat--extrastat-lightgray.png?logo=github + :target: https://github.com/OCA/intrastat-extrastat/tree/12.0/intrastat_product + :alt: OCA/intrastat-extrastat +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/intrastat-extrastat-12-0/intrastat-extrastat-12-0-intrastat_product + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/227/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module contains common objects and fields for the Intrastat Product reporting. It should be used in combination with country-specific Intrastat Product reporting modules such as: @@ -18,14 +37,15 @@ such as: These country-specific modules can be found in the OCA localization for those countries. +**Table of contents** + +.. contents:: + :local: + Installation ============ -WARNING: - -This module conflicts with the module *report_intrastat* from the official addons. -If you have already installed the module *report_intrastat*, -you should uninstall it before installing this module. +This module is NOT compatible with the *account_intrastat* module from Odoo Enterprise. Usage ===== @@ -33,8 +53,7 @@ Usage This module is used in combination with the country-specific localization module(s). -Coding guidelines for localization module: ------------------------------------------- +**Coding guidelines for localization module:** We recommend to start by copying an existing module, e.g. l10n_be_intrastat_product and adapt the code for the specific needs of your country. @@ -65,40 +84,45 @@ and adapt the code for the specific needs of your country. Cf. l10n_be_istrastat_product as example, replace "be" by your Country Code. - -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/227/10.0 - 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. +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 +~~~~~~~ + +* brain-tec AG +* Akretion +* Noviat + Contributors ------------- +~~~~~~~~~~~~ * Alexis de Lattre, Akretion * Luc De Meyer, Noviat -Maintainer ----------- +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -This module is maintained by the OCA. - 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. -To contribute to this module, please visit https://odoo-community.org. +This module is part of the `OCA/intrastat-extrastat `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/intrastat_product/readme/USAGE.rst b/intrastat_product/readme/USAGE.rst index 11bac9d..66ec809 100644 --- a/intrastat_product/readme/USAGE.rst +++ b/intrastat_product/readme/USAGE.rst @@ -1,8 +1,7 @@ This module is used in combination with the country-specific localization module(s). -Coding guidelines for localization module: ------------------------------------------- +**Coding guidelines for localization module:** We recommend to start by copying an existing module, e.g. l10n_be_intrastat_product and adapt the code for the specific needs of your country. diff --git a/intrastat_product/static/description/index.html b/intrastat_product/static/description/index.html new file mode 100644 index 0000000..6312b6b --- /dev/null +++ b/intrastat_product/static/description/index.html @@ -0,0 +1,467 @@ + + + + + + +Intrastat Product + + + +
+

Intrastat Product

+ + +

Beta License: AGPL-3 OCA/intrastat-extrastat Translate me on Weblate Try me on Runbot

+

This module contains common objects and fields for the Intrastat Product reporting.

+

It should be used in combination with country-specific Intrastat Product reporting modules +such as:

+
    +
  • l10n_fr_intrastat_product: +the module for the Déclaration d’Echange de Biens (DEB) for France
    • +
  • l10n_be_intrastat_product: +the module for the Intrastat Product Declaration for Belgium
    • +
+

These country-specific modules can be found in the OCA localization for those countries.

+

Table of contents

+ +
+

Installation

+

This module is NOT compatible with the account_intrastat module from Odoo Enterprise.

+
+
+

Usage

+

This module is used in combination with the country-specific +localization module(s).

+

Coding guidelines for localization module:

+

We recommend to start by copying an existing module, e.g. l10n_be_intrastat_product +and adapt the code for the specific needs of your country.

+
    +

  • Declaration Object

    +

    Create a new class as follows:

    +
    +class L10nCcIntrastatProductDeclaration(models.Model):
+    _name = 'l10n.cc.intrastat.product.declaration'
+    _description = "Intrastat Product Declaration for YourCountry"
+    _inherit = ['intrastat.product.declaration', 'mail.thread']
+
    +

    whereby cc = your country code

    +
    • +

  • Computation & Declaration Lines

    +

    Create also new objects inheriting from the Computation and Declaration Line Objects +so that you can add methods or customise the methods from the base modules (make a PR when +the customization or new method is required for multiple countries).

    +

    Adapt also the parent_id fields of the newly created objects +(cf. l10n_be_intrastat_product as example).

    +
    • +

  • XML Files: Menu, Action, Views

    +

    Cf. l10n_be_istrastat_product as example, replace “be” by your Country Code.

    +
    • +
+
+
+

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

+
    +
  • brain-tec AG
    • +
  • Akretion
    • +
  • Noviat
    • +
+
+
+

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/intrastat-extrastat project on GitHub.

+

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

+
+
+
+ +