audrius/pms
1
0
Fork 1
mirror of https://github.com/OCA/pms.git synced 2025-01-29 00:17:45 +02:00
Code Issues Packages Projects Releases Wiki Activity

[ADD] readme files structure for future oca-gen-addon-readme

Browse Source
This commit is contained in:
Pablo
2019-09-27 08:00:00 +02:00
parent 68e8b5eee5
commit 0fbaa66551
7 changed files with 43 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
hotel_calendar/readme/CONFIGURE.rst Normal file
View File

@@ -0,0 +1,8 @@
.. [ This file is optional, it should explain how to configure
the module before using it; it is aimed at advanced users. ]
No action required. The module is pre-configured with default values.
You will find the hotel calendar settings in `Settings > Users & Companies > Hotels > Your Hotel > Calendar Settings Tab`.
Reservation colors can be configured by company in `Settings > Users & Companies > Companies > Your Company > Hotel Preferences Tab.`

3
hotel_calendar/readme/CONTRIBUTORS.rst
View File

@@ -1 +1,2 @@
* Alexandre Díaz <dev@redneboa.es>
# authors are taken from the __manifest__.py file
* Pablo Quesada <pabloqb@gmail.com>

2
hotel_calendar/readme/CREDITS.rst Normal file
View File

@@ -0,0 +1,2 @@
.. [ This file is optional and contains additional credits, other than
authors, contributors, and maintainers. ]

14
hotel_calendar/readme/DESCRIPTION.rst
View File

@@ -1,8 +1,10 @@
This module adds new view type "pms" and "mpms"
.. [ This file must be max 2-3 paragraphs, and is required. ]
Features:
This module extends the functionality of roomdoo.
* Responsive & Interactive PMS
* Booking Management
* Revenue Management
* Long-Polling Communication
The calendar displays your rooms in a range of dates.
The rooms can be filtered by class, type or even amenities creating new calendars for easily manage all your reservations.
You can manage prices and restrictions day by day using the calendar management view.
This module adds two new view types: ``pms`` and ``mpms``.
The module also incorporates a longpolling for delivering instant notification when using the calendar.

5
hotel_calendar/readme/INSTALL.rst Normal file
View File

@@ -0,0 +1,5 @@
.. [ This file must only be present if there are very specific
installation instructions, such as installing non-python dependencies. The audience is systems administrators. ]
This module depends on modules ``hotel``, ``bus``, ``web``, ``calendar``, and ``web_widget_color``.
Ensure yourself to have all them in your addons list.

7
hotel_calendar/readme/ROADMAP.rst
View File

@@ -1,2 +1,5 @@
* Improve paginator speed
* Improve theme
.. [ Enumerate known caveats and future potential improvements.
It is mostly intended for end-users, and can also help potential new contributors discovering new features to implement. ]
- [ ] Implement the calendar view as an Odoo native view type.
- [ ] Re-design the calendar using SVG or other Odoo native approach.

17
hotel_calendar/readme/USAGE.rst
View File

@@ -1,5 +1,14 @@
The following keyboard shortcuts are implemented:
.. [ This file must be present and contains the usage instructions
for end-users. As all other rst files included in the README, it MUST NOT contain reStructuredText sections
only body text (paragraphs, lists, tables, etc). Should you need a more elaborate structure to explain the addon,
please create a Sphinx documentation (which may include this file as a "quick start" section). ]
* Toggle Advance Search - ALT Key + X Key
* SWAP MODE - CTRL Key + LEFT MOUSE CLICK
* ``ESC`` to cancel active action (ex. Swap)
To use this module, you need to:
* Go to Hotel Calendar menu for managing reservations.
* Go to Hotel Calendar Management for managing prices and restrictions.
* Go to Hotel Management/Configuration/Calendars menu for managing calendar tabs.
Shortcuts
* `CTRL + LEFT MOUSE CLICK`` on a reservation - Start reservation swap
* ``ESC`` - cancel active action (ie. swap)