From 0fbaa665512d057ad35c08c140396da93887d0b4 Mon Sep 17 00:00:00 2001 From: Pablo Date: Fri, 27 Sep 2019 08:00:00 +0200 Subject: [PATCH] [ADD] readme files structure for future oca-gen-addon-readme --- hotel_calendar/readme/CONFIGURE.rst | 8 ++++++++ hotel_calendar/readme/CONTRIBUTORS.rst | 3 ++- hotel_calendar/readme/CREDITS.rst | 2 ++ hotel_calendar/readme/DESCRIPTION.rst | 14 ++++++++------ hotel_calendar/readme/INSTALL.rst | 5 +++++ hotel_calendar/readme/ROADMAP.rst | 7 +++++-- hotel_calendar/readme/USAGE.rst | 17 +++++++++++++---- 7 files changed, 43 insertions(+), 13 deletions(-) create mode 100644 hotel_calendar/readme/CONFIGURE.rst create mode 100644 hotel_calendar/readme/CREDITS.rst create mode 100644 hotel_calendar/readme/INSTALL.rst diff --git a/hotel_calendar/readme/CONFIGURE.rst b/hotel_calendar/readme/CONFIGURE.rst new file mode 100644 index 000000000..a3c81f46a --- /dev/null +++ b/hotel_calendar/readme/CONFIGURE.rst @@ -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.` \ No newline at end of file diff --git a/hotel_calendar/readme/CONTRIBUTORS.rst b/hotel_calendar/readme/CONTRIBUTORS.rst index 55873688c..c0ca43ca9 100644 --- a/hotel_calendar/readme/CONTRIBUTORS.rst +++ b/hotel_calendar/readme/CONTRIBUTORS.rst @@ -1 +1,2 @@ -* Alexandre Díaz +# authors are taken from the __manifest__.py file +* Pablo Quesada \ No newline at end of file diff --git a/hotel_calendar/readme/CREDITS.rst b/hotel_calendar/readme/CREDITS.rst new file mode 100644 index 000000000..61d2f78cc --- /dev/null +++ b/hotel_calendar/readme/CREDITS.rst @@ -0,0 +1,2 @@ +.. [ This file is optional and contains additional credits, other than +authors, contributors, and maintainers. ] \ No newline at end of file diff --git a/hotel_calendar/readme/DESCRIPTION.rst b/hotel_calendar/readme/DESCRIPTION.rst index 0c880ab0e..a44f8af2a 100644 --- a/hotel_calendar/readme/DESCRIPTION.rst +++ b/hotel_calendar/readme/DESCRIPTION.rst @@ -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. \ No newline at end of file diff --git a/hotel_calendar/readme/INSTALL.rst b/hotel_calendar/readme/INSTALL.rst new file mode 100644 index 000000000..96fe22619 --- /dev/null +++ b/hotel_calendar/readme/INSTALL.rst @@ -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. \ No newline at end of file diff --git a/hotel_calendar/readme/ROADMAP.rst b/hotel_calendar/readme/ROADMAP.rst index ed40c796a..3f8c38c78 100644 --- a/hotel_calendar/readme/ROADMAP.rst +++ b/hotel_calendar/readme/ROADMAP.rst @@ -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. \ No newline at end of file diff --git a/hotel_calendar/readme/USAGE.rst b/hotel_calendar/readme/USAGE.rst index 21364b658..e704b7dd3 100644 --- a/hotel_calendar/readme/USAGE.rst +++ b/hotel_calendar/readme/USAGE.rst @@ -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)