Browse Source

📖 keyboard documentation updated (#981)

pull/155/head
Mirgalimova 6 years ago
committed by Vincent Van Rossem
parent
commit
42a4372f77
  1. 50
      pos_keyboard/README.rst
  2. 2
      pos_keyboard/__manifest__.py
  3. 56
      pos_keyboard/doc/index.rst
  4. 87
      pos_keyboard/static/description/index.html
  5. BIN
      pos_keyboard/static/description/keyboard_1.png
  6. BIN
      pos_keyboard/static/description/keyboard_2.png

50
pos_keyboard/README.rst

@ -1,25 +1,41 @@
===================================
Keyboard support in Point Of Sale
===================================
Module allows to use usual keyboard (not virtual one) in Point of Sale.
Usage:
------
Using keys below switch to mode you need. Qty mode is used by default.
Then use number keys to enter quantity, price or discount.
The module allows to apply the usual keyboard (not the virtual one) in the Point of Sale.
=========== ===================== =================
Type Numpad Extra keys
=========== ===================== =================
mode qty ``/`` ``q``
----------- --------------------- -----------------
mode disc ``-`` ``d``
----------- --------------------- -----------------
mode price ``*`` ``p``
----------- --------------------- -----------------
+/- ``+`` ``s``
=========== ===================== =================
Credits
=======
Contributors
------------
* `Ivan Yelizariev <https://it-projects.info/team/yelizariev>`__
* `Kolushov Alexandr <https://it-projects.info/team/KolushovAlexandr>`__
Tested on Odoo 9.0 2ec9a9c99294761e56382bdcd766e90b8bc1bb38
Sponsors
--------
* `IT-Projects LLC <https://it-projects.info>`__
Maintainers
-----------
* `IT-Projects LLC <https://it-projects.info>`__
To get a guaranteed support you are kindly requested to purchase the module at `odoo apps store <https://apps.odoo.com/apps/modules/10.0/pos_keyboard/>`__.
Thank you for understanding!
`IT-Projects Team <https://www.it-projects.info/team>`__
Further information
===================
Demo: http://runbot.it-projects.info/demo/pos-addons/10.0
HTML Description: https://apps.odoo.com/apps/modules/10.0/pos_keyboard/
Usage instructions: `<doc/index.rst>`_
Changelog: `<doc/changelog.rst>`_
Tested on Odoo 10.0 78ba90d54826c2ba11626e9a89b142964db25e2f

2
pos_keyboard/__manifest__.py

@ -2,7 +2,7 @@
{
'name': "Keyboard support in Point Of Sale",
'author': "IT-Projects LLC, Ivan Yelizariev",
'summary': 'Module allows to use usual keyboard (not virtual one) in Point of Sale',
'summary': 'The module allows to apply the usual keyboard (not the virtual one) in the Point of Sale',
"support": "pos@it-projects.info",
"website": "https://it-projects.info",
'images': ['images/keyboard.png'],

56
pos_keyboard/doc/index.rst

@ -2,3 +2,59 @@
Keyboard support in Point Of Sale
===================================
Installation
============
* `Install <https://odoo-development.readthedocs.io/en/latest/odoo/usage/install-module.html>`__ this module in a usual way
Usage
=====
Using hotkeys below switch to mode you need. Qty mode is used by default.
Then use keys with numbers to enter quantity, price or discount.
If you want to reset the amount of product to zero or delete them you can use ``Backspace`` .
=========== ===================== =================
Type Numpad Extra keys
=========== ===================== =================
mode qty ``/`` ``q``
----------- --------------------- -----------------
mode disc ``-`` ``d``
----------- --------------------- -----------------
mode price ``*`` ``p``
----------- --------------------- -----------------
+/- ``+`` ``s``
=========== ===================== =================
Also inside the Pop-ups windows you can use ``Enter``, ``Backspace`` and ``Esc`` keys in order to speed up the process of interaction with the System.
=========== ===================== ==================
Key Pop-up Action
=========== ===================== ==================
Backspace ``<-`` delete symbol
----------- --------------------- ------------------
Enter ``Ok`` confirmation
----------- --------------------- ------------------
Esc ``Cancel`` close Pop-up
=========== ===================== ==================
User Scenario
-------------
* Open menu ``[[ Users ]]``
* Choose a User with PIN code
* Enter PIN code with the keyboard
* You can use ``Backspace`` if you want to delete symbol
* You can use ``Enter`` if you want to confirm PIN code
* You can use ``Esc`` if you want to close the Pop-up keyboard
* Work in your own account using hotkeys for each mode on the Numpad or just press Extra keys. Then enter numbers.
* You can use ``/`` or ``q`` in case of Qrt mode
* You can use ``-`` or ``d`` in case of Disc mode
* You can use ``*`` or ``p`` in case of Price mode
* You can use ``+`` or ``s`` in case of +/-
RESULT: In opened POS Keyboard support is invoked instantly and available for further work without any extra action.

87
pos_keyboard/static/description/index.html

@ -0,0 +1,87 @@
<section class="oe_container">
<div class="oe_row oe_spaced">
<div class="oe_span12">
<h2 class="oe_slogan" style="color:#875A7B;">Keyboard support in Point Of Sale</h2>
<h3 class="oe_slogan">The module allows to apply the usual keyboard (not the virtual one) in the Point of Sale.</h3>
</div>
</div>
</section>
<section class="oe_container oe_dark">
<div class="oe_row oe_spaced">
<h3 class="oe_slogan">How It Works</h3>
<div class="oe_span12 text-center">
<p class="oe_mt32">
<font style="font-size: 120%;">
<p> Users can take advantage of a regular keyboard to process pop-up actions, for example, enter a PIN on cashier changing.</p>
</font>
</p>
</div>
<div class="oe_screenshot" align="center">
<img style="max-width: 40%" src="keyboard_2.png"/>
</div>
<div class="oe_span12 text-center">
<p class="oe_mt32">
<font style="font-size: 120%;">
<p> In the Sale process cashiers can operate with the hotkeys for each of <i> Qty, Price, Disc, +/- modes </i> by using Numpad/Extra keys and after which they can enter necessary numbers.</p>
</font>
</p>
</div>
<div class="oe_screenshot" align="center">
<img style="max-width: 60%" src="keyboard_1.png"/>
</div>
</section>
<section class="oe_container">
<div class="oe_row oe_spaced">
<div class="oe_span8">
<h2>Need our service?</h2>
<p class="oe_mt32">Contact us by <a href="mailto:apps@it-projects.info">email</a> or fill out <a href="https://www.it-projects.info/page/website.contactus " target="_blank">request form</a></p>
<ul>
<li><a href="mailto:apps@it-projects.info">apps@it-projects.info <i class="fa fa-envelope-o"></i></a></li>
<li><a href="https://www.it-projects.info/page/website.contactus " target="_blank">https://www.it-projects.info/page/website.contactus <i class="fa fa-list-alt"></i></a></li>
<li><a href="https://m.me/itprojectsllc" target="_blank">https://m.me/itprojectsllc <i class="fa fa-facebook-square"></i></a></li>
<li>skype@it-projects.info <i class="fa fa-skype"></i></li>
</ul>
</div>
<div class="oe_span4">
<div class="stamp" style="width:200px;">
<div style="margin-top: 15px;
position: relative;
font-family:'Vollkorn', serif;
font-size: 16px;
line-height: 25px;
text-transform: uppercase;
font-weight: bold;
color: #75526b;
border: 3px dashed #75526b;
float: left;
padding: 4px 12px;
-webkit-transform: rotate(8deg);
-o-transform: rotate(8deg);
-moz-transform: rotate(8deg);
-ms-transform: rotate(8deg);">
Tested on Odoo<br/>10.0 community
</div>
<!--<div style="margin-top: 15px;
position: relative;
font-family:'Vollkorn', serif;
font-size: 16px;
line-height: 25px;
text-transform: uppercase;
font-weight: bold;
color: #75526b;
border: 3px dashed #75526b;
float: left;
padding: 4px 12px;
-webkit-transform: rotate(6deg);
-o-transform: rotate(6deg);
-moz-transform: rotate(6deg);
-ms-transform: rotate(6deg);">
Tested on Odoo<br/>10.0 enterprise
</div>-->
</div>
</div>
</div>
</section>

BIN
pos_keyboard/static/description/keyboard_1.png

After

Width: 1308  |  Height: 826  |  Size: 121 KiB

BIN
pos_keyboard/static/description/keyboard_2.png

After

Width: 377  |  Height: 338  |  Size: 21 KiB

Loading…
Cancel
Save