From 7ce3f6dbc130e4adbf60b15dc16c93dc51422c2d Mon Sep 17 00:00:00 2001 From: Roel Adriaans Date: Sat, 21 Jul 2018 14:59:00 +0200 Subject: [PATCH] [IMP] Fix README.rst Runbot URL in old README.rst pointed to 10.0 runbot, fixed by upgrading template --- contract/README.rst | 76 ++-- contract/readme/CONFIGURE.rst | 2 + contract/readme/CONTRIBUTORS.rst | 5 + contract/readme/DESCRIPTION.rst | 4 + contract/readme/ROADMAP.rst | 2 + contract/readme/USAGE.rst | 27 ++ contract/static/description/index.html | 472 +++++++++++++++++++++++++ 7 files changed, 567 insertions(+), 21 deletions(-) create mode 100644 contract/readme/CONFIGURE.rst create mode 100644 contract/readme/CONTRIBUTORS.rst create mode 100644 contract/readme/DESCRIPTION.rst create mode 100644 contract/readme/ROADMAP.rst create mode 100644 contract/readme/USAGE.rst create mode 100644 contract/static/description/index.html diff --git a/contract/README.rst b/contract/README.rst index 267baaef..af3ce01d 100644 --- a/contract/README.rst +++ b/contract/README.rst @@ -1,20 +1,45 @@ -.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg +================================ +Contracts Management - Recurring +================================ + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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%2Fcontract-lightgray.png?logo=github + :target: https://github.com/OCA/contract/tree/11.0/contract + :alt: OCA/contract +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/contract-11-0/contract-11-0-contract + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/110/11.0 + :alt: Try me on Runbot -================================= -Contracts for recurrent invoicing -================================= +|badge1| |badge2| |badge3| |badge4| |badge5| -This module forward-port to v10 the contracts management with recurring -invoicing functions. Also you can print and send by email contract report. +This module brings back the contracts management with recurring invoicing +features. Also you can print and send by email contract report. In upstream Odoo, this functionality was moved into the Enterprise edition. +**Table of contents** + +.. contents:: + :local: + Configuration ============= -To view discount field set *Discount on lines* in user access rights. +To view discount field in contract line, you need to set *Discount on lines* in +user access rights. Usage ===== @@ -31,6 +56,7 @@ To use this module, you need to: years. * Start date and next invoice date. * Invoicing type: pre-paid or post-paid. + #. Add the lines to be invoiced with the product, description, quantity and price. #. You can mark Auto-price? for having a price automatically obtained applying @@ -46,28 +72,34 @@ To use this module, you need to: #. Click on *Print > Contract* menu to print contract report. #. Click on *Send by Email* button to send contract by email. -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/110/10.0 - Known issues / Roadmap ====================== * Recover states and others functional fields in Contracts. + 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 +~~~~~~~ + +* OpenERP SA +* Tecnativa +* LasLabs + Contributors ------------- +~~~~~~~~~~~~ * Pedro M. Baeza * Carlos Dauden @@ -75,17 +107,19 @@ Contributors * Dave Lasley * Vicent Cubells -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/contract `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/contract/readme/CONFIGURE.rst b/contract/readme/CONFIGURE.rst new file mode 100644 index 00000000..d0a7e43b --- /dev/null +++ b/contract/readme/CONFIGURE.rst @@ -0,0 +1,2 @@ +To view discount field in contract line, you need to set *Discount on lines* in +user access rights. diff --git a/contract/readme/CONTRIBUTORS.rst b/contract/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..c749c1ef --- /dev/null +++ b/contract/readme/CONTRIBUTORS.rst @@ -0,0 +1,5 @@ +* Pedro M. Baeza +* Carlos Dauden +* Angel Moya +* Dave Lasley +* Vicent Cubells diff --git a/contract/readme/DESCRIPTION.rst b/contract/readme/DESCRIPTION.rst new file mode 100644 index 00000000..ab6e258d --- /dev/null +++ b/contract/readme/DESCRIPTION.rst @@ -0,0 +1,4 @@ +This module brings back the contracts management with recurring invoicing +features. Also you can print and send by email contract report. + +In upstream Odoo, this functionality was moved into the Enterprise edition. diff --git a/contract/readme/ROADMAP.rst b/contract/readme/ROADMAP.rst new file mode 100644 index 00000000..c8a2afdb --- /dev/null +++ b/contract/readme/ROADMAP.rst @@ -0,0 +1,2 @@ +* Recover states and others functional fields in Contracts. + diff --git a/contract/readme/USAGE.rst b/contract/readme/USAGE.rst new file mode 100644 index 00000000..55474837 --- /dev/null +++ b/contract/readme/USAGE.rst @@ -0,0 +1,27 @@ +To use this module, you need to: + +#. Go to Accounting -> Contracts and select or create a new contract. +#. Check *Generate recurring invoices automatically*. +#. Fill fields for selecting the recurrency and invoice parameters: + + * Journal + * Pricelist + * Period. It can be any interval of days, weeks, months, months last day or + years. + * Start date and next invoice date. + * Invoicing type: pre-paid or post-paid. + +#. Add the lines to be invoiced with the product, description, quantity and + price. +#. You can mark Auto-price? for having a price automatically obtained applying + the pricelist to the product price. +#. You have the possibility to use the markers #START# or #END# in the + description field to show the start and end date of the invoiced period. +#. Choosing between pre-paid and post-paid, you modify the dates that are shown + with the markers. +#. A cron is created with daily interval, but if you are in debug mode, you can + click on *Create invoices* to force this action. +#. Click *Show recurring invoices* link to show all invoices created by the + contract. +#. Click on *Print > Contract* menu to print contract report. +#. Click on *Send by Email* button to send contract by email. diff --git a/contract/static/description/index.html b/contract/static/description/index.html new file mode 100644 index 00000000..20d9870e --- /dev/null +++ b/contract/static/description/index.html @@ -0,0 +1,472 @@ + + + + + + +Contracts Management - Recurring + + + +
+

Contracts Management - Recurring

+ + +

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

+

This module brings back the contracts management with recurring invoicing +features. Also you can print and send by email contract report.

+

In upstream Odoo, this functionality was moved into the Enterprise edition.

+

Table of contents

+ +
+

Configuration

+

To view discount field in contract line, you need to set Discount on lines in +user access rights.

+
+
+

Usage

+

To use this module, you need to:

+
    +
  1. Go to Accounting -> Contracts and select or create a new contract.
    2. +
  2. Check Generate recurring invoices automatically.
    3. +
  3. Fill fields for selecting the recurrency and invoice parameters:
      +
    • Journal
      • +
    • Pricelist
      • +
    • Period. It can be any interval of days, weeks, months, months last day or +years.
      • +
    • Start date and next invoice date.
      • +
    • Invoicing type: pre-paid or post-paid.
      • +
    +
    4. +
  4. Add the lines to be invoiced with the product, description, quantity and +price.
    5. +
  5. You can mark Auto-price? for having a price automatically obtained applying +the pricelist to the product price.
    6. +
  6. You have the possibility to use the markers #START# or #END# in the +description field to show the start and end date of the invoiced period.
    7. +
  7. Choosing between pre-paid and post-paid, you modify the dates that are shown +with the markers.
    8. +
  8. A cron is created with daily interval, but if you are in debug mode, you can +click on Create invoices to force this action.
    9. +
  9. Click Show recurring invoices link to show all invoices created by the +contract.
    10. +
  10. Click on Print > Contract menu to print contract report.
    11. +
  11. Click on Send by Email button to send contract by email.
    12. +
+
+
+

Known issues / Roadmap

+
    +
  • Recover states and others functional fields in Contracts.
    • +
+
+
+

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

+
    +
  • OpenERP SA
    • +
  • Tecnativa
    • +
  • LasLabs
    • +
+
+
+

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

+

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

+
+
+
+ +