From 3df802c19af277bcf46586909de2cbb41f34b962 Mon Sep 17 00:00:00 2001 From: Florian Dold Date: Fri, 27 Sep 2019 00:55:41 +0200 Subject: The big doc refactoring Use new ts:def directive for TypeScript definitions and use ``foo`` for literal text. The form `foo` is an interpreted role. Also, only use the interpreted role form for references in TS definition comments. --- core/taler-uri.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'core/taler-uri.rst') diff --git a/core/taler-uri.rst b/core/taler-uri.rst index 40c110c1..caa32bb4 100644 --- a/core/taler-uri.rst +++ b/core/taler-uri.rst @@ -4,7 +4,7 @@ The taler:// URI scheme ======================= -The `taler` URI scheme represents actions that are processed by a Taler wallet. The basic syntax is as follows: +The ``taler`` URI scheme represents actions that are processed by a Taler wallet. The basic syntax is as follows: .. code:: none @@ -14,21 +14,21 @@ The `taler` URI scheme represents actions that are processed by a Taler wallet. Requesting a Payment -------------------- -Payments are requested with the `pay` action. The parameters are a hierarchical identifier for the requested payment: +Payments are requested with the ``pay`` action. The parameters are a hierarchical identifier for the requested payment: .. code:: none 'taler://pay/' merchant-host '/' merchant-query '/' merchant-instance '/' order-id [ '/' session-id ] -The components `merchant-host`, `merchant-query` and `order-id` identify the URL that is used to claim the contract +The components ``merchant-host``, ``merchant-query`` and ``order-id`` identify the URL that is used to claim the contract for this payment request. -To make the URI shorter (which is important for QR code payments), `-` (minus) can be substituted to get a default value +To make the URI shorter (which is important for QR code payments), ``-`` (minus) can be substituted to get a default value for some components: -* the default for `merchant-instance` is `default` -* the default for `merchant-query` is `/public/proposal` +* the default for ``merchant-instance`` is ``default`` +* the default for ``merchant-query`` is ``/public/proposal`` The following is a minimal example for a payment request from the demo merchant, using the default instance and no session-bound payment: @@ -45,7 +45,7 @@ Withdrawing 'taler://withdraw/' bank-host '/' bank-query '/' withdraw-uid -When `bank-query` is `-`, the default `withdraw-operation` will be used. +When ``bank-query`` is ``-``, the default ``withdraw-operation`` will be used. Example: @@ -73,7 +73,7 @@ in newer wallets. Special URLs for fulfillment ---------------------------- -The special `fulfillment-success` action can be used in a fulfillment URI to indicate success +The special ``fulfillment-success`` action can be used in a fulfillment URI to indicate success with a message, without directing the user to a website. This is useful in applications that are not Web-based: When wallets encounter this URI in any other circumstance than going to a fulfillment URL, they must raise an error. -- cgit v1.2.3