diff --git a/doc/howtos/website/module-empty b/doc/howtos/website/module-empty index 88fe8079d92..db169c753aa 100644 --- a/doc/howtos/website/module-empty +++ b/doc/howtos/website/module-empty @@ -28,7 +28,7 @@ new file mode 100644 + """, + + 'author': "My Company", -+ 'website': "http://www.yourcompany.com", ++ 'website': "https://www.yourcompany.com", + + # Categories can be used to filter modules in modules listing + # Check https://github.com/odoo/odoo/blob/12.0/odoo/addons/base/data/ir_module_category_data.xml diff --git a/doc/setup/deploy.rst b/doc/setup/deploy.rst index f1926eca4ea..c626bc133bd 100644 --- a/doc/setup/deploy.rst +++ b/doc/setup/deploy.rst @@ -624,16 +624,16 @@ of the supported browsers is the following: environment than over the internet. .. _regular expression: https://docs.python.org/3/library/re.html -.. _ARP spoofing: http://en.wikipedia.org/wiki/ARP_spoofing +.. _ARP spoofing: https://en.wikipedia.org/wiki/ARP_spoofing .. _Nginx termination example: - http://nginx.com/resources/admin-guide/nginx-ssl-termination/ + https://nginx.com/resources/admin-guide/nginx-ssl-termination/ .. _Nginx proxying example: - http://nginx.com/resources/admin-guide/reverse-proxy/ + https://nginx.com/resources/admin-guide/reverse-proxy/ .. _socat: http://www.dest-unreach.org/socat/ .. _PostgreSQL connection settings: .. _listen to network interfaces: - http://www.postgresql.org/docs/9.6/static/runtime-config-connection.html + https://www.postgresql.org/docs/9.6/static/runtime-config-connection.html .. _use an SSH tunnel: - http://www.postgresql.org/docs/9.6/static/ssh-tunnels.html -.. _WSGI: http://wsgi.readthedocs.org/ + https://www.postgresql.org/docs/9.6/static/ssh-tunnels.html +.. _WSGI: https://wsgi.readthedocs.org/ .. _POSBox: https://www.odoo.com/page/point-of-sale-hardware#part_2 diff --git a/doc/webservices/iap.rst b/doc/webservices/iap.rst index e4f8d7ed4c4..f796809b190 100644 --- a/doc/webservices/iap.rst +++ b/doc/webservices/iap.rst @@ -75,7 +75,7 @@ Overview service directly, or you can delegate the actual service acting as a bridge/translator between an Odoo system and the actual service. - + .. figure:: images/credits.jpg :align: center @@ -94,7 +94,7 @@ Overview * for a postage service: 1 credit = 1 post stamp. A credit can also simply be associated with a fixed amount of money - to palliate the variations of price (e.g. the prices of sms and stamps + to palliate the variations of price (e.g. the prices of sms and stamps may vary following the countries). The value of the credits is fixed with the help of prepaid credit packs @@ -158,15 +158,15 @@ Register the service on Odoo .. todo:: complete this part with screenshots -The first step is to register your service on the IAP endpoint (production +The first step is to register your service on the IAP endpoint (production and/or test) before you can actually query user accounts. To create a service, go to your *Portal Account* on the IAP endpoint (https://iap.odoo.com for production, https://iap-sandbox.odoo.com for testing, the endpoints are *independent* and *not synchronized*). Alternatively, you can go to your portal on Odoo (https://iap.odoo.com/my/home) and select *In-App Services*. -.. note:: - +.. note:: + On production, there is a manual validation step before the service can be used to manage real transactions. This step is automatically passed when on sandbox to ease the tests. @@ -187,7 +187,7 @@ The service has *seven* important fields: .. warning:: - Both the :class:`ServiceName` and :class:`Label` are unique. As good practice, the + Both the :class:`ServiceName` and :class:`Label` are unique. As good practice, the :class:`ServiceName` should usually match the name of your Odoo Client App. * :samp:`icon` - :class:`Icon`: A generic icon that will serve as default for your @@ -241,8 +241,8 @@ A credit pack is essentially a product with five characteristics: * Amount: amount of credits the client is entitled to when buying the pack, * Price: price in EUR (for the time being, USD support is planned). -.. note:: - +.. note:: + Odoo takes a 25% commission on all pack sales. Adjust your selling price accordingly. @@ -300,7 +300,7 @@ In that call, we will need to provide: * the :class:`token ` of the current client that is provided by the ``iap.account`` model's ``account_token`` field. You can retrieve the account for your service by calling :samp:`env['iap.account'].get({service_name})` - where :class:`service_name ` is the name of the service registered + where :class:`service_name ` is the name of the service registered on IAP endpoint. .. patch:: @@ -353,7 +353,7 @@ The :class:`~odoo.addons.iap.models.iap.charge` helper will: if the account does not have enough credits it will raise the relevant error 2. execute the body of the ``with`` statement -3. if the body of the ``with`` executes succesfully, update the price +3. if the body of the ``with`` executes succesfully, update the price of the transaction if needed 4. capture (confirm) the transaction 5. otherwise, if an error is raised from the body of the ``with``, cancel the @@ -465,7 +465,7 @@ Capture .. code-block:: python :emphasize-lines: 8 - + r2 = requests.post(ODOO + '/iap/1/capture', json={ 'jsonrpc': '2.0', 'id': None, @@ -689,7 +689,7 @@ Cancel ------ .. class:: odoo.addons.iap.models.iap.cancel(env, transaction_token, key) - + Will cancel an authorized transaction. :param odoo.api.Environment env: used to retrieve the ``iap.endpoint`` @@ -763,5 +763,5 @@ Capture capture(env,transaction_token, key, min(credits, 2)) -.. _JSON-RPC2: http://www.jsonrpc.org/specification +.. _JSON-RPC2: https://www.jsonrpc.org/specification .. _Odoo App: https://www.odoo.com/apps diff --git a/doc/webservices/odoo.rst b/doc/webservices/odoo.rst index 459da784ecb..288659c95da 100644 --- a/doc/webservices/odoo.rst +++ b/doc/webservices/odoo.rst @@ -184,13 +184,13 @@ database: These examples use the `Ripcord `_ library, which provides a simple XML-RPC API. Ripcord requires that `XML-RPC support be enabled - `_ in your PHP + `_ in your PHP installation. Since calls are performed over - `HTTPS `_, it also requires that + `HTTPS `_, it also requires that the `OpenSSL extension - `_ be enabled. + `_ be enabled. .. case:: Java @@ -219,7 +219,7 @@ database: Logging in ---------- -Odoo requires users of the API to be authenticated before they can query most +Odoo requires users of the API to be authenticated before they can query most data. The ``xmlrpc/2/common`` endpoint provides meta-calls which don't require @@ -414,31 +414,31 @@ available to only retrieve a subset of all matched records. .. container:: doc-aside .. switcher:: - + .. code-block:: python3 - + models.execute_kw(db, uid, password, 'res.partner', 'search', [[['is_company', '=', True], ['customer', '=', True]]], {'offset': 10, 'limit': 5}) - + .. code-block:: ruby - + models.execute_kw(db, uid, password, 'res.partner', 'search', [[['is_company', '=', true], ['customer', '=', true]]], {offset: 10, limit: 5}) - + .. code-block:: php - + $models->execute_kw($db, $uid, $password, 'res.partner', 'search', array(array(array('is_company', '=', true), array('customer', '=', true))), array('offset'=>10, 'limit'=>5)); - + .. code-block:: java - + asList((Object[])models.execute("execute_kw", asList( db, uid, password, "res.partner", "search", @@ -447,9 +447,9 @@ available to only retrieve a subset of all matched records. asList("customer", "=", true))), new HashMap() {{ put("offset", 10); put("limit", 5); }} ))); - + .. code-block:: json - + [13, 20, 30, 22, 29] Count records @@ -464,28 +464,28 @@ only the number of records matching the query. It takes the same .. container:: doc-aside .. switcher:: - + .. code-block:: python3 - + models.execute_kw(db, uid, password, 'res.partner', 'search_count', [[['is_company', '=', True], ['customer', '=', True]]]) - + .. code-block:: ruby - + models.execute_kw(db, uid, password, 'res.partner', 'search_count', [[['is_company', '=', true], ['customer', '=', true]]]) - + .. code-block:: php - + $models->execute_kw($db, $uid, $password, 'res.partner', 'search_count', array(array(array('is_company', '=', true), array('customer', '=', true)))); - + .. code-block:: java - + (Integer)models.execute("execute_kw", asList( db, uid, password, "res.partner", "search_count", @@ -493,9 +493,9 @@ only the number of records matching the query. It takes the same asList("is_company", "=", true), asList("customer", "=", true))) )); - + .. code-block:: json - + 19 .. warning:: @@ -514,11 +514,11 @@ fetch. By default, it will fetch all the fields the current user can read, which tends to be a huge amount. .. container:: doc-aside - + .. switcher:: - + .. code-block:: python3 - + ids = models.execute_kw(db, uid, password, 'res.partner', 'search', [[['is_company', '=', True], ['customer', '=', True]]], @@ -527,9 +527,9 @@ which tends to be a huge amount. 'res.partner', 'read', [ids]) # count the number of fields fetched by default len(record) - + .. code-block:: ruby - + ids = models.execute_kw(db, uid, password, 'res.partner', 'search', [[['is_company', '=', true], ['customer', '=', true]]], @@ -538,9 +538,9 @@ which tends to be a huge amount. 'res.partner', 'read', [ids]).first # count the number of fields fetched by default record.length - + .. code-block:: php - + $ids = $models->execute_kw($db, $uid, $password, 'res.partner', 'search', array(array(array('is_company', '=', true), @@ -550,9 +550,9 @@ which tends to be a huge amount. 'res.partner', 'read', array($ids)); // count the number of fields fetched by default count($records[0]); - + .. code-block:: java - + final List ids = asList((Object[])models.execute( "execute_kw", asList( db, uid, password, @@ -570,9 +570,9 @@ which tends to be a huge amount. ))[0]; // count the number of fields fetched by default record.size(); - + .. code-block:: json - + 121 Conversedly, picking only three fields deemed interesting. @@ -910,7 +910,7 @@ a record). Delete records -------------- -Records can be deleted in bulk by providing their ids to +Records can be deleted in bulk by providing their ids to :meth:`~odoo.models.Model.unlink`. .. container:: doc-aside @@ -1296,6 +1296,6 @@ activated as actual fields on the model. ] -.. _PostgreSQL: http://www.postgresql.org -.. _XML-RPC: http://en.wikipedia.org/wiki/XML-RPC -.. _base64: http://en.wikipedia.org/wiki/Base64 +.. _PostgreSQL: https://www.postgresql.org +.. _XML-RPC: https://en.wikipedia.org/wiki/XML-RPC +.. _base64: https://en.wikipedia.org/wiki/Base64 diff --git a/doc/webservices/upgrade.rst b/doc/webservices/upgrade.rst index 25310f0e70e..0e166b74be0 100644 --- a/doc/webservices/upgrade.rst +++ b/doc/webservices/upgrade.rst @@ -135,7 +135,7 @@ Sample script Here are 2 examples of database upgrade request creation using: * one in the python programming language using the requests library -* one in the bash programming language using `curl `_ (tool +* one in the bash programming language using `curl `_ (tool for transfering data using http) and `jq `_ (JSON processor): .. rst-class:: setup doc-aside