Merge pull request #48 from xmo-odoo/doc-fixes
[FIX] indentation and formatting of various rst snippets
This commit is contained in:
commit
7d00167dbb
|
@ -5,10 +5,6 @@ PosBox Documentation
|
||||||
Posbox Setup Guide
|
Posbox Setup Guide
|
||||||
==================
|
==================
|
||||||
|
|
||||||
.. image:: _images/posbox_setup.png
|
|
||||||
:width: 100%
|
|
||||||
:align: center
|
|
||||||
|
|
||||||
Prerequisites
|
Prerequisites
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
|
@ -34,7 +30,7 @@ Step By Step Setup Guide
|
||||||
:width: 100%
|
:width: 100%
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
Power the PosBox.
|
Power the PosBox
|
||||||
~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Plug the PosBox to the 2A Power Adapter, a bright red status led should
|
Plug the PosBox to the 2A Power Adapter, a bright red status led should
|
||||||
|
@ -116,10 +112,6 @@ refer to your Router documentation.
|
||||||
PosBoxless Setup Guide
|
PosBoxless Setup Guide
|
||||||
======================
|
======================
|
||||||
|
|
||||||
.. image:: _images/posboxless_setup.png
|
|
||||||
:width: 100%
|
|
||||||
:align: center
|
|
||||||
|
|
||||||
If you are running your Point of Sale on a debian-based linux
|
If you are running your Point of Sale on a debian-based linux
|
||||||
distribution, you do not need the PosBox as you can run its software
|
distribution, you do not need the PosBox as you can run its software
|
||||||
locally. However the installation process is not foolproof. You'll need
|
locally. However the installation process is not foolproof. You'll need
|
||||||
|
@ -141,9 +133,7 @@ Step By Step Setup Guide
|
||||||
Extra dependencies
|
Extra dependencies
|
||||||
~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
The driver modules requires the installation of new python modules:
|
The driver modules requires the installation of new python modules::
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
$ sudo pip install pyserial
|
$ sudo pip install pyserial
|
||||||
$ sudo pip install --pre pyusb
|
$ sudo pip install --pre pyusb
|
||||||
|
@ -159,24 +149,18 @@ Access Rights
|
||||||
|
|
||||||
The drivers need raw access to the printer and barcode scanner devices.
|
The drivers need raw access to the printer and barcode scanner devices.
|
||||||
Doing so requires a bit system administration. First we are going to
|
Doing so requires a bit system administration. First we are going to
|
||||||
create a group that has haccess to usb devices:
|
create a group that has haccess to usb devices::
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
$ sudo groupadd usbusers
|
$ sudo groupadd usbusers
|
||||||
|
|
||||||
Then we add the user who will run the OpenERP server to ``usbusers``
|
Then we add the user who will run the OpenERP server to ``usbusers``::
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
$ sudo useradd -G usbusers USERNAME
|
$ sudo useradd -G usbusers USERNAME
|
||||||
|
|
||||||
Then we need to create a udev rule that will automatically allow members
|
Then we need to create a udev rule that will automatically allow members
|
||||||
of ``usbusers`` to access raw usb devices. To do so create a file called
|
of ``usbusers`` to access raw usb devices. To do so create a file called
|
||||||
``99-usbusers.rule`` in the ``/etc/udev/rules.d/`` directory with the
|
``99-usbusers.rule`` in the ``/etc/udev/rules.d/`` directory with the
|
||||||
following content:
|
following content::
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
SUBSYSTEM=="usb", GROUP="usbusers", MODE="0660"
|
SUBSYSTEM=="usb", GROUP="usbusers", MODE="0660"
|
||||||
SUBSYSTEMS=="usb", GROUP="usbusers", MODE="0660"
|
SUBSYSTEMS=="usb", GROUP="usbusers", MODE="0660"
|
||||||
|
@ -187,9 +171,7 @@ Start the local OpenERP Installl
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
We must launch the OpenERP server on the port ``8069`` with the correct
|
We must launch the OpenERP server on the port ``8069`` with the correct
|
||||||
database settings:
|
database settings::
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
$ ./server/openerp-server --addons-path=addons,web/addons --db-filter='^posbox$' \
|
$ ./server/openerp-server --addons-path=addons,web/addons --db-filter='^posbox$' \
|
||||||
--xmlrpc-port=8069 -d posbox
|
--xmlrpc-port=8069 -d posbox
|
||||||
|
|
|
@ -3,18 +3,22 @@ _blog_blog:
|
||||||
blog.blog
|
blog.blog
|
||||||
=========
|
=========
|
||||||
In ``blog.blog``, added field ``subtitle`` which Indicates the subtitle of blogs.
|
In ``blog.blog``, added field ``subtitle`` which Indicates the subtitle of blogs.
|
||||||
- ``subtitle``: fields.char('Blog Subtitle')
|
|
||||||
|
- ``subtitle``: fields.char('Blog Subtitle')
|
||||||
|
|
||||||
mail.message
|
mail.message
|
||||||
============
|
============
|
||||||
In ``mail.message``, added field ``discussion`` which Indicates the unique identification
|
In ``mail.message``, added field ``discussion`` which Indicates the unique identification
|
||||||
of paragraph on blog post.
|
of paragraph on blog post.
|
||||||
- ``discussion``: fields.char('Discussion Unique Name')
|
|
||||||
|
- ``discussion``: fields.char('Discussion Unique Name')
|
||||||
|
|
||||||
blog.post
|
blog.post
|
||||||
=========
|
=========
|
||||||
|
|
||||||
Fields
|
Fields
|
||||||
++++++
|
++++++
|
||||||
- ``sub_title`` : contains the subtitle of every blog post.
|
|
||||||
- ``visits`` : Indicates the number of visits on evry blog post.
|
- ``sub_title`` : contains the subtitle of every blog post.
|
||||||
- ``ranking`` : Indicates the ranking on every blog post.
|
- ``visits`` : Indicates the number of visits on evry blog post.
|
||||||
|
- ``ranking`` : Indicates the ranking on every blog post.
|
||||||
|
|
|
@ -4,32 +4,29 @@ Changelog
|
||||||
=========
|
=========
|
||||||
|
|
||||||
`trunk (saas-3)`
|
`trunk (saas-3)`
|
||||||
----------------
|
++++++++++++++++
|
||||||
|
|
||||||
- created ``website_blog`` menu, build on defunct document_page module.
|
|
||||||
- added new feature ``Inline Discussion`` , that will allow a user to comment
|
|
||||||
on every paragraph on blog post
|
|
||||||
- added new feature ``Select to Tweet``, that will alllow a user tweet a selected
|
|
||||||
text from blog to post , directly on twitter.
|
|
||||||
|
|
||||||
|
|
||||||
|
- created ``website_blog`` menu, build on defunct document_page module.
|
||||||
|
- added new feature ``Inline Discussion`` , that will allow a user to comment
|
||||||
|
on every paragraph on blog post
|
||||||
|
- added new feature ``Select to Tweet``, that will alllow a user tweet a
|
||||||
|
selected text from blog to post , directly on twitter.
|
||||||
|
|
||||||
WebsiteBlog(controller)
|
WebsiteBlog(controller)
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
Methods
|
Methods
|
||||||
+++++++
|
+++++++
|
||||||
- ``blog`` : remove routing related to date.
|
|
||||||
- ``blog_post`` : updated with , suggestion of next post to the user based on
|
- ``blog`` : remove routing related to date.
|
||||||
cookie and number of views.
|
- ``blog_post`` : updated with , suggestion of next post to the user based on
|
||||||
- ``discussion`` : added method , contains a detail of discussion on every paragraph,
|
cookie and number of views.
|
||||||
if count is true it only return len of ids else return full detail.
|
- ``discussion`` : added method , contains a detail of discussion on every
|
||||||
def discussion(self, post_id=0, discussion=None, count=False, **post)
|
paragraph, if count is true it only return len of ids else return full
|
||||||
- ``post_discussion`` : added methodt, that allow to post discussion on any paragraph.
|
detail.
|
||||||
def post_discussion(self, blog_post_id=0, **post)
|
- ``post_discussion`` : added methodt, that allow to post discussion on any
|
||||||
- ``change_bg`` : added method allow a user to change background image on blog
|
paragraph.
|
||||||
post from front-end.
|
- ``change_bg`` : added method allow a user to change background image on blog
|
||||||
def change_bg(self, post_id=0, image=None, **post)
|
post from front-end.
|
||||||
- ``get_user`` : added method , that will return True if user is public else False.
|
- ``get_user`` : added method , that will return True if user is public else False.
|
||||||
def get_user(self, **post):
|
|
||||||
return [False if request.session.uid else True]
|
|
||||||
|
|
||||||
|
|
|
@ -318,16 +318,15 @@ def route(route=None, **kw):
|
||||||
:param type: The type of request, can be ``'http'`` or ``'json'``.
|
:param type: The type of request, can be ``'http'`` or ``'json'``.
|
||||||
:param auth: The type of authentication method, can on of the following:
|
:param auth: The type of authentication method, can on of the following:
|
||||||
|
|
||||||
* ``user``: The user must be authenticated and the current request
|
* ``user``: The user must be authenticated and the current request
|
||||||
will perform using the rights of the user.
|
will perform using the rights of the user.
|
||||||
* ``admin``: The user may not be authenticated and the current request
|
* ``admin``: The user may not be authenticated and the current request
|
||||||
will perform using the admin user.
|
will perform using the admin user.
|
||||||
* ``none``: The method is always active, even if there is no
|
* ``none``: The method is always active, even if there is no
|
||||||
database. Mainly used by the framework and authentication
|
database. Mainly used by the framework and authentication
|
||||||
modules. There request code will not have any facilities to access
|
modules. There request code will not have any facilities to access
|
||||||
the database nor have any configuration indicating the current
|
the database nor have any configuration indicating the current
|
||||||
database nor the current user.
|
database nor the current user.
|
||||||
|
|
||||||
:param methods: A sequence of http methods this route applies to. If not
|
:param methods: A sequence of http methods this route applies to. If not
|
||||||
specified, all methods are allowed.
|
specified, all methods are allowed.
|
||||||
:param cors: The Access-Control-Allow-Origin cors directive value.
|
:param cors: The Access-Control-Allow-Origin cors directive value.
|
||||||
|
|
Loading…
Reference in New Issue