summaryrefslogtreecommitdiff
path: root/taler-exchange-manual.rst
diff options
context:
space:
mode:
authorThien-Thi Nguyen <ttn@gnuvola.org>2021-01-22 00:11:00 -0500
committerThien-Thi Nguyen <ttn@gnuvola.org>2021-01-22 00:11:00 -0500
commitd80f3acbbfad16dc3a03d2d1ca380bdf1996f335 (patch)
tree16c6dc7edeff74cfa9a869fd60f9ce4a935e6c7e /taler-exchange-manual.rst
parent89c78648167f69d1b256d1de7c2e71495929c950 (diff)
downloaddocs-d80f3acbbfad16dc3a03d2d1ca380bdf1996f335.tar.gz
docs-d80f3acbbfad16dc3a03d2d1ca380bdf1996f335.tar.bz2
docs-d80f3acbbfad16dc3a03d2d1ca380bdf1996f335.zip
tidy section ‘Terms of service’
- mark up ‘[exchange]’ - mark up ‘TERMS_ETAG’ - mark up ‘TERMS_DIR’ - fix typo: s/an HTML/an HTML format/ - change markup of filename from " to ``
Diffstat (limited to 'taler-exchange-manual.rst')
-rw-r--r--taler-exchange-manual.rst22
1 files changed, 11 insertions, 11 deletions
diff --git a/taler-exchange-manual.rst b/taler-exchange-manual.rst
index e104cc0..3e375bf 100644
--- a/taler-exchange-manual.rst
+++ b/taler-exchange-manual.rst
@@ -560,26 +560,26 @@ if none are configured, the exchange will return a simple statement
saying that there are no terms of service available.
To configure the terms of service response, there are two options
-in the [exchange] section:
+in the ``[exchange]`` section:
-- TERMS_ETAG: The current "Etag" to return for the terms of service.
+- ``TERMS_ETAG``: The current "Etag" to return for the terms of service.
This value must be changed whenever the terms of service are
updated. A common value to use would be a version number.
- Note that if you change the TERMS_ETAG, you MUST also provide
- the respective files in TERMS_DIR (see below).
-- TERMS_DIR: The directory that contains the terms of service.
+ Note that if you change the ``TERMS_ETAG``, you MUST also provide
+ the respective files in ``TERMS_DIR`` (see below).
+- ``TERMS_DIR``: The directory that contains the terms of service.
The files in the directory must be readable to the exchange
process.
-The TERMS_DIR directory structure must follow a particular layout.
-First, inside of TERMS_DIR, there should be sub-directories using
+The ``TERMS_DIR`` directory structure must follow a particular layout.
+First, inside of ``TERMS_DIR``, there should be sub-directories using
two-letter language codes like "en", "de", or "jp". Each of these
directories would then hold translations of the current terms of
service into the respective language. Empty directories are
permitted in case translations are not available.
Then, inside each language directory, files with the name of the
-value set as the TERMS_ETAG must be provided. The extension of
+value set as the ``TERMS_ETAG`` must be provided. The extension of
each of the files should be typical for the respective mime type.
The set of supported mime types is currently hard-coded in the
exchange, and includes HTML, PDF and TXT files. If other files are
@@ -588,7 +588,7 @@ present, the exchange may show a warning on startup.
Example
^^^^^^^
-A sample file structure for a TERMS_ETAG of "v1" would be:
+A sample file structure for a ``TERMS_ETAG`` of "v1" would be:
- TERMS_DIR/en/v1.txt
- TERMS_DIR/en/v1.html
@@ -598,8 +598,8 @@ A sample file structure for a TERMS_ETAG of "v1" would be:
- TERMS_DIR/de/v1.pdf
- TERMS_DIR/fr/v1.pdf
-If the user requests an HTML with language preferences "fr" followed by "en",
-the exchange would return "TERMS_DIR/en/v1.html" lacking an HTML version in
+If the user requests an HTML format with language preferences "fr" followed by "en",
+the exchange would return ``TERMS_DIR/en/v1.html`` lacking an HTML version in
French.