[UPD] README.rst

6 years ago · b56c26e8f6
2 changed files with 597 additions and 16 deletions
--- a/pos_picking_delayed/README.rst
+++ b/pos_picking_delayed/README.rst
@ -1,21 +1,129 @@
 **This file is going to be generated by oca-gen-addon-readme.**
 ========================================
 Point of Sale - Picking Creation Delayed
 ========================================
 *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-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%2Fpos-lightgray.png?logo=github
    :target: https://github.com/OCA/pos/tree/10.0/pos_picking_delayed
    :alt: OCA/pos
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/pos-10-0/pos-10-0-pos_picking_delayed
    :alt: Translate me on Weblate
 .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
    :target: https://runbot.odoo-community.org/runbot/184/10.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 functionality of odoo Point Of Sale to reduce creation
 time of the PoS orders, via the front UI.
 A good, one sentence summary in the manifest is also highly recommended.
 For that purpose, it delays the creation of the picking associated, that will
 be created later, by cron. (set by default to run each minute).
 Technical information
 ---------------------
 A log will be generated to mention the creation of the pickings by cron.
 ``2018-09-28 07:47:18,300 163 INFO db odoo.addons.base.ir.ir_cron: Starting job `Create Delayed PoS Picking.``
 ``2018-09-28 07:47:19,168 163 INFO db odoo.addons.pos_picking_delayed.models.pos_order: Pickings created for 3 PoS Orders``
 This module is interesting specially in a context of Synchroneous Point Of
 Sale that is introduced by certification modules like 'l10n_fr_pos_cert' because
 in such cases, the bill will be printed only when the pos order is created (
 after the call of the function create_from_ui) and the creation of the picking
 is the process that takes the most time.
 See https://github.com/odoo/odoo/pull/26314#issuecomment-422949266
 for more information.
 **Table of contents**
 .. contents::
   :local:
 Configuration
 =============
 * Go to 'Point of Sale' / 'Configuration' / 'Point of Sale'
 * Select your Point of Sale
 * Set the value in the field 'Picking Creation Delayed'. (Checked by default)
 .. image:: https://raw.githubusercontent.com/pos_picking_delayed/static/description/pos_config_form.png
 Usage
 =====
 * Use your Point of Sale as usual. when validating an order, the order will
  be in a different color until the cron is executed
 .. image:: https://raw.githubusercontent.com/pos_picking_delayed/static/description/pos_order_tree.png
 Known issues / Roadmap
 ======================
 * Make this module depend on the module OCA `queue_job` job module.
 * In the cron job (or the future queue job), improvment can be done, limiting
  the quantity of environments, grouping orders by company, and changing
  context once.
 Bug Tracker
 ===========
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/pos/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/pos/issues/new?body=module:%20pos_picking_delayed%0Aversion:%2010.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.
 Credits
 =======
 Authors
 ~~~~~~~
 * GRAP
 Contributors
 ~~~~~~~~~~~~
 * Sylvain LE GAL <https://twitter.com/legalsylvain>
 Other credits
 ~~~~~~~~~~~~~
 The development of this module has been financially supported by:
 * GRAP, Groupement Régional Alimentaire de Proximité (www.grap.coop)
 * Mind & Go, (https://mind-and-go.com/)
 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/pos <https://github.com/OCA/pos/tree/10.0/pos_picking_delayed>`_ project on GitHub.
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
--- a/pos_picking_delayed/static/description/index.html
+++ b/pos_picking_delayed/static/description/index.html
@ -0,0 +1,473 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
 <title>Point of Sale - Picking Creation Delayed</title>
 <style type="text/css">
 /*
 :Author: David Goodger (goodger@python.org)
 :Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
 :Copyright: This stylesheet has been placed in the public domain.
 Default cascading style sheet for the HTML output of Docutils.
 See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
 customize this style sheet.
 */
 /* used to remove borders from tables and images */
 .borderless, table.borderless td, table.borderless th {
  border: 0 }
 table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }
 .first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }
 .last, .with-subtitle {
  margin-bottom: 0 ! important }
 .hidden {
  display: none }
 .subscript {
  vertical-align: sub;
  font-size: smaller }
 .superscript {
  vertical-align: super;
  font-size: smaller }
 a.toc-backref {
  text-decoration: none ;
  color: black }
 blockquote.epigraph {
  margin: 2em 5em ; }
 dl.docutils dd {
  margin-bottom: 0.5em }
 object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  overflow: hidden;
 }
 /* Uncomment (and remove this text!) to get bold-faced definition list terms
 dl.docutils dt {
  font-weight: bold }
 */
 div.abstract {
  margin: 2em 5em }
 div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }
 div.admonition, div.attention, div.caution, div.danger, div.error,
 div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }
 div.admonition p.admonition-title, div.hint p.admonition-title,
 div.important p.admonition-title, div.note p.admonition-title,
 div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }
 div.attention p.admonition-title, div.caution p.admonition-title,
 div.danger p.admonition-title, div.error p.admonition-title,
 div.warning p.admonition-title, .code .error {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }
 /* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
 div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }
 div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
 */
 div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }
 div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }
 div.figure {
  margin-left: 2em ;
  margin-right: 2em }
 div.footer, div.header {
  clear: both;
  font-size: smaller }
 div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }
 div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }
 div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }
 div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }
 div.system-messages {
  margin: 5em }
 div.system-messages h1 {
  color: red }
 div.system-message {
  border: medium outset ;
  padding: 1em }
 div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }
 div.topic {
  margin: 2em }
 h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
 h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }
 h1.title {
  text-align: center }
 h2.subtitle {
  text-align: center }
 hr.docutils {
  width: 75% }
 img.align-left, .figure.align-left, object.align-left, table.align-left {
  clear: left ;
  float: left ;
  margin-right: 1em }
 img.align-right, .figure.align-right, object.align-right, table.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }
 img.align-center, .figure.align-center, object.align-center {
  display: block;
  margin-left: auto;
  margin-right: auto;
 }
 table.align-center {
  margin-left: auto;
  margin-right: auto;
 }
 .align-left {
  text-align: left }
 .align-center {
  clear: both ;
  text-align: center }
 .align-right {
  text-align: right }
 /* reset inner alignment in figures */
 div.align-right {
  text-align: inherit }
 /* div.align-center * { */
 /*   text-align: left } */
 .align-top    {
  vertical-align: top }
 .align-middle {
  vertical-align: middle }
 .align-bottom {
  vertical-align: bottom }
 ol.simple, ul.simple {
  margin-bottom: 1em }
 ol.arabic {
  list-style: decimal }
 ol.loweralpha {
  list-style: lower-alpha }
 ol.upperalpha {
  list-style: upper-alpha }
 ol.lowerroman {
  list-style: lower-roman }
 ol.upperroman {
  list-style: upper-roman }
 p.attribution {
  text-align: right ;
  margin-left: 50% }
 p.caption {
  font-style: italic }
 p.credits {
  font-style: italic ;
  font-size: smaller }
 p.label {
  white-space: nowrap }
 p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }
 p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }
 p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }
 p.topic-title {
  font-weight: bold }
 pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font: inherit }
 pre.literal-block, pre.doctest-block, pre.math, pre.code {
  margin-left: 2em ;
  margin-right: 2em }
 pre.code .ln { color: grey; } /* line numbers */
 pre.code, code { background-color: #eeeeee }
 pre.code .comment, code .comment { color: #5C6576 }
 pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
 pre.code .literal.string, code .literal.string { color: #0C5404 }
 pre.code .name.builtin, code .name.builtin { color: #352B84 }
 pre.code .deleted, code .deleted { background-color: #DEB0A1}
 pre.code .inserted, code .inserted { background-color: #A3D289}
 span.classifier {
  font-family: sans-serif ;
  font-style: oblique }
 span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }
 span.interpreted {
  font-family: sans-serif }
 span.option {
  white-space: nowrap }
 span.pre {
  white-space: pre }
 span.problematic {
  color: red }
 span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }
 table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }
 table.docinfo {
  margin: 2em 4em }
 table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }
 table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }
 table.docutils td, table.docutils th,
 table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }
 table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }
 /* "booktabs" style (no vertical lines) */
 table.docutils.booktabs {
  border: 0px;
  border-top: 2px solid;
  border-bottom: 2px solid;
  border-collapse: collapse;
 }
 table.docutils.booktabs * {
  border: 0px;
 }
 table.docutils.booktabs th {
  border-bottom: thin solid;
  text-align: left;
 }
 h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
 h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }
 ul.auto-toc {
  list-style-type: none }
 </style>
 </head>
 <body>
 <div class="document" id="point-of-sale-picking-creation-delayed">
 <h1 class="title">Point of Sale - Picking Creation Delayed</h1>
 <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! 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/pos/tree/10.0/pos_picking_delayed"><img alt="OCA/pos" src="https://img.shields.io/badge/github-OCA%2Fpos-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/pos-10-0/pos-10-0-pos_picking_delayed"><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/184/10.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
 <p>This module extends the functionality of odoo Point Of Sale to reduce creation
 time of the PoS orders, via the front UI.</p>
 <p>For that purpose, it delays the creation of the picking associated, that will
 be created later, by cron. (set by default to run each minute).</p>
 <div class="section" id="technical-information">
 <h1>Technical information</h1>
 <p>A log will be generated to mention the creation of the pickings by cron.</p>
 <p><tt class="docutils literal"><span class="pre">2018-09-28</span> 07:47:18,300 163 INFO db odoo.addons.base.ir.ir_cron: Starting job `Create Delayed PoS Picking.</tt></p>
 <p><tt class="docutils literal"><span class="pre">2018-09-28</span> 07:47:19,168 163 INFO db odoo.addons.pos_picking_delayed.models.pos_order: Pickings created for 3 PoS Orders</tt></p>
 <p>This module is interesting specially in a context of Synchroneous Point Of
 Sale that is introduced by certification modules like ‘l10n_fr_pos_cert’ because
 in such cases, the bill will be printed only when the pos order is created (
 after the call of the function create_from_ui) and the creation of the picking
 is the process that takes the most time.</p>
 <p>See <a class="reference external" href="https://github.com/odoo/odoo/pull/26314#issuecomment-422949266">https://github.com/odoo/odoo/pull/26314#issuecomment-422949266</a>
 for more information.</p>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
 <li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
 <li><a class="reference internal" href="#usage" id="id2">Usage</a></li>
 <li><a class="reference internal" href="#known-issues-roadmap" id="id3">Known issues / Roadmap</a></li>
 <li><a class="reference internal" href="#bug-tracker" id="id4">Bug Tracker</a></li>
 <li><a class="reference internal" href="#credits" id="id5">Credits</a><ul>
 <li><a class="reference internal" href="#authors" id="id6">Authors</a></li>
 <li><a class="reference internal" href="#contributors" id="id7">Contributors</a></li>
 <li><a class="reference internal" href="#other-credits" id="id8">Other credits</a></li>
 <li><a class="reference internal" href="#maintainers" id="id9">Maintainers</a></li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="section" id="configuration">
 <h2><a class="toc-backref" href="#id1">Configuration</a></h2>
 <ul class="simple">
 <li>Go to ‘Point of Sale’ / ‘Configuration’ / ‘Point of Sale’</li>
 <li>Select your Point of Sale</li>
 <li>Set the value in the field ‘Picking Creation Delayed’. (Checked by default)</li>
 </ul>
 <img alt="https://raw.githubusercontent.com/pos_picking_delayed/static/description/pos_config_form.png" src="https://raw.githubusercontent.com/pos_picking_delayed/static/description/pos_config_form.png" />
 </div>
 <div class="section" id="usage">
 <h2><a class="toc-backref" href="#id2">Usage</a></h2>
 <ul class="simple">
 <li>Use your Point of Sale as usual. when validating an order, the order will
 be in a different color until the cron is executed</li>
 </ul>
 <img alt="https://raw.githubusercontent.com/pos_picking_delayed/static/description/pos_order_tree.png" src="https://raw.githubusercontent.com/pos_picking_delayed/static/description/pos_order_tree.png" />
 </div>
 <div class="section" id="known-issues-roadmap">
 <h2><a class="toc-backref" href="#id3">Known issues / Roadmap</a></h2>
 <ul class="simple">
 <li>Make this module depend on the module OCA <cite>queue_job</cite> job module.</li>
 <li>In the cron job (or the future queue job), improvment can be done, limiting
 the quantity of environments, grouping orders by company, and changing
 context once.</li>
 </ul>
 </div>
 <div class="section" id="bug-tracker">
 <h2><a class="toc-backref" href="#id4">Bug Tracker</a></h2>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/pos/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/pos/issues/new?body=module:%20pos_picking_delayed%0Aversion:%2010.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">
 <h2><a class="toc-backref" href="#id5">Credits</a></h2>
 <div class="section" id="authors">
 <h3><a class="toc-backref" href="#id6">Authors</a></h3>
 <ul class="simple">
 <li>GRAP</li>
 </ul>
 </div>
 <div class="section" id="contributors">
 <h3><a class="toc-backref" href="#id7">Contributors</a></h3>
 <ul class="simple">
 <li>Sylvain LE GAL &lt;<a class="reference external" href="https://twitter.com/legalsylvain">https://twitter.com/legalsylvain</a>&gt;</li>
 </ul>
 </div>
 <div class="section" id="other-credits">
 <h3><a class="toc-backref" href="#id8">Other credits</a></h3>
 <p>The development of this module has been financially supported by:</p>
 <ul class="simple">
 <li>GRAP, Groupement Régional Alimentaire de Proximité (www.grap.coop)</li>
 <li>Mind &amp; Go, (<a class="reference external" href="https://mind-and-go.com/">https://mind-and-go.com/</a>)</li>
 </ul>
 </div>
 <div class="section" id="maintainers">
 <h3><a class="toc-backref" href="#id9">Maintainers</a></h3>
 <p>This module is maintained by the OCA.</p>
 <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
 <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/pos/tree/10.0/pos_picking_delayed">OCA/pos</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>
 </div>
 </div>
 </body>
 </html>