summaryrefslogtreecommitdiff
path: root/design-documents
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2021-08-08 20:33:41 +0200
committerChristian Grothoff <christian@grothoff.org>2021-08-08 20:33:41 +0200
commit7d9643064442d0c7c1c695b69fc56b2322a4213d (patch)
tree5dd1c60c03aef6f4a9bd3169b4338c32c05280cf /design-documents
parent40ad8425d0359845b4e14a91f83b8c91ed5d1a3d (diff)
downloaddocs-7d9643064442d0c7c1c695b69fc56b2322a4213d.tar.gz
docs-7d9643064442d0c7c1c695b69fc56b2322a4213d.tar.bz2
docs-7d9643064442d0c7c1c695b69fc56b2322a4213d.zip
-fix misc warnings
Diffstat (limited to 'design-documents')
-rw-r--r--design-documents/016-backoffice-order-management.rst44
-rw-r--r--design-documents/018-contract-json.rst6
2 files changed, 25 insertions, 25 deletions
diff --git a/design-documents/016-backoffice-order-management.rst b/design-documents/016-backoffice-order-management.rst
index 583661c1..00250cd2 100644
--- a/design-documents/016-backoffice-order-management.rst
+++ b/design-documents/016-backoffice-order-management.rst
@@ -38,7 +38,7 @@ Listing orders
4 tabs will be show for a easy access to common filter, click on any of this and
search will reset all filter except date
-* paid (default)
+* paid (default)
* refunded
* not wired
* all (empty filter box)
@@ -78,7 +78,7 @@ this form is divided into 4 sections
* ``payment``: where some default of the payment processing can be changed
* ``extra``: where the merchant can add extra information in JSON format
-
+
Create order: Product section
.............................
@@ -95,7 +95,7 @@ The first part will add/remove product from the current stock.
The second part will add non inventory product. To add a product a :ref:`create
product <backoffice-create-product>` form will be shown. The product in the list
-can be edited or deleted from the list.
+can be edited or deleted from the list.
In both cases, the total unit and price of the products will be calculated and
shown in the bottom of the section. If the merchant collapse one of the product
@@ -107,7 +107,7 @@ list a line with a resume of the total price and units will be shown.
Create order: Price section
...........................
-This section has 2 scenarios.
+This section has 2 scenarios.
The fist one is without products being added: the ``order price`` and
``summary`` inputs will be shown.
@@ -115,7 +115,7 @@ The fist one is without products being added: the ``order price`` and
If there is at least one product added, the ``total products price`` as the sum
of all products prices will be shown. The ``order price`` will default to
``total products price``. The ``products taxes`` and ``profit`` will be shown
-since ``order price`` cannot be less that ``product taxes``.
+since ``order price`` cannot be less that ``product taxes``.
.. image:: ../backoffice-order-create.price-section.svg
:width: 800
@@ -126,7 +126,7 @@ Create order: Payment section
This section show optional values that can be overwritten by the merchant
* ``refund deadline``: calendar type of input. default from instance
-
+
* ``pay deadline``: calendar type of input. default from instance
* ``auto refund deadline``: calendar type of input. default empty, optional.
@@ -155,12 +155,12 @@ An example of how all section in a page will be shown.
Creation order success
-**********************
+......................
A success message showing the amount, summary and the order id. Additionally the
-taler_pay_uri can be shown to be copied to send to the customer.
+taler_pay_uri can be shown to be copied to send to the customer.
-action buttons that allow the following:
+action buttons that allow the following:
* create another payment: go to the create payment page again
* view details: show details of the payment (see page)
@@ -177,11 +177,11 @@ indicated:
* refunded: red
Header
-^^^^^^
+......
This is a resume of most important information
-* big status with color
+* big status with color
* date
* total
@@ -194,9 +194,9 @@ This is a resume of most important information
* actions: refund (if not refunded), add note, copy order_status_url
Timeline of events
-^^^^^^^^^^^^^^^^^^
+..................
-Event of status changed over time describe vertically.
+Event of status changed over time describe vertically.
Sorted from newest to oldest.
On line per status updated, with datetime and a short description.
@@ -216,7 +216,7 @@ Info taken from:
Error status
-^^^^^^^^^^^^
+............
This section is not going to be shown if there is no error
@@ -227,7 +227,7 @@ This section is not going to be shown if there is no error
and exchange_hc
Payment details
-^^^^^^^^^^^^^^^
+...............
If the order was claimed
@@ -238,9 +238,9 @@ If the order was claimed
* net (deposit_total - refund_amount)
* current status
-
+
Contract Terms
-^^^^^^^^^^^^^^
+..............
collapsed as default. show disabled if unpaid
@@ -271,7 +271,7 @@ collapsed as default. show disabled if unpaid
refund popup
-------------
+............
If there is any refund:
@@ -284,7 +284,7 @@ Warn if there is a pending refund when ``refund_pending`` is true
Ask for:
* amount: default 0, show max amount refundable (order amount - already
- refunded)
+ refunded)
* reason: concatenation of the next values
@@ -320,7 +320,7 @@ Alternatives
pagination
------------
+----------
order list was originally thought with pagination footer
.. image:: ../backoffice-order-list.pagination.svg
@@ -363,11 +363,11 @@ Discussion / Q&A
Is there any other case? Is this taking into account auto_refund?
* Field left out in the order creation:
-
+
* contractTerm.summary_i18n: it makes the UI complex
* contractTerm.order_id: should be created by the backend
* contractTerm.timestamp: defined by backend
* contractTerm.merchant_pub: filled by the backend
* contractTerm.merchant_base_url: filled by the backend
* contractTerm.h_wire: defined by the backend
- * contractTerm.nonce: not used \ No newline at end of file
+ * contractTerm.nonce: not used
diff --git a/design-documents/018-contract-json.rst b/design-documents/018-contract-json.rst
index 2162d6ed..d7f78257 100644
--- a/design-documents/018-contract-json.rst
+++ b/design-documents/018-contract-json.rst
@@ -63,7 +63,7 @@ parent object.
.. code-block:: json
{
- "delivery_address": ...,
+ "delivery_address": "...",
"$forgettable": {
"delivery_address": "<salt>"
},
@@ -96,7 +96,7 @@ member of the parent object.
{
...props,
- "delivery_address": ...,
+ "delivery_address": "...",
"$forgettable": {
"delivery_address": "<memb_salt>"
},
@@ -174,7 +174,7 @@ a minimal interoperability test:
Hashing the above contract results in the following Crockford base32 encoded
hash
-``287VXK8T6PXKD05W8Y94QJNEFCMRXBC9S7KNKTWGH2G2J2D7RYKPSHNH1HG9NT1K2HRHGC67W6QM6GEC4BSN1DPNEBCS0AVDT2DBP5G''.
+``287VXK8T6PXKD05W8Y94QJNEFCMRXBC9S7KNKTWGH2G2J2D7RYKPSHNH1HG9NT1K2HRHGC67W6QM6GEC4BSN1DPNEBCS0AVDT2DBP5G``.
Note that typically the salt values must be chosen at random, only for this test we use static salt values.