Browse Source

[UPD] README.rst

pull/504/head
OCA-git-bot 5 years ago
parent
commit
05db829a0e
  1. 52
      pos_cash_move_reason/README.rst
  2. 521
      pos_cash_move_reason/static/description/index.html

52
pos_cash_move_reason/README.rst

@ -13,11 +13,17 @@ POS cash in-out reason
.. |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-legalsylvain%2Fpos-lightgray.png?logo=github
:target: https://github.com/legalsylvain/pos/tree/12.0-mig-pos_cash_move_reason/pos_cash_move_reason
:alt: legalsylvain/pos
|badge1| |badge2| |badge3|
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fpos-lightgray.png?logo=github
:target: https://github.com/OCA/pos/tree/12.0/pos_cash_move_reason
:alt: OCA/pos
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/pos-12-0/pos-12-0-pos_cash_move_reason
: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/12.0
:alt: Try me on Runbot
|badge1| |badge2| |badge3| |badge4| |badge5|
This module allow to define some reasons for the functionality of
"Put Money In" and "Take Money Out" available in point of sale session.
@ -45,7 +51,7 @@ Configuration
* Go to 'Point of Sale' / 'Configuration' / 'Move Reason'
.. figure:: https://raw.githubusercontent.com/legalsylvain/pos/12.0-mig-pos_cash_move_reason/pos_cash_move_reason/static/description/pos_cash_move_tree.png
.. figure:: https://raw.githubusercontent.com/OCA/pos/12.0/pos_cash_move_reason/static/description/pos_cash_move_tree.png
:alt: PoS Move Reasons List
* Create or update your PoS move Reasons.
@ -53,7 +59,7 @@ Configuration
Cash Journal), and if it is a reason to 'put in' and / or to 'take out'
Money.
.. figure:: https://raw.githubusercontent.com/legalsylvain/pos/12.0-mig-pos_cash_move_reason/pos_cash_move_reason/static/description/pos_cash_move_form.png
.. figure:: https://raw.githubusercontent.com/OCA/pos/12.0/pos_cash_move_reason/static/description/pos_cash_move_form.png
:alt: PoS Move Reason
**Note**
@ -68,18 +74,26 @@ Usage
* Click on the button "Put Money In" or "Take Money Out"
.. figure:: https://raw.githubusercontent.com/legalsylvain/pos/12.0-mig-pos_cash_move_reason/pos_cash_move_reason/static/description/pos_session_form.png
.. figure:: https://raw.githubusercontent.com/OCA/pos/12.0/pos_cash_move_reason/static/description/pos_session_form.png
* Select the reason, the journal, the amount, and optionaly an extra
description
.. figure:: https://raw.githubusercontent.com/legalsylvain/pos/12.0-mig-pos_cash_move_reason/pos_cash_move_reason/static/description/wizard_pos_move_reason_form.png
.. figure:: https://raw.githubusercontent.com/OCA/pos/12.0/pos_cash_move_reason/static/description/wizard_pos_move_reason_form.png
* When closing the session, an account move will be created, with two lines,
one with the default journal account, and one with the expense / income
reason account.
.. figure:: https://raw.githubusercontent.com/legalsylvain/pos/12.0-mig-pos_cash_move_reason/pos_cash_move_reason/static/description/account_move_form.png
.. figure:: https://raw.githubusercontent.com/OCA/pos/12.0/pos_cash_move_reason/static/description/account_move_form.png
Known issues / Roadmap
======================
As it is not possible to disable actions on Odoo, a new technical group is
added by this module, named 'Use Old PoS 'Put or Take Money' Actions', to
hide native obsolete actions available on the model ``pos.session``
(the two buttons "Take Money Out" and "Put Money In")
Changelog
=========
@ -108,10 +122,10 @@ Changelog
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/legalsylvain/pos/issues>`_.
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/legalsylvain/pos/issues/new?body=module:%20pos_cash_move_reason%0Aversion:%2012.0-mig-pos_cash_move_reason%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
`feedback <https://github.com/OCA/pos/issues/new?body=module:%20pos_cash_move_reason%0Aversion:%2012.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.
@ -132,6 +146,16 @@ Contributors
Maintainers
~~~~~~~~~~~
This module is part of the `legalsylvain/pos <https://github.com/legalsylvain/pos/tree/12.0-mig-pos_cash_move_reason/pos_cash_move_reason>`_ project on GitHub.
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/12.0/pos_cash_move_reason>`_ project on GitHub.
You are welcome to contribute.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

521
pos_cash_move_reason/static/description/index.html

@ -0,0 +1,521 @@
<?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.15.1: http://docutils.sourceforge.net/" />
<title>POS cash in-out reason</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="pos-cash-in-out-reason">
<h1 class="title">POS cash in-out reason</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/12.0/pos_cash_move_reason"><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-12-0/pos-12-0-pos_cash_move_reason"><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/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This module allow to define some reasons for the functionality of
“Put Money In” and “Take Money Out” available in point of sale session.</p>
<p>So, with this module it’s possible to impact directly an expense or income
account which is defined on the related reasons and create according
accounting entries.</p>
<p><strong>Typical Use Case (not exhaustive)</strong></p>
<ul class="simple">
<li>You want to track <strong>Bank deposit</strong> moves, using an intermediate
bank account named ‘Cash Awaiting Bank Deposit’.
(In France, for instance, “581 - Espèce en attente d’encaissement”)</li>
<li>You want to allow payments from Cash Journal to pay recurring
little expenses. (Gasoline, parking meter, etc.)</li>
</ul>
<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="id4">Configuration</a></li>
<li><a class="reference internal" href="#usage" id="id5">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id6">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#changelog" id="id7">Changelog</a><ul>
<li><a class="reference internal" href="#id1" id="id8">12.0.3.0.0 (2019-08-13)</a></li>
<li><a class="reference internal" href="#id2" id="id9">8.0.2.0.0 (2018-06-25)</a></li>
<li><a class="reference internal" href="#id3" id="id10">8.0.1.0.0 (2017-06-08)</a></li>
</ul>
</li>
<li><a class="reference internal" href="#bug-tracker" id="id11">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id12">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id13">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id14">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id15">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#id4">Configuration</a></h1>
<ul class="simple">
<li>Go to ‘Point of Sale’ / ‘Configuration’ / ‘Move Reason’</li>
</ul>
<div class="figure">
<img alt="PoS Move Reasons List" src="https://raw.githubusercontent.com/OCA/pos/12.0/pos_cash_move_reason/static/description/pos_cash_move_tree.png" />
</div>
<ul class="simple">
<li>Create or update your PoS move Reasons.</li>
<li>for each reason, you can mention the concerned journal(s), (Generally the
Cash Journal), and if it is a reason to ‘put in’ and / or to ‘take out’
Money.</li>
</ul>
<div class="figure">
<img alt="PoS Move Reason" src="https://raw.githubusercontent.com/OCA/pos/12.0/pos_cash_move_reason/static/description/pos_cash_move_form.png" />
</div>
<p><strong>Note</strong></p>
<p>You should have checked first ‘Used in Point of Sale’ for the Journals you want
to enable the feature.</p>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id5">Usage</a></h1>
<ul class="simple">
<li>Go to your current session</li>
<li>Click on the button “Put Money In” or “Take Money Out”</li>
</ul>
<div class="figure">
<img alt="https://raw.githubusercontent.com/OCA/pos/12.0/pos_cash_move_reason/static/description/pos_session_form.png" src="https://raw.githubusercontent.com/OCA/pos/12.0/pos_cash_move_reason/static/description/pos_session_form.png" />
</div>
<ul class="simple">
<li>Select the reason, the journal, the amount, and optionaly an extra
description</li>
</ul>
<div class="figure">
<img alt="https://raw.githubusercontent.com/OCA/pos/12.0/pos_cash_move_reason/static/description/wizard_pos_move_reason_form.png" src="https://raw.githubusercontent.com/OCA/pos/12.0/pos_cash_move_reason/static/description/wizard_pos_move_reason_form.png" />
</div>
<ul class="simple">
<li>When closing the session, an account move will be created, with two lines,
one with the default journal account, and one with the expense / income
reason account.</li>
</ul>
<div class="figure">
<img alt="https://raw.githubusercontent.com/OCA/pos/12.0/pos_cash_move_reason/static/description/account_move_form.png" src="https://raw.githubusercontent.com/OCA/pos/12.0/pos_cash_move_reason/static/description/account_move_form.png" />
</div>
</div>
<div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#id6">Known issues / Roadmap</a></h1>
<p>As it is not possible to disable actions on Odoo, a new technical group is
added by this module, named ‘Use Old PoS ‘Put or Take Money’ Actions’, to
hide native obsolete actions available on the model <tt class="docutils literal">pos.session</tt>
(the two buttons “Take Money Out” and “Put Money In”)</p>
</div>
<div class="section" id="changelog">
<h1><a class="toc-backref" href="#id7">Changelog</a></h1>
<div class="section" id="id1">
<h2><a class="toc-backref" href="#id8">12.0.3.0.0 (2019-08-13)</a></h2>
<ul class="simple">
<li>[MIG] Port module to version 12.0.</li>
<li>[REF] Don’t use <tt class="docutils literal">product.product</tt> model for Reasons, because Odoo remove
the fields <tt class="docutils literal">expense_pdt</tt> <tt class="docutils literal">and income_pdt</tt> from the model.
Use instead a new model <tt class="docutils literal">pos.move.reason</tt> for this purpose.</li>
<li>[REF] Doesn’t inherit from <tt class="docutils literal">cash.box.in</tt> and <tt class="docutils literal">cash.box.out</tt> model,
as there are bad designed and doesn’t allow clean inheritance.
Instead, use new transient model <tt class="docutils literal">wizard.pos.move.reason</tt>.</li>
</ul>
</div>
<div class="section" id="id2">
<h2><a class="toc-backref" href="#id9">8.0.2.0.0 (2018-06-25)</a></h2>
<ul class="simple">
<li>[REF] Minor code refactoring.</li>
</ul>
</div>
<div class="section" id="id3">
<h2><a class="toc-backref" href="#id10">8.0.1.0.0 (2017-06-08)</a></h2>
<ul class="simple">
<li>First Version of the module.</li>
</ul>
</div>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id11">Bug Tracker</a></h1>
<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_cash_move_reason%0Aversion:%2012.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">
<h1><a class="toc-backref" href="#id12">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id13">Authors</a></h2>
<ul class="simple">
<li>ACSONE SA/NV</li>
<li>GRAP</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id14">Contributors</a></h2>
<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="maintainers">
<h2><a class="toc-backref" href="#id15">Maintainers</a></h2>
<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/12.0/pos_cash_move_reason">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>
</body>
</html>
Loading…
Cancel
Save