Author: |
Odoo Community Association (OCA), Coop IT Easy SCRLfs |
License: |
AGPL-3 |
Branch: |
11.0-reservation-summary-alternative |
Repository: |
coopiteasy/vertical-hotel |
Dependencies: |
hotel_reservation,
and
web |
Languages: |
CSS (33, 4.3%),
HTML (356, 46.7%),
JavaScript (68, 8.9%),
Python (182, 23.9%),
XML (52, 6.8%),
and
reStructuredText (71, 9.3%) |
Other branches: |
11.0-reservation-summary-click-actions |
<h1 class="title">Hotel Reservation Summary Base (Alternative)</h1>
<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/vertical-hotel/tree/11.0/hotel_reservation_summary_base"><img alt="oca/vertical-hotel" src="https://img.shields.io/badge/github-oca%2Fvertical--hotel-lightgray.png?logo=github" /></a></p>
<p>This is an alternative implementation of the reservation summary
already implemented in <cite>hotel_reservation</cite> module.</p>
<p>Why did we implement a new version?</p>
<ul class="simple">
<li>the summary is built on top of hotel.room.reservation.line. That model is strongly linked to hotel_reservation.line,</li>
<li>we find it complex to maintain a correct matching state between those two models,</li>
<li>the code to synchronise states is making the reservation code complex,</li>
<li>it is hard to extend the current code (for example we would like to display days where a draft reservation is running)</li>
<li>the summary code could be in a separate module for more modularity</li>
</ul>
<p>What did we keep?
- the reservation table template
- the javascript widget and the data model to use it.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id2">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id5">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id7">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id1">Usage</a></h2>
<p>To create a reservation summary, inherit this module and implement the hotel.room.reservation.summary
abstract class. For the new model, you need to</p>
<ul class="simple">
<li>overwrite action_generate_summary method,</li>
<li>add an action calling action_generate_summary,</li>
<li>add a menuitem calling that action,</li>
<li>write a form view,</li>
<li>set _form_view to that view.</li>
</ul>
<p>See hotel_reservation_summary_range for an example implementation.</p>
<a name="known-issues-roadmap"></a>
<h2><a class="toc-backref" href="#id2">Known issues / Roadmap</a></h2>
<p>If this module is accepted by the community, we could remove
the hotel.room.reservation.line model from hotel_reservation altogether.</p>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id3">Bug Tracker</a></h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/oca/vertical-hotel/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/vertical-hotel/issues/new?body=module:%20hotel_reservation_summary_base%0Aversion:%2011.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>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id4">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id5">Authors</a></h3>
<ul class="simple">
<li>Coop IT Easy SCRLfs</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id6">Contributors</a></h3>
<ul class="simple">
<li>Robin Keunen <<a class="reference external" href="mailto:robin@coopiteasy.be">robin@coopiteasy.be</a>></li>
</ul>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id7">Maintainers</a></h3>
<p>This module is part of the <a class="reference external" href="https://github.com/oca/vertical-hotel/tree/11.0/hotel_reservation_summary_base">oca/vertical-hotel</a> project on GitHub.</p>
<p>You are welcome to contribute.</p>