[taler-docs] branch master updated: -fix notes

[gnunet]

This is an automated email from the git hooks/post-receive script.

grothoff pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new 0aadbd53 -fix notes
0aadbd53 is described below

commit 0aadbd53ba08f672280aac1c040776e4982c8f64
Author: Christian Grothoff <christian@grothoff.org>
AuthorDate: Mon Apr 15 01:02:22 2024 +0200

    -fix notes
---
 taler-challenger-manual.rst | 134 +++++++++++++++++++++-----------------------
 1 file changed, 63 insertions(+), 71 deletions(-)

diff --git a/taler-challenger-manual.rst b/taler-challenger-manual.rst
index 4ff2b40e..45225ecb 100644
--- a/taler-challenger-manual.rst
+++ b/taler-challenger-manual.rst
@@ -561,18 +561,23 @@ file) is also supported.
 
 The template is instantiated using the following information:
 
-  * restrictions: Object; map of keys (names of the fields of the address to 
be entered by the user) to objects with a "regex" (string) containing an 
extended Posix regular expression for allowed address field values, and a 
"hint"/"hint_i18n" giving a human-readable explanation to display if the value 
entered by the user does not match the regex. Keys that are not mapped to such 
an object have no restriction on the value provided by the user.  See 
"ADDRESS_RESTRICTIONS" in the challenger [...]
-  * fix_address: boolean; indicates if the given address cannot be changed
-    anymore, the form should be read-only if set to true.
-
-  * nonce: String; unique value identifying the challenge, should be shown
-    to the user so that they can recognize it when they receive the TAN code
-
-  * last_address: Object; form values from the previous submission if 
available,
-    details depend on the ``ADDRESS_TYPE``, should be used to pre-populate the 
form
-
-  * changes_left: Integer; number of times the address can still be changed,
-    may or may not be shown to the user
+* restrictions: Object; map of keys (names of the fields of the
+  address to be entered by the user) to objects with a "regex"
+  (string) containing an extended Posix regular expression for
+  allowed address field values, and a "hint"/"hint_i18n" giving
+  a human-readable explanation to display if the value entered
+  by the user does not match the regex. Keys that are not mapped
+  to such an object have no restriction on the value provided by
+  the user.  See "ADDRESS_RESTRICTIONS" in the challenger
+  configuration.
+* fix_address: boolean; indicates if the given address cannot be changed
+  anymore, the form should be read-only if set to true.
+* nonce: String; unique value identifying the challenge, should be shown
+  to the user so that they can recognize it when they receive the TAN code
+* last_address: Object; form values from the previous submission if available,
+  details depend on the ``ADDRESS_TYPE``, should be used to pre-populate the 
form
+* changes_left: Integer; number of times the address can still be changed,
+  may or may not be shown to the user
 
 .. _challenger_enter-tan-form:
 
@@ -584,22 +589,18 @@ that they received at the respective address.
 
 The template is instantiated using the following information:
 
-  * nonce: String; unique value identifying the challenge, should be shown
-    to the user so that they can match it to the TAN code they received
-
-  * attempts_left: Integer; how many more attempts are allowed, might be
-    shown to the user, highlighting might be appropriate for low values
-    such as 1 or 2 (the form will never be used if the value is zero)
-
-  * address: Object; the address that is being validated, might be shown
-    or not
-
-  * transmitted: boolean; true if we just retransmitted the challenge,
-    false if we sent a challenge recently and thus refused to transmit it
-    again this time; might make a useful hint to the user
-
-  * next_tx_time: String; timestamp explaining when we would re-transmit
-    the challenge the next time (at the earliest) if requested by the user
+* nonce: String; unique value identifying the challenge, should be shown
+  to the user so that they can match it to the TAN code they received
+* attempts_left: Integer; how many more attempts are allowed, might be
+  shown to the user, highlighting might be appropriate for low values
+  such as 1 or 2 (the form will never be used if the value is zero)
+* address: Object; the address that is being validated, might be shown
+  or not
+* transmitted: boolean; true if we just retransmitted the challenge,
+  false if we sent a challenge recently and thus refused to transmit it
+  again this time; might make a useful hint to the user
+* next_tx_time: String; timestamp explaining when we would re-transmit
+  the challenge the next time (at the earliest) if requested by the user
 
 
 .. _challenger_invalid-pin:
@@ -611,25 +612,22 @@ The user has provided an invalid TAN code (HTTP 403 
Forbidden).
 
 The template is instantiated using the following information:
 
-  * ec: Integer; numeric Taler error code, should be shown to indicate the
-    error compactly for reporting to developers
-
-  * hint: String; human-readable Taler error code, should be shown for the
-    user to understand the error
-
-  * addresses_left: Integer; how many times is the user still allowed to
-    change the address; if 0, the user should not be shown a link to jump
-    to the address entry form
-
-  * pin_transmissions_left: Integer; how many times might the PIN still
-    be retransmitted
-
-  * auth_attempts_left: Integer; how many times might the user still try
-    entering the PIN code
-
-  * exhausted: Bool; if true, the PIN was not even evaluated as the user 
previously exhausted the number of attempts
-
-  * no_challenge: Bool; if true, the PIN was not even evaluated as no 
challenge was ever issued (the user must have skipped the step of providing 
their address first!)
+* ec: Integer; numeric Taler error code, should be shown to indicate the
+  error compactly for reporting to developers
+* hint: String; human-readable Taler error code, should be shown for the
+  user to understand the error
+* addresses_left: Integer; how many times is the user still allowed to
+  change the address; if 0, the user should not be shown a link to jump
+  to the address entry form
+* pin_transmissions_left: Integer; how many times might the PIN still
+  be retransmitted
+* auth_attempts_left: Integer; how many times might the user still try
+  entering the PIN code
+* exhausted: Bool; if true, the PIN was not even evaluated as the user
+  previously exhausted the number of attempts
+* no_challenge: Bool; if true, the PIN was not even evaluated as no
+  challenge was ever issued (the user must have skipped the step of
+  providing their address first!)
 
 If both *pin_transmissions_left* and *auth_attempts_left* are zero, the link
 to re-enter the PIN should be hidden and the user should only be allowed to
@@ -648,14 +646,12 @@ backend (HTTP 404 Not Found).
 
 The template is instantiated using the following information:
 
-  * ec: Integer; numeric Taler error code, should be shown to indicate the
-    error compactly for reporting to developers
-
-  * hint: String; human-readable Taler error code, should be shown for the
-    user to understand the error
-
-  * detail: String; optional, extended human-readable text provided to 
elaborate
-    on the error, should be shown to provide additional context
+* ec: Integer; numeric Taler error code, should be shown to indicate the
+  error compactly for reporting to developers
+* hint: String; human-readable Taler error code, should be shown for the
+  user to understand the error
+* detail: String; optional, extended human-readable text provided to elaborate
+  on the error, should be shown to provide additional context
 
 .. _challenger_invalid-request:
 
@@ -666,14 +662,12 @@ The request of the client is invalid (HTTP 400 Bad 
Request).
 
 The template is instantiated using the following information:
 
-  * ec: Integer; numeric Taler error code, should be shown to indicate the
-    error compactly for reporting to developers
-
-  * hint: String; human-readable Taler error code, should be shown for the
-    user to understand the error
-
-  * detail: String; optional, extended human-readable text provided to 
elaborate
-    on the error, should be shown to provide additional context
+* ec: Integer; numeric Taler error code, should be shown to indicate the
+  error compactly for reporting to developers
+* hint: String; human-readable Taler error code, should be shown for the
+  user to understand the error
+* detail: String; optional, extended human-readable text provided to elaborate
+  on the error, should be shown to provide additional context
 
 .. _challenger_internal-error:
 
@@ -684,11 +678,9 @@ The service experienced an internal error (HTTP 500 
Internal Server Error).
 
 The template is instantiated using the following information:
 
-  * ec: Integer; numeric Taler error code, should be shown to indicate the
-    error compactly for reporting to developers
-
-  * hint: String; human-readable Taler error code, should be shown for the
-    user to understand the error
-
-  * detail: String; optional, extended human-readable text provided to 
elaborate
-    on the error, should be shown to provide additional context
+* ec: Integer; numeric Taler error code, should be shown to indicate the
+  error compactly for reporting to developers
+* hint: String; human-readable Taler error code, should be shown for the
+  user to understand the error
+* detail: String; optional, extended human-readable text provided to elaborate
+  on the error, should be shown to provide additional context

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.